Référence de la classe PlgFinderContacts

Graphe d'héritage de PlgFinderContacts:

Fonctions membres publiques
	onFinderCategoryChangeState ($extension, $pks, $value)
	onFinderAfterDelete ($context, $table)
	onFinderAfterSave ($context, $row, $isNew)
	onFinderBeforeSave ($context, $row, $isNew)
	onFinderChangeState ($context, $pks, $value)
Fonctions membres publiques hérités de FinderIndexerAdapter
	__construct (&$subject, $config)
	onStartIndex ()
	onBeforeIndex ()
	onBuildIndex ()

Fonctions membres protégées
	index (FinderIndexerResult $item, $format='html')
	setup ()
	getListQuery ($query=null)
Fonctions membres protégées hérités de FinderIndexerAdapter
	change ($id, $property, $value)
	index (FinderIndexerResult $item)
	reindex ($id)
	remove ($id)
	setup ()
	categoryAccessChange ($row)
	categoryStateChange ($pks, $value)
	checkCategoryAccess ($row)
	checkItemAccess ($row)
	getContentCount ()
	getItem ($id)
	getItems ($offset, $limit, $query=null)
	getListQuery ($query=null)
	getPluginType ($id)
	getStateQuery ()
	getUpdateQueryByTime ($time)
	getUpdateQueryByIds ($ids)
	getTypeId ()
	getUrl ($id, $extension, $view)
	getItemMenuTitle ($url)
	itemAccessChange ($row)
	itemStateChange ($pks, $value)
	pluginDisable ($pks)
	translateState ($item, $category=null)

Attributs protégés
	$context = 'Contacts'
	$extension = 'com_contact'
	$layout = 'contact'
	$type_title = 'Contact'
	$table = '#__contact_details'
	$state_field = 'published'
	$autoloadLanguage = true
Attributs protégés hérités de FinderIndexerAdapter
	$context
	$extension
	$layout
	$mime
	$old_access
	$old_cataccess
	$type_title
	$type_id
	$db
	$table
	$indexer
	$state_field = 'state'

Description détaillée

Finder adapter for Joomla Contacts.

Depuis

2.5

Documentation des fonctions membres

getListQuery()

getListQuery (   $query = null )

protected

Method to get the SQL query used to retrieve the list of content items.

Paramètres

mixed

$query

A JDatabaseQuery object or null.

Renvoie

JDatabaseQuery A database object.

Depuis

2.5

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

index()

index ( FinderIndexerResult  $item,   $format = 'html'  )

protected

Method to index an item. The item must be a FinderIndexerResult object.

Paramètres

FinderIndexerResult	$item	The item to index as a FinderIndexerResult object.
string	$format	The item format

Renvoie

void

Depuis

2.5

Exceptions

Exception

on database error.

Références $item, $title, extension, ContactHelperRoute\getContactRoute(), FinderIndexerHelper\getContentExtras(), FinderIndexerHelper\getContentPath(), FinderIndexer\META_CONTEXT, et FinderIndexerResult\setLanguage().

onFinderAfterDelete()

onFinderAfterDelete	(		$context,
			$table
	)

Method to remove the link information for items that have been deleted.

This event will fire when contacts are deleted and when an indexed item is deleted.

Paramètres

string	$context	The context of the action being performed.
JTable	$table	A JTable object containing the record to be deleted

Renvoie

boolean True on success.

Depuis

2.5

Exceptions

Exception

on database error.

Références $context, $id, et elseif.

onFinderAfterSave()

onFinderAfterSave	(		$context,
			$row,
			$isNew
	)

Method to determine if the access level of an item changed.

Paramètres

string	$context	The context of the content passed to the plugin.
JTable	$row	A JTable object
boolean	$isNew	If the content has just been created

Renvoie

boolean True on success.

Depuis

2.5

Exceptions

Exception

on database error.

Références $context, et $row.

onFinderBeforeSave()

onFinderBeforeSave	(		$context,
			$row,
			$isNew
	)

Method to reindex the link information for an item that has been saved. This event is fired before the data is actually saved so we are going to queue the item to be indexed later.

Paramètres

string	$context	The context of the content passed to the plugin.
JTable	$row	A JTable object
boolean	$isNew	If the content is just about to be created

Renvoie

boolean True on success.

Depuis

2.5

Exceptions

Exception

on database error.

Références $context, et $row.

onFinderCategoryChangeState()

onFinderCategoryChangeState	(		$extension,
			$pks,
			$value
	)

Method to update the item link information when the item category is changed. This is fired when the item category is published or unpublished from the list view.

Paramètres

string	$extension	The extension whose category has been updated.
array	$pks	A list of primary key ids of the content that has changed state.
integer	$value	The value of the state that the content has been changed to.

Renvoie

void

Depuis

2.5

Références $extension, et $value.

onFinderChangeState()

onFinderChangeState	(		$context,
			$pks,
			$value
	)

Method to update the link information for items that have been changed from outside the edit screen. This is fired when the item is published, unpublished, archived, or unarchived from the list view.

Paramètres

string	$context	The context for the content passed to the plugin.
array	$pks	A list of primary key ids of the content that has changed state.
integer	$value	The value of the state that the content has been changed to.

Renvoie

void

Depuis

2.5

Références $context, et $value.

setup()

setup ( )

protected

Method to setup the indexer to be run.

Renvoie

boolean True on success.

Depuis

2.5

Références FinderIndexerHelper\getContentPath(), JPATH_SITE, et JLoader\register().

Documentation des champs

$autoloadLanguage

$autoloadLanguage = true

protected

$context

$context = 'Contacts'

protected

$extension

$extension = 'com_contact'

protected

$layout

$layout = 'contact'

protected

$state_field

$state_field = 'published'

protected

$table

$table = '#__contact_details'

protected

$type_title

$type_title = 'Contact'

protected

---

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

• plugins/finder/contacts/contacts.php