Class Core_ORM

Object-relational mapping. Implement an Active record pattern.

Creating objects

// Create an empty object of model Book_Model
$object = Core_ORM::factory('Book');

// Create an object of model Book_Model and load from database where primary key is 1
$object = Core_ORM::factory('Book', 1);

Set property, the first way:

$object->value(123)->otherValue('my value');

The second way:

$object->value = 123;
$object->otherValue = 'my value';

Saving object

// Change column and save
$object = Core_ORM::factory('Book', 1);
$object
    ->value(123)
    ->save();

Finding objects

// Find all objects of model Book_Model
$aBooks = Core_ORM::factory('Book')->findAll();

foreach ($aBooks as $oBook)
{
    // do something
}

// Find objects of model Book_Model with conditions
$object = Core_ORM::factory('Book');
$object->queryBuilder()
    ->where('value', '=', 99);
$aBooks = $object->findAll();

foreach ($aBooks as $oBook)
{
    // do something
}

Direct known subclasses

Core_Entity

Indirect known subclasses

Methods summary

`public mixed`	# `getPrimaryKey( )` Get primary key value Get primary key value Returns mixed
`public string`	# `getPrimaryKeyName( )` Get primary key name Get primary key name Returns string
`public string`	# `getTableName( )` Get table name Get table name Returns string
`public Core_ORM`	# `delete( mixed $primaryKey = NULL )` Delete object from database Delete object from database // Delete object with lazy load Core_ORM::factory('Book', 1)->delete(); // Delete object without load Core_ORM::factory('Book')->delete(1); Parameters `$primaryKey` primary key for deleting object Returns `Core_ORM` Hostcms-event modelname.onBeforeDelete modelname.onAfterDelete
`public static string`	# `getClassName( $modelName )` Get Model CallsName Get Model CallsName Parameters `$modelName` name Returns string
`public static`	# `factory( $modelName, $primaryKey = NULL )` Create and return an object of model Create and return an object of model Parameters `$modelName` name `$primaryKey` key
`public Core_ORM`	# `find( mixed $primaryKey = NULL, boolean $bCache = TRUE )` Find object in database and load one. Use clear() before find() with conditions! Find object in database and load one. Use clear() before find() with conditions! Parameters `$primaryKey` default NULL `$bCache` use cache // Find an object and load (without lazy load) // If an object is not found, primary key sets NULL $oBook = Core_ORM::factory('Book')->find(1); Returns `Core_ORM`
`public array`	# `findAll( boolean $bCache = TRUE )` Find all objects Find all objects Parameters `$bCache` use cache, default TRUE // Find objects $aBooks = Core_ORM::factory('Book')->findAll(); foreach ($aBooks as $oBook) { var_dump($oBook->id); } Returns array Hostcms-event modelname.onBeforeFindAll modelname.onAfterFindAll
`public boolean`	# `chunk( integer $count, callable $callback, boolean $bCache = TRUE )` Retrieve a small chunk and feeds each one into $callback for processing. It stops looping when $callback returns FALSE Retrieve a small chunk and feeds each one into $callback for processing. It stops looping when $callback returns FALSE Parameters `$count` chunk size `$callback` `$bCache` use cache Returns boolean
`public Core_ORM`	# `deleteAll( boolean $bCache = TRUE )` Delete all object Delete all object Parameters `$bCache` use cache Core_ORM::factory('Book')->Comments->deleteAll(); Returns `Core_ORM`
`public integer\|false`	# `getCount( boolean $bCache = TRUE, string $fieldName = '', boolean $distinct = FALSE )` Get count object Get count object Parameters `$bCache` use cache, default TRUE `$fieldName` default '' `$distinct` default FALSE Returns integer\|false $iCount = Core_ORM::factory('Book')->getCount(); var_dump($iCount);
`public null\|Core_ORM`	# `getFirst( boolean $bCache = TRUE )` Get fist entity, ordered by primary key Get fist entity, ordered by primary key Parameters `$bCache` use cache, default TRUE Returns null\|`Core_ORM` $mObject = Core_ORM::factory('Book')->getFirst(); if (!is_null($mObject)) { echo $mObject; }
`public null\|Core_ORM`	# `getLast( boolean $bCache = TRUE )` Get last entity, ordered by primary key Get last entity, ordered by primary key Parameters `$bCache` use cache, default TRUE Returns null\|`Core_ORM` $mObject = Core_ORM::factory('Book')->getLast(); if (!is_null($mObject)) { echo $mObject; }
`public Core_ORM`	# `add( Core_ORM $model, string $relation = NULL )` Add related object. If main object does not save, it will save. Add related object. If main object does not save, it will save. Parameters `$model` `$relation` Returns `Core_ORM` Hostcms-event modelname.onBeforeAdd modelname.onAfterAdd $object = Core_ORM::factory('Main', 1); $child = Core_ORM::factory('Child') $child->value1 = 'some value1'; $child->value2 = 'some value2'; $object->add($child);
`public Core_ORM`	# `remove( Core_ORM $model, string $relation = NULL )` Remove related object. If main object does not save, it will save. Remove related object. If main object does not save, it will save. Parameters `$model` `$relation` Returns `Core_ORM` Hostcms-event modelname.onBeforeRemove modelname.onAfterRemove
`public boolean`	# `changed( )` Check model has been changed. Check model has been changed. Returns boolean
`public`	# `__construct( string $primaryKey = NULL )` Constructor. Constructor. Parameters `$primaryKey`
`protected Core_ORM`	# `_relations( )` Calculate model's relation if data does not exist in self::$_relationModelCache. Calculate model's relation if data does not exist in self::$_relationModelCache. Returns `Core_ORM` Hostcms-event modelname.onAfterLoadModelCache modelname.onAfterRelations
`public string`	# `getModelName( )` Get model name, e.g. 'book' for 'Book_Model' Get model name, e.g. 'book' for 'Book_Model' Returns string
`public static`	# `setDatabaseDriver( string $name )` Set name of Database Driver Set name of Database Driver Parameters `$name` driver's name
`protected Core_DataBase`	# `getDatabase( )` Get Database Get Database Returns `Core_DataBase`
`protected Core_ORM`	# `_init( )` Model initialization Model initialization Returns `Core_ORM`
`public Core_ORM`	# `loaded( )` Check if model is loaded Check if model is loaded Returns `Core_ORM`
`public Core_ORM`	# `load( )` Load values from database Load values from database Returns `Core_ORM`
`protected Core_ORM`	# `_load( )` Load values from database Load values from database Returns `Core_ORM`
`protected`	# `_onBeforeLoad( )` Run before loading of the object Run before loading of the object
`protected`	# `_onAfterLoad( )` Run after loading of the object Run after loading of the object
`public Core_QueryBuilder_Select`	# `queryBuilder( )` Get query builder for select Get query builder for select Returns `Core_QueryBuilder_Select`
`public static`	# `clearColumnCache( )` Clear self::$_columnCache and Core_ORM_ColumnCache Clear self::$_columnCache and Core_ORM_ColumnCache
`public static`	# `clearRelationModelCache( mixed $modelName = NULL )` Clear self::$_relationModelCache and Core_ORM_RelationCache Clear self::$_relationModelCache and Core_ORM_RelationCache Parameters `$modelName` default NULL
`protected Core_ORM`	# `_loadColumnCacheDefaultValues( )` Load self::$_columnCacheDefaultValues for current model Load self::$_columnCacheDefaultValues for current model Returns `Core_ORM`
`public array`	# `getTableColumns( )` Get tableColumns Get tableColumns Returns array
`protected Core_ORM`	# `_loadColumns( )` Load columns list for model Load columns list for model Returns `Core_ORM`
`protected Core_ORM`	# `_setPreloadValues( )` Set preload values from _preloadValues Set preload values from _preloadValues Returns `Core_ORM`
`protected Core_ORM`	# `_setDefaultValues( )` Set unidentified values as NULL Set unidentified values as NULL Returns `Core_ORM`
`protected Core_ORM`	# `setValues( array $values, boolean $changed = FALSE )` Set model values Set model values Parameters `$values` list of values `$changed` default FALSE Returns `Core_ORM`
`protected`	# `isEmptyPrimaryKey( )` Check is primary key NULL Check is primary key NULL
`protected object`	# `_getRelation( string $lowerProperty )` Get relation by $lowerProperty Get relation by $lowerProperty Parameters `$lowerProperty` Returns object
`public mixed`	# `__get( string $property )` Utilized for reading data from inaccessible properties Utilized for reading data from inaccessible properties Parameters `$property` property name Returns mixed
`public`	# `isCallable( string $methodName )` Verify that the contents of a variable can be called as a function Verify that the contents of a variable can be called as a function Parameters `$methodName` method name
`public boolean`	# `__isset( string $property )` Triggered by calling isset() or empty() on inaccessible properties Triggered by calling isset() or empty() on inaccessible properties Parameters `$property` property name Returns boolean
`public Core_ORM`	# `__set( string $property, string $value )` Run when writing data to inaccessible properties Run when writing data to inaccessible properties Parameters `$property` property name `$value` property value Returns `Core_ORM`
`public mixed`	# `__call( string $name, array $arguments )` Triggered when invoking inaccessible methods in an object context Triggered when invoking inaccessible methods in an object context Parameters `$name` method name `$arguments` arguments Returns mixed Hostcms-event modelname.onCall
`public array`	# `getChangedData( )` Get changed columns with values Get changed columns with values Returns array
`protected mixed`	# `_convertPropertyValue( string $property, mixed $value )` Convert field value Convert field value Parameters `$property` Property name `$value` Property value Returns mixed converted value
`public Core_ORM`	# `check( boolean $exception = FALSE )` Check model values. If model has incorrect value, one will correct or call exception. Check model values. If model has incorrect value, one will correct or call exception. $object = Core_ORM::factory('Book', 1); $object->value = 123; $object->check(TRUE)->save(); Parameters `$exception` Call exception (TRUE) or correct value (FALSE). Default FALSE. Returns `Core_ORM`
`public Core_ORM`	# `create( )` Insert new object data into database Insert new object data into database Returns `Core_ORM` Hostcms-event modelname.onBeforeCreate modelname.onAfterCreate
`public Core_ORM`	# `update( )` Update object data into database Update object data into database Returns `Core_ORM` Hostcms-event modelname.onBeforeUpdate modelname.onAfterUpdate
`public Core_ORM`	# `save( )` Save object. Uses self::update() or self::create() Save object. Uses self::update() or self::create() Returns `Core_ORM` Hostcms-event modelname.onBeforeSave modelname.onAfterSave
`public array`	# `getRelations( )` Get $this->_relations Get $this->_relations Returns array
`public Core_ORM`	# `setRelations( array $relations )` Set $this->_relations Set $this->_relations Parameters `$relations` Array with new relations Returns `Core_ORM`
`public`	# `__clone( )` Clone entity Clone entity
`public string`	# `__toString( )` Convert object to string Convert object to string Returns string
`public array`	# `toArray( )` Convert Object to Array Convert Object to Array Returns array
`public Core_ORM`	# `clearRelationCache( )` Clear relation cache Clear relation cache Returns `Core_ORM`
`public Core_ORM`	# `clear( )` Clear object Clear object Returns `Core_ORM`

