Class FinderModelFilter

Description

Filter model class for Finder.

  • since: 2.5

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

JObject
   |
   --JModelLegacy
      |
      --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 35)

Model context string.

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

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 JModelLegacy

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

Inherited from JObject

JObject::$_errors
Methods
cleanCache (line 47)

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:
JModelLegacy::cleanCache()
Clean the cache
getFilter (line 59)

Method to get the filter data.

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

Method to get the record form.

  • return: A JForm object on success, false on failure
  • since: 2.5
  • 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 130)

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:
JModelLegacy::getTable()
Method to get a table object, load it if necessary.
loadFormData (line 142)

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

Inherited From JModelForm

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

Inherited From JModelLegacy

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

Inherited From JObject

 JObject::__construct()
 JObject::def()
 JObject::get()
 JObject::getError()
 JObject::getErrors()
 JObject::getProperties()
 JObject::set()
 JObject::setError()
 JObject::setProperties()
 JObject::__toString()

Documentation generated on Tue, 19 Nov 2013 15:03:15 +0100 by phpDocumentor 1.4.3