Class: I2CE Wrangler: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
*Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
*Location: Part of the module [[I2CE Module List#pages|pages]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[I2CE 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.1-release/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php modules/Pages/lib/I2CE_Wrangler.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/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.0.2-release/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.0.2-release/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.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php#L252 i2ce/modules/Pages/lib/I2CE_Wrangler.php] on line 252
*Signature: protected function getArgs($args)
*Signature: protected function getArgs($args)
*Parameters:
*Parameters:
Line 17: Line 20:
===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.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php#L122 i2ce/modules/Pages/lib/I2CE_Wrangler.php] on line 122
*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 30: Line 34:
***Default Value: null  
***Default Value: null  
===processPath()===
===processPath()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php#L202 i2ce/modules/Pages/lib/I2CE_Wrangler.php] on line 202
*Signature: protected function processPath($path)
*Signature: protected function processPath($path)
*Parameters:
*Parameters:
Line 35: Line 40:
===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.0.2-release/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:

Revision as of 09:19, 10 November 2009

This article describes the class I2CE_Wrangler.

Variables

$command_line

true if we are called from the command line

Methods

__construct()

getArgs()

getPage()

Gets the page assoicated with a module

  • Defined in i2ce/modules/Pages/lib/I2CE_Wrangler.php on line 122
  • 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()

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