Référence de la classe ArticleController

Graphe d'héritage de ArticleController:

Fonctions membres publiques
	add ()
	edit ($key=null, $urlVar='a_id')
	getModel ($name='Form', $prefix='Site', $config=array('ignore_request'=> true))
	save ($key=null, $urlVar='a_id')
	reload ($key=null, $urlVar='a_id')
	vote ()
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='a_id')
	getReturnPage ()
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
	$view_item = 'form'
	$view_list = 'categories'
	$urlVar = 'a.id'
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

Content article class.

Depuis

1.6.0

Documentation des fonctions membres

add()

add

(

)

Method to add a new record.

Renvoie

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

Depuis

1.6

Références Route\_().

allowAdd()

allowAdd (   $data = array() )

protected

Method override to check if you can add a new record.

Paramètres

array

$data

An array of input data.

Renvoie

boolean

Depuis

1.6

Références $data, $user, ArrayHelper\getValue(), 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; default is id.

Renvoie

boolean

Depuis

1.6

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

edit()

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

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 $key, $result, et Route\_().

getModel()

getModel	(		$name = 'Form',
			$prefix = 'Site',
			$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

object The model.

Depuis

1.5

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

getRedirectToItemAppend()

getRedirectToItemAppend (   $recordId = null,   $urlVar = 'a_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

if ($layout) { $append .= '&layout=' . $layout; }

Références $append, $itemId, $recordId, $return, et $tmpl.

getReturnPage()

getReturnPage ( )

protected

Get the return URL.

If a "return" variable has been passed in the request

Renvoie

string The return URL.

Depuis

1.6

Références $return, Uri\base(), Uri\isInternal(), et null.

reload()

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

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.8.0

Références $key.

save()

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

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

Références $app, $articleId, $item, $key, $lang, $params, $result, Route\_(), elseif, et Multilanguage\isEnabled().

vote()

vote

(

)

Method to save a vote.

Renvoie

void

Depuis

1.6

Références $id, $model, $url, Text\_(), Route\_(), Joomla\Application\checkToken(), et Uri\isInternal().

Documentation des champs

$urlVar

$urlVar = 'a.id'

protected

$view_item

$view_item = 'form'

protected

$view_list

$view_list = 'categories'

protected

---

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

• components/com_content/src/Controller/ArticleController.php