Class: I2CE Wrangler: Difference between revisions

From IHRIS Wiki
No edit summary
(Redirected page to Class: I2CE Wrangler (4.1.7))
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article desrcibes the class ''I2CE_Wrangler''.
#REDIRECT [[Class: I2CE_Wrangler (4.1.7)]]
*Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
*Location: Part of the module [[iHRIS Module List#pages|pages]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php modules/Pages/lib/I2CE_Wrangler.php]
==Variables==
===$command_line===
true if we are called from the command line
*Type: protected n $command_line
 
==Methods==
===__construct()===
*Signature: public function __construct()
===getArgs()===
*Signature: protected function getArgs($args)
Parameters:
*$args
===getPage()===
Gets the page assoicated with a module
*Signature: public function getPage($module,$page,$request_remainder,$args,$get,$post)
Parameters:
* [http://www.php.net/manual/en/language.types.string.php string ] $module
* [http://www.php.net/manual/en/language.types.string.php string ] $page
* [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder<br/>of string... anything that would be a part of the remainder of the URL
**Default Value: array()
* [http://www.php.net/manual/en/language.types.array.php array ] $args<br/>an array of page arguments.  Defaults to the empty array. Overwrites anything found in config for the page style or page
**Default Value: array()
*$get
**Default Value: null
*$post
**Default Value: null
===processPath()===
*Signature: protected function processPath($path)
Parameters:
*$path
===wrangle()===
Method to call to handle page wrangling
Defaults to null
*Signature: public function wrangle($path,$display,$get,$post)
*Returns: [[Class: I2CE_Page | I2CE_Page]] -- the page created
Parameters:
* [http://www.php.net/manual/en/language.types.string.php string ] $path<br/>If non-null the path of the page we want to wrangle.  otherwise it processes from the url or commandline arguments
**Default Value: null
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $display<br/>Set to true (default) to call the page's display() method
**Default Value: true
*$get
**Default Value: null
*$post
**Default Value: null
==Inherited Fuzzy Methods==
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
==Fuzzy Methods==
===manipulateWrangler_I2CE_logout()===
This method is implemented by [[Class: I2CE_Module_Login#manipulateWrangler() | I2CE_Module_Login->manipulateWrangler() ]]
===manipulateWrangler_I2CE_home()===
This method is implemented by [[Class: I2CE_Module_ModulePrompter#changeHomePage() | I2CE_Module_ModulePrompter->changeHomePage() ]]
 
 
[[Category:Class Documentation]]

Latest revision as of 08:53, 23 August 2013