\FinderModelFilter

Filter model class for Finder.

Synopsis

class FinderModelFilter extends JModelAdmin {

• // members
• protected  $text_prefix;
• protected  $context;
• // Inherited members from JModelAdmin
• protected  $text_prefix;
• protected  $event_after_delete;
• protected  $event_after_save;
• protected  $event_before_delete;
• protected  $event_before_save;
• protected  $event_change_state;
• // Inherited members from JModelForm
• protected  $_forms;
• // Inherited members from JModelLegacy
• protected  $__state_set;
• protected   $_db;
• protected  $name;
• protected  $option;
• protected  $state;
• protected  $event_clean_cache;
• // Inherited members from JObject
• protected  $_errors;
• // methods
• protected void cleanCache()
• public mixed getFilter()
• public mixed getForm()
• public JTable getTable()
• protected mixed loadFormData()
• // Inherited methods from JModelAdmin
• public void __construct()
• public boolean batch()
• protected boolean batchAccess()
• protected mixed batchCopy()
• protected boolean batchLanguage()
• protected boolean batchMove()
• protected void. batchTag()
• protected boolean canDelete()
• protected boolean canEditState()
• public mixed checkin()
• public boolean checkout()
• public boolean delete()
• protected array generateNewTitle()
• public mixed getItem()
• protected array getReorderConditions()
• protected void populateState()
• protected void prepareTable()
• public boolean publish()
• public mixed reorder()
• public boolean save()
• public mixed saveorder()
• public void createTagsHelper()
• protected boolean checkCategoryId()
• public void generateTitle()
• // Inherited methods from JModelForm
• public boolean checkin()
• public boolean checkout()
• public abstract mixed getForm()
• protected mixed loadForm()
• protected array loadFormData()
• protected void preprocessData()
• protected void preprocessForm()
• public mixed validate()
• // Inherited methods from JModelLegacy
• public static array addIncludePath()
• public static void addTablePath()
• protected static string _createFileName()
• public static mixed getInstance()
• public void __construct()
• protected array _getList()
• protected integer _getListCount()
• protected mixed _createTable()
• public JDatabaseDriver getDbo()
• public string getName()
• public  getState()
• public JTable getTable()
• public boolean loadHistory()
• protected void populateState()
• public void setDbo()
• public mixed setState()
• protected void cleanCache()
• // Inherited methods from JObject
• public void __construct()
• public string __toString()
• public mixed def()
• public mixed get()
• public array getProperties()
• public string getError()
• public array getErrors()
• public mixed set()
• public boolean setProperties()
• public void setError()
}


Hierarchy

Extends

• JModelAdmin

Tasks

Tasks

Line	Task
382	Deal with ordering?

Members

protected

• $__state_set — boolean
  Indicates if the internal state has been set
• $_db —
  Database Connector
• $_errors — array
  An array of error messages or Exception objects.
• $_forms — array
  Array of form objects.
• $context — string
  Model context string.
• $event_after_delete — string
  The event to trigger after deleting the data.
• $event_after_save — string
  The event to trigger after saving the data.
• $event_before_delete — string
  The event to trigger before deleting the data.
• $event_before_save — string
  The event to trigger before saving the data.
• $event_change_state — string
  The event to trigger after changing the published state of the data.
• $event_clean_cache — string
  The event to trigger when cleaning cache.
• $name — string
  The model (base) name
• $option — string
  The URL option for the component.
• $state — string
  A state object
• $text_prefix — string
  The prefix to use with controller messages.
• $text_prefix — string
  The prefix to use with controller messages.

Methods

protected

• cleanCache() — Custom clean cache method.
• loadFormData() — Method to get the data that should be injected in the form.

public

• getFilter() — Method to get the filter data.
• getForm() — Method to get the record form.
• getTable() — Returns a JTable object, always creating it.

Inherited from JModelAdmin

protected

• batchAccess() — Batch access level changes for a group of rows.
• batchCopy() — Batch copy items to a new category or current.
• batchLanguage() — Batch language changes for a group of rows.
• batchMove() — Batch move items to a new category
• batchTag() — Batch tag a list of item.
• canDelete() — Method to test whether a record can be deleted.
• canEditState() — Method to test whether a record can be deleted.
• checkCategoryId() — Method to check the validity of the category ID for batch copy and move
• generateNewTitle() — Method to change the title & alias.
• getReorderConditions() — A protected method to get a set of ordering conditions.
• populateState() — Stock method to auto-populate the model state.
• prepareTable() — Prepare and sanitise the table data prior to saving.

public

• batch() — Method to perform batch operations on an item or a set of items.
• checkin() — Method override to check-in a record or an array of record
• checkout() — Method override to check-out a record.
• createTagsHelper() — Method to create a tags helper to ensure proper management of tags
• delete() — Method to delete one or more records.
• generateTitle() — A method to preprocess generating a new title in order to allow tables with alternative names for alias and title to use the batch move and copy methods
• getItem() — Method to get a single record.
• publish() — Method to change the published state of one or more records.
• reorder() — Method to adjust the ordering of a row.
• save() — Method to save the form data.
• saveorder() — Saves the manually set order of records.

Inherited from JModelForm

protected

• loadForm() — Method to get a form object.
• loadFormData() — Method to get the data that should be injected in the form.
• preprocessData() — Method to allow derived classes to preprocess the data.
• preprocessForm() — Method to allow derived classes to preprocess the form.

public

• checkin() — Method to checkin a row.
• checkout() — Method to check-out a row for editing.
• getForm() — Abstract method for getting the form from the model.
• validate() — Method to validate the form data.

Inherited from JModelLegacy

protected

• _createFileName() — Create the filename for a resource
• _createTable() — Method to load and return a model object.
• _getList() — Gets an array of objects from the results of database query.
• _getListCount() — Returns a record count for the query.
• cleanCache() — Clean the cache
• populateState() — Method to auto-populate the model state.

public

• addIncludePath() — Add a directory where JModelLegacy should search for models. You may either pass a string or an array of directories.
• addTablePath() — Adds to the stack of model table paths in LIFO order.
• getDbo() — Method to get the database driver object
• getInstance() — Returns a Model object, always creating it
• getName() — Method to get the model name
• getState() — Method to get model state variables
• getTable() — Method to get a table object, load it if necessary.
• loadHistory() — Method to load a row for editing from the version history table.
• setDbo() — Method to set the database driver object
• setState() — Method to set model state variables

Inherited from JObject

public

• __toString() — Magic method to convert the object to a string gracefully.
• def() — Sets a default value if not alreay assigned
• get() — Returns a property of the object or the default value if the property is not set.
• getError() — Get the most recent error message.
• getErrors() — Return all errors, if any.
• getProperties() — Returns an associative array of object properties.
• set() — Modifies a property of the object, creating it if it does not already exist.
• setError() — Add an error message.
• setProperties() — Set the object properties based on a named array/hash.