Référence de la classe ApiController

Graphe d'héritage de ApiController:

Fonctions membres publiques
	__construct ($config=array(), MVCFactoryInterface $factory=null, ?CMSApplication $app=null, ?Input $input=null)
	add ()
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
	allowEdit ($data=array(), $key='id')
	allowAdd ($data=array())
	preprocessSaveData (array $data)
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
	$contentType
	$option
	$text_prefix
	$context
	$itemsPerPage = 20
	$modelState
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 API Controller

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

Depuis

4.0.0

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	Input

Depuis

4.0.0

Exceptions

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

Documentation des fonctions membres

add()

add

(

)

Method to add a new record.

Renvoie

void

Depuis

4.0.0

Exceptions

NotAllowed

Références $recordId.

allowAdd()

allowAdd (   $data = array() )

protected

Method to check if you can add a new record.

Extended classes can override this if necessary.

Paramètres

array

$data

An array of input data.

Renvoie

boolean

Depuis

4.0.0

Références $this, et $user.

allowEdit()

allowEdit (   $data = array(),   $key = 'id'  )

protected

Method to check if you can edit an existing record.

Extended classes can override this if necessary.

Paramètres

array	$data	An array of input data.
string	$key	The name of the key for the primary key; default is id.

Renvoie

boolean

Depuis

4.0.0

preprocessSaveData()

preprocessSaveData ( array  $data )

protected

Method to allow extended classes to manipulate the data to be saved for an extension.

Paramètres

array

$data

An array of input data.

Renvoie

array

Depuis

4.0.0

Références $data.

Documentation des champs

$contentType

$contentType

protected

$context

$context

protected

$itemsPerPage

$itemsPerPage = 20

protected

$modelState

$modelState

protected

$option

$option

protected

$text_prefix

$text_prefix

protected

---

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

• libraries/src/MVC/Controller/ApiController.php