Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe WorkflowController
+ Graphe d'héritage de WorkflowController:

Fonctions membres publiques

 __construct ($config=array(), MVCFactoryInterface $factory=null, $app=null, $input=null)
 
 postSaveHook (BaseDatabaseModel $model, $validData=array())
 
- 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=array())
 
 allowEdit ($data=array(), $key='id')
 
 getRedirectToItemAppend ($recordId=null, $urlVar='id')
 
 getRedirectToListAppend ()
 
- 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)
 

Attributs protégés

 $extension
 
 $section
 
- 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
 

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

Workflow 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$configAn optional associative array of configuration settings.
MVCFactoryInterface$factoryThe factory.
CMSApplication$appThe Application for the dispatcher
Input$inputInput
Depuis
4.0.0
Exceptions

Références $app, $config, $extension, $input, $parts, Text\_(), Symfony\Contracts\Service\__construct(), et extension.

Documentation des fonctions membres

◆ allowAdd()

allowAdd (   $data = array())
protected

Method to check if you can add a new record.

Paramètres
array$dataAn array of input data.
Renvoie
boolean
Depuis
4.0.0

Références extension.

◆ allowEdit()

allowEdit (   $data = array(),
  $key = 'id' 
)
protected

Method to check if you can edit a record.

Paramètres
array$dataAn array of input data.
string$keyThe name of the key for the primary key.
Renvoie
boolean
Depuis
4.0.0

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

◆ 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
4.0.0

Références $append, $recordId, et extension.

◆ getRedirectToListAppend()

getRedirectToListAppend ( )
protected

Gets the URL arguments to append to a list redirect.

Renvoie
string The arguments to append to the redirect URL.
Depuis
4.0.0

Références $append, et extension.

◆ postSaveHook()

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

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

Paramètres
BaseDatabaseModel$modelThe data model object.
array$validDataThe validated data.
Renvoie
void
Depuis
4.0.0

Références $db, $key, $model, $query, $recordId, $task, $transitions, et ParameterType\INTEGER.

Documentation des champs

◆ $extension

$extension
protected

◆ $section

$section
protected

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