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

(no description)

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

Defines 1 class

PlgFinderCategories:: (8 methods):
  setup()
  onFinderDelete()
  onFinderAfterSave()
  onFinderBeforeSave()
  onFinderChangeState()
  index()
  getListQuery()
  getStateQuery()

Class: PlgFinderCategories - X-Ref

Smart Search adapter for Joomla Categories.

setup() X-Ref

Method to setup the indexer to be run.

return: boolean True on success.

onFinderDelete($context, $table) X-Ref

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

param: string  $context  The context of the action being performed.
param: Table   $table    A Table object containing the record to be deleted
return: boolean  True on success.

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

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: string   $context  The context of the category passed to the plugin.
param: Table    $row      A Table object.
param: boolean  $isNew    True if the category has just been created.
return: void

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

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

param: string   $context  The context of the category passed to the plugin.
param: Table    $row      A Table object.
param: boolean  $isNew    True if the category 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 category passed to the plugin.
param: array    $pks      An array of primary key ids of the category that has changed state.
param: integer  $value    The value of the state that the category 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

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.

getStateQuery() X-Ref

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

return: DatabaseQuery A database object.

PHP Cross Reference of Joomla 4.2.2 documentation

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

Defines 1 class