The eZModule class is used to instanciate and use modules & views. More...

Public Member Functions
	actionParameter ($parameterName, $view= '')
	Returns an action parameter value.
	addHook ($hookName, $function, $priority=1, $expandParameters=true, $append=false)
	Adds an entry to a hook.
	attribute ($attr)
	Returns the value of an attribute.
	attributes ()
	Returns the defined object attributes (as in persistent objects)
	currentAction ($view= '')
	Returns the current action name.
	currentModule ()
	Returns the current module name.
	currentRedirectionURI ()
	Creates the redirection URI for the current module, view & parameters.
	currentView ()
	Returns the current view name.
	errorCode ()
	Returns the last error code.
	errorModule ()
	Returns the error module which will be ran if an error occurs.
	exitStatus ()
	Returns the last exit status after a view has been executed.
	eZModule ($path, $file, $moduleName, $checkFileExistence=true)
	Constructor.
	forward ($module, $functionName, $parameters=false)
	Forwards the current execution to another module/view with the existing parameters.
	functionURI ($function)
	Returns the URI to a module's function.
	getNamedParameters ()
	Returns the named parameters array.
	handleError ($errorCode, $errorType=false, $parameters=array(), $userParameters=false)
	Runs the defined error module Sets the state of the module object to `failed` and sets the error code.
	hasActionParameter ($parameterName, $view= '')
	Checks if an action parameter is defined for a view.
	hasAttribute ($attr)
	Checks if an attribute exists.
	hasViewResult ($view= '')
	Checks if a view has a result set.
	initialize ($path, $file, $moduleName, $checkFileExistence=true)
	Initializes the module object.
	isCurrentAction ($actionName, $view= '')
	Checks if the current action is the given one.
	parameters ($viewName= '')
	Returns the defined parameter for a view.
	redirect ($moduleName, $viewName, $parameters=array(), $unorderedParameters=null, $userParameters=false, $anchor=false)
	Redirects to another module / view.
	redirectCurrent ()
	Redirects to the current module and view, it will use currentRedirectionURI() to figure out the URL.
	redirectionURI ($moduleName, $viewName, $parameters=array(), $unorderedParameters=null, $userParameters=false, $anchor=false)
	Creates the redirection URI for a given module, view & parameters.
	redirectionURIForModule ($module, $viewName, $parameters=array(), $unorderedParameters=null, $userParameters=false, $anchor=false)
	Creates the redirection URI for a given module, view & parameters.
	redirectModule ($module, $viewName, $parameters=array(), $unorderedParameters=null, $userParameters=false, $anchor=false)
	Redirects to another module / view.
	redirectStatus ()
	Returns the redirection HTTP status (!)
	redirectTo ($uri)
	Sets the module to redirect at the end of the execution.
	redirectToView ($viewName= '', $parameters=array(), $unorderedParameters=null, $userParameters=false, $anchor=false)
	Redirects to another view in the current module.
	redirectURI ()
	Returns the current redirection URI.
	run ($functionName, $parameters=array(), $overrideParameters=false, $userParameters=false)
	Runs a function in the current module.
	runHooks ($hookName, $parameters=null)
	Runs all hooks found in the hook list named $hookName.
	setActionParameter ($parameterName, $parameterValue, $view= '')
	Sets an action parameter value.
	setCurrentAction ($actionName, $view= '')
	Sets the current action for a view.
	setCurrentName ($name)
	Sets the name of the currently running module.
	setCurrentView ($name)
	Sets the currently executed view.
	setErrorCode ($errorCode)
	Sets the current error code.
	setErrorModule ($moduleName, $viewName)
	Sets the module to be used to handle errors.
	setExitStatus ($stat)
	Sets the exit status.
	setRedirectStatus ($status)
	Sets the HTTP status which will be set when redirecting.
	setRedirectURI ($uri)
	Sets the URI which will be redirected to when the function exits.
	setTitle ($title)
	Sets the current view for the module to $title.
	setUIComponentName ($component)
	Sets the current component name.
	setUIContextName ($context)
	Sets the current context.
	setViewResult ($result, $view= '')
	Sets the view result.
	singleFunction ()
	Checks if the module is a single view one.
	title ()
	Returns the title of the last ran view.
	uiComponentName ()
	Returns the UI component, by default the module name.
	uiContextName ()
	Returns the UI context.
	unorderedParameters ($viewName= '')
	Returns the unordered parameters definition.
	uri ()
	Returns the module's URI (/content, /user...)
	viewData ($viewName= '')
	Returns data for a view.
	viewResult ($view= '')
	Returns the view result.
