Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe FinderIndexerAdapter
+ Graphe d'héritage de FinderIndexerAdapter:

Fonctions membres publiques

 __construct (&$subject, $config)
 
 onStartIndex ()
 
 onBeforeIndex ()
 
 onBuildIndex ()
 

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, $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
 
 $extension
 
 $layout
 
 $mime
 
 $old_access
 
 $old_cataccess
 
 $type_title
 
 $type_id
 
 $db
 
 $table
 
 $indexer
 
 $state_field = 'state'
 

Description détaillée

Prototype adapter class for the Finder indexer package.

Depuis
2.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( $subject,
  $config 
)

Method to instantiate the indexer adapter.

Paramètres
object&$subjectThe object to observe.
array$configAn array that holds the plugin configuration.
Depuis
2.5

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

Documentation des fonctions membres

◆ categoryAccessChange()

categoryAccessChange (   $row)
protected

Method to update index data on category access level changes

Paramètres
JTable$rowA JTable object
Renvoie
void
Depuis
2.5

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

◆ categoryStateChange()

categoryStateChange (   $pks,
  $value 
)
protected

Method to update index data on category access level changes

Paramètres
array$pksA list of primary key ids of the content that has changed state.
integer$valueThe value of the state that the content has been changed to.
Renvoie
void
Depuis
2.5

Références $item, $items, $query, et $value.

◆ change()

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$idThe ID of the item to change.
string$propertyThe property that is being changed.
integer$valueThe new value of that property.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

Références $id, $item, $query, $value, et extension.

◆ checkCategoryAccess()

checkCategoryAccess (   $row)
protected

Method to check the existing access level for categories

Paramètres
JTable$rowA JTable object
Renvoie
void
Depuis
2.5

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

◆ checkItemAccess()

checkItemAccess (   $row)
protected

Method to check the existing access level for items

Paramètres
JTable$rowA JTable object
Renvoie
void
Depuis
2.5

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

◆ getContentCount()

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
Exceptionon database error.

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

◆ getItem()

getItem (   $id)
protected

Method to get a content item to index.

Paramètres
integer$idThe id of the content item.
Renvoie
FinderIndexerResult A FinderIndexerResult object.
Depuis
2.5
Exceptions
Exceptionon database error.

Références $id, $item, $layout, $query, $row, et ArrayHelper\toObject().

◆ getItemMenuTitle()

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$urlThe URL of the item.
Renvoie
mixed The title on success, null if not found.
Depuis
2.5
Exceptions
Exceptionon database error.

Références $groups, $params, $query, $return, $url, $user, et null.

◆ getItems()

getItems (   $offset,
  $limit,
  $query = null 
)
protected

Method to get a list of content items to index.

Paramètres
integer$offsetThe list offset.
integer$limitThe list limit.
JDatabaseQuery$queryA JDatabaseQuery object. [optional]
Renvoie
array An array of FinderIndexerResult objects.
Depuis
2.5
Exceptions
Exceptionon database error.

Références $item, $items, $layout, $limit, $mime, $offset, $query, $row, $rows, et ArrayHelper\toObject().

◆ getListQuery()

getListQuery (   $query = null)
protected

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

Paramètres
mixed$queryA JDatabaseQuery object. [optional]
Renvoie
JDatabaseQuery A database object.
Depuis
2.5

Références $query.

◆ getPluginType()

getPluginType (   $id)
protected

Method to get the plugin type

Paramètres
integer$idThe plugin ID
Renvoie
string The plugin type
Depuis
2.5

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

◆ getStateQuery()

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éférences $query.

◆ getTypeId()

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
Exceptionon database error.

Références $query.

◆ getUpdateQueryByIds()

getUpdateQueryByIds (   $ids)
protected

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

Paramètres
array$idsThe ids to load.
Renvoie
JDatabaseQuery A database object.
Depuis
2.5

Références $query.

◆ getUpdateQueryByTime()

getUpdateQueryByTime (   $time)
protected

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

Paramètres
string$timeThe modified timestamp.
Renvoie
JDatabaseQuery A database object.
Depuis
2.5

Références $query.

◆ getUrl()

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$idThe id of the item.
string$extensionThe extension the category is in.
string$viewThe view for the URL.
Renvoie
string The URL of the item.
Depuis
2.5

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

◆ index()

index ( FinderIndexerResult  $item)
abstractprotected

Method to index an item.

Paramètres
FinderIndexerResult$itemThe item to index as a FinderIndexerResult object.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

◆ itemAccessChange()

itemAccessChange (   $row)
protected

Method to update index data on access level changes

Paramètres
JTable$rowA JTable object
Renvoie
void
Depuis
2.5

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

◆ itemStateChange()

itemStateChange (   $pks,
  $value 
)
protected

Method to update index data on published state changes

Paramètres
array$pksA list of primary key ids of the content that has changed state.
integer$valueThe value of the state that the content has been changed to.
Renvoie
void
Depuis
2.5

Références $item, $query, et $value.

◆ onBeforeIndex()

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
Exceptionon error.

Références $context, et FinderIndexer\getState().

◆ onBuildIndex()

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
Exceptionon error.

Références $context, $i, $items, $limit, $n, $offset, FinderIndexer\getState(), et FinderIndexer\setState().

◆ onStartIndex()

onStartIndex ( )

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

Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon error.

Références $context, $total, FinderIndexer\getState(), et FinderIndexer\setState().

◆ pluginDisable()

pluginDisable (   $pks)
protected

Method to update index data when a plugin is disabled

Paramètres
array$pksA list of primary key ids of the content that has changed state.
Renvoie
void
Depuis
2.5

Références $item, $items, et $query.

◆ reindex()

reindex (   $id)
protected

Method to reindex an item.

Paramètres
integer$idThe ID of the item to reindex.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

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

◆ remove()

remove (   $id)
protected

Method to remove an item from the index.

Paramètres
string$idThe ID of the item to remove.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

Références $id, $item, $items, $query, $url, et extension.

◆ setup()

setup ( )
abstractprotected

Method to setup the adapter before indexing.

Renvoie
boolean True on success, false on failure.
Depuis
2.5
Exceptions
Exceptionon database error.

◆ translateState()

translateState (   $item,
  $category = null 
)
protected

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

Paramètres
integer$itemThe item state.
integer$categoryThe category state. [optional]
Renvoie
integer The translated indexer state.
Depuis
2.5

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

Documentation des champs

◆ $context

$context
protected

◆ $db

$db
protected

◆ $extension

$extension
protected

◆ $indexer

$indexer
protected

◆ $layout

$layout
protected

◆ $mime

$mime
protected

◆ $old_access

$old_access
protected

◆ $old_cataccess

$old_cataccess
protected

◆ $state_field

$state_field = 'state'
protected

◆ $table

$table
protected

◆ $type_id

$type_id
protected

◆ $type_title

$type_title
protected

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