Home » Documentation » Class Reference » CBaseActiveRelation

CBaseActiveRelation

Package	system.db.ar
Inheritance	class CBaseActiveRelation » CComponent
Subclasses	CActiveRelation, CStatRelation
Since	1.0.4
Version	$Id: CActiveRecord.php 2230 2010-06-25 20:16:41Z qiang.xue $

CBaseActiveRelation is the base class for all active relations.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
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
join	string	how to join with other tables.	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

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.	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 string $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'.

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.

Constructor.

mergeWith() method (available since v1.0.5)

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

Merges this relation with a criteria specified dynamically.