0 follower

CActiveRelation

Package system.db.ar
Inheritance class CActiveRelation » CBaseActiveRelation » CComponent
Subclasses CBelongsToRelation, CHasManyRelation, CHasOneRelation
Since 1.0
Version $Id$
Source Code framework/db/ar/CActiveRecord.php
CActiveRelation is the base class for representing active relations that bring back related objects.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
alias string the alias for the table that this relation refers to. CActiveRelation
aliasToken string the column prefix placeholder. CActiveRelation
className string name of the related active record class CBaseActiveRelation
condition string WHERE clause. CBaseActiveRelation
foreignKey string the foreign key in this relation CBaseActiveRelation
group string GROUP BY clause. CBaseActiveRelation
having string HAVING clause. CBaseActiveRelation
joinType string join type. CActiveRelation
name string name of the related object CBaseActiveRelation
on string ON clause. CActiveRelation
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
together boolean whether this table should be joined with the primary table. CActiveRelation
with string|array specifies which related objects should be eagerly loaded when this related object is lazily loaded. CActiveRelation

Public Methods

Hide inherited methods

MethodDescriptionDefined 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
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. CActiveRelation
raiseEvent() Raises an event. CComponent

Property Details

alias property (available since v1.0.1)
public string $alias;

the alias for the table that this relation refers to. Defaults to null, meaning the alias will be generated automatically. If you set this property explicitly, make sure the alias is unique globally.

See Also

aliasToken property
public string $aliasToken;

the column prefix placeholder. It will be replaced by the corresponding table alias.

See Also

joinType property
public string $joinType;

join type. Defaults to 'LEFT OUTER JOIN'.

on property (available since v1.0.2)
public string $on;

ON clause. The condition specified here will be appended to the joining condition using AND operator.

together property (available since v1.0.3)
public boolean $together;

whether this table should be joined with the primary table. If not set or false, Each HAS_MANY or MANY_MANY table will appear in a separate JOIN statement. Defaults to null.

with property
public string|array $with;

specifies which related objects should be eagerly loaded when this related object is lazily loaded. For more details about this property, see CActiveRecord::with().

Method Details

mergeWith() method (available since v1.0.5)
public void mergeWith(array $criteria)
$criteria array the dynamically specified criteria
Source Code: framework/db/ar/CActiveRecord.php#2108 (show)
public function mergeWith($criteria)
{
    parent::mergeWith($criteria);

    if(isset($criteria['joinType']))
        $this->joinType=$criteria['joinType'];

    if(isset($criteria['on']) && $this->on!==$criteria['on'])
    {
        if($this->on==='')
            $this->on=$criteria['on'];
        else if($criteria['on']!=='')
            $this->on="({$this->on}) AND ({$criteria['on']})";
    }

    if(isset($criteria['with']))
        $this->with=$criteria['with'];

    if(isset($criteria['alias']))
        $this->alias=$criteria['alias'];

    if(isset($criteria['aliasToken']))
        $this->aliasToken=$criteria['aliasToken'];

    if(isset($criteria['together']))
        $this->together=$criteria['together'];
}

Merges this relation with a criteria specified dynamically.