eZPublishCommunityProject(LegacyStack)  2013.9
eZModule Class Reference

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

Public Member Functions

 actionParameter ($parameterName, $view= '')
 Returns an action parameter value. More...
 
 addHook ($hookName, $function, $priority=1, $expandParameters=true, $append=false)
 Adds an entry to a hook. More...
 
 attribute ($attr)
 Returns the value of an attribute. More...
 
 attributes ()
 Returns the defined object attributes (as in persistent objects) More...
 
 currentAction ($view= '')
 Returns the current action name. More...
 
 currentModule ()
 Returns the current module name. More...
 
 currentRedirectionURI ()
 Creates the redirection URI for the current module, view & parameters. More...
 
 currentView ()
 Returns the current view name. More...
 
 errorCode ()
 Returns the last error code. More...
 
 errorModule ()
 Returns the error module which will be ran if an error occurs. More...
 
 exitStatus ()
 Returns the last exit status after a view has been executed. More...
 
 eZModule ($path, $file, $moduleName, $checkFileExistence=true)
 Constructor. More...
 
 forward ($module, $functionName, $parameters=false)
 Forwards the current execution to another module/view with the existing parameters. More...
 
 functionURI ($function)
 Returns the URI to a module's function. More...
 
 getNamedParameters ()
 Returns the named parameters array. More...
 
 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. More...
 
 hasActionParameter ($parameterName, $view= '')
 Checks if an action parameter is defined for a view. More...
 
 hasAttribute ($attr)
 Checks if an attribute exists. More...
 
 hasViewResult ($view= '')
 Checks if a view has a result set. More...
 
 initialize ($path, $file, $moduleName, $checkFileExistence=true)
 Initializes the module object. More...
 
 isCurrentAction ($actionName, $view= '')
 Checks if the current action is the given one. More...
 
 parameters ($viewName= '')
 Returns the defined parameter for a view. More...
 
 redirect ($moduleName, $viewName, $parameters=array(), $unorderedParameters=null, $userParameters=false, $anchor=false)
 Redirects to another module / view. More...
 
 redirectCurrent ()
 Redirects to the current module and view, it will use currentRedirectionURI() to figure out the URL. More...
 
 redirectionURI ($moduleName, $viewName, $parameters=array(), $unorderedParameters=null, $userParameters=false, $anchor=false)
 Creates the redirection URI for a given module, view & parameters. More...
 
 redirectionURIForModule ($module, $viewName, $parameters=array(), $unorderedParameters=null, $userParameters=false, $anchor=false)
 Creates the redirection URI for a given module, view & parameters. More...
 
 redirectModule ($module, $viewName, $parameters=array(), $unorderedParameters=null, $userParameters=false, $anchor=false)
 Redirects to another module / view. More...
 
 redirectStatus ()
 Returns the redirection HTTP status (!) More...
 
 redirectTo ($uri)
 Sets the module to redirect at the end of the execution. More...
 
 redirectToView ($viewName= '', $parameters=array(), $unorderedParameters=null, $userParameters=false, $anchor=false)
 Redirects to another view in the current module. More...
 
 redirectURI ()
 Returns the current redirection URI. More...
 
 run ($functionName, $parameters=array(), $overrideParameters=false, $userParameters=false)
 Runs a function in the current module. More...
 
 runHooks ($hookName, $parameters=null)
 Runs all hooks found in the hook list named $hookName. More...
 
 setActionParameter ($parameterName, $parameterValue, $view= '')
 Sets an action parameter value. More...
 
 setCurrentAction ($actionName, $view= '')
 Sets the current action for a view. More...
 
 setCurrentName ($name)
 Sets the name of the currently running module. More...
 
 setCurrentView ($name)
 Sets the currently executed view. More...
 
 setErrorCode ($errorCode)
 Sets the current error code. More...
 
 setErrorModule ($moduleName, $viewName)
 Sets the module to be used to handle errors. More...
 
 setExitStatus ($stat)
 Sets the exit status. More...
 
 setRedirectStatus ($status)
 Sets the HTTP status which will be set when redirecting. More...
 
 setRedirectURI ($uri)
 Sets the URI which will be redirected to when the function exits. More...
 
 setTitle ($title)
 Sets the current view for the module to $title. More...
 
 setUIComponentName ($component)
 Sets the current component name. More...
 
 setUIContextName ($context)
 Sets the current context. More...
 
 setViewResult ($result, $view= '')
 Sets the view result. More...
 
 singleFunction ()
 Checks if the module is a single view one. More...
 
 title ()
 Returns the title of the last ran view. More...
 
 uiComponentName ()
 Returns the UI component, by default the module name. More...
 
 uiContextName ()
 Returns the UI context. More...
 
 unorderedParameters ($viewName= '')
 Returns the unordered parameters definition. More...
 
 uri ()
 Returns the module's URI (/content, /user...) More...
 
 viewData ($viewName= '')
 Returns data for a view. More...
 
 viewResult ($view= '')
 Returns the view result. More...
 