Static Public Member Functions
static	accessAllowed (eZURI $uri)
	Checks if access is allowed to a module/view based on site.ini[SiteAccessRules]Rules[] settings.
static	activeModuleRepositories ($useExtensions=true)
	Returns the list of active module repositories, as defined in module.ini.
static	addGlobalPathList ($pathList)
	Adds a new entry to the global path list.
static	exists ($moduleName, $pathList=null, $showError=false)
	Loads a module object by name.
static	findModule ($moduleName, $module=null, $pathList=null, $showError=false)
	Loads a module object by name.
static	globalPathList ()
	Returns the search path list for modules.
static	setGlobalPathList ($pathList)
	Sets the value of the global path list used to search for modules.
Public Attributes
	$ErrorCode
	$ExitStatus
	$Functions
	$HookList
	$Module
	$Name
	$NamedParameters
	$OriginalParameters
	$OriginalUnorderedParameters
	$OriginalViewParameters
	$Path
	$RedirectStatus
	$RedirectURI
	$Title
	$UIComponent
	$UIComponentMatch
	$UIContext
	$UserParameters
	$ViewActions
	$ViewParameters
	$ViewResult
const	HOOK_STATUS_CANCEL_RUN = 1
const	HOOK_STATUS_FAILED = 2
const	HOOK_STATUS_OK = 0
const	STATUS_FAILED = 2
const	STATUS_IDLE = 0
const	STATUS_OK = 1
const	STATUS_REDIRECT = 3
const	STATUS_RERUN = 4

Detailed Description

The eZModule class is used to instanciate and use modules & views.

Loading the "content" module, and running the "history" view <?php $contentModule = eZModule::findModule( 'content' ); $result = $contentModule->run( 'history', array( 1 ) ); ?>

Running the CopyVersion action of the content/history view: <?php $contentModule = eZModule::findModule( 'content' ); $contentModule->setCurrentView( 'history' ); $contentModule->setCurrentAction( 'CopyVersion' ); // we will copy version 3 $contentModule->setActionParameter( 'VersionID', 3 ); $contentModule->run( 'history', array( 20 ) ); ?>

Definition at line 35 of file ezmodule.php.

Member Function Documentation

static eZModule::accessAllowed ( eZURI $ uri ) [static]

Checks if access is allowed to a module/view based on site.ini[SiteAccessRules]Rules[] settings.

Since:: 4.4

Parameters:

eZURI $uri

Returns:: array An associative array with: 'result' => bool Indicates if access is allowed 'module' => string Module name 'view' => string View name 'view_checked' => bool Indicates if view access has been checked

Definition at line 1837 of file ezmodule.php.

Referenced by accessAllowed().

eZModule::actionParameter	(	$	parameterName,
		$	view = `''`
	)

Returns an action parameter value.

Parameters:

string	$parameterName
string	$view	The view to return the parameter for. If omited, uses the current view

Returns:: mixed The parameter value, or null + error if not found

See also:: setActionParameter(), hasActionParameter()

Definition at line 1023 of file ezmodule.php.

static eZModule::activeModuleRepositories ( $ useExtensions = true ) [static]

Returns the list of active module repositories, as defined in module.ini.

Parameters:

boolean $useExtensions If true, module.ini files in extensions will be scanned as well. If false, only the module.ini overrides in settings will be.

Returns:: array a path list of currently active modules

Definition at line 1648 of file ezmodule.php.

Referenced by eZScript\initialize(), and eZSiteAccess\load().

