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 PlgFinderCategories
+ Graphe d'héritage de PlgFinderCategories:

Fonctions membres publiques

 onFinderDelete ($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)
 
 getStateQuery ()
 
- 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 = 'Categories'
 
 $extension = 'com_categories'
 
 $layout = 'category'
 
 $type_title = 'Category'
 
 $table = '#__categories'
 
 $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

Smart Search adapter for Joomla Categories.

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$queryA JDatabaseQuery object or null.
Renvoie
JDatabaseQuery A database object.
Depuis
2.5

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

◆ getStateQuery()

getStateQuery ( )
protected

Method to get a SQL query to load the published and access states for a category and its parents.

Renvoie
JDatabaseQuery A database object.
Depuis
2.5

Références $query.

◆ index()

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

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

Paramètres
FinderIndexerResult$itemThe item to index as a FinderIndexerResult object.
string$formatThe item format. Not used.
Renvoie
void
Depuis
2.5
Exceptions
Exceptionon database error.

Références $class, $extension, $item, $title, extension, ContentHelperRoute\getCategoryRoute(), FinderIndexerHelper\getContentExtras(), FinderIndexerHelper\getContentPath(), JPATH_SITE, FinderIndexer\META_CONTEXT, FinderIndexerHelper\prepareContent(), et JLoader\register().

◆ onFinderAfterSave()

onFinderAfterSave (   $context,
  $row,
  $isNew 
)

Smart Search after save content method. Reindexes the link information for a category that has been saved. It also makes adjustments if the access level of the category has changed.

Paramètres
string$contextThe context of the category passed to the plugin.
JTable$rowA JTable object.
boolean$isNewTrue if the category has just been created.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

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

◆ onFinderBeforeSave()

onFinderBeforeSave (   $context,
  $row,
  $isNew 
)

Smart Search before content save method. This event is fired before the data is actually saved.

Paramètres
string$contextThe context of the category passed to the plugin.
JTable$rowA JTable object.
boolean$isNewTrue if the category is just about to be created.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

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

◆ 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$contextThe context for the category passed to the plugin.
array$pksAn array of primary key ids of the category that has changed state.
integer$valueThe value of the state that the category has been changed to.
Renvoie
void
Depuis
2.5

Références $context, $item, $query, $state, $value, et null.

◆ onFinderDelete()

onFinderDelete (   $context,
  $table 
)

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

Paramètres
string$contextThe context of the action being performed.
JTable$tableA JTable object containing the record to be deleted
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

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

◆ setup()

setup ( )
protected

Method to setup the indexer to be run.

Renvoie
boolean True on success.
Depuis
2.5

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

Documentation des champs

◆ $autoloadLanguage

$autoloadLanguage = true
protected

◆ $context

$context = 'Categories'
protected

◆ $extension

$extension = 'com_categories'
protected

◆ $layout

$layout = 'category'
protected

◆ $state_field

$state_field = 'published'
protected

◆ $table

$table = '#__categories'
protected

◆ $type_title

$type_title = 'Category'
protected

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