• Главная
• Prado
• Data
• ActiveRecord
• TActiveRecord

PHP Класс Prado\Data\ActiveRecord\TActiveRecord

An active record creates an object that wraps a row in a database table or view, encapsulates the database access, and adds domain logic on that data. Active record objects are stateful, this is main difference between the TActiveRecord implementation and the TTableGateway implementation. The essence of an Active Record is an object model of the domain (e.g. products, items) that incorporates both behavior and data in which the classes match very closely the record structure of an underlying database. Each Active Record is responsible for saving and loading to the database and also for any domain logic that acts on the data. The Active Record provides methods that do the following: 1. Construct an instance of the Active Record from a SQL result set row. 2. Construct a new instance for later insertion into the table. 3. Finder methods to wrap commonly used SQL queries and return Active Record objects. 4. Update the database and insert into it the data in the Active Record. Example: class UserRecord extends TActiveRecord { const TABLE='users'; //optional table name. public $username; //corresponds to the fieldname in the table public $email; returns active record finder instance public static function finder($className=__CLASS__) { return parent::finder($className); } } create a connection and give it to the ActiveRecord manager. $dsn = 'pgsql:host=localhost;dbname=test'; $conn = new TDbConnection($dsn, 'dbuser','dbpass'); TActiveRecordManager::getInstance()->setDbConnection($conn); load the user record with username (primary key) 'admin'. $user = UserRecord::finder()->findByPk('admin'); $user->email = '[email protected]'; $user->save(); //update the 'admin' record. Since v3.1.1, TActiveRecord starts to support column mapping. The physical column names (defined in database) can be mapped to logical column names (defined in active classes as public properties.) To use this feature, declare a static class variable COLUMN_MAPPING like the following: class UserRecord extends TActiveRecord { const TABLE='users'; public static $COLUMN_MAPPING=array ( 'user_id'=>'username', 'email_address'=>'email', ); public $username; public $email; } In the above, the 'users' table consists of 'user_id' and 'email_address' columns, while the UserRecord class declares 'username' and 'email' properties. By using column mapping, we can regularize the naming convention of column names in active record. Since v3.1.2, TActiveRecord enhanced its support to access of foreign objects. By declaring a public static variable RELATIONS like the following, one can access the corresponding foreign objects easily: class UserRecord extends TActiveRecord { const TABLE='users'; public static $RELATIONS=array ( 'department'=>array(self::BELONGS_TO, 'DepartmentRecord', 'department_id'), 'contacts'=>array(self::HAS_MANY, 'ContactRecord', 'user_id'), ); } In the above, the users table is related with departments table (represented by DepartmentRecord) and contacts table (represented by ContactRecord). Now, given a UserRecord instance $user, one can access its department and contacts simply by: $user->department and $user->contacts. No explicit data fetching is needed. Internally, the foreign objects are fetched in a lazy way, which avoids unnecessary overhead if the foreign objects are not accessed at all. Since v3.1.2, new events OnInsert, OnUpdate and OnDelete are available. The event OnInsert, OnUpdate and OnDelete methods are executed before inserting, updating, and deleting the current record, respectively. You may override these methods; a TActiveRecordChangeEventParameter parameter is passed to these methods. The property {@link TActiveRecordChangeEventParameter::setIsValid IsValid} of the parameter can be set to false to prevent the change action to be executed. This can be used, for example, to validate the record before the action is executed. For example, in the following the password property is hashed before a new record is inserted. class UserRecord extends TActiveRecord { function OnInsert($param) { parent method should be called to raise the event parent::OnInsert($param); $this->nounce = md5(time()); $this->password = md5($this->password.$this->nounce); } } Since v3.1.3 you can also define a method that returns the table name. class UserRecord extends TActiveRecord { public function table() { return 'users'; } } Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$COLUMN_MAPPING		The keys are physical column names as defined in database, and the values are logical column names as defined as public variable/property names for the corresponding active record class.
$RELATIONS		The keys are public variable/property names defined in the AR class. Each value is an array, e.g. array(self::HAS_MANY, 'PlayerRecord').

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_connection		database connection object.
$_invalidFinderResult	TActiveRecordInvalidFinderResult	Defaults to 'null'
$_recordState		record state: 0 = new, 1 = loaded, 2 = deleted.

Открытые методы

Метод	Описание
__call ( $method, $args ) : mixed	Dynamic find method using parts of method name as search criteria.
__construct ( $data = [], $connection = null )	Create a new instance of an active record with given $data. The record can be saved to the database specified by the $connection object.
__get ( $name ) : mixed	Magic method for reading properties.
__set ( $name, $value )	Magic method for writing properties.
__sleep ( )	Prevent __call() method creating __sleep() when serializing.
__wakeup ( )	Prevent __call() method creating __wakeup() when unserializing.
copyFrom ( $data )	Copies data from an array or another object.
count ( $criteria = null, $parameters = [] ) : integer	Find the number of records.
createRecord ( $type, $data ) : TActiveRecord	Create an AR instance specified by the AR class name and initial data.
delete ( ) : boolean	Deletes the current record from the database. Once deleted, this object can not be saved again in the same instance.
deleteAll ( $criteria = null, $parameters = [] ) : integer	Delete multiple records using a criteria.
deleteAllByPks ( $keys )	Alias for deleteByPk()
deleteByPk ( $keys ) : integer	Delete records by primary key. Usage:
equals ( TActiveRecord $record, $strict = false ) : boolean	Compare two records using their primary key values (all column values if table does not defined primary keys). The default uses simple == for comparison of their values. Set $strict=true for identity comparison (===).
find ( $criteria, $parameters = [] ) : TActiveRecord	Find one single record that matches the criteria.
findAll ( $criteria = null, $parameters = [] ) : array	Same as find() but returns an array of objects.
findAllByIndex ( $criteria, $fields, $values ) : array	Fetches records using the sql clause "(fields) IN (values)", where fields is an array of column names and values is an array of values that the columns must have.
findAllByPks ( $keys ) : array	Find multiple records matching a list of primary or composite keys.
findAllBySql ( $sql, array $parameters = [] ) : array	Find records using full SQL, returns corresponding record object.
findByPk ( $keys ) : TActiveRecord.	Find one record using only the primary key or composite primary keys. Usage:
findBySql ( $sql, array $parameters = [] ) : TActiveRecord,	Find records using full SQL, returns corresponding record object.
finder ( $className = __CLASS__ ) : TActiveRecord	Returns the instance of a active record finder for a particular class.
getActiveDbConnection ( )
getColumnValue ( $columnName ) : mixed	Retrieves the column value according to column name.
getDbConnection ( ) : TDbConnection	Gets the current Db connection, the connection object is obtained from the TActiveRecordManager if connection is currently null.
getInvalidFinderResult ( ) : TActiveRecordInvalidFinderResult
getRecordGateway ( ) : TActiveRecordGateway
getRecordManager ( ) : TActiveRecordManager	Gets the record manager for this object, the default is to call TActiveRecordManager::getInstance().
getRecordRelation ( $property ) : array
getRecordRelations ( ) : array
getRecordTableInfo ( ) : TDbTableInfo
hasRecordRelation ( $property ) : boolean
onCreateCommand ( $param )	Raised when a command is prepared and parameter binding is completed.
onDelete ( $param )	Raised before the record attempt to delete its data from the database.
onExecuteCommand ( $param )	Raised when a command is executed and the result from the database was returned.
onInsert ( $param )	Raised before the record attempt to insert its data into the database.
onUpdate ( $param )	Raised before the record attempt to update its data in the database.
save ( ) : boolean	Saves the current record to the database, insert or update is automatically determined.
setColumnValue ( $columnName, $value )	Sets the column value according to column name.
setDbConnection ( $connection )
setInvalidFinderResult ( $value )	Define the way an active record finder react if an invalid magic-finder invoked
toArray ( ) : array	Return record data as array
toJSON ( ) : JSON	Return record data as JSON

Защищенные методы

Метод	Описание
createRelationContext ( $name ) : TActiveRecordRelationContext	Gets a static copy of the relationship context for given property (a key in $RELATIONS), returns null if invalid relationship. Keeps a null reference to all invalid relations called.
fetchResultsFor ( $property ) : boolean	Tries to load the relationship results for the given property. The $property value should correspond to an entry key in the $RELATION array.
getRecordCriteria ( $criteria, $parameters, $args = [] ) : TSqlCriteria	Create a new TSqlCriteria object from a string $criteria. The $args are additional parameters and are used in place of the $parameters if $parameters is not an array and $args is an arrary.
getRelationHandler ( $name, $args = [] ) : TActiveRecordRelation,	Returns the active record relationship handler for $RELATION with key value equal to the $property value.
populateObject ( $data ) : TActiveRecord	Populates a new record with the query result.
populateObjects ( $reader ) : array

Приватные методы

Метод	Описание
setupColumnMapping ( )
setupRelations ( )

Описание методов

Описание свойств