Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe FormController
+ Graphe d'héritage de FormController:

Fonctions membres publiques

 __construct ($config=array())
 
 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)
 
- Fonctions membres publiques hérités de BaseController
 __construct ($config=array())
 
 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
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de BaseController
static addModelPath ($path, $prefix='')
 
static getInstance ($prefix, $config=array())
 
- Fonctions membres protégées statiques hérités de BaseController
static createFileName ($type, $parts=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())

Constructor.

Paramètres
array$configAn optional associative array of configuration settings.
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$dataAn 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$dataAn array of input data.
string$keyThe 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$dataAn array of input data.
string$keyThe 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$modelThe 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$keyThe 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, null, et option.

◆ edit()

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

Method to edit an existing record.

Paramètres
string$keyThe name of the primary key of the URL variable.
string$urlVarThe 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.

◆ getModel()

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

Method to get a model object, loading it if required.

Paramètres
string$nameThe model name. Optional.
string$prefixThe class prefix. Optional.
array$configConfiguration 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$recordIdThe primary key id for the item.
string$urlVarThe 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$modelThe data model object.
array$validDataThe validated data.
Renvoie
void
Depuis
1.6

◆ reload()

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

Method to reload a record.

Paramètres
string$keyThe name of the primary key of the URL variable.
string$urlVarThe name of the URL variable if different from the primary key (sometimes required to avoid router collisions).
Renvoie
void
Depuis
3.7.4

Références $app, $data, $form, $key, et option.

◆ save()

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

Method to save a record.

Paramètres
string$keyThe name of the primary key of the URL variable.
string$urlVarThe 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

Références $app, $context, $data, $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 :