Class: I2CE Wrangler

From IHRIS Wiki
Revision as of 20:26, 16 October 2009 by Litlfred (talk | contribs)

This article desrcibes the class I2CE_Wrangler which extends the class I2CE_Fuzzy It is contained in the module pages in the package I2CE

The class is defined in the file: modules/Pages/lib/I2CE_Wrangler.php

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 Defaults to null

  • Signature: public function wrangle($path,$display,$get,$post)
  • Returns: I2CE_Page -- the page created

Parameters:

  • string $path
    If non-null the path of the page we want to wrangle. otherwise it processes from the url or commandline arguments
    • 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

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