static eZModule::addGlobalPathList ( $ pathList ) [static]

Adds a new entry to the global path list.

Parameters:

array | string $pathList Either an array of path or a single path string

Returns:: void

See also:: setGlobalPathList(), globalPathList()

Definition at line 1715 of file ezmodule.php.

eZModule::addHook	(	$	hookName,
		$	function,
		$	priority = `1`,
		$	expandParameters = `true`,
		$	append = `false`
	)

Adds an entry to a hook.

The entry is placed before all other existing entries (LIFO) unless $append is set to true.

Parameters:

string	$hookName	The hook name.
string	$function	Either the name of the function to be run or an array where the first entry is the object and the second is the method name.
integer	$priority	The hook priority in the hooks stack.
boolean	$expandParameters	Wether or not to expand parameters. If set to true (default), the parameters will be sent as real function parameters to the hooked function/method. If set to false, they will be sent as a single array. In both cases, the eZModule object will be the first parameter sent to each hook.
boolean	$append	If set to false (default), the hook will be added at the top of the hooks list. If set to true, it will be added at the end

Returns:: void

Definition at line 1156 of file ezmodule.php.

eZModule::attribute ( $ attr )

Returns the value of an attribute.

Parameters:

string $attr Attribute name

Returns:: mixed The attribute value. If the attribute doesn't exist, a warning is thrown, and false is returned

Definition at line 853 of file ezmodule.php.

eZModule::attributes ( )

Returns the defined object attributes (as in persistent objects)

Returns:: array the persistent object attributes

Definition at line 821 of file ezmodule.php.

Referenced by hasAttribute().

eZModule::currentAction ( $ view = '' )

Returns the current action name.

If the current action is not yet determined it will use the definitions in module.php in order to find out the current action. It first looks trough the single_post_actions array in the selected view mode, the key to each element is the name of the post-variable to match, if it matches the element value is set as the action.

 'single_post_actions' => array( 'PreviewButton' => 'Preview',
                                 'PublishButton' => 'Publish' )

If none of these matches it will use the elements from the post_actions array to find a match. It uses the element value for each element to match agains a post-variable, if it is found the contents of the post-variable is set as the action.

 'post_actions' => array( 'BrowseActionName' )

Returns:: string The current action, or false if not set nor found

See also:: setCurrentAction(), isCurrentAction()

Definition at line 926 of file ezmodule.php.

Referenced by actionParameter(), hasActionParameter(), and isCurrentAction().

eZModule::currentModule ( )

Returns the current module name.

Returns:: string the current module name, or false if not set

Note:: This is a system-wide value

Definition at line 1617 of file ezmodule.php.

eZModule::currentRedirectionURI ( )

Creates the redirection URI for the current module, view & parameters.

Returns:: string The redirection URI

See also:: redirectionURIForModule()

Definition at line 575 of file ezmodule.php.

Referenced by redirectCurrent().

eZModule::currentView ( )

Returns the current view name.

Returns:: string The current view name, or false if not defined

Note:: This is a system-wide value

See also:: currentModule(), setCurrentView()

Definition at line 1602 of file ezmodule.php.

Referenced by actionParameter(), currentAction(), currentRedirectionURI(), forward(), hasActionParameter(), hasViewResult(), isCurrentAction(), parameters(), redirectionURIForModule(), setActionParameter(), setCurrentAction(), setViewResult(), unorderedParameters(), viewData(), and viewResult().

eZModule::errorCode ( )

Returns the last error code.

An error should only be returned if the module's status is eZModule::STATUS_FAILED

Returns:: int The error code, or 0 if no error occured

See also:: setErrorCode(), exitStatus(), setExitStatus()

Definition at line 372 of file ezmodule.php.

eZModule::errorModule ( )

Returns the error module which will be ran if an error occurs.

Returns:: array the error module name (keys: module, view)

See also:: handleError()

Definition at line 396 of file ezmodule.php.

Referenced by handleError().

static eZModule::exists	(	$	moduleName,
		$	pathList = `null`,
		$	showError = `false`
	)		`[static]`

