Référence de la classe TemplateController

Graphe d'héritage de TemplateController:

Fonctions membres publiques
	__construct ($config=array(), MVCFactoryInterface $factory=null, $app=null, $input=null)
	edit ($key=null, $urlVar=null)
Fonctions membres publiques hérités de FormController
	__construct ( $config=array(), MVCFactoryInterface $factory=null, ?CMSApplication $app=null, ?Input $input=null, FormFactoryInterface $formFactory=null)
	add ()
	batch ($model)
	cancel ($key=null)
	edit ($key=null, $urlVar=null)
	getModel ($name='', $prefix='', $config=array('ignore_request'=> true))
	save ($key=null, $urlVar=null)
	editAssociations ()
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 publiques hérités de FormFactoryAwareInterface
	setFormFactory (FormFactoryInterface $factory)

Fonctions membres protégées
	allowAdd ($data=[])
	getRedirectToItemAppend ($recordId=null, $urlVar='id')
Fonctions membres protégées hérités de FormController
	allowAdd ($data=[])
	allowEdit ($data=[], $key='id')
	allowSave ($data, $key='id')
	getRedirectToItemAppend ($recordId=null, $urlVar='id')
	getRedirectToListAppend ()
	postSaveHook (BaseDatabaseModel $model, $validData=array())
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)

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 hérités de FormController
	$context
	$option
	$view_item
	$view_list
	$text_prefix
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
Attributs protégés statiques hérités de BaseController
static	$instance
static	$views

Description détaillée

The template controller

Depuis

4.0.0

Documentation des constructeurs et destructeur

__construct()

__construct	(		$config = array(),
		MVCFactoryInterface	$factory = null,
			$app = null,
			$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, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

allowAdd()

allowAdd (   $data = [] )

protected

Method to check if you can add a new record.

Paramètres

array

$data

An array of input data.

Renvoie

boolean

Depuis

4.0.0

edit()

edit	(		$key = null,
			$urlVar = null
	)

Method to edit an existing record.

Paramètres

string	$key	The name of the primary key of the URL variable.
string	$urlVar	The name of the URL variable if different from the primary key (sometimes required to avoid router collisions).

Renvoie

boolean True if access level check and checkout passes, false otherwise.

Depuis

4.0.0

Références $context, $language, Text\_(), Route\_(), et null.

getRedirectToItemAppend()

getRedirectToItemAppend (   $recordId = null,   $urlVar = 'id'  )

protected

Gets the URL arguments to append to an item redirect.

Paramètres

	string[]	$recordId The primary key id for the item in the first element and the language of the mail template in the second key.
string	$urlVar	The name of the URL variable for the id.

Renvoie

string The arguments to append to the redirect URL.

Depuis

4.0.0

Références $language, $recordId, et $return.

---

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

• com_mails/src/Controller/TemplateController.php