CActiveRecordMetaData
| Package | system.db.ar |
|---|---|
| Inheritance | class CActiveRecordMetaData |
| Since | 1.0 |
| Version | $Id: CActiveRecord.php 3533 2012-01-08 22:07:55Z mdomba $ |
| Source Code | framework/db/ar/CActiveRecord.php |
CActiveRecordMetaData represents the meta-data for an Active Record class.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| attributeDefaults | array | attribute default values | CActiveRecordMetaData |
| columns | array | table columns | CActiveRecordMetaData |
| relations | array | list of relations | CActiveRecordMetaData |
| tableSchema | CDbTableSchema | the table schema information | CActiveRecordMetaData |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | Constructor. | CActiveRecordMetaData |
| addRelation() | Adds a relation. | CActiveRecordMetaData |
| hasRelation() | Checks if there is a relation with specified name defined. | CActiveRecordMetaData |
| removeRelation() | Deletes a relation with specified name. | CActiveRecordMetaData |
Property Details
attributeDefaults
property
public array $attributeDefaults;
attribute default values
columns
property
public array $columns;
table columns
relations
property
public array $relations;
list of relations
tableSchema
property
public CDbTableSchema $tableSchema;
the table schema information
Method Details
__construct()
method
|
public void __construct(CActiveRecord $model)
| ||
| $model | CActiveRecord | the model instance |
Source Code: framework/db/ar/CActiveRecord.php#2258 (show)
public function __construct($model)
{
$this->_model=$model;
$tableName=$model->tableName();
if(($table=$model->getDbConnection()->getSchema()->getTable($tableName))===null)
throw new CDbException(Yii::t('yii','The table "{table}" for active record class "{class}" cannot be found in the database.',
array('{class}'=>get_class($model),'{table}'=>$tableName)));
if($table->primaryKey===null)
{
$table->primaryKey=$model->primaryKey();
if(is_string($table->primaryKey) && isset($table->columns[$table->primaryKey]))
$table->columns[$table->primaryKey]->isPrimaryKey=true;
else if(is_array($table->primaryKey))
{
foreach($table->primaryKey as $name)
{
if(isset($table->columns[$name]))
$table->columns[$name]->isPrimaryKey=true;
}
}
}
$this->tableSchema=$table;
$this->columns=$table->columns;
foreach($table->columns as $name=>$column)
{
if(!$column->isPrimaryKey && $column->defaultValue!==null)
$this->attributeDefaults[$name]=$column->defaultValue;
}
foreach($model->relations() as $name=>$config)
{
$this->addRelation($name,$config);
}
}
Constructor.
addRelation()
method
(available since v1.1.2)
|
public void addRelation(string $name, array $config)
| ||
| $name | string | $name Name of the relation. |
| $config | array | $config Relation parameters. |
| {return} | void | |
Source Code: framework/db/ar/CActiveRecord.php#2307 (show)
public function addRelation($name,$config)
{
if(isset($config[0],$config[1],$config[2])) // relation class, AR class, FK
$this->relations[$name]=new $config[0]($name,$config[1],$config[2],array_slice($config,3));
else
throw new CDbException(Yii::t('yii','Active record "{class}" has an invalid configuration for relation "{relation}". It must specify the relation type, the related active record class and the foreign key.', array('{class}'=>get_class($this->_model),'{relation}'=>$name)));
}
Adds a relation.
$config is an array with three elements:
relation type, the related active record class and the foreign key.
hasRelation()
method
(available since v1.1.2)
|
public boolean hasRelation(string $name)
| ||
| $name | string | $name Name of the relation. |
| {return} | boolean | |
Source Code: framework/db/ar/CActiveRecord.php#2322 (show)
public function hasRelation($name)
{
return isset($this->relations[$name]);
}
Checks if there is a relation with specified name defined.
removeRelation()
method
(available since v1.1.2)
|
public void removeRelation(string $name)
| ||
| $name | string | $name |
| {return} | void | |
Source Code: framework/db/ar/CActiveRecord.php#2334 (show)
public function removeRelation($name)
{
unset($this->relations[$name]);
}
Deletes a relation with specified name.