Class: I2CE Wrangler (Development): Difference between revisions
From IHRIS Wiki
(Created page with '{{otherversions|Class: I2CE_Wrangler}} This article describes the class ''I2CE_Wrangler'' . *Extends the class: I2CE_Fuzzy. *Location: Part …') |
No edit summary |
||
Line 2: | Line 2: | ||
This article describes the class ''I2CE_Wrangler'' . | This article describes the class ''I2CE_Wrangler'' . | ||
*Extends the class: [[Class: I2CE_Fuzzy (Development) | I2CE_Fuzzy]]. | *Extends the class: [[Class: I2CE_Fuzzy (Development) | I2CE_Fuzzy]]. | ||
*Location: Part of the module [[I2CE Module List (Development)#pages|pages]] in the package [https://launchpad.net/i2ce I2CE] 4. | *Location: Part of the module [[I2CE Module List (Development)#pages|pages]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php#L29 modules/Pages/lib/I2CE_Wrangler.php] on line 29 | ||
==Variables== | ==Variables== | ||
===$command_line=== | ===$command_line=== | ||
true if we are called from the command line | true if we are called from the command line | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php#L108 i2ce/modules/Pages/lib/I2CE_Wrangler.php] on line 108 | ||
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $command_line | *Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $command_line | ||
==Methods== | ==Methods== | ||
===__construct()=== | ===__construct()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php#L110 i2ce/modules/Pages/lib/I2CE_Wrangler.php] on line 110 | ||
*Signature: public function __construct() | *Signature: public function __construct() | ||
===getArgs()=== | ===getArgs()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php#L263 i2ce/modules/Pages/lib/I2CE_Wrangler.php] on line 263 | ||
*Signature: protected function getArgs($args) | *Signature: protected function getArgs($args) | ||
*Parameters: | *Parameters: | ||
Line 21: | Line 21: | ||
===getPage()=== | ===getPage()=== | ||
Gets the page assoicated with a module | Gets the page assoicated with a module | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php#L123 i2ce/modules/Pages/lib/I2CE_Wrangler.php] on line 123 | ||
*Signature: public function getPage($module,$page,$request_remainder,$args,$get,$post) | *Signature: public function getPage($module,$page,$request_remainder,$args,$get,$post) | ||
*Parameters: | *Parameters: | ||
Line 35: | Line 35: | ||
***Default Value: null | ***Default Value: null | ||
===processPath()=== | ===processPath()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php#L213 i2ce/modules/Pages/lib/I2CE_Wrangler.php] on line 213 | ||
*Signature: protected function processPath($path) | *Signature: protected function processPath($path) | ||
*Parameters: | *Parameters: | ||
Line 41: | Line 41: | ||
===wrangle()=== | ===wrangle()=== | ||
Method to call to handle page wrangling | Method to call to handle page wrangling | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php#L39 i2ce/modules/Pages/lib/I2CE_Wrangler.php] on line 39 | ||
*Signature: public function wrangle($path,$display,$get,$post) | *Signature: public function wrangle($path,$display,$get,$post) | ||
*Parameters: | *Parameters: |
Latest revision as of 08:20, 6 May 2015
For other versions, see Class: I2CE_Wrangler (versions) .
This article describes the class I2CE_Wrangler .
- Extends the class: I2CE_Fuzzy.
- Location: Part of the module pages in the package I2CE 4.1-dev
- Source: Defined in the file modules/Pages/lib/I2CE_Wrangler.php on line 29
Variables
$command_line
true if we are called from the command line
- Defined in i2ce/modules/Pages/lib/I2CE_Wrangler.php on line 108
- Type: protected boolean $command_line
Methods
__construct()
- Defined in i2ce/modules/Pages/lib/I2CE_Wrangler.php on line 110
- Signature: public function __construct()
getArgs()
- Defined in i2ce/modules/Pages/lib/I2CE_Wrangler.php on line 263
- Signature: protected function getArgs($args)
- Parameters:
- $args
getPage()
Gets the page assoicated with a module
- Defined in i2ce/modules/Pages/lib/I2CE_Wrangler.php on line 123
- Signature: public function getPage($module,$page,$request_remainder,$args,$get,$post)
- Parameters:
- string $module
- string $page
- array $request_remainder
of string... anything that would be a part of the remainder of the URL- Default Value: array()
- array $args
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()
- Defined in i2ce/modules/Pages/lib/I2CE_Wrangler.php on line 213
- Signature: protected function processPath($path)
- Parameters:
- $path
wrangle()
Method to call to handle page wrangling
- Defined in i2ce/modules/Pages/lib/I2CE_Wrangler.php on line 39
- Signature: public function wrangle($path,$display,$get,$post)
- Parameters:
- string $path
If non-null the path of the page we want to wrangle. otherwise it processes from the url or commandline arguments Defaults to null- Default Value: null
- boolean $display
Set to true (default) to call the page's display() method- Default Value: true
- $get
- Default Value: null
- $post
- Default Value: null
- string $path
- Returns: I2CE_Page
the page created
Inherited Methods
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
Fuzzy Methods
manipulateWrangler_I2CE_logout()
This method is implemented by I2CE_Module_Login->manipulateWrangler()
manipulateWrangler_I2CE_home()
This method is implemented by I2CE_Module_ModulePrompter->changeHomePage()