Docs For Class FOFModelBehavior

FOFModelBehavior

Description

FrameworkOnFramework model behavior class. It defines the events which are called by a Model.

abstract:
since: 2.1

Located in /libraries/fof/model/behavior.php (line 18)

JObject
   |
   --JEvent
      |
      --FOFModelBehavior

Direct descendents

Class	Description
FOFModelBehaviorAccess	FrameworkOnFramework model behavior class to filter front-end access to items based on the viewing access levels.
FOFModelBehaviorEnabled	FrameworkOnFramework model behavior class to filter front-end access to items that are enabled.
FOFModelBehaviorFilters	FrameworkOnFramework model behavior class
FOFModelBehaviorLanguage	FrameworkOnFramework model behavior class to filter front-end access to items based on the language.
FOFModelBehaviorPrivate	FrameworkOnFramework model behavior class to filter front-end access to items craeted by the currently logged in user only.

Method Summary

void onAfterBuildQuery (FOFModel &$model, JDatabaseQuery &$query)

void onAfterCopy (FOFModel &$model)

void onAfterDelete (FOFModel &$model)

void onAfterGetItem (FOFModel &$model, FOFTable &$record)

void onAfterHit (FOFModel &$model)

void onAfterMove (FOFModel &$model)

void onAfterPublish (FOFModel &$model)

void onAfterReorder (FOFModel &$model)

void onAfterSave (FOFModel &$model)

void onBeforeBuildQuery (FOFModel &$model, JDatabaseQuery &$query)

void onBeforeCopy (FOFModel &$model)

void onBeforeDelete (FOFModel &$model)

void onBeforeHit (FOFModel &$model)

void onBeforeMove (FOFModel &$model)

void onBeforePublish (FOFModel &$model)

void onBeforeReorder (FOFModel &$model)

void onBeforeSave (FOFModel &$model, array &$data)

Variables

Inherited Variables

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors

Methods

onAfterBuildQuery (line 197)

This event runs after we have built the query used to fetch a record list in a model

access: public

void onAfterBuildQuery (FOFModel &$model, JDatabaseQuery &$query)

FOFModel &$model: The model which calls this event
JDatabaseQuery &$query: The model which calls this event

Redefined in descendants as:

FOFModelBehaviorAccess::onAfterBuildQuery() : This event runs after we have built the query used to fetch a record list in a model. It is used to apply automatic query filters.
FOFModelBehaviorEnabled::onAfterBuildQuery() : This event runs after we have built the query used to fetch a record list in a model. It is used to apply automatic query filters.
FOFModelBehaviorFilters::onAfterBuildQuery() : This event runs after we have built the query used to fetch a record list in a model. It is used to apply automatic query filters.
FOFModelBehaviorLanguage::onAfterBuildQuery() : This event runs after we have built the query used to fetch a record list in a model. It is used to apply automatic query filters.
FOFModelBehaviorPrivate::onAfterBuildQuery() : This event runs after we have built the query used to fetch a record list in a model. It is used to apply automatic query filters.

onAfterCopy (line 140)

This event runs after copying a record in a model

access: public

void onAfterCopy (FOFModel &$model)

FOFModel &$model: The model which calls this event

onAfterDelete (line 129)

This event runs after deleting a record in a model

access: public

void onAfterDelete (FOFModel &$model)

FOFModel &$model: The model which calls this event

onAfterGetItem (line 209)

This event runs after getting a single item

access: public

void onAfterGetItem (FOFModel &$model, FOFTable &$record)

FOFModel &$model: The model which calls this event
FOFTable &$record: The record loaded by this model

Redefined in descendants as:

FOFModelBehaviorAccess::onAfterGetItem() : The event runs after FOFModel has called FOFTable and retrieved a single item from the database. It is used to apply automatic filters.
FOFModelBehaviorEnabled::onAfterGetItem() : The event runs after FOFModel has called FOFTable and retrieved a single item from the database. It is used to apply automatic filters.
FOFModelBehaviorLanguage::onAfterGetItem() : The event runs after FOFModel has called FOFTable and retrieved a single item from the database. It is used to apply automatic filters.
FOFModelBehaviorPrivate::onAfterGetItem() : The event runs after FOFModel has called FOFTable and retrieved a single item from the database. It is used to apply automatic filters.

onAfterHit (line 162)

This event runs after registering a hit on a record in a model

access: public

void onAfterHit (FOFModel &$model)

FOFModel &$model: The model which calls this event

onAfterMove (line 173)

This event runs after moving a record in a model

access: public

void onAfterMove (FOFModel &$model)

FOFModel &$model: The model which calls this event

onAfterPublish (line 151)

This event runs after publishing a record in a model

access: public

void onAfterPublish (FOFModel &$model)

FOFModel &$model: The model which calls this event

onAfterReorder (line 184)

This event runs after reordering records in a model

access: public

void onAfterReorder (FOFModel &$model)

FOFModel &$model: The model which calls this event

onAfterSave (line 118)

This event runs after saving a record in a model

access: public

void onAfterSave (FOFModel &$model)

FOFModel &$model: The model which calls this event

onBeforeBuildQuery (line 107)

This event runs when we are building the query used to fetch a record list in a model

access: public

void onBeforeBuildQuery (FOFModel &$model, JDatabaseQuery &$query)

FOFModel &$model: The model which calls this event
JDatabaseQuery &$query: The model which calls this event

onBeforeCopy (line 50)

This event runs before copying a record in a model

access: public

void onBeforeCopy (FOFModel &$model)

FOFModel &$model: The model which calls this event

onBeforeDelete (line 39)

This event runs before deleting a record in a model

access: public

void onBeforeDelete (FOFModel &$model)

FOFModel &$model: The model which calls this event

onBeforeHit (line 72)

This event runs before registering a hit on a record in a model

access: public

void onBeforeHit (FOFModel &$model)

FOFModel &$model: The model which calls this event

onBeforeMove (line 83)

This event runs before moving a record in a model

access: public

void onBeforeMove (FOFModel &$model)

FOFModel &$model: The model which calls this event

onBeforePublish (line 61)

This event runs before publishing a record in a model

access: public

void onBeforePublish (FOFModel &$model)

FOFModel &$model: The model which calls this event

onBeforeReorder (line 94)

This event runs before changing the records' order in a model

access: public

void onBeforeReorder (FOFModel &$model)

FOFModel &$model: The model which calls this event

onBeforeSave (line 28)

This event runs before saving data in the model

access: public

void onBeforeSave (FOFModel &$model, array &$data)

FOFModel &$model: The model which calls this event
array &$data: The data to save

Inherited Methods

Inherited From JEvent

JEvent::__construct()
JEvent::update()

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 14:54:30 +0100 by phpDocumentor 1.4.3