Loads a module object by name.

Parameters:

string	$moduleName	The name of the module to find (ex: content)
	array\|string	Either an array of path or a single path string. These will be used as additionnal locations that will be looked into
boolean	$showError	If true an error will be shown if the module it not found.

Returns:: eZModule The eZModule object, or null if the module wasn't found

See also:: findModule()

Definition at line 1740 of file ezmodule.php.

Referenced by eZPolicyLimitation\allValuesAsArrayWithNames(), fetchModule(), redirect(), redirectionURI(), and eZURLAliasML\urlToAction().

eZModule::exitStatus ( )

Returns the last exit status after a view has been executed.

Returns:: int one of STATUS_* constants

See also:: setExitStatus()

Definition at line 345 of file ezmodule.php.

Referenced by handleError().

eZModule::eZModule	(	$	path,
		$	file,
		$	moduleName,
		$	checkFileExistence = `true`
	)

Constructor.

Initializes the module.

Parameters:

string	$path	Relative path to the module, without the module name
string	$file	Relative path to the module definition file module.php
string	$moduleName
boolean	$checkFileExistence	Always set to false in the current code base, since the check is usually performed before the constructor is called

Definition at line 97 of file ezmodule.php.

Referenced by findModule().

static eZModule::findModule	(	$	moduleName,
		$	module = `null`,
		$	pathList = `null`,
		$	showError = `false`
	)		`[static]`

Loads a module object by name.

The only difference with exists() is that the $module parameter will be assigned the found module.

Parameters:

string	$moduleName	The name of the module to find (ex: content)
mixed	$module	This parameter will receive the found module object
	array\|string	Either an array of path or a single path string. These will be used as additionnal locations that will be looked into
boolean	$showError	If true an error will be shown if the module it not found.

Returns:: eZModule The eZModule object, or null if the module wasn't found

See also:: exists()

Definition at line 1761 of file ezmodule.php.

Referenced by exists(), and handleError().

eZModule::forward	(	$	module,
		$	functionName,
		$	parameters = `false`
	)

Forwards the current execution to another module/view with the existing parameters.

Parameters:

eZModule	$module	The eZModule object the request will be forwarded to
string	$functionName	The function to run in that module
array	$parameters	An array of parameters that will be added to the request. These will be merged with the existing parameters

Returns:: array The forwarded module/view result

Definition at line 1349 of file ezmodule.php.

eZModule::functionURI ( $ function )

Returns the URI to a module's function.

Parameters:

string $function The function to return the URI for

Returns:

string|null

the function's URI (content/edit, user/login, etc)
if $function is empty or the module is a singleView one, the module's uri (content/, user/...)
null if the function's not found

See also:: uri()

Definition at line 209 of file ezmodule.php.

eZModule::getNamedParameters ( )

Returns the named parameters array.

Returns:: array

Definition at line 1821 of file ezmodule.php.

static eZModule::globalPathList ( ) [static]

Returns the search path list for modules.

Returns:: array

See also:: setGlobalPathList(), addGlobalPathList()

Definition at line 1632 of file ezmodule.php.

Referenced by findModule(), eZModuleFunctionInfo\loadDefinition(), and eZModuleOperationInfo\loadDefinition().

eZModule::handleError	(	$	errorCode,
		$	errorType = `false`,
		$	parameters = `array()`,
		$	userParameters = `false`
	)

Runs the defined error module Sets the state of the module object to failed and sets the error code.

Parameters:

mixed	$errorCode
mixed	$errorType
array	$parameters
mixed	$userParameters

See also:: setErrorModule(), errorModule()

Definition at line 429 of file ezmodule.php.

eZModule::hasActionParameter	(	$	parameterName,
		$	view = `''`
	)

Checks if an action parameter is defined for a view.

Parameters:

string	$parameterName
string	$view	The view to check the parameter for. If omited, uses the current view

Returns:: bool

See also:: setActionParameter(), actionParameter()

Definition at line 1075 of file ezmodule.php.

eZModule::hasAttribute ( $ attr )

Checks if an attribute exists.

