Class Controller

Class Controller definition.

Direct known subclasses

App\Controllers\App, CMS\Controllers\Authentication, Core\Base\Entity

Indirect known subclasses

CMS\Controllers\Account, CMS\Controllers\CMS, CMS\Controllers\CMSHelp, CMS\Controllers\CMSUserRoles, CMS\Controllers\CMSUsers

Abstract
Namespace: Core\Base
Located at base/controller.php

Methods summary

`public`	# `__construct( )` Base Controller Constructor definition. Base Controller Constructor definition.
`final public`	# `__executeAction( string $action, Core\Modules\Router\Request $request )` Executes an controller action. Executes an controller action. Parameters `$action` Action name. `$request` Request object.
`public`	# `actionNotFound( Core\Modules\Router\Request $request )` Handles 404 pages. Handles 404 pages. Displayed when a requested controller action does not exist. Parameters `$request` Request object.
`final public static`	# `resourceNotFound( Core\Modules\Router\Request $request )` Global 404 page. Global 404 page. Displayed when a requested controller does not exist. Parameters `$request` Request object.
`protected static string`	# `generateOutputCacheId( Core\Modules\Router\Request $request )` Generate cache identifier value. Generate cache identifier value. Parameters `$request` Request object. Returns string See md5(), implode()
`protected static`	# `setOutputDefaultHeaders( )` Set default response HTTP headers. Set default response HTTP headers.
`final protected`	# `addBeforeFilters( array $methods, array $scope = array() )` Adds methods which will be executed before any controller action. Adds methods which will be executed before any controller action. Parameters `$methods` Array with method names to be executed. `$scope` Execution scope conditions.
`final protected`	# `addAfterFilters( array $methods, array $scope = array() )` Adds methods which will be executed after any controller action. Adds methods which will be executed after any controller action. Parameters `$methods` Array with method names to be executed. `$scope` Execution scope conditions.
`final protected string`	# `getControllerName( )` Gets current controller name. Gets current controller name. Returns string
`final protected string`	# `getActionName( )` Gets current action name. Gets current action name. Returns string
`protected`	# `processOutput( )` Renders the assigned template. Renders the assigned template. Manages static template caching. See see http://www.smarty.net/docs/en/caching.tpl
`final protected mixed`	# `getPartialOutput( string $name )` Renders a partial template specified by its name. Renders a partial template specified by its name. Parameters `$name` Name of the partial template for render. Returns mixed
`private integer`	# `getOutputCachingLifetime( string $action )` Retrieves the output cache lifetime for an action. Retrieves the output cache lifetime for an action. Parameters `$action` Action name. Returns integer
`private`	# `executeBeforeFilters( string $action, Core\Modules\Router\Request $request )` Executes the queued before action filters. Executes the queued before action filters. Parameters `$action` Current action. `$request` Current Router Request. Throws BadMethodCallException When specifying non-existing method.
`private`	# `executeAfterFilters( string $action, Core\Modules\Router\Request $request )` Executes the queued after action filters. Executes the queued after action filters. Parameters `$action` Current action. `$request` Current Router Request. Throws BadMethodCallException When specifying non-existing method.
`protected`	# `loadLabels( )` Load labels for the controller. Load labels for the controller.
`private static array`	# `loadLabelsFile( string $fileName )` Load Labels file. Load Labels file. Parameters `$fileName` Labels file name. Returns array
`private`	# `assignContentVariables( )` Assign easy to use template vars. Assign easy to use template vars. See get_object_vars()
`private static Core\Modules\Render\Render`	# `assignVariablesToRender( Core\Modules\Render\Render & $renderer )` Assigns common template engine vars. Assigns common template engine vars. Parameters `$renderer` Render module object. Returns `Core\Modules\Render\Render`

Properties summary

`public Core\Modules\Render\Render`	`$renderer` Render instance. Render instance.	#
`public string`	`$rendererAdapter` Renderer adapter name. Renderer adapter name.	#
`public array\|boolean`	`$labels` Labels name. Labels name.	#
`protected array`	`$meta` Controller meta data. Controller meta data.	# `array( 'filters' => array( 'before' => array(), 'after' => array(), ), )`
`protected string`	`$layout` Default layout name. Default layout name.	# `'default'`
`protected array`	`$cachingOutput` Action output cache. Action output cache. Example format: [action:string -> lifetime:integer(seconds)]	# `array()`