Static Public Member Functions

static accessAllowed (eZURI $uri)
 Checks if access is allowed to a module/view based on site.ini[SiteAccessRules]Rules[] settings. More...
 
static activeModuleRepositories ($useExtensions=true)
 Returns the list of active module repositories, as defined in module.ini. More...
 
static addGlobalPathList ($pathList)
 Adds a new entry to the global path list. More...
 
static exists ($moduleName, $pathList=null, $showError=false)
 Loads a module object by name. More...
 
static findModule ($moduleName, $module=null, $pathList=null, $showError=false)
 Loads a module object by name. More...
 
static globalPathList ()
 Returns the search path list for modules. More...
 
static setGlobalPathList ($pathList)
 Sets the value of the global path list used to search for modules. More...
 

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
 

Static Public Attributes

static $useExceptions
 

Private Member Functions

 getAllowedRedirectHosts ()
 Returns the set of hosts that are allowed for absolute redirection. More...
 

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 ) ); ?>

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

Referenced by ezpKernelWeb\dispatchLoop(), and eZModuleOperator\modify().

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

Returns an action parameter value.

Parameters
string$parameterName
string$viewThe 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()
static eZModule::activeModuleRepositories (   $useExtensions = true)
static

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

Parameters
boolean$useExtensionsIf 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

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

static eZModule::addGlobalPathList (   $pathList)
static

Adds a new entry to the global path list.

Parameters
array | string$pathListEither an array of path or a single path string
Returns
void
See Also
setGlobalPathList(), globalPathList()
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$hookNameThe hook name.
string$functionEither 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$priorityThe hook priority in the hooks stack.
boolean$expandParametersWether 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$appendIf 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
eZModule::attribute (   $attr)

Returns the value of an attribute.

Parameters
string$attrAttribute name
Returns
mixed The attribute value. If the attribute doesn't exist, a warning is thrown, and false is returned
eZModule::attributes ( )

Returns the defined object attributes (as in persistent objects)

Returns
array the persistent object attributes

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

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
eZModule::currentRedirectionURI ( )

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

Returns
string The redirection URI
See Also
redirectionURIForModule()

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

Referenced by hasViewResult(), setViewResult(), 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()
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()

Referenced by handleError().

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

Loads a module object by name.

Parameters
string$moduleNameThe name of the module to find (ex: content)
array|stringEither an array of path or a single path string. These will be used as additionnal locations that will be looked into
boolean$showErrorIf 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()

Referenced by eZPolicyLimitation\allValuesAsArrayWithNames(), ezpKernelWeb\dispatchLoop(), fetchModule(), ezpKernelTreeMenu\run(), 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()

Referenced by handleError().

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

Constructor.

Initializes the module.

Parameters
string$pathRelative path to the module, without the module name
string$fileRelative path to the module definition file module.php
string$moduleName
boolean$checkFileExistenceAlways set to false in the current code base, since the check is usually performed before the constructor is called
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$moduleNameThe name of the module to find (ex: content)
mixed$moduleThis parameter will receive the found module object
array|stringEither an array of path or a single path string. These will be used as additionnal locations that will be looked into
boolean$showErrorIf 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()
eZModule::forward (   $module,
  $functionName,
  $parameters = false 
)

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

Parameters
eZModule$moduleThe eZModule object the request will be forwarded to
string$functionNameThe function to run in that module
array$parametersAn 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
eZModule::functionURI (   $function)

Returns the URI to a module's function.

Parameters
string$functionThe 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()
eZModule::getAllowedRedirectHosts ( )
private

Returns the set of hosts that are allowed for absolute redirection.

Returns
array

Referenced by redirectTo().

eZModule::getNamedParameters ( )

Returns the named parameters array.

Returns
array
static eZModule::globalPathList ( )
static

Returns the search path list for modules.

Returns
array
See Also
setGlobalPathList(), addGlobalPathList()

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

Referenced by eZNodeviewfunctions\contentViewGenerateError().

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

Checks if an action parameter is defined for a view.

