Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe TemplatesModelStyle
+ Graphe d'héritage de TemplatesModelStyle:

Fonctions membres publiques

 __construct ($config=array())
 
 delete (&$pks)
 
 duplicate (&$pks)
 
 getForm ($data=array(), $loadData=true)
 
 getItem ($pk=null)
 
 getTable ($type='Style', $prefix='TemplatesTable', $config=array())
 
 save ($data)
 
 setHome ($id=0)
 
 unsetHome ($id=0)
 
 getHelp ()
 

Fonctions membres protégées

 populateState ()
 
 generateNewTitle ($categoryId, $alias, $title)
 
 loadFormData ()
 
 preprocessForm (JForm $form, $data, $group='content')
 
 cleanCache ($group=null, $clientId=0)
 

Attributs protégés

 $helpKey = 'JHELP_EXTENSIONS_TEMPLATE_MANAGER_STYLES_EDIT'
 
 $helpURL
 

Attributs privés

 $_cache = array()
 

Description détaillée

Template style model.

Depuis
1.6

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array())

Constructor.

Paramètres
array$configAn optional associative array of configuration settings.

Références $config.

Documentation des fonctions membres

◆ cleanCache()

cleanCache (   $group = null,
  $clientId = 0 
)
protected

Custom clean cache method

Paramètres
string$groupThe cache group
integer$clientIdThe ID of the client
Renvoie
void
Depuis
1.6

◆ delete()

delete ( $pks)

Method to delete rows.

Paramètres
array&$pksAn array of item ids.
Renvoie
boolean Returns true on success, false on failure.
Depuis
1.6
Exceptions
Exception

Références $context, $dispatcher, $name, $user, JEventDispatcher\getInstance(), option, et JError\raiseWarning().

◆ duplicate()

duplicate ( $pks)

Method to duplicate styles.

Paramètres
array&$pksAn array of primary key IDs.
Renvoie
boolean True if successful.
Exceptions
Exception

Références $context, $dispatcher, $name, $user, JEventDispatcher\getInstance(), null, et option.

◆ generateNewTitle()

generateNewTitle (   $categoryId,
  $alias,
  $title 
)
protected

Method to change the title.

Paramètres
integer$categoryIdThe id of the category.
string$aliasThe alias.
string$titleThe title.
Renvoie
string New title.
Depuis
1.7.1

Références $title.

◆ getForm()

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

Method to get the record form.

Paramètres
array$dataAn optional array of data for the form to interrogate.
boolean$loadDataTrue 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 $clientId, $data, $form, $item, $template, JPATH_ADMINISTRATOR, et JPATH_SITE.

◆ getHelp()

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

◆ getItem()

getItem (   $pk = null)

Method to get a single record.

Paramètres
integer$pkThe id of the primary key.
Renvoie
mixed Object on success, false on failure.

Références $client, $path, $return, et null.

◆ getTable()

getTable (   $type = 'Style',
  $prefix = 'TemplatesTable',
  $config = array() 
)

Returns a reference to the 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

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.

Note
Calling getState in this method will result in recursion.
Renvoie
void
Depuis
1.6

Références $app, et $params.

◆ preprocessForm()

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

Method to allow derived classes to preprocess the form.

Paramètres
JForm$formA JForm object.
mixed$dataThe data expected for the form.
string$groupThe name of the plugin group to import (defaults to "content").
Renvoie
void
Depuis
1.6
Exceptions
Exceptionif there is an error in the form event.

Références $client, $clientId, $data, $form, $lang, $template, jimport(), et null.

◆ save()

save (   $data)

Method to save the form data.

Paramètres
array$dataThe form data.
Renvoie
boolean True on success.

Références $app, $data, $db, $dispatcher, $extension, $n, $query, $user, JEventDispatcher\getInstance(), et null.

◆ setHome()

setHome (   $id = 0)

Method to set a template style as home.

Paramètres
integer$idThe primary key ID for the style.
Renvoie
boolean True if successful.
Exceptions
Exception

Références $db, $extension, $id, $query, $style, et $user.

◆ unsetHome()

unsetHome (   $id = 0)

Method to unset a template style as default for a language.

Paramètres
integer$idThe primary key ID for the style.
Renvoie
boolean True if successful.
Exceptions
Exception

Références $db, $id, $query, $style, $user, et elseif.

Documentation des champs

◆ $_cache

$_cache = array()
private

◆ $helpKey

$helpKey = 'JHELP_EXTENSIONS_TEMPLATE_MANAGER_STYLES_EDIT'
protected

◆ $helpURL

$helpURL
protected

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