CBaseActiveRelation
| Package | system.db.ar |
|---|---|
| Inheritance | class CBaseActiveRelation » CComponent |
| Subclasses | CActiveRelation, CStatRelation |
| Source Code | framework/db/ar/CActiveRecord.php |
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| className | string | name of the related active record class | CBaseActiveRelation |
| condition | string | WHERE clause. | CBaseActiveRelation |
| foreignKey | mixed | the foreign key in this relation | CBaseActiveRelation |
| group | string | GROUP BY clause. | CBaseActiveRelation |
| having | string | HAVING clause. | CBaseActiveRelation |
| join | string | how to join with other tables. | CBaseActiveRelation |
| joinOptions | string|array | property for setting post-JOIN operations such as USE INDEX. | CBaseActiveRelation |
| name | string | name of the related object | CBaseActiveRelation |
| order | string | ORDER BY clause. | CBaseActiveRelation |
| params | array | the parameters that are to be bound to the condition. | CBaseActiveRelation |
| select | mixed | list of column names (an array, or a string of names separated by commas) to be selected. | CBaseActiveRelation |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CBaseActiveRelation |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| mergeWith() | Merges this relation with a criteria specified dynamically. | CBaseActiveRelation |
| raiseEvent() | Raises an event. | CComponent |
Property Details
className property
public string $className;
name of the related active record class
condition property
public string $condition;
WHERE clause. For CActiveRelation descendant classes, column names referenced in the condition should be disambiguated with prefix 'relationName.'.
foreignKey property
public mixed $foreignKey;
the foreign key in this relation
group property
public string $group;
GROUP BY clause. For CActiveRelation descendant classes, column names referenced in this property should be disambiguated with prefix 'relationName.'.
having property
public string $having;
HAVING clause. For CActiveRelation descendant classes, column names referenced in this property should be disambiguated with prefix 'relationName.'.
join property (available since v1.1.3)
public string $join;
how to join with other tables. This refers to the JOIN clause in an SQL statement. For example, 'LEFT JOIN users ON users.id=authorID'.
joinOptions property (available since v1.1.16)
public string|array $joinOptions;
property for setting post-JOIN operations such as USE INDEX. String typed value can be used with JOINs for HAS_MANY and MANY_MANY relations, while array typed value designed to be used only with MANY_MANY relations. First array element will be used for junction table JOIN and second array element will be used for target table JOIN.
name property
public string $name;
name of the related object
order property
public string $order;
ORDER BY clause. For CActiveRelation descendant classes, column names referenced in this property should be disambiguated with prefix 'relationName.'.
params property
public array $params;
the parameters that are to be bound to the condition. The keys are parameter placeholder names, and the values are parameter values.
select property
public mixed $select;
list of column names (an array, or a string of names separated by commas) to be selected. Do not quote or prefix the column names unless they are used in an expression. In that case, you should prefix the column names with 'relationName.'.
Method Details
__construct() method
public void __construct(string $name, string $className, string $foreignKey, array $options=array ( )) | ||
| $name | string | name of the relation |
| $className | string | name of the related active record class |
| $foreignKey | string | foreign key for this relation |
| $options | array | additional options (name=>value). The keys must be the property names of this class. |
public function __construct($name,$className,$foreignKey,$options=array())
{
$this->name=$name;
$this->className=$className;
$this->foreignKey=$foreignKey;
foreach($options as $name=>$value)
$this->$name=$value;
}
Constructor.
mergeWith() method
public void mergeWith(array $criteria, boolean $fromScope=false) | ||
| $criteria | array | the dynamically specified criteria |
| $fromScope | boolean | whether the criteria to be merged is from scopes |
public function mergeWith($criteria,$fromScope=false)
{
if($criteria instanceof CDbCriteria)
$criteria=$criteria->toArray();
if(isset($criteria['select']) && $this->select!==$criteria['select'])
{
if($this->select==='*'||$this->select===false)
$this->select=$criteria['select'];
elseif($criteria['select']===false)
$this->select=false;
elseif($criteria['select']!=='*')
{
$select1=is_string($this->select)?preg_split('/\s*,\s*/',trim($this->select),-1,PREG_SPLIT_NO_EMPTY):$this->select;
$select2=is_string($criteria['select'])?preg_split('/\s*,\s*/',trim($criteria['select']),-1,PREG_SPLIT_NO_EMPTY):$criteria['select'];
$this->select=array_merge($select1,array_diff($select2,$select1));
}
}
if(isset($criteria['condition']) && $this->condition!==$criteria['condition'])
{
if($this->condition==='')
$this->condition=$criteria['condition'];
elseif($criteria['condition']!=='')
$this->condition="({$this->condition}) AND ({$criteria['condition']})";
}
if(isset($criteria['params']) && $this->params!==$criteria['params'])
$this->params=array_merge($this->params,$criteria['params']);
if(isset($criteria['order']) && $this->order!==$criteria['order'])
{
if($this->order==='')
$this->order=$criteria['order'];
elseif($criteria['order']!=='')
$this->order=$criteria['order'].', '.$this->order;
}
if(isset($criteria['group']) && $this->group!==$criteria['group'])
{
if($this->group==='')
$this->group=$criteria['group'];
elseif($criteria['group']!=='')
$this->group.=', '.$criteria['group'];
}
if(isset($criteria['join']) && $this->join!==$criteria['join'])
{
if($this->join==='')
$this->join=$criteria['join'];
elseif($criteria['join']!=='')
$this->join.=' '.$criteria['join'];
}
if(isset($criteria['having']) && $this->having!==$criteria['having'])
{
if($this->having==='')
$this->having=$criteria['having'];
elseif($criteria['having']!=='')
$this->having="({$this->having}) AND ({$criteria['having']})";
}
}
Merges this relation with a criteria specified dynamically.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CBaseActiveRelation