Parameters
string$parameterName
string$viewThe view to check the parameter for. If omited, uses the current view
Returns
bool
See Also
setActionParameter(), actionParameter()
eZModule::hasAttribute (   $attr)

Checks if an attribute exists.

Parameters
string$attrAttribute name
Returns
bool True if the attribute exists, false otherwise
eZModule::hasViewResult (   $view = '')

Checks if a view has a result set.

Parameters
string$viewThe view to test for. If omited, uses the current view
Returns
bool

Referenced by run().

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

Initializes the module object.

Parameters
string$pathDirectory where the module is declared, without the modulename component
string$fileFull (relative) path to the module.php file describing the module
string$moduleNameThe module name (content, user...)
bool$checkFileExistenceWether or not $file's existence should be checked
Returns
void

Referenced by eZModule().

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

Checks if the current action is the given one.

Parameters
string$actionNameThe action to check
string$viewThe view to check the action for. Current view if omited.
Returns
bool
See Also
currentAction(), setCurrentAction()
eZModule::parameters (   $viewName = '')

Returns the defined parameter for a view.

Parameters
string$viewNameThe view to get parameters for. If not specified, the current view is used
Returns
array The parameters definition
See Also
unorderedParameters(), viewData(), currentView(), currentModule()
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$moduleNameTarget module name
string$viewNameTarget view name
array$parametersView parameters array
array$unorderedParametersUnordered parameters array
array$userParametersUser parameters array
string$anchorAnchor to use in the redirection (prepended to the URL)
Returns
bool true if the redirection was performed, false if the module wasn't found
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
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$moduleNameRedirection module name
string$viewNameRedirection view name
array$parametersView parameters
array$unorderedParametersUnordered parameters
array$userParametersUser parameters
string$anchorRedirection URI anchor
Returns
string|boolean The redirection URI, or false if the module isn't found
See Also
redirect(), redirectionURIForModule(), redirectToView(), redirectModule()
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$moduleNameRedirection module name
string$viewNameRedirection view name. If empty, the current view will be used
array$parametersView parameters
array$unorderedParametersUnordered parameters
array$userParametersUser parameters
string$anchorRedirection URI anchor
Returns
string|boolean The redirection URI, or false if the module isn't found
See Also
redirect(), redirectionURIForModule(), redirectToView(), redirectModule()

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$moduleNameTarget module name
string$viewNameTarget view name
array$parametersView parameters array
array$unorderedParametersUnordered parameters array
array$userParametersUser parameters array
string$anchorRedirection URI anchor
Returns
boolean true. Just true.
Todo:
Deprecate; have redirect() check if $module is an eZModule or a string

Referenced by redirect(), and redirectToView().

eZModule::redirectStatus ( )

Returns the redirection HTTP status (!)

See Also
setRedirectStatus();
Returns
the HTTP Status header
eZModule::redirectTo (   $uri)

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

Parameters
string$urithe URI to redirect to
See Also
setRedirectURI(), setExitStatus()
Returns
void

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$viewNameTarget view name
array$parametersView parameters
array$unorderedParametersUnordered view parameters
array$userParametersUser parameters
string$anchorRedirection URI anchor
Returns
boolean true if successful, false if the view isn't found
eZModule::redirectURI ( )

Returns the current redirection URI.

Returns
string
See Also
setRedirectURI()
eZModule::run (   $functionName,
  $parameters = array(),
  $overrideParameters = false,
  $userParameters = false 
)

Runs a function in the current module.

Parameters
string$functionNameThe function to run
array$parametersAn 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$overrideParametersAn asociative array of parameters that will ultimately override what's in $parameters
array$userParametersUser (custom view) parameters
Returns
array The run result
eZModule::runHooks (   $hookName,
  $parameters = null 
)

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

Parameters
string$hookName
array$parametersParameters 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.
eZModule::setActionParameter (   $parameterName,
  $parameterValue,
  $view = '' 
)

Sets an action parameter value.

Parameters
string$parameterName
mixed$parameterValue
string$viewThe view to set the action parameter for. If omited, the current view is used
Returns
void
See Also
actionParameter(), hasActionParameter()
eZModule::setCurrentAction (   $actionName,
  $view = '' 
)

Sets the current action for a view.

Parameters
string$actionNameThe action to make current
string$viewThe view to set the action for. If omited, the current view is used
Returns
void
See Also
currentAction(), isCurrentAction()
eZModule::setCurrentName (   $name)

Sets the name of the currently running module.

The URIs will be updated accordingly