Properties summary

`protected string`	`$_primaryKey` Primary key Primary key	# `'id'`
`protected mixed`	`$_modelName` Model name, e.g. 'book' for 'Book_Model' Model name, e.g. 'book' for 'Book_Model'	# `NULL`
`protected array`	`$_modelColumns` List of columns in model with values List of columns in model with values	# `array()`
`protected mixed`	`$_tableName` Table name, e.g. 'books' for 'Book_Model' Table name, e.g. 'books' for 'Book_Model'	# `NULL`
`protected array`	`$_tableColumns` List of columns in table List of columns in table	# `array()`
`protected array`	`$_preloadValues` List of preloaded values those will set for new object which does not have primary key List of preloaded values those will set for new object which does not have primary key	# `array()`
`protected array`	`$_skipColumns` List of skipped columns from table List of skipped columns from table	# `array()`
`protected array`	`$_changedColumns` List of changed columns List of changed columns	# `array()`
`protected array`	`$_dataValues` data-values, e.g. dataMyValue data-values, e.g. dataMyValue	# `array()`
`protected array`	`$_relations` List of all relations are created by _relations() based on _hasOne, _hasMany and _belongsTo array('field_name' => array( 'type' => Type of relation: one\|many 'model' => Model name 'foreign_key' => Foreign key 'primary_key' => Primary key in the parent table 'through' => Model name for many-to-many relation 'through_table_name' => Table name for many-to-many relation 'dependent_key' => Dependent child's key in "through" table ) ) List of all relations are created by _relations() based on _hasOne, _hasMany and _belongsTo array('field_name' => array( 'type' => Type of relation: one\|many 'model' => Model name 'foreign_key' => Foreign key 'primary_key' => Primary key in the parent table 'through' => Model name for many-to-many relation 'through_table_name' => Table name for many-to-many relation 'dependent_key' => Dependent child's key in "through" table ) )	# `array()`
`protected array`	`$_hasMany` One-to-many or many-to-many relations One-to-many or many-to-many relations One-to-many relation // Relation one-to-many for Book-Comments: protected $_hasMany = array('comment' => array()); // Equivalence relation one-to-many for Book-Comments with detailed conditions: // comment - Model name // foreign_key - Foreign key protected $_hasMany = array('comment' => array( 'foreign_key' => 'book_id' )); Many-to-many relation // Relation many-to-many for Book-Comments through model 'books_comment': protected $_hasMany = array('comment' => array( 'through' => 'books_comment' )); // Relation many-to-many for Book-Comments through model 'books_comment' with detailed conditions: protected $_hasMany = array('comment' => array( 'foreign_key' => 'book_id', 'through' => 'books_comment', 'dependent_key' => 'comment_id' ));	# `array()`
`protected array`	`$_hasOne` One-to-one relations One-to-one relations // Relation one-to-one for Book-Comment: protected $_hasOne = array('comment' => array()); // Equivalence relation one-to-one for Book-Comment with detailed conditions: // comment - Model name // foreign_key - Foreign key protected $_hasOne = array('comment' => array( 'foreign_key' => 'book_id' ));	# `array()`
`protected array`	`$_belongsTo` Belongs to relations Belongs to relations // Belongs to relation for Comment-Book: protected $_belongsTo = array('book' => array()); // Equivalence belongs to relation for Comment-Book with detailed conditions: // book - Model name // foreign_key - Foreign key // primary_key - Primary key in the parent table protected $_belongsTo = array('book' => array( 'foreign_key' => 'book_id' ));	# `array()`
`public static mixed`	`$config` ORM config ORM config	# `NULL`
`public static Core_Cache`	`$cache` ORM cache ORM cache	# `NULL`
`public static Core_Cache`	`$columnCache` ORM column cache ORM column cache	# `NULL`
`public static Core_Cache`	`$relationCache` ORM relation cache ORM relation cache	# `NULL`
`protected array`	`$_relationCache` Objects cache for _hasOne and _belongsTo Objects cache for _hasOne and _belongsTo	# `array()`
`protected static array`	`$_relationModelCache` Relations cache for models Relations cache for models	# `array()`
`protected static array`	`$_columnCache` Columns cache for models Columns cache for models	# `array()`
`protected static array`	`$_columnCacheDefaultValues` Columns cache for models default values Columns cache for models default values	# `array()`
`protected array`	`$_database` Core_DataBase object Core_DataBase object	# `array()`
`protected Core_QueryBuilder_Select`	`$_queryBuilder` Select query builder Select query builder	# `NULL`
`protected boolean`	`$_bSetPreloadValues` Preload values have been set Preload values have been set	# `FALSE`
`protected boolean`	`$_loaded` Model has already been loaded from database Model has already been loaded from database	# `FALSE`
`protected`	`$_saved` Model has already been saved into database NULL value used in the __set() for separate value settings through mysql_fetch_object() Model has already been saved into database NULL value used in the __set() for separate value settings through mysql_fetch_object()	# `NULL`
`protected array`	`$_sorting` Default sorting for models protected $_sorting = array( 'tablename.sorting' => 'ASC' ); Default sorting for models protected $_sorting = array( 'tablename.sorting' => 'ASC' );	# `array()`
`protected static string`	`$_databaseDriver` Database driver's name, default is 'default' Database driver's name, default is 'default'	# `'default'`

Classes

Exceptions

Functions

Class Core_ORM

Direct known subclasses

Indirect known subclasses

Methods summary

Returns

Returns

Returns

Parameters

Returns

Hostcms-event

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Hostcms-event

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Hostcms-event

Parameters

Returns

Hostcms-event

Returns

Parameters

Returns

Hostcms-event

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Hostcms-event

Returns

Parameters

Returns

Parameters

Returns

Returns

Hostcms-event

Returns

Hostcms-event

Returns

Hostcms-event