| [ Index ] |
PHP Cross Reference of Joomla 1.5.26 DE |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved. |
| License: | GNU/GPL, see LICENSE.php |
| Version: | $Id: controller.php 14401 2010-01-26 14:10:00Z louis $ |
| File Size: | 721 lines (17 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
JController:: (22 methods):
__construct()
execute()
authorize()
display()
redirect()
getModel()
addModelPath()
getTasks()
getTask()
getName()
getView()
addViewPath()
registerTask()
registerDefaultTask()
setMessage()
setRedirect()
setAccessControl()
_createModel()
_createView()
_setPath()
_addPath()
_createFileName()
Class: JController - X-Ref
Base class for a Joomla Controller| __construct( $config = array() X-Ref |
| Constructor. param: array An optional associative array of configuration settings. |
| execute( $task ) X-Ref |
| Execute a task by triggering a method in the derived class. param: string The task to perform. If no matching task is found, the return: mixed|false The value returned by the called method, false in |
| authorize( $task ) X-Ref |
| Authorization check param: string $task The ACO Section Value to check access on return: boolean True if authorized |
| display($cachable=false) X-Ref |
| Typical view method for MVC based architecture This function is provide as a default implementation, in most cases you will need to override it in your own controllers. param: string $cachable If true, the view output will be cached |
| redirect() X-Ref |
| Redirects the browser or returns false if no redirect is set. return: boolean False if no redirect exists. |
| getModel( $name = '', $prefix = '', $config = array() X-Ref |
| Method to get a model object, loading it if required. param: string The model name. Optional. param: string The class prefix. Optional. param: array Configuration array for model. Optional. return: object The model. |
| addModelPath( $path ) X-Ref |
| Adds to the stack of model paths in LIFO order. param: string|array The directory (string), or list of directories return: void |
| getTasks() X-Ref |
| Gets the available tasks in the controller. return: array Array[i] of task names. |
| getTask() X-Ref |
| Get the last task that is or was to be performed. return: string The task that was or is being performed. |
| getName() X-Ref |
| Method to get the controller name The dispatcher name by default parsed using the classname, or it can be set by passing a $config['name'] in the class constructor return: string The name of the dispatcher |
| getView( $name = '', $type = '', $prefix = '', $config = array() X-Ref |
| Method to get a reference to the current view and load it if necessary. param: string The view name. Optional, defaults to the controller param: string The view type. Optional. param: string The class prefix. Optional. param: array Configuration array for view. Optional. return: object Reference to the view or an error. |
| addViewPath( $path ) X-Ref |
| Add one or more view paths to the controller's stack, in LIFO order. param: string|array The directory (string), or list of directories return: void |
| registerTask( $task, $method ) X-Ref |
| Register (map) a task to a method in the class. param: string The task. param: string The name of the method in the derived class to perform return: void |
| registerDefaultTask( $method ) X-Ref |
| Register the default task to perform if a mapping is not found. param: string The name of the method in the derived class to perform if return: void |
| setMessage( $text ) X-Ref |
| Sets the internal message that is passed with a redirect param: string The message return: string Previous message |
| setRedirect( $url, $msg = null, $type = 'message' ) X-Ref |
| Set a URL for browser redirection. param: string URL to redirect to. param: string Message to display on redirect. Optional, defaults to param: string Message type. Optional, defaults to 'message'. return: void |
| setAccessControl( $section, $value = null ) X-Ref |
| Sets the access control levels. param: string The ACO section (eg, the component). param: string The ACO section value (if using a constant value). return: void |
| _createModel( $name, $prefix = '', $config = array() X-Ref |
| Method to load and return a model object. param: string The name of the model. param: string Optional model prefix. param: array Configuration array for the model. Optional. return: mixed Model object on success; otherwise null |
| _createView( $name, $prefix = '', $type = '', $config = array() X-Ref |
| Method to load and return a view object. This method first looks in the current template directory for a match, and failing that uses a default set path to load the view class file. Note the "name, prefix, type" order of parameters, which differs from the "name, type, prefix" order used in related public methods. param: string The name of the view. param: string Optional prefix for the view class name. param: string The type of view. param: array Configuration array for the view. Optional. return: mixed View object on success; null or error result on failure. |
| _setPath( $type, $path ) X-Ref |
| Sets an entire array of search paths for resources. param: string The type of path to set, typically 'view' or 'model'. param: string|array The new set of search paths. If null or false, |
| _addPath( $type, $path ) X-Ref |
| Adds to the search path for templates and resources. param: string The path type (e.g. 'model', 'view'. param: string|array The directory or stream to search. return: void |
| _createFileName( $type, $parts = array() X-Ref |
| Create the filename for a resource. param: string The resource type to create the filename for. param: array An associative array of filename information. Optional. return: string The filename. |
| Generated: Wed Mar 28 15:54:07 2012 | Cross-referenced by PHPXref 0.7.1 |