Class: I2CE Wrangler: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article describes the class ''I2CE_Wrangler''.
This article describes the class ''I2CE_Wrangler''.
*Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
*Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
*Parent Classses:  [[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.0-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.0-release/annotate/head:/modules/Pages/lib/I2CE_Wrangler.php modules/Pages/lib/I2CE_Wrangler.php]
Line 47: Line 46:
***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
==Inherited Methods==
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Fuzzy Methods==
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
==Fuzzy Methods==
==Fuzzy Methods==
===manipulateWrangler_I2CE_logout()===
===manipulateWrangler_I2CE_logout()===

Revision as of 12:21, 19 October 2009

This article describes the class I2CE_Wrangler.

Variables

$command_line

true if we are called from the 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 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()