Référence de la classe FinderIndexerAdapter

Graphe d'héritage de FinderIndexerAdapter:

Graphe de collaboration de FinderIndexerAdapter:

Liste de tous les membres

Fonctions membres publiques
	__construct (&$subject, $config)
	onStartIndex ()
	onBeforeIndex ()
	onBuildIndex ()
Fonctions membres publiques inherited from JPlugin
	loadLanguage ($extension= '', $basePath=JPATH_ADMINISTRATOR)
Fonctions membres publiques inherited from JEvent
	__construct (&$subject)
	update (&$args)
Fonctions membres publiques inherited from JObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

Fonctions membres protégées
	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, $sql=null)
	getListQuery ($sql=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
	$extension
	$layout
	$mime
	$old_access
	$old_cataccess
	$type_title
	$type_id
	$db
	$table
	$state_field = 'state'
Attributs protégés inherited from JPlugin
	$_name = null
	$_type = null
Attributs protégés inherited from JEvent
	$_subject = null
Attributs protégés inherited from JObject
	$_errors = array()

Additional Inherited Members
Attributs publics inherited from JPlugin
	$params = null

---

Documentation des constructeurs et destructeur

FinderIndexerAdapter::__construct	(	&	$subject,
			$config
	)

Method to instantiate the indexer adapter.

Paramètres:

object	&$subject	The object to observe.
array	$config	An array that holds the plugin configuration.

Depuis:

2.5

Réimplémentée à partir de JPlugin.

Réimplémentée dans plgFinderCategories, plgFinderContacts, plgFinderNewsfeeds, plgFinderContent, et plgFinderWeblinks.

Références $config, et FinderIndexerHelper\addContentType().

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

FinderIndexerAdapter::categoryAccessChange (   $row )

protected

Method to update index data on category access level changes

Paramètres:

JTable

$row

A JTable object

Renvoie:

void

Depuis:

2.5

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

FinderIndexerAdapter::categoryStateChange (   $pks,   $value  )

protected

Method to update index data on category access level changes

Paramètres:

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 $item.

FinderIndexerAdapter::change (   $id,   $property,   $value  )

protected

Method to change the value of a content item's property in the links table. This is used to synchronize published and access states that are changed when not editing an item directly.

Paramètres:

string	$id	The ID of the item to change.
string	$property	The property that is being changed.
integer	$value	The new value of that property.

Renvoie:

boolean True on success.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $id, $item, $query, JLog\add(), et JLog\INFO.

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::checkCategoryAccess (   $row )

protected

Method to check the existing access level for categories

Paramètres:

JTable

$row

A JTable object

Renvoie:

void

Depuis:

2.5

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

FinderIndexerAdapter::checkItemAccess (   $row )

protected

Method to check the existing access level for items

Paramètres:

JTable

$row

A JTable object

Renvoie:

void

Depuis:

2.5

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

FinderIndexerAdapter::getContentCount ( )

protected

Method to get the number of content items available to index.

Renvoie:

integer The number of content items available to index.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $return, JLog\add(), et JLog\INFO.

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::getItem (   $id )

protected

Method to get a content item to index.

Paramètres:

integer

$id

The id of the content item.

Renvoie:

FinderIndexerResult A FinderIndexerResult object.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $id, $item, $layout, $row, JLog\add(), JLog\INFO, et JArrayHelper\toObject().

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::getItemMenuTitle (   $url )

protected

Method to get the page title of any menu item that is linked to the content item, if it exists and is set.

Paramètres:

string

$url

The url of the item.

Renvoie:

mixed The title on success, null if not found.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $params, $return, $url, $user, JLog\add(), JFactory\getUser(), JLog\INFO, et null.

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::getItems (   $offset,   $limit,   $sql = null  )

protected

Method to get a list of content items to index.

Paramètres:

integer	$offset	The list offset.
integer	$limit	The list limit.
JDatabaseQuery	$sql	A JDatabaseQuery object. [optional]

Renvoie:

array An array of FinderIndexerResult objects.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $item, $layout, $limit, $mime, $row, JLog\add(), JLog\INFO, et JArrayHelper\toObject().

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::getListQuery (   $sql = null )

protected

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

Paramètres:

mixed

$sql

A JDatabaseQuery object. [optional]

Renvoie:

JDatabaseQuery A database object.

Depuis:

2.5

Réimplémentée dans plgFinderContacts, plgFinderCategories, plgFinderContent, plgFinderNewsfeeds, et plgFinderWeblinks.

Références JLog\add(), et JLog\INFO.

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::getPluginType (   $id )

protected

Method to get the plugin type

Paramètres:

integer

$id

The plugin ID

Renvoie:

string The plugin type

Depuis:

2.5

Références $id, $query, et $type.

FinderIndexerAdapter::getStateQuery ( )

protected

Method to get a SQL query to load the published and access states for an article and category.

Renvoie:

JDatabaseQuery A database object.

Depuis:

2.5

Réimplémentée dans plgFinderCategories.

FinderIndexerAdapter::getTypeId ( )

protected

Method to get the type id for the adapter content.

Renvoie:

integer The numeric type id for the content.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $query, JLog\add(), et JLog\INFO.

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::getUpdateQueryByIds (   $ids )

protected

Method to get the query clause for getting items to update by id.

Paramètres:

array

$ids

The ids to load.

Renvoie:

JDatabaseQuery A database object.

Depuis:

2.5

Références JLog\add(), et JLog\INFO.

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::getUpdateQueryByTime (   $time )

protected

Method to get the query clause for getting items to update by time.

Paramètres:

string

$time

The modified timestamp.

Renvoie:

JDatabaseQuery A database object.

Depuis:

2.5

Réimplémentée dans plgFinderWeblinks.

Références JLog\add(), et JLog\INFO.

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::getURL (   $id,   $extension,   $view  )

protected

Method to get the URL for the item. The URL is how we look up the link in the Finder index.

Paramètres:

integer	$id	The id of the item.
string	$extension	The extension the category is in.
string	$view	The view for the URL.

Renvoie:

string The URL of the item.

Depuis:

2.5

Références $extension, $id, et $view.

FinderIndexerAdapter::index ( FinderIndexerResult  $item )

abstractprotected

Method to index an item.

Paramètres:

FinderIndexerResult

$item

The item to index as a FinderIndexerResult object.

Renvoie:

boolean True on success.

Depuis:

2.5

Exceptions:

Exception

on database error.

FinderIndexerAdapter::itemAccessChange (   $row )

protected

Method to update index data on access level changes

Paramètres:

JTable

$row

A JTable object

Renvoie:

void

Depuis:

2.5

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

FinderIndexerAdapter::itemStateChange (   $pks,   $value  )

protected

Method to update index data on published state changes

Paramètres:

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 $item.

FinderIndexerAdapter::onBeforeIndex

(

)

Method to prepare for the indexer to be run. This method will often be used to include dependencies and things of that nature.

Renvoie:

boolean True on success.

Depuis:

2.5

Exceptions:

Exception

on error.

Références JLog\add(), FinderIndexer\getState(), et JLog\INFO.

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::onBuildIndex

(

)

Method to index a batch of content items. This method can be called by the indexer many times throughout the indexing process depending on how much content is available for indexing. It is important to track the progress correctly so we can display it to the user.

Renvoie:

boolean True on success.

Depuis:

2.5

Exceptions:

Exception

on error.

Références $i, $limit, $n, JLog\add(), FinderIndexer\getState(), JLog\INFO, et FinderIndexer\setState().

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::onStartIndex

(

)

Method to get the adapter state and push it into the indexer.

Renvoie:

boolean True on success.

Depuis:

2.5

Exceptions:

Exception

on error.

Références $total, JLog\add(), FinderIndexer\getState(), JLog\INFO, et FinderIndexer\setState().

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::pluginDisable (   $pks )

protected

Method to update index data when a plugin is disabled

Paramètres:

array

$pks

A list of primary key ids of the content that has changed state.

Renvoie:

void

Depuis:

2.5

Références $item.

FinderIndexerAdapter::reindex (   $id )

protected

Method to reindex an item.

Paramètres:

integer

$id

The ID of the item to reindex.

Renvoie:

boolean True on success.

Depuis:

2.5

Exceptions:

Exception

on database error.

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

FinderIndexerAdapter::remove (   $id )

protected

Method to remove an item from the index.

Paramètres:

string

$id

The ID of the item to remove.

Renvoie:

boolean True on success.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $id, $item, $query, $url, JLog\add(), JLog\INFO, et FinderIndexer\remove().

Voici le graphe d'appel pour cette fonction :

FinderIndexerAdapter::setup ( )

abstractprotected

Method to setup the adapter before indexing.

Renvoie:

boolean True on success, false on failure.

Depuis:

2.5

Exceptions:

Exception

on database error.

Réimplémentée dans plgFinderContacts, plgFinderCategories, plgFinderContent, plgFinderNewsfeeds, et plgFinderWeblinks.

FinderIndexerAdapter::translateState (   $item,   $category = null  )

protected

Method to translate the native content states into states that the indexer can use.

Paramètres:

integer	$item	The item state.
integer	$category	The category state. [optional]

Renvoie:

integer The translated indexer state.

Depuis:

2.5

Références $category, $item, et null.

---

Documentation des données membres

FinderIndexerAdapter::$context

protected

Réimplémentée dans plgFinderCategories, plgFinderContacts, plgFinderContent, plgFinderNewsfeeds, et plgFinderWeblinks.

FinderIndexerAdapter::$db

protected

FinderIndexerAdapter::$extension

protected

Réimplémentée dans plgFinderCategories, plgFinderContacts, plgFinderContent, plgFinderNewsfeeds, et plgFinderWeblinks.

FinderIndexerAdapter::$layout

protected

Réimplémentée dans plgFinderCategories, plgFinderContacts, plgFinderContent, plgFinderNewsfeeds, et plgFinderWeblinks.

FinderIndexerAdapter::$mime

protected

FinderIndexerAdapter::$old_access

protected

FinderIndexerAdapter::$old_cataccess

protected

FinderIndexerAdapter::$state_field = 'state'

protected

Réimplémentée dans plgFinderCategories, plgFinderContacts, et plgFinderNewsfeeds.

FinderIndexerAdapter::$table

protected

Réimplémentée dans plgFinderCategories, plgFinderContacts, plgFinderContent, plgFinderNewsfeeds, et plgFinderWeblinks.

FinderIndexerAdapter::$type_id

protected

FinderIndexerAdapter::$type_title

protected

Réimplémentée dans plgFinderCategories, plgFinderContacts, plgFinderContent, plgFinderNewsfeeds, et plgFinderWeblinks.

---

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

• administrator/components/com_finder/helpers/indexer/adapter.php