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

$config

An 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	$group	The cache group
integer	$clientId	The ID of the client

Renvoie

void

Depuis

1.6

delete()

delete

(

&

$pks

)

Method to delete rows.

Paramètres

array

&$pks

An 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

&$pks

An 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	$categoryId	The id of the category.
string	$alias	The alias.
string	$title	The 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	$data	An optional array of data for the form to interrogate.
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 $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

$pk

The 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	$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

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	$form	A JForm object.
mixed	$data	The data expected for the form.
string	$group	The name of the plugin group to import (defaults to "content").

Renvoie

void

Depuis

1.6

Exceptions

Exception

if 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

$data

The 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

$id

The 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

$id

The 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 :

• models/style.php