Class Model

Properties summary

• $Behaviors public
  BehaviorCollection
  Holds the Behavior objects currently bound to this model.
• $__affectedRows public
  integer
  The number of records affected by the last query.
• $__associationKeys public
  array
  Default list of association keys.
• $__associations public
  array
  Holds provided/generated association key names and other data for all associations.
• $__backAssociation public
  array
  Holds model associations temporarily to allow for dynamic (un)binding.
• $__insertID public
  integer
  The ID of the model record that was last inserted.
• $__numRows public
  integer
  The number of records returned by the last query.
• $__safeUpdateMode public
  boolean
  Safe update mode
• $_findMethods public
  array
  List of valid finder method options, supplied as the first parameter to find().
• $_schema public
  array
  Field-by-field table metadata.
• $actsAs public
  array

  List of behaviors to load when the model object is initialized. Settings can be passed to behaviors by using the behavior name as index. Eg:

• $alias public
  string
  Alias name for model.
• $belongsTo public
  array
  Detailed list of belongsTo associations.
• $cacheQueries public
  boolean

  Whether or not to cache queries for this model. This enables in-memory caching only, the results are not stored beyond the current request.

• $cacheSources public
  boolean
  Whether or not to cache sources for this model.
• $data public
  array
  Container for the data that this model gets from persistent storage (usually, a database).
• $displayField public
  string
  Custom display field name. Display fields are used by Scaffold, in SELECT boxes' OPTION elements.
• $findQueryType public
  string
  Type of find query currently executing.
• $hasAndBelongsToMany public
  array
  Detailed list of hasAndBelongsToMany associations.
• $hasMany public
  array
  Detailed list of hasMany associations.
• $hasOne public
  array
  Detailed list of hasOne associations.
• $id public
  mixed

  Value of the primary key ID of the record that this model is currently pointing to. Automatically set after database insertions.

• $logTransactions public
  boolean
  Whether or not to log transactions for this model.
• $name public
  string
  Name of the model.
• $order public
  string
  The column name(s) and direction(s) to order find results by default.
• $primaryKey public
  string
  The name of the primary key field for this model.
• $recursive public
  integer

  Number of associations to recurse through during find calls. Fetches only the first level by default.

• $table public
  string
  Table name for this Model.
• $tablePrefix public
  string
  Database table prefix for tables in model.
• $tableToModel public
  array
  List of table names included in the model description. Used for associations.
• $useDbConfig public
  string
  The name of the DataSource connection that this Model uses
• $useTable public
  string
  Custom database table name, or null/false if no table association is desired.
• $validate public
  array

  List of validation rules. Append entries for validation as ('field_name' => '/^perl_compat_regexp$/') that have to match with preg_match(). Use these rules with Model::validate()

• $validationErrors public
  array
  List of validation errors.
• $virtualFields public
  array

  Array of virtual fields this model has. Virtual fields are aliased SQL expressions. Fields added to this property will be read as other fields in a model but will not be saveable.

• $whitelist public
  array
  Whitelist of fields allowed to be saved.

Method Summary

• __collectForeignKeys() public

  Collects foreign keys from associations.

• __construct() public

  Constructor. Binds the model's database table to the object.

• __constructLinkedModel() public deprecated

  Private helper method to create associated models of a given class.

• __createLinks() public

  Create a set of associations.

• __filterResults() public

  Passes query results through model and behavior afterFilter() methods.

• __generateAssociation() public

  Build an array-based association from string.

• __save() public

  Private helper method used by saveAll.

• __saveMulti() public

  Saves model hasAndBelongsToMany data to the database.

• __sleep() public

  Called when serializing a model.

• __validateWithModels() public

  Runs validation for hasAndBelongsToMany associations that have 'with' keys set. And data in the set() data set.

• __wakeup() public

  Called when de-serializing a model.

• _clearCache() public

  Private method. Clears cache for this model.

• _deleteDependent() public

  Cascades model deletes through associated hasMany and hasOne child records.

• _deleteLinks() public

  Cascades model deletes through HABTM join keys.

• _findCount() public

  Handles the before/after filter logic for find('count') operations. Only called by Model::find().

• _findFirst() public

  Handles the before/after filter logic for find('first') operations. Only called by Model::find().

• _findList() public

  Handles the before/after filter logic for find('list') operations. Only called by Model::find().

• _findNeighbors() public

  Detects the previous field's value, then uses logic to find the 'wrapping' rows and return them.

• _findThreaded() public

  In the event of ambiguous results returned (multiple top level results, with different parent_ids) top level results with different parent_ids to the first result will be dropped

• _prepareUpdateFields() public

  Helper method for Model::updateCounterCache(). Checks the fields to be updated for

• afterDelete() public

  Called after every deletion operation.

• afterFind() public

  Called after each find operation. Can be used to modify any results returned by find(). Return value should be the (modified) results.

• afterSave() public

  Called after each successful save operation.

• beforeDelete() public

  Called before every deletion operation.

• beforeFind() public

  Called before each find operation. Return false if you want to halt the find call, otherwise return the (modified) query data.

