Docs For Class PlgFinderContacts

Description

Finder adapter for Joomla Contacts.

since: 2.5

Located in /plugins/finder/contacts/contacts.php (line 21)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --FinderIndexerAdapter
            |
            --PlgFinderContacts

Variable Summary

boolean $autoloadLanguage

string $context

string $extension

string $layout

string $state_field

string $table

string $type_title

Method Summary

JDatabaseQuery getListQuery ([mixed $query = null])

void index (FinderIndexerResult $item, [string $format = 'html'])

boolean onFinderAfterDelete (string $context, JTable $table)

boolean onFinderAfterSave (string $context, JTable $row, boolean $isNew)

boolean onFinderBeforeSave (string $context, JTable $row, boolean $isNew)

void onFinderCategoryChangeState (string $extension, array $pks, integer $value)

void onFinderChangeState (string $context, array $pks, integer $value)

boolean setup ()

Variables

boolean $autoloadLanguage = true (line 77)

Load the language file on instantiation.

since: 3.1
access: protected

Redefinition of:

JPlugin::$autoloadLanguage: Affects constructor behavior. If true, language files will be loaded automatically.

string $context = 'Contacts' (line 29)

The plugin identifier.

since: 2.5
access: protected

Redefinition of:

FinderIndexerAdapter::$context: The context is somewhat arbitrary but it must be unique or there will be conflicts when managing plugin/indexer state. A good best practice is to use the plugin name suffix as the context. For example, if the plugin is named 'plgFinderContent', the context could be 'Content'.

string $extension = 'com_contact' (line 37)

The extension name.

since: 2.5
access: protected

Redefinition of:

FinderIndexerAdapter::$extension: The extension name.

string $layout = 'contact' (line 45)

The sublayout to use when rendering the results.

since: 2.5
access: protected

Redefinition of:

FinderIndexerAdapter::$layout: The sublayout to use when rendering the results.

string $state_field = 'published' (line 69)

The field the published state is stored in.

since: 2.5
access: protected

Redefinition of:

FinderIndexerAdapter::$state_field: The field the published state is stored in.

string $table = '#__contact_details' (line 61)

The table name.

since: 2.5
access: protected

Redefinition of:

FinderIndexerAdapter::$table: The table name.

string $type_title = 'Contact' (line 53)

The type of content that the adapter indexes.

since: 2.5
access: protected

Redefinition of:

FinderIndexerAdapter::$type_title: The type of content the adapter indexes.

Inherited Variables

Inherited from FinderIndexerAdapter

FinderIndexerAdapter::$db
FinderIndexerAdapter::$indexer
FinderIndexerAdapter::$mime
FinderIndexerAdapter::$old_access
FinderIndexerAdapter::$old_cataccess
FinderIndexerAdapter::$type_id

Inherited from JPlugin

JPlugin::$params
JPlugin::$_name
JPlugin::$_type

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors

Methods

getListQuery (line 408)

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

return: A database object.
since: 2.5
access: protected

JDatabaseQuery getListQuery ([mixed $query = null])

mixed $query: A JDatabaseQuery object or null.

Redefinition of:

FinderIndexerAdapter::getListQuery(): Method to get the SQL query used to retrieve the list of content items.

index (line 251)

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

since: 2.5
throws: Exception on database error.
access: protected

void index (FinderIndexerResult $item, [string $format = 'html'])

FinderIndexerResult $item: The item to index as an FinderIndexerResult object.
string $format: The item format

Redefinition of:

FinderIndexerAdapter::index(): Method to index an item.

onFinderAfterDelete (line 114)

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.

return: True on success.
since: 2.5
throws: Exception on database error.
access: public

boolean onFinderAfterDelete (string $context, JTable $table)

string $context: The context of the action being performed.
JTable $table: A JTable object containing the record to be deleted

onFinderAfterSave (line 144)

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

return: True on success.
since: 2.5
throws: Exception on database error.
access: public

boolean onFinderAfterSave (string $context, JTable $row, boolean $isNew)

string $context: The context of the content passed to the plugin.
JTable $row: A JTable object
boolean $isNew: If the content has just been created

onFinderBeforeSave (line 187)

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.

return: True on success.
since: 2.5
throws: Exception on database error.
access: public

boolean onFinderBeforeSave (string $context, JTable $row, boolean $isNew)

string $context: The context of the content passed to the plugin.
JTable $row: A JTable object
boolean $isNew: If the content is just about to be created

onFinderCategoryChangeState (line 92)

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.

since: 2.5
access: public

void onFinderCategoryChangeState (string $extension, array $pks, integer $value)

string $extension: The extension whose category has been updated.
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.

onFinderChangeState (line 225)

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.

since: 2.5
access: public

void onFinderChangeState (string $context, array $pks, integer $value)

string $context: The context for the content passed to the plugin.
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.

setup (line 388)

Method to setup the indexer to be run.

return: True on success.
since: 2.5
access: protected

boolean setup ()

Redefinition of:

FinderIndexerAdapter::setup(): Method to setup the adapter before indexing.

Inherited Methods

Inherited From FinderIndexerAdapter

FinderIndexerAdapter::__construct()
FinderIndexerAdapter::categoryAccessChange()
FinderIndexerAdapter::categoryStateChange()
FinderIndexerAdapter::change()
FinderIndexerAdapter::checkCategoryAccess()
FinderIndexerAdapter::checkItemAccess()
FinderIndexerAdapter::getContentCount()
FinderIndexerAdapter::getItem()
FinderIndexerAdapter::getItemMenuTitle()
FinderIndexerAdapter::getItems()
FinderIndexerAdapter::getListQuery()
FinderIndexerAdapter::getPluginType()
FinderIndexerAdapter::getStateQuery()
FinderIndexerAdapter::getTypeId()
FinderIndexerAdapter::getUpdateQueryByIds()
FinderIndexerAdapter::getUpdateQueryByTime()
FinderIndexerAdapter::getURL()
FinderIndexerAdapter::index()
FinderIndexerAdapter::itemAccessChange()
FinderIndexerAdapter::itemStateChange()
FinderIndexerAdapter::onBeforeIndex()
FinderIndexerAdapter::onBuildIndex()
FinderIndexerAdapter::onStartIndex()
FinderIndexerAdapter::pluginDisable()
FinderIndexerAdapter::reindex()
FinderIndexerAdapter::remove()
FinderIndexerAdapter::setup()
FinderIndexerAdapter::translateState()

Inherited From JPlugin

JPlugin::__construct()
JPlugin::loadLanguage()

Inherited From JEvent

JEvent::__construct()
JEvent::update()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()