Graphe d'héritage de JController:

Graphe de collaboration de JController:

Fonctions membres publiques
	__construct ($config=array())
	addViewPath ($path)
	authorize ($task)
	authorise ($task)
	display ($cachable=false, $urlparams=false)
	execute ($task)
	getModel ($name= '', $prefix= '', $config=array())
	getName ()
	getTask ()
	getTasks ()
	getView ($name= '', $type= '', $prefix= '', $config=array())
	redirect ()
	registerDefaultTask ($method)
	registerTask ($task, $method)
	unregisterTask ($task)
	setAccessControl ($section, $value=null)
	setMessage ($text, $type= 'message')
	setRedirect ($url, $msg=null, $type=null)
Fonctions membres publiques inherited from JObject
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

Fonctions membres publiques statiques
static	addModelPath ($path, $prefix= '')
static	getInstance ($prefix, $config=array())

Fonctions membres protégées
	addPath ($type, $path)
	checkEditId ($context, $id)
	createModel ($name, $prefix= '', $config=array())
	createView ($name, $prefix= '', $type= '', $config=array())
	holdEditId ($context, $id)
	releaseEditId ($context, $id)
	setPath ($type, $path)

Fonctions membres protégées statiques
static	createFileName ($type, $parts=array())

Attributs protégés
	$_acoSection
	$_acoSectionValue
	$basePath
	$default_view
	$doTask
	$message
	$messageType
	$methods
	$name
	$model_prefix
	$paths
	$redirect
	$task
	$taskMap
Attributs protégés inherited from JObject
	$_errors = array()

Attributs protégés statiques
static	$instance

Documentation des constructeurs et destructeur

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

Constructor.

Paramètres:

array $config 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:: 11.1

Réimplémentée à partir de JObject.

Réimplémentée dans JControllerForm, JControllerAdmin, UsersControllerUsers, CategoriesControllerCategory, BannersControllerBanners, ContactControllerContacts, ContentControllerArticles, LanguagesControllerStrings, CategoriesController, ContentControllerArticle, ConfigControllerComponent, ConfigControllerApplication, InstallerControllerManage, TemplatesControllerSource, MenusControllerItems, et ContentController.

Références $config, JLog\addLogger(), JLog\ALL, elseif, JDEBUG, et null.

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

static JController::addModelPath	(	$path,
		$prefix = `''`
	)

static

Adds to the stack of model paths in LIFO order.

Paramètres:

mixed	$path	The directory (string), or list of directories (array) to add.
string	$prefix	A prefix for models

Renvoie:: void

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

Voici le graphe d'appel pour cette fonction :

JController::addPath	(	$type,
		$path
	)

protected

Adds to the search path for templates and resources.

Paramètres:

string	$type	The path type (e.g. 'model', 'view').
mixed	$path	The directory string or stream array to search.

Renvoie:: JController A JController object to support chaining.

Depuis:: 11.1

Note:: Replaces _addPath.

Références $path, $type, et JPath\check().

Voici le graphe d'appel pour cette fonction :

JController::addViewPath ( $path )

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

Paramètres:

mixed $path The directory (string) or list of directories (array) to add.

Renvoie:: JController This object to support chaining.

Références $path.

JController::authorise ( $task )

Authorisation check

Paramètres:

string $task The ACO Section Value to check access on.

Renvoie:: boolean True if authorised

Depuis:: 11.1

Obsolète:: 12.3

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

Voici le graphe d'appel pour cette fonction :

JController::authorize ( $task )

Authorisation check

Paramètres:

string $task The ACO Section Value to check access on

Renvoie:: boolean True if authorised

Depuis:: 11.1

Obsolète:: 12.1 Use JAuthorise

Références $task, JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JController::checkEditId	(	$context,
		$id
	)

protected

Method to check whether an ID is in the edit list.

Paramètres:

string	$context	The context for the session storage.
integer	$id	The ID of the record to add to the edit list.

Renvoie:: boolean True if the ID is in the edit list.

Depuis:: 11.1

Références $app, $id, JLog\add(), JFactory\getApplication(), JLog\INFO, et JDEBUG.

Voici le graphe d'appel pour cette fonction :

static JController::createFileName	(	$type,
		$parts = `array()`
	)

staticprotected

Create the filename for a resource.

Paramètres:

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

Renvoie:: string The filename.

Note:: Replaced _createFileName.

Depuis:: 11.1

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

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

protected

Method to load and return a model object.

Paramètres:

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

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

Depuis:: 11.1

Note:: Replaces _createModel.

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

Voici le graphe d'appel pour cette fonction :

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

protected

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ètres:

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

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

Depuis:: 11.1

Note:: Replaces _createView.

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

Voici le graphe d'appel pour cette fonction :

