module_abstract Class Reference

Inheritance diagram for module_abstract:

Public Member Functions
	exec (array $prm=array())
	callbackTpl (array $prm)
	getResponse ()
	publish (array $prm=array())
	getName ()
	getAttr ($name)
	setAttr ($name, $value)
	getCfg ()

Protected Member Functions
	afterInit ()
	beforeExec ($realExec)
	middleExec ($realExec)
	afterExec ($realExec)
	getViewAction ()
	setViewAction ($action)
	getViewVar ($name)
	setViewVar ($name, $value)
	setViewVars (array $values)
	preFetch ()
	isCacheEnabled ()
	addCacheTag ($val)
	beforeInit ()

Protected Attributes
	$prmExec
	$tpl
	$cfg

Detailed Description

Abstract class for module classes

Definition at line 10 of file module/abstract.class.php.

Member Function Documentation

addCacheTag()

addCacheTag (   $val )

protected

Add a cache tag

Parameters

mixed

$val

The tag to add

Definition at line 239 of file module/abstract.class.php.

afterExec()

afterExec (   $realExec )

protected

Definition at line 146 of file module/abstract.class.php.

afterInit()

afterInit ( )

protected

Definition at line 26 of file module/abstract.class.php.

beforeExec()

beforeExec (   $realExec )

protected

Definition at line 136 of file module/abstract.class.php.

beforeInit()

beforeInit ( )

protectedinherited

Call just before the configuration initialisation

Definition at line 35 of file object.class.php.

callbackTpl()

callbackTpl

(

array

$prm

)

Definition at line 123 of file module/abstract.class.php.

exec()

exec ( array  $prm = array() )

final

Every called action must pass by this function

Parameters

null | string

$prm

Actopn Parameters

Exceptions

nException

if wrong parameter or other errors

Definition at line 40 of file module/abstract.class.php.

getAttr()

getAttr (   $name )

inherited

Get an attribute

Parameters

string

$name

Attribute name

Returns

mixed|null The attribute or null if not set

Definition at line 48 of file object.class.php.

getCfg()

getCfg ( )

inherited

Get the configuration object

Returns

config

Definition at line 67 of file object.class.php.

getName()

getName

(

)

Get the module name

Returns

string

Definition at line 251 of file module/abstract.class.php.

getResponse()

getResponse

(

)

Definition at line 129 of file module/abstract.class.php.

getViewAction()

getViewAction ( )

protected

Get the current view action

Returns

string

Definition at line 153 of file module/abstract.class.php.

getViewVar()

getViewVar (   $name )

protected

Get a variable for the view

Parameters

string

$name

Variable name

Returns

mixed|null The value or null if not existing

Definition at line 176 of file module/abstract.class.php.

isCacheEnabled()

isCacheEnabled ( )

protected

Check against the configuration if the current request should be cached

Returns

bool True if enabled

Definition at line 225 of file module/abstract.class.php.

middleExec()

middleExec (   $realExec )

protected

Definition at line 141 of file module/abstract.class.php.

preFetch()

preFetch ( )

protected

Function called just before fetching the TPL. This is useful to add cacheTag or change tpl properties

Definition at line 218 of file module/abstract.class.php.

publish()

publish

(

array

$prm = array()

)

Publish the module to shown

Returns

string The fetched view

Definition at line 204 of file module/abstract.class.php.

setAttr()

setAttr (   $name,   $value  )

inherited

Set an attribute

Parameters

string	$name	Attribute name
mixed	$value	Attribute value

Definition at line 58 of file object.class.php.

setViewAction()

setViewAction (   $action )

protected

Set the action which will use for the view

Parameters

string

$action

Definition at line 162 of file module/abstract.class.php.

setViewVar()

setViewVar (   $name,   $value  )

protected

Add a variable to the view

Parameters

string	$name	Variable name
mixed	$value

Definition at line 186 of file module/abstract.class.php.

setViewVars()

setViewVars ( array  $values )

protected

Add variables to the view with an array

Parameters

array

$values

Definition at line 195 of file module/abstract.class.php.

Field Documentation

$cfg

$cfg	protectedinherited

Definition at line 17 of file object.class.php.

$prmExec

$prmExec

protected

Definition at line 17 of file module/abstract.class.php.

$tpl

$tpl

protected

Definition at line 24 of file module/abstract.class.php.

---

The documentation for this class was generated from the following file:

• module/abstract.class.php