Graphe d'héritage de JController:

Graphe de collaboration de JController:

Liste de tous les membres

Fonctions membres publiques

__construct ($config=array())
execute ($task)
authorize ($task)
display ($cachable=false)
redirect ()
& getModel ($name= '', $prefix= '', $config=array())
getTasks ()
getTask ()
getName ()
& getView ($name= '', $type= '', $prefix= '', $config=array())
registerTask ($task, $method)
registerDefaultTask ($method)
setMessage ($text)
setRedirect ($url, $msg=null, $type= 'message')
setAccessControl ($section, $value=null)
& _createModel ($name, $prefix= '', $config=array())
& _createView ($name, $prefix= '', $type= '', $config=array())
_setPath ($type, $path)
_addPath ($type, $path)
_createFileName ($type, $parts=array())

Fonctions membres publiques statiques

addModelPath ($path)
addViewPath ($path)

Attributs publics

$_basePath = null
$_name = null
$_methods = null
$_taskMap = null
$_task = null
$_doTask = null
$_path
$_redirect = null
$_message = null
$_messageType = null
$_acoSection = null
$_acoSectionValue = null

Documentation des constructeurs et destructeur

JController::__construct ( $ config = array() )

Constructor.

protected

Paramètres:

array An optional associative array of configuration settings. Recognized key values include 'name', 'default_task', 'model_path', and 'view_path' (this list is not meant to be comprehensive).

Depuis:: 1.5

Réimplémentée dans BannerControllerBanner, BannerControllerClient, ConfigControllerApplication, ConfigControllerComponent, PluginsController, PollController, UsersController, WeblinksController, et JInstallationController.

Références $config.

Documentation des fonctions membres

JController::_addPath	(	$	type,
		$	path
	)

Adds to the search path for templates and resources.

protected

Paramètres:

