Phpfox_Component

Description

Module Component Parent Class is parent with all block/controller components that control each page on the site as well as blocks found on this pages.

  • author: Raymond Benc
  • version: $Id: component.class.php 1687 2010-07-22 03:13:27Z Raymond_Benc $
  • copyright: [PHPFOX_COPYRIGHT]

Located in /include/library/phpfox/module/component.class.php (line 18)


	
			
Variable Summary
 static array $_aParams
 static string $_sMenuName
 string $_sCacheVar
 string $_sComponent
 string $_sModule
Method Summary
 Phpfox_Component __construct (array $aParams)
 mixed getParam (string $sVar, [string $mDef = null])
 object This param (string $sVar)
 object request ()
 void setParam (mixed $mParams, [string $sValue = ''])
 object template ()
 object url ()
 string _getMenuName ()
 void _setMenuName (string $sMenuName)
 mixed __get (string $sData)
Variables
static array $_aParams = array() (line 26)

Params that can be passed to a component other then request methods.

  • access: private
static string $_sMenuName = null (line 54)

Holds the current menu for the page we are on.

  • access: private
string $_sCacheVar = null (line 47)

Groups params based on unique cache ID for the component.

  • access: private
string $_sComponent (line 40)

Holds the current component being loaded.

  • access: private
string $_sModule (line 33)

Holds the current module that component belongs to.

  • access: private
Methods
Constructor __construct (line 62)

Class constructor that sets all the variables to identify what component we are loading, module it is a part of and any custom params we are passing.

  • access: public
Phpfox_Component __construct (array $aParams)
  • array $aParams: ARRAY of params we are passing to the component.
getParam (line 132)

Get a param for any component loaded after it was set using the method setParam()

  • return: If the param exists we return the value or NULL if nothing was found and a default value was not provided.
  • see: self::setParam()
  • access: protected
mixed getParam (string $sVar, [string $mDef = null])
  • string $sVar: Var name of the param.
  • string $mDef: If we cannot find the param you can provide a default value.
param (line 176)

Creates a groupig for a param.

  • return: this class.
  • access: protected
object This param (string $sVar)
  • string $sVar: The name of the group.
request (line 165)

Extends the request class and returns its class object.

object request ()
setParam (line 111)

Set a param that can be used in other component so we don't pass information via get/post requests.

  • access: protected
void setParam (mixed $mParams, [string $sValue = ''])
  • mixed $mParams: ARRAY or string of param with values.
  • string $sValue: Value of param if argument 1 is not an ARRAY.
template (line 143)

Extends the template class and returns its class object.

object template ()
url (line 154)

Extends the url class and returns its class object.

object url ()
_getMenuName (line 100)

Get the current menu name of the page we are on.

  • access: protected
string _getMenuName ()
_setMenuName (line 90)

Set the menu name for the current page we are on.

  • access: protected
void _setMenuName (string $sMenuName)
  • string $sMenuName: Unique menu name.
__get (line 75)

Gets a param that is part of this component group.

  • return: If param exists we return the param value otherwise we return NULL.
  • access: public
mixed __get (string $sData)
  • string $sData: Param name.

Documentation generated on Tue, 28 Sep 2010 10:36:38 +0200 by phpDocumentor 1.4.0a2