• beforeSave() public

  Called before each save operation, after validation. Return a non-true result to halt the save.

• beforeValidate() public

  Called during validation operations, before validation. Please note that custom validation rules can be defined in $validate.

• bindModel() public

  Bind model associations on the fly.

• call__() public

  Handles custom method calls, like findBy for DB models, and custom RPC calls for remote data sources.

• create() public

  Initializes the model for writing a new record, loading the default values for those fields that are not defined in $data, and clearing previous validation errors. Especially helpful for saving data in loops.

• deconstruct() public

  Deconstructs a complex data type (array or object) into a single field value.

• delete() public

  Removes record for given ID. If no ID is given, the current ID is used. Returns true on success.

• deleteAll() public

  Deletes multiple model records based on a set of conditions.

• escapeField() public

  Escapes the field name and prepends the model name. Escaping is done according to the current database driver's rules.

• exists() public

  Returns true if a record with the currently set ID exists.

• field() public

  Returns the contents of a single field given the supplied conditions, in the supplied order.

• find() public

  Queries the datasource and returns a result set array.

• getAffectedRows() public

  Returns the number of rows affected by the last query.

• getAssociated() public

  Gets all the models with which this model is associated.

• getColumnType() public

  Returns the column type of a column in the model.

• getColumnTypes() public

  Returns an associative array of field names and column types.

• getDataSource() public

  Gets the DataSource to which this model is bound. Not safe for use with some versions of PHP4, because this class is overloaded.

• getID() public

  Returns the current record's ID

• getInsertID() public

  Returns the ID of the last record this model inserted.

• getLastInsertID() public

  Returns the ID of the last record this model inserted.

• getNumRows() public

  Returns the number of rows returned from the last query.

• getVirtualField() public

  Returns the expression for a model virtual field

• hasAny() public

  Returns true if a record that meets given conditions exists.

• hasField() public

  Returns true if the supplied field exists in the model's database table.

• invalidFields() public

  Returns an array of fields that have failed validation. On the current model.

• invalidate() public

  Marks a field as invalid, optionally setting the name of validation rule (in case of multiple validation for field) that was broken.

• isForeignKey() public

  Returns true if given field name is a foreign key in this model.

• isUnique() public

  Returns false if any fields passed match any (by default, all if $or = false) of their matching values.

• isVirtualField() public

  Returns true if the supplied field is a model Virtual Field

• joinModel() public

  Gets the name and fields to be used by a join model. This allows specifying join fields in the association definition.

• onError() public

  Called when a DataSource-level error occurs.

• query() public

  Returns a resultset for a given SQL statement. Custom SQL queries should be performed with this method.

• read() public

  Returns a list of fields from the database, and sets the current model data (Model::$data) with the record found.

• resetAssociations() public

  This resets the association arrays for the model back to those originally defined in the model. Normally called at the end of each call to Model::find()

• save() public

  Saves model data (based on white-list, if supplied) to the database. By default, validation occurs before save.

• saveAll() public

  Saves multiple individual records for a single model; Also works with a single record, as well as all its associated records.

• saveField() public

  Saves the value of a single field to the database, based on the current model ID.

• schema() public

  Returns an array of table metadata (column names and types) from the database. $field => keys(type, null, default, key, length, extra)

• set() public

  This function does two things:

• setDataSource() public

  Sets the DataSource to which this model is bound.

• setInsertID() public

  Sets the ID of the last record this model inserted

• setSource() public

  Sets a custom table for your controller class. Used by your controller to select a database table.

• unbindModel() public

  Turn off associations on the fly.

• updateAll() public

  Updates multiple model records based on a set of conditions.

• updateCounterCache() public

  Updates the counter cache of belongsTo associations after a save or delete operation

• validates() public

  Returns true if all fields pass validation. Will validate hasAndBelongsToMany associations that use the 'with' key as well. Since __saveMulti is incapable of exiting a save operation.

Method Detail

            var $hasMany = array('ModelName');
                usage: $this->ModelName->modelMethods();

Methods inherited from Overloadable

Methods inherited from Object

Properties detail

null

null

array(
    'belongsTo' => array('className', 'foreignKey', 'conditions', 'fields', 'order', 'counterCache'),
    'hasOne' => array('className', 'foreignKey','conditions', 'fields','order', 'dependent'),
    'hasMany' => array('className', 'foreignKey', 'conditions', 'fields', 'order', 'limit', 'offset', 'dependent', 'exclusive', 'finderQuery', 'counterQuery'),
    'hasAndBelongsToMany' => array('className', 'joinTable', 'with', 'foreignKey', 'associationForeignKey', 'conditions', 'fields', 'order', 'limit', 'offset', 'unique', 'finderQuery', 'deleteQuery', 'insertQuery')
)

array('belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany')

array()

null

null

false

array(
    'all' => true, 'first' => true, 'count' => true,
    'neighbors' => true, 'list' => true, 'threaded' => true
)

null

null

null

array()

false

true

array()

null

null

array()

array()

array()

false

false

null

null

null

1

false

null

array()

'default'

null

array()

array()

array()

array()