Référence de la classe BannersModelBanners

Graphe d'héritage de BannersModelBanners:

Fonctions membres publiques
	__construct ($config=array())
&	getCategoryOrders ()
	getTable ($type='Banner', $prefix='BannersTable', $config=array())
	getItems ()
	impress ()

Fonctions membres protégées
	getListQuery ()
	getStoreId ($id='')
	populateState ($ordering='a.name', $direction='asc')
	getStoreId ($id='')
	getListQuery ()

Description détaillée

Methods supporting a list of banner records.

Depuis

1.6

Banners model for the Joomla Banners component.

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Constructor.

Paramètres

array

$config

An optional associative array of configuration settings.

Voir également

JControllerLegacy

Depuis

1.6

Références $config.

Documentation des fonctions membres

getCategoryOrders()

& getCategoryOrders

(

)

Method to get the maximum ordering value for each category.

Renvoie

array

Depuis

1.6

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

getItems()

getItems

(

)

Get a list of banners.

Renvoie

array

Depuis

1.6

Références $item, et $keywords.

getListQuery() [1/2]

getListQuery ( )

protected

Method to get a JDatabaseQuery object for retrieving the data set from a database.

Renvoie

JDatabaseQuery A JDatabaseQuery object to retrieve the data set.

Depuis

1.6

Références $config, $db, $keywords, $ordering, $prefix, $query, $type, et elseif.

getListQuery() [2/2]

getListQuery ( )

protected

Build an SQL query to load the list data.

Renvoie

JDatabaseQuery

Depuis

1.6

Références $clientId, $db, $language, $published, $query, et elseif.

getStoreId() [1/2]

getStoreId (   $id = '' )

protected

Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements.

Paramètres

string

$id

A prefix for the store id.

Renvoie

string A store id.

Depuis

1.6

Références $id.

getStoreId() [2/2]

getStoreId (   $id = '' )

protected

Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements.

Paramètres

string

$id

A prefix for the store id.

Renvoie

string A store id.

Depuis

1.6

Références $id.

getTable()

getTable	(		$type = 'Banner',
			$prefix = 'BannersTable',
			$config = array()
	)

Returns a reference to the a Table object, always creating it.

Paramètres

string	$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 JTable object

Depuis

1.6

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

impress()

impress

(

)

Makes impressions on a list of banners

Renvoie

void

Depuis

1.6

Références $config, $db, $item, $items, $query, et JError\raiseError().

populateState()

populateState (   $ordering = 'a.name',   $direction = 'asc'  )

protected

Method to auto-populate the model state.

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

Paramètres

string	$ordering	An optional ordering field.
string	$direction	An optional direction (asc|desc).

Renvoie

void

Depuis

1.6

Références $direction, et $ordering.

---

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

• administrator/components/com_banners/models/banners.php