Référence de la classe FinderModelMaps

Graphe d'héritage de FinderModelMaps:

Fonctions membres publiques
	__construct ($config=array())
	delete (&$pks)
	getTable ($type='Map', $prefix='FinderTable', $config=array())
	publish (&$pks, $value=1)
	purge ()

Fonctions membres protégées
	canDelete ($record)
	canEditState ($record)
	getListQuery ()
	_getListCount ($query)
	getStoreId ($id='')
	populateState ($ordering='d.branch_title', $direction='ASC')

Description détaillée

Maps model for the Finder package.

Depuis

2.5

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Constructor.

Paramètres

array

$config

An associative array of configuration settings. [optional]

Depuis

2.5

Voir également

JControllerLegacy

Références $config.

Documentation des fonctions membres

_getListCount()

_getListCount (   $query )

protected

Returns a record count for the query.

Paramètres

JDatabaseQuery | string

$query

The query.

Renvoie

integer Number of rows for query.

Depuis

3.0

Références $query.

canDelete()

canDelete (   $record )

protected

Method to test whether a record can be deleted.

Paramètres

object

$record

A record object.

Renvoie

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

Depuis

2.5

Références option.

canEditState()

canEditState (   $record )

protected

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

Paramètres

object

$record

A record object.

Renvoie

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

Depuis

2.5

Références option.

delete()

delete

(

&

$pks

)

Method to delete one or more records.

Paramètres

array

$pks

An array of record primary keys.

Renvoie

boolean True if successful, false if an error occurs.

Depuis

2.5

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

getListQuery()

getListQuery ( )

protected

Build an SQL query to load the list data.

Renvoie

JDatabaseQuery A JDatabaseQuery object

Depuis

2.5

Références $db, $listDirn, $query, $state, et elseif.

getStoreId()

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. [optional]

Renvoie

string A store id.

Depuis

2.5

Références $id.

getTable()

getTable	(		$type = 'Map',
			$prefix = 'FinderTable',
			$config = array()
	)

Returns a JTable object, always creating it.

Paramètres

string	$type	The table type to instantiate. [optional]
string	$prefix	A prefix for the table class name. [optional]
array	$config	Configuration array for model. [optional]

Renvoie

JTable A database object

Depuis

2.5

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

populateState()

populateState (   $ordering = 'd.branch_title',   $direction = 'ASC'  )

protected

Method to auto-populate the model state. Calling getState in this method will result in recursion.

Paramètres

string	$ordering	An optional ordering field. [optional]
string	$direction	An optional direction. [optional]

Renvoie

void

Depuis

2.5

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

publish()

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.
integer	$value	The value of the published state. [optional]

Renvoie

boolean True on success.

Depuis

2.5

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

purge()

purge

(

)

Method to purge all maps from the taxonomy.

Renvoie

boolean Returns true on success, false on failure.

Depuis

2.5

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

---

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

• administrator/components/com_finder/models/maps.php