Class FinderModelIndex

Description

Index model class for Finder.

  • since: 2.5

Located in /administrator/components/com_finder/models/index.php (line 21)

JObject
   |
   --JModel
      |
      --JModelList
         |
         --FinderModelIndex
Variable Summary
Method Summary
FinderModelIndex __construct ([array $config = array()])
boolean canDelete (object $record)
boolean canEditState (object $record)
boolean delete (array &$pks)
array getPluginState ()
string getStoreId ([string $id = ''])
JTable getTable ([string $type = 'Link'], [string $prefix = 'FinderTable'], [array $config = array()])
void populateState ([string $ordering = null], [string $direction = null])
boolean publish (array &$pks, [integer $value = 1])
boolean purge ()
Variables
string $event_after_delete = 'onContentAfterDelete' (line 29)

The event to trigger after deleting the data.

  • since: 2.5
  • access: protected
string $event_before_delete = 'onContentBeforeDelete' (line 37)

The event to trigger before deleting the data.

  • since: 2.5
  • access: protected

Inherited Variables

Inherited from JModelList

JModelList::$cache
JModelList::$context
JModelList::$filter_fields
JModelList::$query

Inherited from JModel

JModel::$event_clean_cache
JModel::$name
JModel::$option
JModel::$state
JModel::$_db
JModel::$__state_set

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 47)

Constructor.

FinderModelIndex __construct ([array $config = array()])
  • array $config: An associative array of configuration settings. [optional]

Redefinition of:
JModelList::__construct()
Constructor.
canDelete (line 72)

Method to test whether a record can be deleted.

  • return: True if allowed to delete the record. Defaults to the permission for the component.
  • since: 2.5
  • access: protected
boolean canDelete (object $record)
  • object $record: A record object.
canEditState (line 87)

Method to test whether a record can be deleted.

  • return: True if allowed to change the state of the record. Defaults to the permission for the component.
  • since: 2.5
  • access: protected
boolean canEditState (object $record)
  • object $record: A record object.
delete (line 102)

Method to delete one or more records.

  • return: True if successful, false if an error occurs.
  • since: 2.5
  • access: public
boolean delete (array &$pks)
  • array &$pks: An array of record primary keys.
getListQuery (line 175)

Build an SQL query to load the list data.

  • return: A JDatabaseQuery object
  • since: 2.5
  • access: protected
JDatabaseQuery getListQuery ()

Redefinition of:
JModelList::getListQuery()
Method to get a JDatabaseQuery object for retrieving the data set from a database.
getPluginState (line 222)

Method to get the state of the Smart Search plug-ins.

  • return: Array of relevant plug-ins and whether they are enabled or not.
  • since: 2.5
  • access: public
array getPluginState ()
getStoreId (line 252)

Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements.

  • return: A store id.
  • since: 2.5
  • access: protected
string getStoreId ([string $id = ''])
  • string $id: A prefix for the store id. [optional]

Redefinition of:
JModelList::getStoreId()
Method to get a store id based on the model configuration state.
getTable (line 273)

Returns a JTable object, always creating it.

  • return: A database object
  • since: 2.5
  • access: public
JTable getTable ([string $type = 'Link'], [string $prefix = 'FinderTable'], [array $config = array()])
  • string $type: The table type to instantiate. [optional]
  • string $prefix: A prefix for the table class name. [optional]
  • array $config: Configuration array for model. [optional]

Redefinition of:
JModel::getTable()
Method to get a table object, load it if necessary.
populateState (line 383)

Method to auto-populate the model state. Calling getState in this method will result in recursion.

  • since: 2.5
  • access: protected
void populateState ([string $ordering = null], [string $direction = null])
  • string $ordering: An optional ordering field. [optional]
  • string $direction: An optional direction. [optional]

Redefinition of:
JModelList::populateState()
Method to auto-populate the model state.
publish (line 413)

Method to change the published state of one or more records.

  • return: True on success.
  • since: 2.5
  • access: public
boolean publish (array &$pks, [integer $value = 1])
  • array &$pks: A list of the primary keys to change.
  • integer $value: The value of the published state. [optional]
purge (line 285)

Method to purge the index, deleting all links.

  • return: True on success, false on failure.
  • since: 2.5
  • access: public
boolean purge ()

Inherited Methods

Inherited From JModelList

JModelList::__construct()
JModelList::getItems()
JModelList::getListQuery()
JModelList::getPagination()
JModelList::getStart()
JModelList::getStoreId()
JModelList::getTotal()
JModelList::getUserStateFromRequest()
JModelList::populateState()
JModelList::_getListQuery()

Inherited From JModel

JModel::__construct()
JModel::addIncludePath()
JModel::addTablePath()
JModel::cleanCache()
JModel::getDbo()
JModel::getInstance()
JModel::getName()
JModel::getState()
JModel::getTable()
JModel::populateState()
JModel::setDbo()
JModel::setState()
JModel::_createFileName()
JModel::_createTable()
JModel::_getList()
JModel::_getListCount()

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:55:46 -0500 by phpDocumentor 1.4.4