CActiveRelation

Package	system.db.ar
Inheritance	class CActiveRelation » CBaseActiveRelation » CComponent
Subclasses	CBelongsToRelation, CHasManyRelation, CHasOneRelation
Since	1.0
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

Property	Type	Description	Defined By
alias	string	the alias for the table that this relation refers to.	CActiveRelation
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
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
scopes	mixed	scopes to apply Can be set to the one of the following: Single scope: 'scopes'=>'scopeName'.	CActiveRelation
select	mixed	list of column names (an array, or a string of names separated by commas) to be selected.	CBaseActiveRelation
through	string	the name of the relation that should be used as the bridge to this relation.	CActiveRelation
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

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

Property Details

alias property

public string $alias;

the alias for the table that this relation refers to. Defaults to null, meaning the alias will be the same as the relation name.

joinType property

public string $joinType;

join type. Defaults to 'LEFT OUTER JOIN'.

on property

public string $on;

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

scopes property (available since v1.1.9)

public mixed $scopes;

scopes to apply Can be set to the one of the following:

Single scope: 'scopes'=>'scopeName'.
Multiple scopes: 'scopes'=>array('scopeName1','scopeName2').

through property (available since v1.1.7)

public string $through;

the name of the relation that should be used as the bridge to this relation. Defaults to null, meaning don't use any bridge.

together property

public boolean $together;

whether this table should be joined with the primary table. When setting this property to be false, the table associated with this relation will appear in a separate JOIN statement. If this property is set true, then the corresponding table will ALWAYS be joined together with the primary table, no matter the primary table is limited or not. If this property is not set, the corresponding table will be joined with the primary table only when the primary table is not limited.

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

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

Source Code: framework/db/ar/CActiveRecord.php#2189 (show)


public function mergeWith($criteria,$fromScope=false)
{
    if($criteria instanceof CDbCriteria)
        $criteria=$criteria->toArray();
    if($fromScope)
    {
        if(isset($criteria['condition']) && $this->on!==$criteria['condition'])
        {
            if($this->on==='')
                $this->on=$criteria['condition'];
            elseif($criteria['condition']!=='')
                $this->on="({$this->on}) AND ({$criteria['condition']})";
        }
        unset($criteria['condition']);
    }

    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'];
        elseif($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['together']))
        $this->together=$criteria['together'];
}

Merges this relation with a criteria specified dynamically.

User Contributed Notes