PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of contacts.php

(no description)

Copyright:	(C) 2011 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	431 lines (14 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

PlgFinderContacts:: (8 methods):
  onFinderCategoryChangeState()
  onFinderAfterDelete()
  onFinderAfterSave()
  onFinderBeforeSave()
  onFinderChangeState()
  index()
  setup()
  getListQuery()

Class: PlgFinderContacts - X-Ref

Finder adapter for Joomla Contacts.

onFinderCategoryChangeState($extension, $pks, $value) X-Ref

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: string   $extension  The extension whose category has been updated.
param: array    $pks        A list of primary key ids of the content that has changed state.
param: integer  $value      The value of the state that the content has been changed to.
return: void

onFinderAfterDelete($context, $table) X-Ref

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: string $context The context of the action being performed.
param: Table $table A Table object containing the record to be deleted
return: void

onFinderAfterSave($context, $row, $isNew) X-Ref

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

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

onFinderBeforeSave($context, $row, $isNew) X-Ref

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: string   $context  The context of the content passed to the plugin.
param: Table    $row      A Table object
param: boolean  $isNew    If the content is just about to be created
return: boolean  True on success.

onFinderChangeState($context, $pks, $value) X-Ref

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: string   $context  The context for the content passed to the plugin.
param: array    $pks      A list of primary key ids of the content that has changed state.
param: integer  $value    The value of the state that the content has been changed to.
return: void

index(Result $item) X-Ref

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

param: Result $item The item to index as a Result object.
return: void

setup() X-Ref

Method to setup the indexer to be run.

return: boolean True on success.

getListQuery($query = null) X-Ref

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

param: mixed $query A DatabaseQuery object or null.
return: DatabaseQuery A database object.

PHP Cross Reference of Joomla 4.2.2 documentation

/plugins/finder/contacts/ -> contacts.php (summary)

Defines 1 class