FOFController
FrameworkOnFramework controller class. FOF is based on the thin controller paradigm, where the controller is mainly used to set up the model state and spawn the view.
Located in /libraries/fof/controller/controller.php (line 20)
JObject | --FOFController
| Class | Description |
|---|---|
PostinstallControllerMessage
|
static FOFController
&getAnInstance
([string $option = null], [string $view = null], [array $config = array()])
static \className
&getTmpInstance
([string $option = null], [string $view = null], [array $config = array()])
FOFView
createView
(string $name, [string $prefix = ''], [string $type = ''], [array $config = array()])
FOFView
getView
([string $name = ''], [string $type = ''], [string $prefix = ''], [array $config = array()])
FOFView
&_createView
(string $name, [string $prefix = ''], [string $type = ''], [array $config = array()])
int
$autoRouting
= 0 (line 29)
string
$bareComponent
= 'foobar' (line 36)
The current component's name without the com_ prefix
string
$basePath
(line 43)
The base path of the controller
array
$cacheableTasks
= array('browse', 'read') (line 50)
The tasks for which caching should be enabled by default
string
$component
= 'com_foobar' (line 57)
The current component's name; you can override it in the configuration
array
$config
= array() (line 64)
A cached copy of the class configuration parameter passed during initialisation
FOFConfigProvider
$configProvider
= null (line 71)
An instance of FOFConfigProvider to provision configuration overrides
integer
$csrfProtection
= 2 (line 83)
Set to true to enable CSRF protection on selected tasks. The possible
values are: 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 performer only in the back-end
string
$default_view
(line 90)
The default view for the display method.
string
$doTask
(line 97)
The mapped task that was performed.
boolean
$hasForm
= false (line 223)
Does this tried have a FOFForm which will be used to render it?
The input object for this MVC triad; you can override it in the configuration
string
$layout
= null (line 125)
The current layout; you can override it in the configuration
string
$message
(line 111)
Redirect message.
string
$messageType
(line 118)
Redirect message type.
array
$methods
(line 132)
Array of class methods
string
$modelName
= null (line 146)
Overrides the name of the view's default model
string
$model_prefix
(line 139)
The prefix of the models
array
$name
(line 181)
The name of the controller
array
$paths
(line 153)
The set of search directories for resources (views).
string
$redirect
(line 160)
URL for redirection.
string
$task
(line 167)
Current or most recently performed task.
array
$taskMap
(line 174)
Array of class methods to call for a given task.
string
$view
= '' (line 188)
The current view name; you can override it in the configuration
string
$viewName
= null (line 195)
Overrides the name of the view's default view
array
$viewsCache
= array() (line 209)
A cache for the view item objects created in this controller
Inherited Variables
Inherited from JObject
Adds to the stack of model paths in LIFO order.
- mixed $path: The directory (string) , or list of directories (array) to add.
- string $prefix: A prefix for models
Create the filename for a resource.
- string $type: The resource type to create the filename for.
- array $parts: An associative array of filename information. Optional.
Gets a static (Singleton) instance of a controller class. It loads the relevant controller file from the component's directory or, if it doesn't exist, creates a new controller object out of thin air.
- string $option: Component name, e.g. com_foobar
- string $view: The view name, also used for the controller name
- array $config: Configuration parameters
Gets a temporary instance of a controller object. A temporary instance is not a Singleton and can be disposed off after use.
- string $option: The component name, e.g. com_foobar
- string $view: The view name, e.g. cpanel
- array $config: Configuration parameters
Public constructor of the Controller class
- array $config: Optional configuration parameters
- JObject::__construct()
- Class constructor, overridden in descendant classes.
Sets the access to registered. Joomla! 1.5 compatibility.
Sets the access to special. Joomla! 1.5 compatibility.
Adds to the search path for templates and resources.
- string $type: The path type (e.g. 'model', 'view').
- mixed $path: The directory string or stream array to search.
Add one or more view paths to the controller's stack, in LIFO order.
- mixed $path: The directory (string) or list of directories (array) to add.
Authorisation check
- string $task: The ACO Section Value to check access on.
Implements a default browse task, i.e. read a bunch of records and send them to the browser.
Cancel the edit, check in the record and return to the Browse task
Checks if the current user has enough privileges for the requested ACL area.
- string $area: The ACL area, e.g. core.manage.
Creates a new model object
- string $name: The name of the model class, e.g. Items
- string $prefix: The prefix of the model class, e.g. FoobarModel
- array $config: The configuration parameters for the model class
Creates a View object instance and returns it
- string $name: The name of the view, e.g. Items
- string $prefix: The prefix of the view, e.g. FoobarView
- string $type: The type of the view, usually one of Html, Raw, Json or Csv
- array $config: The configuration variables to use for creating the view
Default task. Assigns a model to the view and asks the view to render itself.
YOU MUST NOT USETHIS TASK DIRECTLY IN A URL. It is supposed to be used ONLY inside your code. In the URL, use task=browse instead.
- bool $cachable: Is this view cacheable?
- bool $urlparams: Add your safe URL parameters (see further down in the code)
Single record edit. The ID set in the request is passed to the model, then the form layout is used to edit the result.
Executes a given controller task. The onBefore<task> and onAfter<task> methods are called automatically if they exist.
- string $task: The task to execute, e.g. "browse"
Method to get a model object, loading it if required.
- string $name: The model name. Optional.
- string $prefix: The class prefix. Optional.
- array $config: Configuration array for model. Optional.
Method to get the controller name
The dispatcher name is set by default parsed using the classname, or it can be set by passing a $config['name'] in the class constructor
Get the last task that is being performed or was most recently performed.
Returns the default model associated with the current view
- array $config: Configuration variables for the model
Returns current view object
- array $config: Configuration variables for the model
Method to get a reference to the current view and load it if necessary.
- string $name: The view name. Optional, defaults to the controller name.
- string $type: The view type. Optional.
- string $prefix: The class prefix. Optional.
- array $config: Configuration array for view. Optional.
Returns true if there is a redirect set in the controller
ACL check before changing the access level; override to customise
ACL check before changing the access level; override to customise
ACL check before changing the access level; override to customise
ACL check before adding a new record; override to customise
ACL check before saving a new/modified record; override to customise
Execute something before applySave is called. Return false to prevent applySave from executing.
- array &$data: The data upon which applySave will act
ACL check before editing a record; override to customise
A catch-all method for all tasks without a corresponding onBefore method. Applies the ACL preferences defined in fof.xml.
- string $task: The task being executed
ACL check before changing the ordering of a record; override to customise
ACL check before changing the ordering of a record; override to customise
ACL check before changing the publish status of a record; override to customise
ACL check before removing a record; override to customise
ACL check before saving a new/modified record; override to customise
ACL check before saving a new/modified record; override to customise
ACL check before changing the ordering of a record; override to customise
ACL check before changing the publish status of a record; override to customise
Single record read. The id set in the request is passed to the model and then the item layout is used to render the result.
Redirects the browser or returns false if no redirect is set.
Register the default task to perform if a mapping is not found.
- string $method: The name of the method in the derived class to perform if a named task is not found.
Register (map) a task to a method in the class.
- string $task: The task.
- string $method: The name of the method in the derived class to perform for this task.
Sets the access level of the selected item(s).
- integer $level: The desired viewing access level ID
Sets the internal message that is passed with a redirect
- string $text: Message to display on redirect.
- string $type: Message type. Optional, defaults to 'message'.
Sets an entire array of search paths for resources.
- string $type: The type of path to set, typically 'view' or 'model'.
- string $path: The new set of search paths. If null or false, resets to the current directory only.
Registers a redirection with an optional message. The redirection is carried out when you use the redirect method.
- string $url: The URL to redirect to
- string $msg: The message to be pushed to the application
- string $type: The message type to be pushed to the application, e.g. 'error'
Sets the published state (the enabled field) of the selected item(s)
- integer $state: The desired state. 0 is unpublished, 1 is published.
Set the name of the model to be used by this Controller
- string $modelName: The name of the model
Set the name of the view to be used by this Controller
- string $viewName: The name of the view
Unregister (unmap) a task in the class.
- string $task: The task.
Method to load and return a model object.
- string $name: The name of the model.
- string $prefix: Optional model prefix.
- array $config: Configuration array for the model. Optional.
Deprecated function to create a View object instance
- string $name: The name of the view, e.g. 'Items'
- string $prefix: The prefix of the view, e.g. 'FoobarView'
- string $type: The view type, e.g. 'html'
- array $config: The configuration array for the view
Applies CSRF protection by means of a standard Joomla! token (nonce) check.
Raises a 403 Access Forbidden error through JError or an exception (depending the Joomla! version) if the check fails.
Inherited Methods
Inherited From JObject
JObject::__construct()
Documentation generated on Tue, 19 Nov 2013 14:57:21 +0100 by phpDocumentor 1.4.3