Référence de la classe MessagesModelMessage

Graphe d'héritage de MessagesModelMessage:

Fonctions membres publiques
	delete (&$pks)
	getTable ($type='Message', $prefix='MessagesTable', $config=array())
	getItem ($pk=null)
	getForm ($data=array(), $loadData=true)
	publish (&$pks, $value=1)
	save ($data)

Fonctions membres protégées
	populateState ()
	loadFormData ()

Attributs protégés
	$item

Description détaillée

Private Message model.

Depuis

1.6

Documentation des fonctions membres

delete()

delete

(

&

$pks

)

Check that recipient user is the one trying to delete and then call parent delete method

Paramètres

array

&$pks

An array of record primary keys.

Renvoie

boolean True if successful, false if an error occurs.

Depuis

3.1

Références $i, et $user.

getForm()

getForm	(		$data = array(),
			$loadData = true
	)

Method to get the record form.

Paramètres

array	$data	Data for the form.
boolean	$loadData	True if the form is to load its own data (default case), false if not.

Renvoie

JForm A JForm object on success, false on failure

Depuis

1.6

Références $form.

getItem()

getItem

(

$pk = null

)

Method to get a single record.

Paramètres

integer

$pk

The id of the primary key.

Renvoie

mixed Object on success, false on failure.

Depuis

1.6

Références $db, $item, $message, $query, elseif, et item.

getTable()

getTable	(		$type = 'Message',
			$prefix = 'MessagesTable',
			$config = array()
	)

Returns a Table object, always creating it.

Paramètres

type	$type	The table type to instantiate
string	$prefix	A prefix for the table class name. Optional.
array	$config	Configuration array for model. Optional.

Renvoie

JTable A database object

Depuis

1.6

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

loadFormData()

loadFormData ( )

protected

Method to get the data that should be injected in the form.

Renvoie

mixed The data for the form.

Depuis

1.6

Références $data.

populateState()

populateState ( )

protected

Method to auto-populate the model state.

This method should only be called once per instantiation and is designed to be called on the first call to the getState() method unless the model configuration flag to ignore the request is set.

Note. Calling getState in this method will result in recursion.

Renvoie

void

Depuis

1.6

Références $input, et $user.

publish()

publish	(	&	$pks,
			$value = 1
	)

Checks that the current user matches the message recipient and calls the parent publish method

Paramètres

array	&$pks	A list of the primary keys to change.
integer	$value	The value of the published state.

Renvoie

boolean True on success.

Depuis

3.1

Références $i, $user, et $value.

save()

save

(

$data

)

Method to save the form data.

Paramètres

array

$data

The form data.

Renvoie

boolean True on success.

Depuis

1.6

Références $app, $config, $data, $lang, $message, $sitename, $subject, ENT_COMPAT, et JPATH_ADMINISTRATOR.

Documentation des champs

$item

$item

protected

Message

---

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

• administrator/components/com_messages/models/message.php