Référence de la classe AdminController

Graphe d'héritage de AdminController:

Fonctions membres publiques
	__construct ($config=array(), MVCFactoryInterface $factory=null, ?CMSApplication $app=null, ?Input $input=null)
	delete ()
	publish ()
	reorder ()
	saveorder ()
	checkin ()
	saveOrderAjax ()
	runTransition ()
Fonctions membres publiques hérités de BaseController
	__construct ($config=array(), MVCFactoryInterface $factory=null, ?CMSApplication $app=null, ?Input $input=null)
	addViewPath ($path)
	execute ($task)
	getModel ($name='', $prefix='', $config=array())
	getName ()
	getTask ()
	getTasks ()
	getView ($name='', $type='', $prefix='', $config=array())
	redirect ()
	registerDefaultTask ($method)
	registerTask ($task, $method)
	unregisterTask ($task)
	setMessage ($text, $type='message')
	checkToken ($method='post', $redirect=true)
	setRedirect ($url, $msg=null, $type=null)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Fonctions membres protégées
	postDeleteHook (BaseDatabaseModel $model, $id=null)
	getRedirectToListAppend ()
Fonctions membres protégées hérités de BaseController
	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)

Attributs protégés
	$option
	$text_prefix
	$view_list
Attributs protégés hérités de BaseController
	$basePath
	$default_view
	$doTask
	$message
	$messageType
	$methods
	$name
	$model_prefix
	$paths
	$redirect
	$task
	$taskMap
	$input
	$factory
	$app

Membres hérités additionnels
Fonctions membres publiques statiques hérités de BaseController
static	addModelPath ($path, $prefix='')
static	createFileName ($type, $parts=array())
static	getInstance ($prefix, $config=array())
Attributs protégés statiques hérités de BaseController
static	$instance
static	$views

Description détaillée

Base class for a Joomla Administrator Controller

Controller (controllers are where you put all the actual code) Provides basic functionality, such as rendering views (aka displaying templates).

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

__construct	(		$config = array(),
		MVCFactoryInterface	$factory = null,
		?CMSApplication	$app = null,
		?Input	$input = null
	)

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).
MVCFactoryInterface	$factory	The factory.
CMSApplication	$app	The Application for the dispatcher
Input	$input	The Input object for the request

Depuis

3.0

Références $app, $config, $input, $r, $this, Symfony\Contracts\Service\__construct(), elseif, ComponentHelper\getComponentName(), et Text\sprintf().

Documentation des fonctions membres

checkin()

checkin

(

)

Check in of one or more records.

Renvoie

boolean True on success

Depuis

1.6

Références $message, $model, $return, Route\_(), Joomla\Application\checkToken(), Text\plural(), et Text\sprintf().

delete()

delete

(

)

Removes an item.

Renvoie

void

Depuis

1.6

Références $model, Text\_(), Route\_(), Joomla\Application\checkToken(), et Text\plural().

getRedirectToListAppend()

getRedirectToListAppend ( )

protected

Gets the URL arguments to append to a list redirect.

Renvoie

string The arguments to append to the redirect URL.

Depuis

4.0.0

postDeleteHook()

postDeleteHook ( BaseDatabaseModel  $model,   $id = null  )

protected

Function that allows child controller access to model data after the item has been deleted.

Paramètres

BaseDatabaseModel	$model	The data model object.
integer	$id	The validated data.

Renvoie

void

Depuis

3.1

publish()

publish

(

)

Method to publish a list of items

Renvoie

void

Depuis

1.6

Références $data, $model, $task, $value, Text\_(), Route\_(), Joomla\Application\checkToken(), elseif, ArrayHelper\getValue(), null, et Text\plural().

reorder()

reorder

(

)

Changes the order of one or more records.

Renvoie

boolean True on success

Depuis

1.6

Références $message, $model, $return, Text\_(), Route\_(), Joomla\Application\checkToken(), et Text\sprintf().

runTransition()

runTransition

(

)

Method to run Transition by id of item.

Renvoie

boolean Indicates whether the transition was successful.

Depuis

4.0.0

Références $message, $model, $return, Text\_(), Route\_(), Joomla\Application\checkToken(), et Text\sprintf().

saveorder()

saveorder

(

)

Method to save the submitted ordering values for records.

Renvoie

boolean True on success

Depuis

1.6

Références $i, $message, $model, $return, Text\_(), Route\_(), Joomla\Application\checkToken(), et Text\sprintf().

saveOrderAjax()

saveOrderAjax

(

)

Method to save the submitted ordering values for records via AJAX.

Renvoie

void

Depuis

3.0

Références $i, $model, $return, et Joomla\Application\checkToken().

Documentation des champs

$option

$option

protected

$text_prefix

$text_prefix

protected

$view_list

$view_list

protected

---

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

• AdminController.php