Parameters:

string $attr Attribute name

Returns:: bool True if the attribute exists, false otherwise

Definition at line 840 of file ezmodule.php.

eZModule::hasViewResult ( $ view = '' )

Checks if a view has a result set.

Parameters:

string $view The view to test for. If omited, uses the current view

Returns:: bool

Definition at line 1312 of file ezmodule.php.

Referenced by run().

eZModule::initialize	(	$	path,
		$	file,
		$	moduleName,
		$	checkFileExistence = `true`
	)

Initializes the module object.

Parameters:

string	$path	Directory where the module is declared, without the modulename component
string	$file	Full (relative) path to the module.php file describing the module
string	$moduleName	The module name (content, user...)
bool	$checkFileExistence	Wether or not $file's existence should be checked

Returns:: void

Definition at line 116 of file ezmodule.php.

Referenced by eZModule().

eZModule::isCurrentAction	(	$	actionName,
		$	view = `''`
	)

Checks if the current action is the given one.

Parameters:

string	$actionName	The action to check
string	$view	The view to check the action for. Current view if omited.

Returns:: bool

See also:: currentAction(), setCurrentAction()

Definition at line 1124 of file ezmodule.php.

eZModule::parameters ( $ viewName = '' )

Returns the defined parameter for a view.

Parameters:

string $viewName The view to get parameters for. If not specified, the current view is used

Returns:: array The parameters definition

See also:: unorderedParameters(), viewData(), currentView(), currentModule()

Definition at line 693 of file ezmodule.php.

eZModule::redirect	(	$	moduleName,
		$	viewName,
		$	parameters = `array()`,
		$	unorderedParameters = `null`,
		$	userParameters = `false`,
		$	anchor = `false`
	)

Redirects to another module / view.

Note:: Use redirectModule() If the target module object is already available; Use redirectToView() if you want to redirect to another view in the same module

See also:: redirectionURI(), redirectModule(), redirectToView()

Parameters:

string	$moduleName	Target module name
string	$viewName	Target view name
array	$parameters	View parameters array
array	$unorderedParameters	Unordered parameters array
array	$userParameters	User parameters array
string	$anchor	Anchor to use in the redirection (prepended to the URL)

Returns:: bool true if the redirection was performed, false if the module wasn't found

Definition at line 473 of file ezmodule.php.

eZModule::redirectCurrent ( )

Redirects to the current module and view, it will use currentRedirectionURI() to figure out the URL.

Note:: By changing using setCurrentName() and setCurrentView() first it is possible to redirect to another module or view with the same parameters.

See also:: currentRedirectionURI(), redirectTo()

Returns:: void

Definition at line 598 of file ezmodule.php.

eZModule::redirectionURI	(	$	moduleName,
		$	viewName,
		$	parameters = `array()`,
		$	unorderedParameters = `null`,
		$	userParameters = `false`,
		$	anchor = `false`
	)

Creates the redirection URI for a given module, view & parameters.

Unlike redirectionURIForModule(), the $module parameter is the module name

Parameters:

string	$moduleName	Redirection module name
string	$viewName	Redirection view name
array	$parameters	View parameters
array	$unorderedParameters	Unordered parameters
array	$userParameters	User parameters
string	$anchor	Redirection URI anchor

Returns:: string|boolean The redirection URI, or false if the module isn't found

See also:: redirect(), redirectionURIForModule(), redirectToView(), redirectModule()

Definition at line 553 of file ezmodule.php.

eZModule::redirectionURIForModule	(	$	module,
		$	viewName,
		$	parameters = `array()`,
		$	unorderedParameters = `null`,
		$	userParameters = `false`,
		$	anchor = `false`
	)

Creates the redirection URI for a given module, view & parameters.

Unlike redirectionURI(), the $module parameter is a module object

Parameters:

string	$moduleName	Redirection module name
string	$viewName	Redirection view name. If empty, the current view will be used
array	$parameters	View parameters
array	$unorderedParameters	Unordered parameters
array	$userParameters	User parameters
string	$anchor	Redirection URI anchor

Returns:: string|boolean The redirection URI, or false if the module isn't found

See also:: redirect(), redirectionURIForModule(), redirectToView(), redirectModule()

Definition at line 619 of file ezmodule.php.

Referenced by currentRedirectionURI(), redirectionURI(), and redirectModule().

eZModule::redirectModule	(	$	module,
		$	viewName,
		$	parameters = `array()`,
		$	unorderedParameters = `null`,
		$	userParameters = `false`,
		$	anchor = `false`
	)

Redirects to another module / view.

The difference with redirect is that the $module parameter is an object instead of a string

Parameters:

eZModule	$moduleName	Target module name
string	$viewName	Target view name
array	$parameters	View parameters array
array	$unorderedParameters	Unordered parameters array
array	$userParameters	User parameters array
string	$anchor	Redirection URI anchor

Returns:: boolean true. Just true.

Todo:: Deprecate; have redirect() check if $module is an eZModule or a string

Definition at line 528 of file ezmodule.php.

Referenced by redirect(), and redirectToView().

eZModule::redirectStatus ( )

Returns the redirection HTTP status (!)

See also:: setRedirectStatus();

Returns:: the HTTP Status header

Definition at line 799 of file ezmodule.php.

eZModule::redirectTo ( $ uri )

Sets the module to redirect at the end of the execution.

Parameters:

string $uri the URI to redirect to

See also:: setRedirectURI(), setExitStatus()

Returns:: void

Definition at line 757 of file ezmodule.php.

Referenced by redirectCurrent(), and redirectModule().

eZModule::redirectToView	(	$	viewName = `''`,
		$	parameters = `array()`,
		$	unorderedParameters = `null`,
		$	userParameters = `false`,
		$	anchor = `false`
	)

Redirects to another view in the current module.

See also:: redirectionURI(), redirectModule(), redirect()

Parameters:

string	$viewName	Target view name
array	$parameters	View parameters
array	$unorderedParameters	Unordered view parameters
array	$userParameters	User parameters
string	$anchor	Redirection URI anchor

Returns:: boolean true if successful, false if the view isn't found

Definition at line 503 of file ezmodule.php.

eZModule::redirectURI ( )

Returns the current redirection URI.

Returns:: string

See also:: setRedirectURI()

Definition at line 775 of file ezmodule.php.

eZModule::run	(	$	functionName,
		$	parameters = `array()`,
		$	overrideParameters = `false`,
		$	userParameters = `false`
	)

Runs a function in the current module.

Parameters:

string	$functionName	The function to run
array	$parameters	An indexed list of parameters, these will be mapped onto real parameters names using the defined parameters names in the module/function definition. Any unspecified parameter will be assigned null.
array	$overrideParameters	An asociative array of parameters that will ultimately override what's in $parameters
array	$userParameters	User (custom view) parameters

Returns:: array The run result

Definition at line 1403 of file ezmodule.php.

eZModule::runHooks	(	$	hookName,
		$	parameters = `null`
	)

Runs all hooks found in the hook list named $hookName.

Parameters:

string	$hookName
array	$parameters	Parameters to provide each function with

Returns:

integer The hook execution status, as one of the eZModule::HOOK_STATUS_* constants:

HOOK_STATUS_OK: means that every hook was executed correctly.
HOOK_STATUS_CANCEL_RUN: execution was cancelled by one hook
HOOK_STATUS_FAILED: only returned if the last hook failed. In any case, a warning is thrown.

Definition at line 1195 of file ezmodule.php.

eZModule::setActionParameter	(	$	parameterName,
		$	parameterValue,
		$	view = `''`
	)

Sets an action parameter value.

Parameters:

string	$parameterName
mixed	$parameterValue
string	$view	The view to set the action parameter for. If omited, the current view is used

Returns:: void

See also:: actionParameter(), hasActionParameter()

Definition at line 1006 of file ezmodule.php.

eZModule::setCurrentAction	(	$	actionName,
		$	view = `''`
	)

Sets the current action for a view.

Parameters:

string	$actionName	The action to make current
string	$view	The view to set the action for. If omited, the current view is used

Returns:: void

See also:: currentAction(), isCurrentAction()

Definition at line 893 of file ezmodule.php.

eZModule::setCurrentName ( $ name )

Sets the name of the currently running module.

The URIs will be updated accordingly

Parameters:

string $name The name to be set

Returns:: void

See also:: uri(), functionURI()

Definition at line 255 of file ezmodule.php.

eZModule::setCurrentView ( $ name )

Sets the currently executed view.

Parameters:

string $name The view name

Returns:: void

See also:: currentView()

Definition at line 273 of file ezmodule.php.

eZModule::setErrorCode ( $ errorCode )

Sets the current error code.

Note:: For the error code to be used, the module's status needs to be set to eZModule::STATUS_FAILED

See also:: setExitStatus(), errorCode()

Returns:: void

Definition at line 384 of file ezmodule.php.

Referenced by handleError().

eZModule::setErrorModule	(	$	moduleName,
		$	viewName
	)

Sets the module to be used to handle errors.

Parameters:

string	$moduleName
string	$viewName

See also:: handleError(), errorModule()

Definition at line 412 of file ezmodule.php.

eZModule::setExitStatus ( $ stat )

Sets the exit status.

This status will be used to inform the user, perform a redirection...

Parameters:

int $stat One of the eZModule::STATUS_* constants

See also:: exitStatus()

Returns:: void

Definition at line 359 of file ezmodule.php.

Referenced by forward(), handleError(), redirectTo(), and run().

static eZModule::setGlobalPathList ( $ pathList ) [static]

Sets the value of the global path list used to search for modules.

Parameters:

array | string $pathList Either an array of path, or a single path as a string

Returns:: void

See also:: addGlobalPathList(), globalPathList()

Definition at line 1701 of file ezmodule.php.

Referenced by eZScript\initialize(), and eZSiteAccess\load().

eZModule::setRedirectStatus ( $ status )

Sets the HTTP status which will be set when redirecting.

Parameters:

string $status HTTP status

Note:: The status must be a valid HTTP status with number and text.

Definition at line 811 of file ezmodule.php.

eZModule::setRedirectURI ( $ uri )

Sets the URI which will be redirected to when the function exits.

Parameters:

string $uri The redirection URI

Returns:: void

Definition at line 787 of file ezmodule.php.

eZModule::setTitle ( $ title )

Sets the current view for the module to $title.

Parameters:

string $title The title to be set

See also:: title()

Definition at line 240 of file ezmodule.php.

eZModule::setUIComponentName ( $ component )

Sets the current component name.

Parameters:

string $component The new component name

See also:: uiComponentName()

Returns:: void

Definition at line 333 of file ezmodule.php.

eZModule::setUIContextName ( $ context )

Sets the current context.

Parameters:

string $context The new context string

See also:: uiContextName()

Returns:: void

Definition at line 319 of file ezmodule.php.

eZModule::setViewResult	(	$	result,
		$	view = `''`
	)

Sets the view result.

Parameters:

string	$result	The (usually HTML) view result
string	$view	The view to set the result for. If omited, the current view is used

Returns:: void

See also:: hasViewResult(), viewResult()

Definition at line 1299 of file ezmodule.php.

eZModule::singleFunction ( )

Checks if the module is a single view one.

Returns:: bool

Definition at line 282 of file ezmodule.php.

Referenced by forward(), functionURI(), run(), and viewData().

eZModule::title ( )

Returns the title of the last ran view.

Normally set by the view itself, and displayed as the page's title

Returns:: string

See also:: setTitle()

Definition at line 228 of file ezmodule.php.

eZModule::uiComponentName ( )

Returns the UI component, by default the module name.

Returns:: string The current UI component

See also:: setUIComponentName()

Definition at line 305 of file ezmodule.php.

eZModule::uiContextName ( )

Returns the UI context.

Returns:: string The current UI context. Default: 'navigation'

See also:: setUIContextName()

Definition at line 293 of file ezmodule.php.

