Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JControllerForm
+ Graphe d'héritage de JControllerForm:
+ Graphe de collaboration de JControllerForm:

Liste de tous les membres

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))
 save ($key=null, $urlVar=null)
- Fonctions membres publiques inherited from JController
 addViewPath ($path)
 authorize ($task)
 authorise ($task)
 display ($cachable=false, $urlparams=false)
 execute ($task)
 getName ()
 getTask ()
 getTasks ()
 getView ($name= '', $type= '', $prefix= '', $config=array())
 redirect ()
 registerDefaultTask ($method)
 registerTask ($task, $method)
 unregisterTask ($task)
 setAccessControl ($section, $value=null)
 setMessage ($text, $type= 'message')
 setRedirect ($url, $msg=null, $type=null)
- Fonctions membres publiques inherited from JObject
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Fonctions membres protégées

 allowAdd ($data=array())
 allowEdit ($data=array(), $key= 'id')
 allowSave ($data, $key= 'id')
 getRedirectToItemAppend ($recordId=null, $urlVar= 'id')
 getRedirectToListAppend ()
 postSaveHook (JModel &$model, $validData=array())
- Fonctions membres protégées inherited from JController
 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 inherited from JController
 $_acoSection
 $_acoSectionValue
 $basePath
 $default_view
 $doTask
 $message
 $messageType
 $methods
 $name
 $model_prefix
 $paths
 $redirect
 $task
 $taskMap
- Attributs protégés inherited from JObject
 $_errors = array()

Additional Inherited Members

- Fonctions membres publiques statiques inherited from JController
static addModelPath ($path, $prefix= '')
static getInstance ($prefix, $config=array())
- Fonctions membres protégées statiques inherited from JController
static createFileName ($type, $parts=array())
- Attributs protégés statiques inherited from JController
static $instance

Documentation des constructeurs et destructeur

JControllerForm::__construct (   $config = array())

Constructor.

Paramètres:
array$configAn optional associative array of configuration settings.
Voir également:
JController
Depuis:
11.1

Réimplémentée à partir de JController.

Réimplémentée dans CategoriesControllerCategory, et ContentControllerArticle.

Références $config, JText\_(), null, et JError\raiseError().

+ Voici le graphe d'appel pour cette fonction :


Documentation des fonctions membres

JControllerForm::add ( )

Method to add a new record.

Renvoie:
mixed True if the record can be added, a JError object if not.
Depuis:
11.1

Réimplémentée dans WeblinksControllerWeblink, ContentControllerArticle, ModulesControllerModule, et MenusControllerItem.

Références $app, JRoute\_(), JText\_(), JFactory\getApplication(), et null.

+ Voici le graphe d'appel pour cette fonction :

JControllerForm::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:
11.1

Réimplémentée dans CategoriesControllerCategory, ContentControllerArticle, ContentControllerArticle, WeblinksControllerWeblink, BannersControllerBanner, NewsfeedsControllerNewsfeed, WeblinksControllerWeblink, et ContactControllerContact.

Références $user, et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

JControllerForm::allowEdit (   $data = array(),
  $key = 'id' 
)
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.
string$keyThe name of the key for the primary key; default is id.
Renvoie:
boolean
Depuis:
11.1

Réimplémentée dans ContentControllerArticle, ContentControllerArticle, WeblinksControllerWeblink, CategoriesControllerCategory, BannersControllerBanner, NewsfeedsControllerNewsfeed, WeblinksControllerWeblink, ContactControllerContact, UsersControllerGroup, UsersControllerUser, et AdminControllerProfile.

Références JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

JControllerForm::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:
11.1

Réimplémentée dans ModulesControllerModule, UsersControllerGroup, UsersControllerLevel, et MessagesControllerMessage.

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

JControllerForm::batch (   $model)

Method to run batch operations.

Paramètres:
JModel$modelThe model of the component being processed.
Renvoie:
boolean True if successful, false otherwise and internal error is set.
Depuis:
11.1

Réimplémentée dans ContentControllerArticle, CategoriesControllerCategory, ModulesControllerModule, BannersControllerBanner, NewsfeedsControllerNewsfeed, WeblinksControllerWeblink, ContactControllerContact, UsersControllerUser, et MenusControllerItem.

Références $extension, $id, JText\_(), JFactory\getApplication(), et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

JControllerForm::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:
11.1

Réimplémentée dans ContentControllerArticle, WeblinksControllerWeblink, MenusControllerItem, AdminControllerProfile, et ModulesControllerModule.

Références $app, $key, JRoute\_(), JText\_(), JSession\checkToken(), JFactory\getApplication(), JRequest\getInt(), jexit(), null, et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

JControllerForm::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:
11.1

Réimplémentée dans ContentControllerArticle, WeblinksControllerWeblink, MenusControllerItem, et LanguagesControllerOverride.

Références $app, $key, JRoute\_(), JText\_(), JFactory\getApplication(), JRequest\getInt(), JRequest\getVar(), null, et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

JControllerForm::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:
object The model.
Depuis:
11.1

Réimplémentée à partir de JController.

Réimplémentée dans ContentControllerArticle, WeblinksControllerWeblink, et ContactControllerContact.

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

JControllerForm::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:
11.1

Réimplémentée dans ContentControllerArticle, WeblinksControllerWeblink, CategoriesControllerCategory, UsersControllerNote, et LanguagesControllerLanguage.

Références $layout, et JRequest\getCmd().

+ Voici le graphe d'appel pour cette fonction :

JControllerForm::getRedirectToListAppend ( )
protected

Gets the URL arguments to append to a list redirect.

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

Réimplémentée dans CategoriesControllerCategory.

Références JRequest\getCmd().

+ Voici le graphe d'appel pour cette fonction :

JControllerForm::postSaveHook ( JModel $model,
  $validData = array() 
)
protected

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

Paramètres:
JModel&$modelThe data model object.
array$validDataThe validated data.
Renvoie:
void
Depuis:
11.1

Réimplémentée dans ContentControllerArticle, WeblinksControllerWeblink, et ModulesControllerModule.

JControllerForm::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:
11.1

Réimplémentée dans ContentControllerArticle, WeblinksControllerWeblink, MenusControllerItem, UsersControllerUser, LanguagesControllerOverride, AdminControllerProfile, MenusControllerMenu, et FinderControllerFilter.

Références $app, $data, $i, $key, $lang, $n, $task, JRoute\_(), JText\_(), JSession\checkToken(), JFactory\getApplication(), JObject\getError(), JObject\getErrors(), JRequest\getInt(), JFactory\getLanguage(), JModel\getState(), JModel\getTable(), JRequest\getVar(), jexit(), null, et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :


Documentation des données membres

JControllerForm::$context
protected
JControllerForm::$option
protected
JControllerForm::$view_item
protected
JControllerForm::$view_list
protected

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