Class FinderModelFilter

Description

Filter model class for Finder.

  • since: 2.5

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

JObject
   |
   --JModel
      |
      --JModelForm
         |
         --JModelAdmin
            |
            --FinderModelFilter
Variable Summary
string $context
string $text_prefix
Method Summary
void cleanCache ([string $group = 'com_finder'], [integer $client_id = 1])
mixed getFilter ()
mixed getForm ([array $data = array()], [boolean $loadData = true])
JTable getTable ([string $type = 'Filter'], [string $prefix = 'FinderTable'], [array $config = array()])
mixed loadFormData ()
Variables
string $context = 'com_finder.filter' (line 37)

Model context string.

  • since: 2.5
  • access: protected
string $text_prefix = 'COM_FINDER' (line 29)

The prefix to use with controller messages.

  • since: 2.5
  • access: protected

Redefinition of:
JModelAdmin::$text_prefix
The prefix to use with controller messages.

Inherited Variables

Inherited from JModelAdmin

JModelAdmin::$event_after_delete
JModelAdmin::$event_after_save
JModelAdmin::$event_before_delete
JModelAdmin::$event_before_save
JModelAdmin::$event_change_state

Inherited from JModelForm

JModelForm::$_forms

Inherited from JModel

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

Inherited from JObject

JObject::$_errors
Methods
cleanCache (line 49)

Custom clean cache method.

  • since: 2.5
  • access: protected
void cleanCache ([string $group = 'com_finder'], [integer $client_id = 1])
  • string $group: The component name. [optional]
  • integer $client_id: The client ID. [optional]

Redefinition of:
JModel::cleanCache()
Clean the cache
getFilter (line 61)

Method to get the filter data.

  • return: The filter data.
  • since: 2.5
  • access: public
mixed getFilter ()
getForm (line 108)

Method to get the record form.

  • return: A JForm object on success, false on failure
  • since: 1.6
  • access: public
mixed getForm ([array $data = array()], [boolean $loadData = true])
  • array $data: Data for the form. [optional]
  • boolean $loadData: True if the form is to load its own data (default case), false if not. [optional]

Redefinition of:
JModelForm::getForm()
Abstract method for getting the form from the model.
getTable (line 132)

Returns a JTable object, always creating it.

  • return: A database object
  • since: 2.5
  • access: public
JTable getTable ([string $type = 'Filter'], [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.
loadFormData (line 144)

Method to get the data that should be injected in the form.

  • return: The data for the form.
  • since: 2.5
  • access: protected
mixed loadFormData ()

Redefinition of:
JModelForm::loadFormData()
Method to get the data that should be injected in the form.

Inherited Methods

Inherited From JModelAdmin

JModelAdmin::__construct()
JModelAdmin::batch()
JModelAdmin::batchAccess()
JModelAdmin::batchCopy()
JModelAdmin::batchLanguage()
JModelAdmin::batchMove()
JModelAdmin::canDelete()
JModelAdmin::canEditState()
JModelAdmin::checkin()
JModelAdmin::checkout()
JModelAdmin::delete()
JModelAdmin::generateNewTitle()
JModelAdmin::getItem()
JModelAdmin::getReorderConditions()
JModelAdmin::populateState()
JModelAdmin::prepareTable()
JModelAdmin::publish()
JModelAdmin::reorder()
JModelAdmin::save()
JModelAdmin::saveorder()

Inherited From JModelForm

JModelForm::checkin()
JModelForm::checkout()
JModelForm::getForm()
JModelForm::loadForm()
JModelForm::loadFormData()
JModelForm::preprocessForm()
JModelForm::validate()

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:54:48 -0500 by phpDocumentor 1.4.4