JController::display	(	$cachable = `false`,
		$urlparams = `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.

Paramètres:

boolean	$cachable	If true, the view output will be cached
array	$urlparams	An array of safe url parameters and their variable types, for valid values see JFilterInput::clean().

Renvoie:: JController A JController object to support chaining.

Depuis:: 11.1

Réimplémentée dans JControllerAdmin, JoomlaupdateControllerUpdate, TemplatesControllerSource, UsersController, CategoriesController, BannersControllerTracks, ContentController, FinderController, ConfigController, FinderController, LanguagesController, RedirectController, SearchController, TemplatesController, ContactController, ContentController, InstallerController, JoomlaupdateController, LoginController, MenusControllerMenu, WeblinksController, ContactController, MediaController, NewsfeedsController, SearchController, UsersController, WeblinksController, WrapperController, JInstallationController, BannersController, CacheController, MediaController, MenusController, MenusControllerMenus, MessagesController, ModulesController, NewsfeedsController, PluginsController, et CheckinController.

Références $app, $key, $view, JFactory\getApplication(), JFactory\getCache(), JRequest\getCmd(), JFactory\getConfig(), 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.

Paramètres:

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

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

Depuis:: 11.1

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

Voici le graphe d'appel pour cette fonction :

static JController::getInstance	(	$prefix,
		$config = `array()`
	)

static

Method to get a singleton controller instance.

Paramètres:

string	$prefix	The prefix for the controller.
array	$config	An array of optional constructor options.

Renvoie:: JController

Depuis:: 11.1

Exceptions:

Exception if the controller cannot be loaded.

Références $class, $config, $file, $path, $task, $type, elseif, JFilterInput\getInstance(), JRequest\getVar(), JRequest\getWord(), null, JRequest\setVar(), et JText\sprintf().

Référencé par JInstallation\render().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

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

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

Paramètres:

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

Renvoie:: object The model.

Depuis:: 11.1

Réimplémentée dans JControllerForm, ContentControllerArticle, WeblinksControllerWeblink, ContentControllerArticles, ContactControllerContacts, ContentControllerFeatured, TemplatesControllerSource, RedirectControllerLinks, ModulesControllerModules, UsersControllerUsers, TemplatesControllerStyles, BannersControllerBanners, MenusControllerMenus, UsersControllerNotes, BannersControllerClients, BannersControllerTracks, FinderControllerFilters, FinderControllerIndex, FinderControllerMaps, MessagesControllerMessages, PluginsControllerPlugins, LanguagesControllerLanguages, MenusControllerItems, CategoriesControllerCategories, WeblinksControllerWeblinks, NewsfeedsControllerNewsfeeds, et ContactControllerContact.

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

Voici le graphe d'appel pour cette fonction :

JController::getName ( )

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

Renvoie:: string The name of the dispatcher

Depuis:: 11.1

Références $name, JText\_(), null, et JError\raiseError().

Voici le graphe d'appel pour cette fonction :

JController::getTask ( )

Get the last task that is being performed or was most recently performed.

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

Depuis:: 11.1

Références $task.

JController::getTasks ( )

Gets the available tasks in the controller.

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

Depuis:: 11.1

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

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

Paramètres:

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.

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

Depuis:: 11.1

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

Voici le graphe d'appel pour cette fonction :

JController::holdEditId	(	$context,
		$id
	)

protected

Method to add a record ID to the edit list.

Paramètres:

string	$context	The context for the session storage.
integer	$id	The ID of the record to add to the edit list.

Renvoie:: void

Depuis:: 11.1

Références $app, $id, JLog\add(), JFactory\getApplication(), JLog\INFO, et JDEBUG.

Voici le graphe d'appel pour cette fonction :

JController::redirect ( )

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

Renvoie:: boolean False if no redirect exists.

Depuis:: 11.1

Références $app, et JFactory\getApplication().

Voici le graphe d'appel pour cette fonction :

JController::registerDefaultTask ( $method )

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

Paramètres:

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

Renvoie:: JController A JController object to support chaining.

Depuis:: 11.1

JController::registerTask	(	$task,
		$method
	)

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

Paramètres:

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

Renvoie:: JController A JController object to support chaining.

Depuis:: 11.1

Références $task.

JController::releaseEditId	(	$context,
		$id
	)

protected

Method to check whether an ID is in the edit list.

Paramètres:

string	$context	The context for the session storage.
integer	$id	The ID of the record to add to the edit list.

Renvoie:: void

Depuis:: 11.1

Références $app, $id, JLog\add(), JFactory\getApplication(), JLog\INFO, et JDEBUG.

Voici le graphe d'appel pour cette fonction :

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

Sets the access control levels.

Paramètres:

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

Renvoie:: void

Obsolète:: 12.1 Use JAccess

Voir également:: Jaccess

Depuis:: 11.1

Références JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JController::setMessage	(	$text,
		$type = `'message'`
	)

Sets the internal message that is passed with a redirect

Paramètres:

string	$text	Message to display on redirect.
string	$type	Message type (since 11.1). Optional, defaults to 'message'.

Renvoie:: string Previous message

Depuis:: 11.1

Références $message, $text, et $type.

JController::setPath	(	$type,
		$path
	)

protected

Sets an entire array of search paths for resources.

Paramètres:

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.

Renvoie:: void

Note:: Replaces _setPath.

Depuis:: 11.1

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

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

Set a URL for browser redirection.

Paramètres:

string	$url	URL to redirect to.
string	$msg	Message to display on redirect. Optional, defaults to value set internally by controller, if any.
string	$type	Message type. Optional, defaults to 'message' or the type set by a previous call to setMessage.

Renvoie:: JController This object to support chaining.

Depuis:: 11.1

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

JController::unregisterTask ( $task )

Unregister (unmap) a task in the class.

Paramètres:

string $task The task.

Renvoie:: JController This object to support chaining.

Depuis:: 11.1

Références $task.

Documentation des données membres

JController::$_acoSection

protected

JController::$_acoSectionValue

protected

JController::$basePath

protected

JController::$default_view

protected

Réimplémentée dans FinderController, ConfigController, LanguagesController, RedirectController, SearchController, TemplatesController, ContactController, et ContentController.

JController::$doTask

protected

JController::$instance

staticprotected

JController::$message

protected

JController::$messageType

protected

JController::$methods

protected

JController::$model_prefix

protected

JController::$name

protected

JController::$paths

protected

JController::$redirect

protected

JController::$task

protected

JController::$taskMap

protected

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

libraries/joomla/application/component/controller.php

Fonctions membres publiques

Fonctions membres publiques statiques

Fonctions membres protégées

Fonctions membres protégées statiques

Attributs protégés

Attributs protégés statiques

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres