Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe plgFinderCategories
+ Graphe d'héritage de plgFinderCategories:
+ Graphe de collaboration de plgFinderCategories:

Liste de tous les membres

Fonctions membres publiques

 __construct (&$subject, $config)
 onFinderDelete ($context, $table)
 onFinderAfterSave ($context, $row, $isNew)
 onFinderBeforeSave ($context, $row, $isNew)
 onFinderChangeState ($context, $pks, $value)
- Fonctions membres publiques inherited from FinderIndexerAdapter
 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

 index (FinderIndexerResult $item, $format= 'html')
 setup ()
 getListQuery ($sql=null)
 getStateQuery ()
- Fonctions membres protégées inherited from FinderIndexerAdapter
 change ($id, $property, $value)
 index (FinderIndexerResult $item)
 reindex ($id)
 remove ($id)
 categoryAccessChange ($row)
 categoryStateChange ($pks, $value)
 checkCategoryAccess ($row)
 checkItemAccess ($row)
 getContentCount ()
 getItem ($id)
 getItems ($offset, $limit, $sql=null)
 getPluginType ($id)
 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'
- Attributs protégés inherited from FinderIndexerAdapter
 $mime
 $old_access
 $old_cataccess
 $type_id
 $db
- 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()

Documentation des constructeurs et destructeur

plgFinderCategories::__construct ( $subject,
  $config 
)

Constructor

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

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

Références $config.


Documentation des fonctions membres

plgFinderCategories::getListQuery (   $sql = null)
protected

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

Paramètres:
mixed$sqlA JDatabaseQuery object or null.
Renvoie:
JDatabaseQuery A database object.
Depuis:
2.5

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

Références $db, et JFactory\getDbo().

+ Voici le graphe d'appel pour cette fonction :

plgFinderCategories::getStateQuery ( )
protected

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

Renvoie:
JDatabaseQuery A database object.
Depuis:
2.5

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

plgFinderCategories::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 an FinderIndexerResult object.
string$formatThe item format
Renvoie:
void
Depuis:
2.5
Exceptions:
Exceptionon database error.

Références $class, $extension, $title, FinderIndexerResult\addInstruction(), FinderIndexerResult\addTaxonomy(), JFile\exists(), ContentHelperRoute\getCategoryRoute(), FinderIndexerHelper\getContentExtras(), FinderIndexerHelper\getContentPath(), FinderIndexer\index(), JComponentHelper\isEnabled(), JPATH_SITE, JRegistry\loadString(), FinderIndexer\META_CONTEXT, et FinderIndexerHelper\prepareContent().

+ Voici le graphe d'appel pour cette fonction :

plgFinderCategories::onFinderAfterSave (   $context,
  $row,
  $isNew 
)

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

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

Références $row.

plgFinderCategories::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$contextThe context of the content passed to the plugin.
JTable$rowA JTable object
boolean$isNewIf the content is just about to be created
Renvoie:
boolean True on success.
Depuis:
2.5
Exceptions:
Exceptionon database error.

Références $row.

plgFinderCategories::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 content passed to the plugin.
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.

plgFinderCategories::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 $id, et elseif.

plgFinderCategories::setup ( )
protected

Method to setup the indexer to be run.

Renvoie:
boolean True on success.
Depuis:
2.5

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

Références JPATH_SITE.


Documentation des données membres

plgFinderCategories::$context = 'Categories'
protected

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

plgFinderCategories::$extension = 'com_categories'
protected

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

plgFinderCategories::$layout = 'category'
protected

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

plgFinderCategories::$state_field = 'published'
protected

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

plgFinderCategories::$table = '#__categories'
protected

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

plgFinderCategories::$type_title = 'Category'
protected

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


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