PHPXRef 0.7.1 : Joomla 2.5.4 DE : Detail view of index.php

(no description)

Copyright:	Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License:	GNU General Public License version 2 or later; see LICENSE
File Size:	464 lines (12 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

FinderModelIndex:: (11 methods):
  __construct()
  canDelete()
  canEditState()
  delete()
  getListQuery()
  getPluginState()
  getStoreId()
  getTable()
  purge()
  populateState()
  publish()

Class: FinderModelIndex - X-Ref

Index model class for Finder.

__construct($config = array() X-Ref

Constructor.

param: array $config An associative array of configuration settings. [optional]

canDelete($record) X-Ref

Method to test whether a record can be deleted.

param: object $record A record object.
return: boolean True if allowed to delete the record. Defaults to the permission for the component.

canEditState($record) X-Ref

Method to test whether a record can be deleted.

param: object $record A record object.
return: boolean True if allowed to change the state of the record. Defaults to the permission for the component.

delete(&$pks) X-Ref

Method to delete one or more records.

param: array &$pks An array of record primary keys.
return: boolean True if successful, false if an error occurs.

getListQuery() X-Ref

Build an SQL query to load the list data.

return: JDatabaseQuery A JDatabaseQuery object

getPluginState() X-Ref

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

return: array Array of relevant plug-ins and whether they are enabled or not.

getStoreId($id = '') X-Ref

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.

param: string $id A prefix for the store id. [optional]
return: string A store id.

getTable($type = 'Link', $prefix = 'FinderTable', $config = array() X-Ref

Returns a JTable object, always creating it.

param: string  $type    The table type to instantiate. [optional]
param: string  $prefix  A prefix for the table class name. [optional]
param: array   $config  Configuration array for model. [optional]
return: JTable  A database object

purge() X-Ref

Method to purge the index, deleting all links.

return: boolean True on success, false on failure.

populateState($ordering = null, $direction = null) X-Ref

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

param: string  $ordering   An optional ordering field. [optional]
param: string  $direction  An optional direction. [optional]
return: void

publish(&$pks, $value = 1) X-Ref

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

param: array    &$pks   A list of the primary keys to change.
param: integer  $value  The value of the published state. [optional]
return: boolean  True on success.

PHP Cross Reference of Joomla 2.5.4 DE

/administrator/components/com_finder/models/ -> index.php (summary)

Defines 1 class