string	The path type (e.g. 'model', 'view'.
string\|array	The directory or stream to search.

Renvoie:: void

Références $path, et $type.

JController::_createFileName	(	$	type,
		$	parts = `array()`
	)

Create the filename for a resource.

private

Paramètres:

string	The resource type to create the filename for.
array	An associative array of filename information. Optional.

Renvoie:: string The filename.

Depuis:: 1.5

Références $filename, $parts, et $type.

& JController::_createModel	(	$	name,
		$	prefix = `''`,
		$	config = `array()`
	)

Method to load and return a model object.

private

Paramètres:

string	The name of the model.
string	Optional model prefix.
array	Configuration array for the model. Optional.

Renvoie:: mixed Model object on success; otherwise null failure.

Depuis:: 1.5

Références $config, $name, et JModel::getInstance().

Voici le graphe d'appel pour cette fonction :

& JController::_createView	(	$	name,
		$	prefix = `''`,
		$	type = `''`,
		$	config = `array()`
	)

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.

private

Paramètres:

string	The name of the view.
string	Optional prefix for the view class name.
string	The type of view.
array	Configuration array for the view. Optional.

Renvoie:: mixed View object on success; null or error result on failure.

Depuis:: 1.5

Références $config, $name, $path, $type, JText::_(), JPath::find(), jimport(), et JError::raiseError().

Voici le graphe d'appel pour cette fonction :

JController::_setPath	(	$	type,
		$	path
	)

Sets an entire array of search paths for resources.

protected

Paramètres:

string	The type of path to set, typically 'view' or 'model'.
string\|array	The new set of search paths. If null or false, resets to the current directory only.

Références $path, et $type.

JController::addModelPath ( $ path ) [static]

Adds to the stack of model paths in LIFO order.

Paramètres:

string|array The directory (string), or list of directories (array) to add.

Renvoie:: void

Références $path, JModel::addIncludePath(), et jimport().

Voici le graphe d'appel pour cette fonction :

JController::addViewPath ( $ path ) [static]

Add one or more view paths to the controller's stack, in LIFO order.

Paramètres:

string|array The directory (string), or list of directories (array) to add.

Renvoie:: void

Références $path.

JController::authorize ( $ task )

Authorization check

public

Paramètres:

string $task The ACO Section Value to check access on

Renvoie:: boolean True if authorized

Depuis:: 1.5

Références $task, $user, et JFactory::getUser().

Voici le graphe d'appel pour cette fonction :

JController::display ( $ cachable = false )

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.

public

Paramètres:

string $cachable If true, the view output will be cached

Depuis:: 1.5

Références $document, $option, $view, JFactory::getCache(), JRequest::getCmd(), et JFactory::getDocument().

Voici le graphe d'appel pour cette fonction :

JController::execute ( $ task )

Execute a task by triggering a method in the derived class.

public

Paramètres:

string The task to perform. If no matching task is found, the '__default' task is executed, if defined.

Renvoie:: mixed|false The value returned by the called method, false in error case.

Depuis:: 1.5

Réimplémentée dans JInstallationController.

Références $task, JText::_(), elseif, et JError::raiseError().

Voici le graphe d'appel pour cette fonction :

& JController::getModel	(	$	name = `''`,
		$	prefix = `''`,
		$	config = `array()`
	)

Method to get a model object, loading it if required.

public

Paramètres:

string	The model name. Optional.
string	The class prefix. Optional.
array	Configuration array for model. Optional.

Renvoie:: object The model.

Depuis:: 1.5

Références $config, $item, $menu, $name, $params, et JFactory::getApplication().

Voici le graphe d'appel pour cette fonction :

JController::getName ( )

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

public

Renvoie:: string The name of the dispatcher

Depuis:: 1.5

Références $name, et JError::raiseError().

Voici le graphe d'appel pour cette fonction :

JController::getTask ( )

Get the last task that is or was to be performed.

public

Renvoie:: string The task that was or is being performed.

Depuis:: 1.5

JController::getTasks ( )

Gets the available tasks in the controller. public

Renvoie:: array Array[i] of task names.

Depuis:: 1.5

& JController::getView	(	$	name = `''`,
		$	type = `''`,
		$	prefix = `''`,
		$	config = `array()`
	)

Method to get a reference to the current view and load it if necessary.

public

Paramètres:

string	The view name. Optional, defaults to the controller name.
string	The view type. Optional.
string	The class prefix. Optional.
array	Configuration array for view. Optional.

Renvoie:: object Reference to the view or an error.

Depuis:: 1.5

Références $config, $name, $type, $view, JText::_(), et JError::raiseError().

Voici le graphe d'appel pour cette fonction :

JController::redirect ( )

Redirects the browser or returns false if no redirect is set.

public

Renvoie:: boolean False if no redirect exists.

Depuis:: 1.5

Références $mainframe.

JController::registerDefaultTask ( $ method )

Register the default task to perform if a mapping is not found.

public

Paramètres:

string The name of the method in the derived class to perform if a named task is not found.

Renvoie:: void

Depuis:: 1.5

JController::registerTask	(	$	task,
		$	method
	)

Register (map) a task to a method in the class.

public

Paramètres:

string	The task.
string	The name of the method in the derived class to perform for this task.

Renvoie:: void

Depuis:: 1.5

Références $task.

JController::setAccessControl	(	$	section,
		$	value = `null`
	)

Sets the access control levels.

public

Paramètres:

string	The ACO section (eg, the component).
string	The ACO section value (if using a constant value).

Renvoie:: void

Depuis:: 1.5

Références $section.

JController::setMessage ( $ text )

Sets the internal message that is passed with a redirect

public

Paramètres:

string The message

Renvoie:: string Previous message

Depuis:: 1.5

Références $text.

JController::setRedirect	(	$	url,
		$	msg = `null`,
		$	type = `'message'`
	)

Set a URL for browser redirection.

public

Paramètres:

string	URL to redirect to.
string	Message to display on redirect. Optional, defaults to value set internally by controller, if any.
string	Message type. Optional, defaults to 'message'.

Renvoie:: void

Depuis:: 1.5

Références $type, et $url.

Documentation des données membres

JController::$_acoSection = null

JController::$_acoSectionValue = null

JController::$_basePath = null

JController::$_doTask = null

JController::$_message = null

JController::$_messageType = null

JController::$_methods = null

JController::$_name = null

JController::$_path

Valeur initiale :

 array(
                'view'  => array()
        )

JController::$_redirect = null

JController::$_task = null

JController::$_taskMap = null

La documentation de cette classe a été générée à partir du fichier suivant :

libraries/joomla/application/component/controller.php

Référence de la classe JController

Fonctions membres publiques

Fonctions membres publiques statiques

Attributs publics

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres