Class: I2CE Wrangler: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 13: Line 13:
===getArgs()===
===getArgs()===
*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
*Signature: public function getPage($module,$page,$request_remainder,$args,$get,$post)
*Signature: public function getPage($module,$page,$request_remainder,$args,$get,$post)
Parameters:
*Parameters:
* [http://www.php.net/manual/en/language.types.string.php string ] $module
** [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.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
** [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()
***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
** [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
Defaults to null
*Signature: public function wrangle($path,$display,$get,$post)
*Signature: public function wrangle($path,$display,$get,$post)
*Returns: [[Class: I2CE_Page | I2CE_Page]] -- the page created
*Parameters:
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 Defaults to null
* [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
**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
* [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
==Inherited Fuzzy Methods==
==Inherited Fuzzy Methods==
===userMessage()===
===userMessage()===

Revision as of 23:42, 16 October 2009

This article desrcibes the class I2CE_Wrangler.

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:
    • 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
  • 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()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_Wrangler&oldid=7827"