CActiveRelation
| Package | system.db.ar |
|---|---|
| Inheritance | class CActiveRelation » CBaseActiveRelation » CComponent |
| Subclasses | CBelongsToRelation, CHasManyRelation, CHasOneRelation |
| Since | 1.0 |
| Version | $Id: CActiveRecord.php 2230 2010-06-25 20:16:41Z qiang.xue $ |
CActiveRelation is the base class for representing active relations that bring back related objects.
Public 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 | 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 |
| 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 |
| with | string|array | specifies which related objects should be eagerly loaded when this related object is lazily loaded. | CActiveRelation |
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. | 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 the same as the relation name.
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.
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, 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.