Référence de la classe MenusModelItem

Graphe d'héritage de MenusModelItem:

Graphe de collaboration de MenusModelItem:

Liste de tous les membres

Fonctions membres publiques
	batch ($commands, $pks, $contexts)
	getForm ($data=array(), $loadData=true)
	getHelp ()
	getItem ($pk=null)
	getModules ()
	getTable ($type= 'Menu', $prefix= 'MenusTable', $config=array())
	rebuild ()
	save ($data)
	saveorder ($idArray=null, $lft_array=null)
	setHome (&$pks, $value=1)
	publish (&$pks, $value=1)
Fonctions membres publiques inherited from JModelAdmin
	__construct ($config=array())
	checkin ($pks=array())
	checkout ($pk=null)
	delete (&$pks)
	reorder ($pks, $delta=0)
Fonctions membres publiques inherited from JModelForm
	validate ($form, $data, $group=null)
Fonctions membres publiques inherited from JModel
	getDbo ()
	getName ()
	getState ($property=null, $default=null)
	setDbo (&$db)
	setState ($property, $value=null)
Fonctions membres publiques inherited from JObject
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

Fonctions membres protégées
	canDelete ($record)
	canEditState ($record)
	batchCopy ($value, $pks, $contexts)
	batchMove ($value, $pks, $contexts)
	canSave ($data=array(), $key= 'id')
	loadFormData ()
	getReorderConditions ($table)
	populateState ()
	preprocessForm (JForm $form, $data, $group= 'content')
	generateNewTitle ($parent_id, $alias, $title)
	cleanCache ($group=null, $client_id=0)
Fonctions membres protégées inherited from JModelAdmin
	batchAccess ($value, $pks, $contexts)
	batchLanguage ($value, $pks, $contexts)
	prepareTable (&$table)
Fonctions membres protégées inherited from JModelForm
	loadForm ($name, $source=null, $options=array(), $clear=false, $xpath=false)
Fonctions membres protégées inherited from JModel
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
	_createTable ($name, $prefix= 'Table', $config=array())

Attributs protégés
	$text_prefix = 'COM_MENUS_ITEM'
	$helpKey = 'JHELP_MENUS_MENU_ITEM_MANAGER_EDIT'
	$helpURL
	$helpLocal = false
Attributs protégés inherited from JModelAdmin
	$event_after_delete = null
	$event_after_save = null
	$event_before_delete = null
	$event_before_save = null
	$event_change_state = null
Attributs protégés inherited from JModelForm
	$_forms = array()
Attributs protégés inherited from JModel
	$__state_set = null
	$_db
	$name
	$option = null
	$state
	$event_clean_cache = null
Attributs protégés inherited from JObject
	$_errors = array()

---

Documentation des fonctions membres

MenusModelItem::batch	(		$commands,
			$pks,
			$contexts
	)

Method to perform batch operations on an item or a set of items.

Paramètres:

array	$commands	An array of commands to perform.
array	$pks	An array of item ids.
array	$contexts	An array of item contexts.

Renvoie:

boolean Returns true on success, false on failure.

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

Références $cmd, JText\_(), elseif, JArrayHelper\getValue(), et JArrayHelper\toInteger().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::batchCopy (   $value,   $pks,   $contexts  )

protected

Batch copy menu items to a new menu or parent.

Paramètres:

integer	$value	The new menu or sub-item.
array	$pks	An array of row IDs.
array	$contexts	An array of item contexts.

Renvoie:

mixed An array of new IDs on success, boolean false on failure.

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

Références $count, $db, $i, $parts, $query, $title, $user, JText\_(), JFactory\getUser(), JArrayHelper\getValue(), null, et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::batchMove (   $value,   $pks,   $contexts  )

protected

Batch move menu items to a new menu or parent.

Paramètres:

integer	$value	The new menu or sub-item.
array	$pks	An array of row IDs.
array	$contexts	An array of item contexts.

Renvoie:

boolean True on success.

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

Références $db, $parts, $query, $user, JText\_(), JFactory\getUser(), JArrayHelper\getValue(), JText\sprintf(), et JArrayHelper\toInteger().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::canDelete (   $record )

protected

Method to test whether a record can be deleted.

Paramètres:

object

A record object.

Renvoie:

boolean True if allowed to delete the record. Defaults to the permission set in the component.

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

Références $user, JFactory\getUser(), et return.

Voici le graphe d'appel pour cette fonction :

MenusModelItem::canEditState (   $record )

protected

Method to test whether a record can have its state edited.

Paramètres:

object

A record object.

Renvoie:

boolean True if allowed to change the state of the record. Defaults to the permission set in the component.

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

Références $user, et JFactory\getUser().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::canSave (   $data = array(),   $key = 'id'  )

protected

Method to check if you can save a 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 JFactory\getUser().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::cleanCache (   $group = null,   $client_id = 0  )

protected

Custom clean cache method

Depuis:

1.6

Réimplémentée à partir de JModel.

MenusModelItem::generateNewTitle (   $parent_id,   $alias,   $title  )

protected

Method to change the title & alias.

Paramètres:

integer	$parent_id	The id of the parent.
string	$alias	The alias.
string	$title	The title.

Renvoie:

array Contains the modified title and alias.

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

Références $parent_id, $title, et JString\increment().

Voici le graphe d'appel pour cette fonction :

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

Method to get the row 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:

mixed A JForm object on success, false on failure

Depuis:

1.6

Réimplémentée à partir de JModelForm.

Références $data, $item, et JArrayHelper\getValue().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::getHelp

(

)

Get the necessary data to load an item help screen.

Renvoie:

object An object with key, url, and local properties for loading the item help screen.

Depuis:

1.6

MenusModelItem::getItem

(

$pk = null

)

Method to get a menu item.

Paramètres:

integer

$pk

An optional id of the object to get, otherwise the id from the model state is used.

Renvoie:

mixed Menu item data object on success, false on failure.

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

Références $lang, $link, $type, JFactory\getApplication(), MenusHelper\getAssociations(), JComponentHelper\getComponent(), JFactory\getLanguage(), MenusHelper\getLinkKey(), JPATH_ADMINISTRATOR, JRegistry\loadString(), null, et JArrayHelper\toObject().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::getModules

(

)

Get the list of modules not in trash.

Renvoie:

mixed An array of module records (id, title, position), or false on error.

Depuis:

1.6

Références $db, et $query.

MenusModelItem::getReorderConditions (   $table )

protected

A protected method to get the where clause for the reorder This ensures that the row will be moved relative to a row with the same menutype

Paramètres:

JTableMenu

$table

instance

Renvoie:

array An array of conditions to add to add to ordering queries.

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

MenusModelItem::getTable	(		$type = 'Menu',
			$prefix = 'MenusTable',
			$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éimplémentée à partir de JModel.

Références $config, $type, et JTable\getInstance().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::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éimplémentée à partir de JModelForm.

Références JFactory\getApplication().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::populateState ( )

protected

Auto-populate the model state.

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

Renvoie:

void

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

Références $app, $link, $params, $type, JFactory\getApplication(), JRequest\getCmd(), JRequest\getInt(), et JComponentHelper\getParams().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::preprocessForm ( JForm  $form,   $data,   $group = 'content'  )

protected

Paramètres:

object	$form	A form object.
mixed	$data	The data expected for the form.

Renvoie:

void

Depuis:

1.6

Exceptions:

Exception

if there is an error in the form event.

Réimplémentée à partir de JModelForm.

Références $base, $data, $field, $fields, $language, $layout, $link, $path, $tag, $type, $view, JText\_(), JPath\clean(), JFile\exists(), JPath\find(), JFactory\getApplication(), JLanguageHelper\getLanguages(), JPATH_ADMINISTRATOR, JPATH_ROOT, JPATH_SITE, JForm\load(), et JForm\loadFile().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::publish	(	&	$pks,
			$value = 1
	)

Method to change the published state of one or more records.

Paramètres:

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

Renvoie:

boolean True on success.

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

Références $i, JText\_(), et JError\raiseWarning().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::rebuild

(

)

Method rebuild the entire nested set tree.

Renvoie:

boolean False on failure or error, true otherwise.

Depuis:

1.6

Références $db, $item, $params, et JRegistry\loadString().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::save

(

$data

)

Method to save the form data.

Paramètres:

array

$data

The form data.

Renvoie:

boolean True on success.

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

Références $base, $data, $db, $id, $key, $query, $tag, $title, JText\_(), JURI\base(), elseif, JFactory\getApplication(), JFactory\getDbo(), JURI\getInstance(), et JError\raiseNotice().

Voici le graphe d'appel pour cette fonction :

MenusModelItem::saveorder	(		$idArray = null,
			$lft_array = null
	)

Method to save the reordered nested set tree. First we save the new order values in the lft values of the changed ids. Then we invoke the table rebuild to implement the new ordering.

Paramètres:

array	$idArray	id's of rows to be reordered
array	$lft_array	lft values of rows to be reordered

Renvoie:

boolean false on failuer or error, true otherwise

Depuis:

1.6

Réimplémentée à partir de JModelAdmin.

MenusModelItem::setHome	(	&	$pks,
			$value = 1
	)

Method to change the home state of one or more items.

Paramètres:

array	$pks	A list of the primary keys to change.
int	$value	The value of the home state.

Renvoie:

boolean True on success.

Depuis:

1.6

Références $i, $user, JText\_(), elseif, JFactory\getUser(), JError\raiseNotice(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

---

Documentation des données membres

MenusModelItem::$helpKey = 'JHELP_MENUS_MENU_ITEM_MANAGER_EDIT'

protected

MenusModelItem::$helpLocal = false

protected

MenusModelItem::$helpURL

protected

MenusModelItem::$text_prefix = 'COM_MENUS_ITEM'

protected

Réimplémentée à partir de JModelAdmin.

---

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

• models/item.php