Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
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 Adapter
 __construct (&$subject, $config)
 
 onStartIndex ()
 
 onBeforeIndex ()
 
 onBuildIndex ()
 
 onFinderGarbageCollection ()
 
- Fonctions membres publiques hérités de CMSPlugin
 __construct (&$subject, $config=array())
 
 loadLanguage ($extension='', $basePath=JPATH_ADMINISTRATOR)
 
 setApplication (CMSApplicationInterface $application)
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 
- Fonctions membres publiques hérités de PluginInterface
 registerListeners ()
 

Fonctions membres protégées

 index (Result $item)
 
 setup ()
 
 getListQuery ($query=null)
 
- Fonctions membres protégées hérités de Adapter
 change ($id, $property, $value)
 
 index (Result $item)
 
 reindex ($id)
 
 remove ($id, $removeTaxonomies=true)
 
 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)
 
- Fonctions membres protégées hérités de CMSPlugin
 registerLegacyListener (string $methodName)
 
 registerListener (string $methodName)
 
 getApplication ()
 

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 Adapter
 $context
 
 $extension
 
 $layout
 
 $mime
 
 $old_access
 
 $old_cataccess
 
 $type_title
 
 $type_id
 
 $db
 
 $table
 
 $indexer
 
 $state_field = 'state'
 
- Attributs protégés hérités de CMSPlugin
 $_name = null
 
 $_type = null
 
 $autoloadLanguage = false
 
 $allowLegacyListeners = true
 

Membres hérités additionnels

- Champs de données hérités de CMSPlugin
 $params = null
 

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

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

◆ index()

index ( Result  $item)
protected

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

Paramètres
Result$itemThe item to index as a Result object.
Renvoie
void
Depuis
2.5
Exceptions
Exceptionon database error.

Références $category, $item, $this, $title, extension, Categories\getInstance(), ComponentHelper\isEnabled(), et Result\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$contextThe context of the action being performed.
Table$tableA Table object containing the record to be deleted
Renvoie
void
Depuis
2.5
Exceptions
Exceptionon 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$contextThe context of the content passed to the plugin.
Table$rowA Table object
boolean$isNewIf the content has just been created
Renvoie
void
Depuis
2.5
Exceptions
Exceptionon database error.

Références $context.

◆ 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$contextThe context of the content passed to the plugin.
Table$rowA Table 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 $context.

◆ 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$extensionThe extension whose category has been updated.
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 $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$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 $context, et $value.

◆ setup()

setup ( )
protected

Method to setup the indexer to be run.

Renvoie
boolean True on success.
Depuis
2.5

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 :