Référence de la classe ModuleController

Graphe d'héritage de ModuleController:

Fonctions membres publiques
	add ()
	cancel ($key=null)
	batch ($model=null)
	save ($key=null, $urlVar=null)
	orderPosition ()
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
	allowSave ($data, $key='id')
	allowEdit ($data=array(), $key='id')
	postSaveHook (BaseDatabaseModel $model, $validData=array())
	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)

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 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
Attributs protégés statiques hérités de BaseController
static	$instance
static	$views

Description détaillée

Module controller class.

Depuis

1.6

Documentation des fonctions membres

add()

add

(

)

Override parent add method.

Renvoie

|void True if the record can be added, a object if not.

Depuis

1.6

Références $app, $params, $result, Text\_(), Route\_(), et null.

allowEdit()

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

protected

Method override to check if you can edit an existing record.

Paramètres

array	$data	An array of input data.
string	$key	The name of the key for the primary key.

Renvoie

boolean

Depuis

3.2

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

allowSave()

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

protected

Override parent allowSave method.

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 = null

)

Method to run batch operations.

Paramètres

string

$model

The model

Renvoie

boolean True on success.

Depuis

1.7

Références $model, Route\_(), et Joomla\Application\checkToken().

cancel()

cancel

(

$key = null

)

Override parent cancel method to reset the add module state.

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 $result, $return, Uri\base(), Uri\isInternal(), et null.

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

4.0.0

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

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.

orderPosition()

orderPosition

(

)

Method to get the other modules in the same position

Renvoie

string The data for the Ajax request.

Depuis

3.6.3

Références $app, $clientId, $db, $html, $i, $moduleId, $n, $position, $query, $title, Text\_(), Session\checkToken(), ENT_QUOTES, Factory\getDbo(), ParameterType\INTEGER, et Text\sprintf().

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

Références $model, $task, et null.

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

Renvoie

boolean True if successful, false otherwise.

Références $data, $item, $key, $model, Form\addFormPath(), Joomla\Application\checkToken(), et JPATH_ADMINISTRATOR.

---

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

• ModuleController.php