Référence de la classe FormController

Graphe d'héritage de FormController:

Fonctions membres publiques
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	add ()
	batch ($model)
	cancel ($key=null)
	edit ($key=null, $urlVar=null)
	getModel ($name='', $prefix='', $config=array('ignore_request'=> true))
	loadhistory ()
	save ($key=null, $urlVar=null)
	reload ($key=null, $urlVar=null)
	editAssociations ()
Fonctions membres publiques hérités de BaseController
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	addViewPath ($path)
	authorise ($task)
	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 protégées
	allowAdd ($data=array())
	allowEdit ($data=array(), $key='id')
	allowSave ($data, $key='id')
	getRedirectToItemAppend ($recordId=null, $urlVar='id')
	getRedirectToListAppend ()
	postSaveHook (\JModelLegacy $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

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
	)

Constructor.

Paramètres

array	$config	An optional associative array of configuration settings.
MVCFactoryInterface	$factory	The factory.

Voir également

Depuis

1.6

Exceptions

Références $config, $context, $r, null, et option.

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, null, et option.

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

1.6

Références $user, et option.

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

1.6

Références option.

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, et $key.

batch()

batch

(

$model

)

Method to run batch operations.

Paramètres

\JModelLegacy

$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, $option, et extension.

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, $return, $url, null, et option.

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, null, et option.

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, et $input.

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

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 $forcedLanguage, $layout, $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 $forcedLanguage, et $tmpl.

loadhistory()

loadhistory

(

)

Method to load a row from version history

Renvoie

mixed True if the record can be added, an error object if not.

Depuis

3.2

Références $key, null, et option.

postSaveHook()

postSaveHook ( \JModelLegacy  $model,   $validData = array()  )

protected

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

Paramètres

\JModelLegacy	$model	The data model object.
array	$validData	The validated data.

Renvoie

void

Depuis

1.6

reload()

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

Method to reload 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

void

Depuis

3.7.4

We need the filtered value of calendar fields because the UTC normalision 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, $data, $field, $form, $key, et option.

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 normalision 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, $n, $prefix, $return, $task, $url, null, et option.

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