Référence de la classe ContentControllerArticle

Graphe d'héritage de ContentControllerArticle:

Fonctions membres publiques
	__construct ($config=array())
	add ()
	cancel ($key='a_id')
	edit ($key=null, $urlVar='a_id')
	getModel ($name='form', $prefix='', $config=array('ignore_request'=> true))
	save ($key=null, $urlVar='a_id')
	reload ($key=null, $urlVar='a_id')
	vote ()

Fonctions membres protégées
	allowAdd ($data=array())
	allowEdit ($data=array(), $key='id')
	allowAdd ($data=array())
	allowEdit ($data=array(), $key='id')
	getRedirectToItemAppend ($recordId=null, $urlVar='a_id')
	getReturnPage ()

Attributs protégés
	$view_item = 'form'
	$view_list = 'categories'
	$urlVar = 'a.id'

Description détaillée

The article controller

Depuis

1.6

Content article class.

Depuis

1.6.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Class constructor.

Paramètres

array

$config

A named array of configuration variables.

Depuis

1.6

Références $config.

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

allowAdd() [1/2]

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, et null.

allowAdd() [2/2]

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, et null.

allowEdit() [1/2]

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

1.6

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

allowEdit() [2/2]

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, et $user.

cancel()

cancel

(

$key = 'a_id'

)

Method to cancel an edit.

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 $app, $item, $key, $lang, et $params.

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, et edit.

getModel()

getModel	(		$name = 'form',
			$prefix = '',
			$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 $itemId, $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, 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, et $params.

vote()

vote

(

)

Method to save a vote.

Renvoie

void

Depuis

1.6

Références $id, et $url.

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 :

• administrator/components/com_content/controllers/article.php