• Home
• FOF30
• Controller
• Controller

PHP Class FOF30\Controller\Controller

A generic MVC controller implementation Show file Open project: akeeba/fof Class Usage Examples

Protected Properties

Property	Type	Description
$autoRouting	integer	0 = never 1 = frontend only 2 = backend only 3 = always
$cacheableTasks	array	The tasks for which caching should be enabled by default
$config	array	A cached copy of the class configuration parameter passed during initialisation
$container	FOF30\Container\Container	The container attached to this Controller
$csrfProtection	integer	0 Disabled; no token checks are performed 1 Enabled; token checks are always performed 2 Only on HTML requests and backend; token checks are always performed in the back-end and in the front-end only when format is 'html' 3 Only on back-end; token checks are performed only in the back-end
$doTask	string	The mapped task that was performed.
$instance	Controller	Instance container.
$layout	string	The current layout; you can override it in the configuration
$message	string	Redirect message.
$messageType	string	Redirect message type.
$methods	array	Array of class methods
$modelInstances	array[Model]	An array of Model instances known to this Controller
$modelName	string	Overrides the name of the view's default model
$name	array	The name of the controller
$paths	array	The set of search directories for resources (views).
$redirect	string	URL for redirection.
$task	string	Current or most recently performed task.
$taskMap	array	Array of class methods to call for a given task.
$taskPrivileges	array	You can use the notation '@task' which means 'apply the same privileges as "task"'. If you create a reference back to yourself (e.g. 'mytask' => array('@mytask')) it will return TRUE.
$view	string	The current view name; you can override it in the configuration
$viewInstances	array[View]	An array of View instances known to this Controller
$viewName	string	Overrides the name of the view's default view

Public Methods

Method	Description
__construct ( Container $container, array $config = [] ) : Controller	Public constructor of the Controller class. You can pass the following variables in the $config array: name string The name of the Controller. Default: auto detect from the class name default_task string The task to use when none is specified. Default: main autoRouting int See the autoRouting property csrfProtection int See the csrfProtection property viewName string The view name. Default: the same as the controller name modelName string The model name. Default: the same as the controller name viewConfig array The configuration overrides for the View.
__get ( string $name ) : mixed | null	Magic get method. Handles magic properties: $this->input mapped to $this->container->input
display ( boolean $cachable = false, boolean $urlparams = false, string $tpl = null ) : void	Default task. Assigns a model to the view and asks the view to render itself.
execute ( string $task ) : null | boolean	Executes a given controller task. The onBefore and onAfter methods are called automatically if they exist.
getModel ( string $name = null, array $config = [] ) : Model	Returns a named Model object
getName ( ) : string	Method to get the controller name
getTask ( ) : string	Get the last task that is being performed or was most recently performed.
getTasks ( ) : array	Gets the available tasks in the controller.
getView ( string $name = null, array $config = [] ) : View	Returns a named View object
hasRedirect ( ) : boolean	Returns true if there is a redirect set in the controller
main ( )	Alias to the display() task
redirect ( ) : boolean	Redirects the browser or returns false if no redirect is set.
registerDefaultTask ( string $method ) : Controller	Register the default task to perform if a mapping is not found.
registerTask ( string $task, string $method ) : Controller	Register (map) a task to a method in the class.
setMessage ( string $text, string $type = 'message' ) : string	Sets the internal message that is passed with a redirect
setModel ( string $modelName, Model &$model ) : void	Pushes a named model to the Controller
setModelName ( string $modelName ) : void	Set the name of the model to be used by this Controller
setRedirect ( string $url, string $msg = null, string $type = null ) : Controller	Set a URL for browser redirection.
setView ( string $viewName, View &$view ) : void	Pushes a named view to the Controller
setViewName ( string $viewName ) : void	Set the name of the view to be used by this Controller
unregisterTask ( string $task ) : Controller	Unregister (unmap) a task in the class.

Protected Methods

Method	Description
checkACL ( string $area ) : boolean	Checks if the current user has enough privileges for the requested ACL area.
csrfProtection ( ) : boolean	Provides CSRF protection through the forced use of a secure token. If the token doesn't match the one in the session we return false.
getACLRuleFor ( string $area, array $oldAreas = [] ) : mixed	Resolves @task and &callback notations for ACL privileges
triggerEvent ( string $event, array $arguments = [] ) : boolean	Triggers an object-specific event. The event runs both locally –if a suitable method exists– and through the Joomla! plugin system. A true/false return value is expected. The first false return cancels the event.

Method Details

Property Details