Graphe d'héritage de FormController:

Fonctions membres publiques
	__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=[])

	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)

Attributs protégés
	$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

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

Controller tailored to suit most form-based admin operations.

Depuis: 1.6

Documentation des constructeurs et destructeur

◆ __construct()

__construct	(		$config = `array()`,
		MVCFactoryInterface	$factory = `null`,
		?CMSApplication	$app = `null`,
		?Input	$input = `null`,
		FormFactoryInterface	$formFactory = `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
FormFactoryInterface	$formFactory	The form factory.

Depuis: 3.0

Références $app, $config, $context, $input, $r, $this, Symfony\Contracts\Service\__construct(), ComponentHelper\getComponentName(), Inflector\getInstance(), null, Joomla\CMS\Form\setFormFactory(), et Text\sprintf().

Documentation des fonctions membres

◆ add()

add ( )

Method to add a new record.

Renvoie: boolean True if the record can be added, false if not.

Depuis: 1.6

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

◆ allowAdd()

allowAdd ( $data = [] )

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: 1.6

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

◆ allowEdit()

allowEdit	(	$data = `[]`,
		$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: 1.6

◆ allowSave()

allowSave	(	$data,
		$key = `'id'`
	)

protected

Method to check if you can save a new or 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.

Renvoie: boolean

Depuis: 1.6

Références $data, $key, et $recordId.

◆ batch()

batch ( $model )

Method to run batch operations.

Paramètres

BaseDatabaseModel $model The model of the component being processed.

Renvoie: boolean True if successful, false otherwise and internal error is set.

Depuis: 1.7

Références $id, $model, $option, Text\_(), extension, et Text\sprintf().

◆ cancel()

cancel ( $key = null )

Method to cancel an edit.

Paramètres

string $key The name of the primary key of the URL variable.

Renvoie: boolean True if access level checks pass, false otherwise.

Depuis: 1.6

Références $context, $key, $model, $recordId, $return, $url, Route\_(), Joomla\Application\checkToken(), Uri\isInternal(), null, et Text\sprintf().

◆ 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: 1.6

Références $context, $key, $model, $recordId, Text\_(), Route\_(), null, et Text\sprintf().

◆ editAssociations()

editAssociations ( )

Load item to edit associations in com_associations

Renvoie: void

Depuis: 3.9.0

Obsolète:: 5.0 It is handled by regular save method now.

Références $app, $data, $input, et $model.

◆ getModel()

getModel	(	$name = `''`,
		$prefix = `''`,
		$config = `array('ignore_request' => true)`
	)

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: BaseDatabaseModel The model.

Depuis: 1.6

Références $config, $context, $name, et $prefix.

◆ getRedirectToItemAppend()

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

protected

Gets the URL arguments to append to an item redirect.

Paramètres

integer	$recordId	The primary key id for the item.
string	$urlVar	The name of the URL variable for the id.

Renvoie: string The arguments to append to the redirect URL.

Depuis: 1.6

Références $append, $layout, $recordId, $return, $tmpl, et null.

◆ getRedirectToListAppend()

getRedirectToListAppend ( )

protected

Gets the URL arguments to append to a list redirect.

Renvoie: string The arguments to append to the redirect URL.

Depuis: 1.6

Références $append, et $tmpl.

◆ postSaveHook()

postSaveHook	(	BaseDatabaseModel	$model,
			$validData = `array()`
	)

protected

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

Paramètres

BaseDatabaseModel	$model	The data model object.
array	$validData	The validated data.

Renvoie: void

Depuis: 1.6

◆ save()

save	(	$key = `null`,
		$urlVar = `null`
	)

Method to save a 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 successful, false otherwise.

Depuis: 1.6

We need the filtered value of calendar fields because the UTC normalisation is done in the filter and on output. This would apply the Timezone offset on reload. We set the calendar values we save to the processed date.

Références $app, $context, $data, $field, $form, $i, $key, $model, $n, $prefix, $recordId, $return, $task, $url, Text\_(), Route\_(), Joomla\Application\checkToken(), Uri\isInternal(), null, et Text\sprintf().

Documentation des champs

◆ $context

$context

protected

◆ $option

$option

protected

◆ $text_prefix

$text_prefix

protected

◆ $view_item

$view_item

protected

◆ $view_list

$view_list

protected

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

FormController.php

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct()

Documentation des fonctions membres

◆ add()

◆ allowAdd()

◆ allowEdit()

◆ allowSave()

◆ batch()

◆ cancel()

◆ edit()

◆ editAssociations()

◆ getModel()

◆ getRedirectToItemAppend()

◆ getRedirectToListAppend()

◆ postSaveHook()

◆ save()

Documentation des champs

◆ $context

◆ $option

◆ $text_prefix

◆ $view_item

◆ $view_list