Parameters
string$nameThe name to be set
Returns
void
See Also
uri(), functionURI()
eZModule::setCurrentView (   $name)

Sets the currently executed view.

Parameters
string$nameThe view name
Returns
void
See Also
currentView()
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

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()
eZModule::setExitStatus (   $stat)

Sets the exit status.

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

Parameters
int$statOne of the eZModule::STATUS_* constants
See Also
exitStatus()
Returns
void

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$pathListEither an array of path, or a single path as a string
Returns
void
See Also
addGlobalPathList(), globalPathList()

Referenced by eZScript\initialize(), eZSiteAccess\load(), ezpKernelWeb\requestInit(), and ezpKernelTreeMenu\run().

eZModule::setRedirectStatus (   $status)

Sets the HTTP status which will be set when redirecting.

Parameters
string$statusHTTP status
Note
The status must be a valid HTTP status with number and text.
eZModule::setRedirectURI (   $uri)

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

Parameters
string$uriThe redirection URI
Returns
void
eZModule::setTitle (   $title)

Sets the current view for the module to $title.

Parameters
string$titleThe title to be set
See Also
title()
eZModule::setUIComponentName (   $component)

Sets the current component name.

Parameters
string$componentThe new component name
See Also
uiComponentName()
Returns
void
eZModule::setUIContextName (   $context)

Sets the current context.

Parameters
string$contextThe new context string
See Also
uiContextName()
Returns
void
eZModule::setViewResult (   $result,
  $view = '' 
)

Sets the view result.

Parameters
string$resultThe (usually HTML) view result
string$viewThe view to set the result for. If omited, the current view is used
Returns
void
See Also
hasViewResult(), viewResult()
eZModule::singleFunction ( )

Checks if the module is a single view one.

Returns
bool

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()
eZModule::uiComponentName ( )

Returns the UI component, by default the module name.

Returns
string The current UI component
See Also
setUIComponentName()
eZModule::uiContextName ( )

Returns the UI context.

Returns
string The current UI context. Default: 'navigation'
See Also
setUIContextName()
eZModule::unorderedParameters (   $viewName = '')

Returns the unordered parameters definition.

Parameters
string$viewNameThe 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()
eZModule::uri ( )

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

Returns
string The module's URI
See Also
functionURI()

Referenced by attribute(), and functionURI().

eZModule::viewData (   $viewName = '')

Returns data for a view.

Parameters
string$viewNameThe view to return data for. If omited, the current view is used
See Also
parameters(), unorderedParameters(), currentView(), currentModule()
Returns
array

Referenced by parameters(), and unorderedParameters().

eZModule::viewResult (   $view = '')

Returns the view result.

Parameters
string$viewThe view to return the result for, or the current one if omited
Returns
string|null The view result, or null if not set

Referenced by run().

Member Data Documentation

eZModule::$ErrorCode

Referenced by errorCode().

eZModule::$ExitStatus

Referenced by exitStatus().

eZModule::$Functions

Referenced by attribute().

eZModule::$HookList
eZModule::$Module

Referenced by attribute(), and initialize().

eZModule::$Name

Referenced by attribute(), run(), and uri().

eZModule::$NamedParameters

Referenced by getNamedParameters().

eZModule::$OriginalParameters
eZModule::$OriginalUnorderedParameters

Referenced by currentRedirectionURI(), and forward().

eZModule::$OriginalViewParameters

Referenced by currentRedirectionURI().

eZModule::$Path

Referenced by attribute().

eZModule::$RedirectStatus

Referenced by redirectStatus().

eZModule::$RedirectURI

Referenced by redirectURI().

eZModule::$Title

Referenced by title().

eZModule::$UIComponent

Referenced by uiComponentName().

eZModule::$UIComponentMatch
eZModule::$UIContext

Referenced by uiContextName().

eZModule::$UserParameters

Referenced by currentRedirectionURI(), and forward().

eZModule::$ViewActions
eZModule::$ViewParameters
eZModule::$ViewResult
const eZModule::HOOK_STATUS_CANCEL_RUN = 1
const eZModule::HOOK_STATUS_FAILED = 2
const eZModule::HOOK_STATUS_OK = 0
const eZModule::STATUS_FAILED = 2
const eZModule::STATUS_IDLE = 0
const eZModule::STATUS_OK = 1

Referenced by ezpKernelWeb\run().

const eZModule::STATUS_REDIRECT = 3

Referenced by ezpKernelWeb\run().

const eZModule::STATUS_RERUN = 4

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