eZModule::unorderedParameters ( $ viewName = '' )

Returns the unordered parameters definition.

Parameters:

string $viewName The view to return parameters for. If npt specified, the current view is used

Returns:: the unordered parameter definition for the requested view

See also:: parameters(), viewData(), currentView(), currentModule()

Definition at line 716 of file ezmodule.php.

eZModule::uri ( )

Returns the module's URI (/content, /user...)

Returns:: string The module's URI

See also:: functionURI()

Definition at line 192 of file ezmodule.php.

Referenced by attribute(), and functionURI().

eZModule::viewData ( $ viewName = '' )

Returns data for a view.

Parameters:

string $viewName The view to return data for. If omited, the current view is used

See also:: parameters(), unorderedParameters(), currentView(), currentModule()

Returns:: array

Definition at line 737 of file ezmodule.php.

Referenced by parameters(), and unorderedParameters().

eZModule::viewResult ( $ view = '' )

Returns the view result.

Parameters:

string $view The view to return the result for, or the current one if omited

Returns:: string|null The view result, or null if not set

Definition at line 1327 of file ezmodule.php.

Referenced by run().

Member Data Documentation

eZModule::$ErrorCode

Definition at line 1948 of file ezmodule.php.

eZModule::$ExitStatus

Definition at line 1941 of file ezmodule.php.

eZModule::$Functions

Definition at line 1907 of file ezmodule.php.

eZModule::$HookList

Definition at line 1976 of file ezmodule.php.

eZModule::$Module

Definition at line 1919 of file ezmodule.php.

Referenced by initialize().

eZModule::$Name

Definition at line 1925 of file ezmodule.php.

eZModule::$NamedParameters

Definition at line 2019 of file ezmodule.php.

eZModule::$OriginalParameters

Definition at line 2005 of file ezmodule.php.

eZModule::$OriginalUnorderedParameters

Definition at line 2026 of file ezmodule.php.

eZModule::$OriginalViewParameters

Definition at line 2012 of file ezmodule.php.

eZModule::$Path

Definition at line 1932 of file ezmodule.php.

eZModule::$RedirectStatus

Definition at line 1962 of file ezmodule.php.

eZModule::$RedirectURI

Definition at line 1955 of file ezmodule.php.

eZModule::$Title

Definition at line 1969 of file ezmodule.php.

eZModule::$UIComponent

Definition at line 2049 of file ezmodule.php.

eZModule::$UIComponentMatch

Definition at line 2057 of file ezmodule.php.

eZModule::$UIContext

Definition at line 2041 of file ezmodule.php.

eZModule::$UserParameters

Definition at line 2033 of file ezmodule.php.

eZModule::$ViewActions

Definition at line 1984 of file ezmodule.php.

eZModule::$ViewParameters

Definition at line 1998 of file ezmodule.php.

eZModule::$ViewResult

Definition at line 1991 of file ezmodule.php.

const eZModule::HOOK_STATUS_CANCEL_RUN = 1

Definition at line 77 of file ezmodule.php.

Referenced by checkNodeActions(), checkRelationActions(), checkRelationAssignments(), and runHooks().

const eZModule::HOOK_STATUS_FAILED = 2

Definition at line 83 of file ezmodule.php.

Referenced by runHooks().

const eZModule::HOOK_STATUS_OK = 0

Definition at line 71 of file ezmodule.php.

Referenced by runHooks().

const eZModule::STATUS_FAILED = 2

Definition at line 53 of file ezmodule.php.

Referenced by handleError(), and run().

const eZModule::STATUS_IDLE = 0

Definition at line 41 of file ezmodule.php.

Referenced by initialize().

const eZModule::STATUS_OK = 1

Definition at line 47 of file ezmodule.php.

Referenced by run().

const eZModule::STATUS_REDIRECT = 3

Definition at line 59 of file ezmodule.php.

Referenced by handleError(), and redirectTo().

const eZModule::STATUS_RERUN = 4

Definition at line 65 of file ezmodule.php.

Referenced by handleError().

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

ezmodule.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation