Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
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$commandsAn array of commands to perform.
array$pksAn array of item ids.
array$contextsAn 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$valueThe new menu or sub-item.
array$pksAn array of row IDs.
array$contextsAn 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$valueThe new menu or sub-item.
array$pksAn array of row IDs.
array$contextsAn 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:
objectA 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:
objectA 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$dataAn array of input data.
string$keyThe 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_idThe id of the parent.
string$aliasThe alias.
string$titleThe 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$dataData for the form.
boolean$loadDataTrue 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$pkAn 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$tableinstance
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$typeThe table type to instantiate
string$prefixA prefix for the table class name. Optional.
array$configConfiguration 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$formA form object.
mixed$dataThe data expected for the form.
Renvoie:
void
Depuis:
1.6
Exceptions:
Exceptionif 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$pksA list of the primary keys to change.
int$valueThe 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$dataThe 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$idArrayid's of rows to be reordered
array$lft_arraylft 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$pksA list of the primary keys to change.
int$valueThe 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 :