Class: I2CE Wrangler: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
Line 14: | Line 14: | ||
*Signature: protected function getArgs($args) | *Signature: protected function getArgs($args) | ||
*Parameters: | *Parameters: | ||
*$args | **$args | ||
===getPage()=== | ===getPage()=== | ||
Gets the page assoicated with a module | Gets the page assoicated with a module | ||
Line 25: | Line 25: | ||
** [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 | ** [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() | ***Default Value: array() | ||
*$get | **$get | ||
***Default Value: null | ***Default Value: null | ||
*$post | **$post | ||
***Default Value: null | ***Default Value: null | ||
===processPath()=== | ===processPath()=== | ||
*Signature: protected function processPath($path) | *Signature: protected function processPath($path) | ||
*Parameters: | *Parameters: | ||
*$path | **$path | ||
===wrangle()=== | ===wrangle()=== | ||
Method to call to handle page wrangling | Method to call to handle page wrangling | ||
Line 41: | Line 41: | ||
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $display <br/>Set to true (default) to call the page's display() method | ** [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 | ***Default Value: true | ||
*$get | **$get | ||
***Default Value: null | ***Default Value: null | ||
*$post | **$post | ||
***Default Value: null | ***Default Value: null | ||
*Returns: [[Class: I2CE_Page | I2CE_Page]]<br/>the page created | *Returns: [[Class: I2CE_Page | I2CE_Page]]<br/>the page created |
Revision as of 12:10, 17 October 2009
This article desrcibes the class I2CE_Wrangler.
- Extends the class: I2CE_Fuzzy.
- Location: Part of the module pages in the package I2CE
- Source: Defined in the file modules/Pages/lib/I2CE_Wrangler.php
Variables
$command_line
true if we are called from the command line
- Type: protected boolean $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:
- 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()
- Signature: protected function processPath($path)
- Parameters:
- $path
wrangle()
Method to call to handle page wrangling
- 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 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()