\CacheModelCache

Cache Model

Synopsis

class CacheModelCache extends JModelList {

• // members
• protected Array  $_data;
• protected  $_total;
• protected   $_pagination;
• // Inherited members from JModelList
• protected  $cache;
• protected  $context;
• protected  $filter_fields;
• protected JDatabaseQuery  $query;
• protected  $filterFormName;
• protected  $htmlFormName;
• // 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 populateState()
• public array getData()
• public  getCache()
• public array getClient()
• public int getTotal()
• public integer getPagination()
• public void clean()
• public void cleanlist()
• public void purge()
• // Inherited methods from JModelList
• public void __construct()
• protected JDatabaseQuery _getListQuery()
• public array getActiveFilters()
• public mixed getItems()
• protected JDatabaseQuery getListQuery()
• public JPagination getPagination()
• protected string getStoreId()
• public integer getTotal()
• public integer getStart()
• public JForm/false getFilterForm()
• protected mixed loadForm()
• protected mixed loadFormData()
• protected void populateState()
• protected void preprocessForm()
• public The getUserStateFromRequest()
• // 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

• JModelList

Members

protected

• $__state_set — boolean
  Indicates if the internal state has been set
• $_data — Array
  An Array of CacheItems indexed by cache group ID
• $_db —
  Database Connector
• $_errors — array
  An array of error messages or Exception objects.
• $_pagination —
  Pagination object
• $_total — integer
  Group total
• $cache — array
  Internal memory based cache array of data.
• $context — string
  Context string for the model type. This is used to handle uniqueness when dealing with the getStoreId() method and caching data structures.
• $event_clean_cache — string
  The event to trigger when cleaning cache.
• $filterFormName — string
  Name of the filter form to load
• $filter_fields — array
  Valid filter fields or ordering.
• $htmlFormName — string
  Associated HTML form
• $name — string
  The model (base) name
• $option — string
  The URL option for the component.
• $query — JDatabaseQuery
  An internal cache for the last query used.
• $state — string
  A state object

Methods

protected

• populateState() — Method to auto-populate the model state.

public

• clean() — Clean out a cache group as named by param.
• cleanlist()
• getCache() — Method to get cache instance
• getClient() — Method to get client data
• getData() — Method to get cache data
• getPagination() — Method to get a pagination object for the cache
• getTotal() — Get the number of current Cache Groups
• purge()

Inherited from JModelList

protected

• _getListQuery() — Method to cache the last query constructed.
• getListQuery() — Method to get a JDatabaseQuery object for retrieving the data set from a database.
• getStoreId() — Method to get a store id based on the model configuration state.
• loadForm() — Method to get a form object.
• loadFormData() — Method to get the data that should be injected in the form.
• populateState() — Method to auto-populate the model state.
• preprocessForm() — Method to allow derived classes to preprocess the form.

public

• getActiveFilters() — Function to get the active filters
• getFilterForm() — Get the filter form
• getItems() — Method to get an array of data items.
• getPagination() — Method to get a JPagination object for the data set.
• getStart() — Method to get the starting number of items for the data set.
• getTotal() — Method to get the total number of items for the data set.
• getUserStateFromRequest() — Gets the value of a user state variable and sets it in the session

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.