Class plgFinderNewsfeeds

Description

Finder adapter for Joomla Newsfeeds.

  • since: 2.5

Located in /plugins/finder/newsfeeds/newsfeeds.php (line 24)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --FinderIndexerAdapter
            |
            --plgFinderNewsfeeds
Variable Summary
string $context
string $extension
string $layout
string $state_field
string $table
string $type_title
Method Summary
plgFinderNewsfeeds __construct (object &$subject, array $config)
JDatabaseQuery getListQuery ([mixed $sql = 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
string $context = 'Newsfeeds' (line 32)

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_newsfeeds' (line 40)

The extension name.

  • since: 2.5
  • access: protected

Redefinition of:
FinderIndexerAdapter::$extension
The extension name.
string $layout = 'newsfeed' (line 48)

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 72)

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 = '#__newsfeeds' (line 64)

The table name.

  • since: 2.5
  • access: protected

Redefinition of:
FinderIndexerAdapter::$table
The table name.
string $type_title = 'News Feed' (line 56)

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::$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
Constructor __construct (line 82)

Constructor

  • since: 2.5
  • access: public
plgFinderNewsfeeds __construct (object &$subject, array $config)
  • object &$subject: The object to observe
  • array $config: An array that holds the plugin configuration

Redefinition of:
FinderIndexerAdapter::__construct()
Method to instantiate the indexer adapter.
getListQuery (line 337)

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 $sql = null])
  • mixed $sql: 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 258)

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 121)

Method to remove the link information for items that have been 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 151)

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 194)

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 101)

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 232)

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 319)

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()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:58:08 -0500 by phpDocumentor 1.4.4