FOFModel
FrameworkOnFramework Model class. The Model is the worhorse. It performs all
of the business logic based on its state and then returns the raw (processed) data to the caller, or modifies its own state. It's important to note that the model doesn't get data directly from the request (this is the Controller's business) and that it doesn't output anything (that the View's business).
Located in /libraries/fof/model/model.php (line 22)
JObject | --FOFModel
| Class | Description |
|---|---|
PostinstallModelMessages
|
Model class to manage postinstall messages |
static 
The
getUserStateFromRequest
(string $key, string $request, [string $default = null], [string $type = 'none'], [boolean $setUserState = true])
mixed
loadForm
(string $name, [string $source = null], [array $options = array()], [boolean $clear = false], [string $xpath = false])
array
&_getList
(string $query, [integer $limitstart = 0], [integer $limit = 0], [string $group = ''])
FOFConfigProvider
$configProvider
= null (line 183)
An instance of FOFConfigProvider to provision configuration overrides
array
$default_behaviors
= array('filters') (line 197)
Default behaviors to apply to the model
string
$event_after_delete
= 'onContentAfterDelete' (line 44)
The event to trigger after deleting the data.
string
$event_after_save
= 'onContentAfterSave' (line 50)
The event to trigger after saving the data.
string
$event_before_delete
= 'onContentBeforeDelete' (line 56)
The event to trigger before deleting the data.
string
$event_before_save
= 'onContentBeforeSave' (line 62)
The event to trigger before saving the data.
string
$event_change_state
= 'onContentChangeState' (line 68)
The event to trigger after changing the published state of the data.
string
$event_clean_cache
= null (line 76)
The event to trigger when cleaning cache.
int
$id
= null (line 88)
The first row ID passed to the model's state
array
$id_list
= array() (line 82)
Stores a list of IDs passed to the model's state
array
$input
= array() (line 94)
Input variables, passed on from the controller, in an associative array
array
$list
= null (line 100)
The list of records made available through getList
FOFModelDispatcherBehavior
$modelDispatcher
= null (line 190)
FOFModelDispatcherBehavior for dealing with extra behaviors
string
$name
(line 108)
The model (base) name
string
$option
= null (line 116)
The URL option for the component.
JPagination
$pagination
= null (line 128)
Pagination object
string
$state
(line 142)
A state object
string
$table
= null (line 148)
The name of the table to use
int
$total
= null (line 154)
Total rows based on the filters set in the model's state
object
$_db
(line 38)
Database Connector
array
$_formData
= array() (line 176)
The data to load into a form
array
$_forms
= array() (line 168)
Array of form objects.
bool
$_savestate
= null (line 160)
Should I save the model's state in the session?
boolean
$__state_set
= null (line 30)
Indicates if the internal state has been set
Inherited Variables
Inherited from JObject
Add a directory where FOFModel should search for models. You may either pass a string or an array of directories.
- mixed $path: A path or array[sting] of paths to search.
- string $prefix: A prefix for models.
Adds to the stack of model table paths in LIFO order.
- mixed $path: The directory as a string or directories as an array to add.
Returns a new model object. Unless overriden by the $config array, it will try to automatically populate its state from the request variables.
- string $type: Model type, e.g. 'Items'
- string $prefix: Model prefix, e.g. 'FoobarModel'
- array $config: Model configuration variables
Returns a new instance of a model, with the state reset to defaults
- string $type: Model type, e.g. 'Items'
- string $prefix: Model prefix, e.g. 'FoobarModel'
- array $config: Model configuration variables
Create the filename for a resource
- string $type: The resource type to create the filename for.
- array $parts: An associative array of filename information.
Public class constructor
- type $config: The configuration array
- JObject::__construct()
- Class constructor, overridden in descendant classes.
Adds a behavior to the model
- string $name: The name of the behavior
- array $config: Optional Behavior configuration
Applies view access level filtering for the specified user. Useful to filter a front-end items listing.
- integer $userID: The user ID to use. Skip it to use the currently logged in user.
Builds the SELECT query
- boolean $overrideLimits: Are we requested to override the set limits?
- PostinstallModelMessages::buildQuery() : Builds the SELECT query
Clean the cache
- string $group: The cache group
- integer $client_id: The ID of the client
Clears the model state, but doesn't touch the internal lists of records, record tables or record id variables. To clear these values, please use reset().
Guesses the best candidate for the path to use for a particular form.
- string $source: The name of the form file to load, without the .xml extension.
- array $paths: The paths to look into. You can declare this to override the default FOF paths.
A cross-breed between getItem and getItemList. It runs the complete query, like getItemList does. However, instead of returning an array of ad-hoc objects, it binds the data from the first item fetched on the list to an instance of the table object and returns that table object instead.
- boolean $overrideLimits: Should I override set limits?
A method for getting the form from the model.
- array $data: Data for the form.
- boolean $loadData: True if the form is to load its own data (default case), false if not.
- boolean $source: The name of the form. If not set we'll try the form_name state variable or fall back to default.
Returns a hash for this component and view, e.g. "foobar.items.", used for determining the keys of the variables which will be placed in the session storage.
Returns a single item. It uses the id set with setId, or the first ID in the list of IDs for batch operations
- integer $id: Force a primary key ID to the model. Use null to use the id from the state.
Returns a list of items
- boolean $overrideLimits: Should I override set limits?
- string $group: The group by clause
Alias for getItemList
- boolean $overrideLimits: Should I override set limits?
- string $group: The group by clause
Method to get the model name
The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor
Returns the table object after the last save() operation
Get a filtered state variable
- string $key: The name of the state variable
- mixed $default: The default value to use
- string $filter_type: Filter type
Method to get a table object, load it if necessary.
- string $name: The table name. Optional.
- string $prefix: The class prefix. Optional.
- array $options: Configuration array for model. Optional.
Returns a list of the fields of the table associated with this model
Gets the value of a user state variable.
- string $key: The key of the user state variable.
- string $request: The name of the variable passed in a request.
- string $default: The default value for the variable if not found. Optional.
- string $type: Filter for the variable, for valid values see JFilterInput::clean(). Optional.
- boolean $setUserState: Should I save the variable in the user state? Default: true. Optional.
Tells you if the current item is checked out or not
Method to get a form object.
- string $name: The name of the form.
- string $source: The form source. Can be XML string if file flag is set to false.
- array $options: Optional array of options for the form creation.
- boolean $clear: Optional argument to force load a new form.
- string $xpath: An optional xpath to search for the fields.
Method to get the data that should be injected in the form.
Moves the current item up or down in the ordering list
- string $dirn: The direction and magnitude to use (2 means move up by 2 positions, -3 means move down three positions)
This method runs after a record has been copied
- FOFTable &$table: The table instance of the record which was copied
This method runs after a record with key value $id is deleted
- integer $id: The id of the record which was deleted
This method runs after an item has been gotten from the database in a read operation. You can modify it before it's returned to the MVC triad for further processing.
- FOFTable &$record: The table instance we fetched
This method runs after a record has been hit
- FOFTable &$table: The table instance of the record which was hit
Allows the manipulation after the form is loaded
- FOFForm $form: A FOFForm object.
- string &$name: The name of the form.
- string &$source: The form source. Can be XML string if file flag is set to false.
- array &$options: Optional array of options for the form creation.
This method runs after a record has been moved
- FOFTable &$table: The table instance of the record which was moved
Allows data and form manipulation after preprocessing the form
- FOFForm $form: A FOFForm object.
- array &$data: The data expected for the form.
This method runs after a record has been published
- FOFTable &$table: The table instance of the record which was published
This method runs after a table is reordered
- FOFTable &$table: The table instance which was reordered
This method runs after the data is saved to the $table.
- FOFTable &$table: The table which was saved
This method runs before a record is copied
- FOFTable &$table: The table instance of the record being copied
This method runs before the record with key value of $id is deleted from $table
- integer &$id: The ID of the record being deleted
- FOFTable &$table: The table instance used to delete the record
This method runs before a record is hit
- FOFTable &$table: The table instance of the record being hit
Allows the manipulation before the form is loaded
- string &$name: The name of the form.
- string &$source: The form source. Can be XML string if file flag is set to false.
- array &$options: Optional array of options for the form creation.
This method runs before a record is moved
- FOFTable &$table: The table instance of the record being moved
Allows data and form manipulation before preprocessing the form
- FOFForm $form: A FOFForm object.
- array &$data: The data expected for the form.
This method runs before a record is published
- FOFTable &$table: The table instance of the record being published
This method runs before a table is reordered
- FOFTable &$table: The table instance being reordered
This method runs before the $data is saved to the $table. Return false to stop saving.
- array &$data: The data to save
- FOFTable &$table: The table to save the data to
This method can be overriden to automatically do something with the list results array. You are supposed to modify the list which was passed in the parameters; DO NOT return a new array!
- array &$resultArray: An array of objects, each row representing a record
- PostinstallModelMessages::onProcessList() : List post-processing. This is used to run the programmatic display conditions against each list item and decide if we have to show it or not.
Initialises the _savestate variable
- integer $defaultSaveState: The default value for the savestate
Method to auto-populate the model state.
This method should only be called once per instantiation and is designed to be called on the first call to the getState() method unless the model configuration flag to ignore the request is set.
Method to allow derived classes to preprocess the form.
- FOFForm $form: A FOFForm object.
- mixed &$data: The data expected for the form.
- string $group: The name of the plugin group to import (defaults to "content").
Toggles the published state of one or several items
- integer $publish: The publishing state to set (e.g. 0 is unpublished)
- integer $user: The user ID performing this action
Binds the data to the model and tries to save it
- array|object $data: The source data array or object
Sets the model state auto-save status. By default the model is set up to save its state to the session.
- boolean $newState: True to save the state, false to not save it.
Method to set the database driver object
- JDatabaseDriver $db: A JDatabaseDriver based object
Sets the ID and resets internal data
- integer $id: The ID to use
Sets a list of IDs for batch operations from an array and resets the model
- array $idlist: An array of item IDs to be set to the model's state
Sets the list of IDs from the request data
Method to set model state variables
- string $property: The name of the property.
- mixed $value: The value of the property to set or null.
Method to validate the form data.
- FOFForm $form: The form to validate against.
- array $data: The data to validate.
- string $group: The name of the field group to validate.
Method to load and return a model object.
- string $name: The name of the view
- string $prefix: The class prefix. Optional.
- array $config: The configuration array to pass to the table
Returns an object list
- string $query: The query
- integer $limitstart: Offset from start
- integer $limit: The number of records
- string $group: The group by clause
Returns a record count for the query
- string $query: The query.
Method to get model state variables
- string $property: Optional parameter name
- mixed $default: Optional default value
Magic caller; allows to use the name of model state keys as methods to set their values.
- string $name: The name of the state variable to set
- mixed $arguments: The value to set the state variable to
Magic getter; allows to use the name of model state keys as properties
- string $name: The name of the variable to get
Magic setter; allows to use the name of model state keys as properties
- string $name: The name of the variable
- mixed $value: The value to set the variable to
Inherited Methods
Inherited From JObject
JObject::__construct()
Documentation generated on Tue, 19 Nov 2013 15:08:34 +0100 by phpDocumentor 1.4.3