CActiveRelation
| Package | system.db.ar |
|---|---|
| Inheritance | class CActiveRelation » CComponent |
| Subclasses | CBelongsToRelation, CHasManyRelation, CHasOneRelation |
| Since | 1.0 |
| Version | $Id: CActiveRecord.php 725 2009-02-22 14:13:05Z qiang.xue $ |
Public Properties
| Property | Type | Description | Defined 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 | CActiveRelation |
| condition | string | WHERE clause. | CActiveRelation |
| foreignKey | string | the foreign key in this relation | CActiveRelation |
| joinType | string | join type. | CActiveRelation |
| name | string | name of the related object | CActiveRelation |
| on | string | ON clause. | CActiveRelation |
| order | string | ORDER BY clause. | CActiveRelation |
| params | array | the parameters that are to be bound to the condition. | CActiveRelation |
| select | string | list of column names (separated by commas) to be selected. | 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
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CActiveRelation |
| __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 |
| raiseEvent() | Raises an event. | CComponent |
Property Details
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
the column prefix placeholder. It will be replaced by the corresponding table alias.
See Also
name of the related active record class
WHERE clause. Column names referenced in the condition should be prefixed with '??.'.
the foreign key in this relation
join type. Defaults to 'LEFT OUTER JOIN'.
name of the related object
ON clause. The condition specified here will be appended to the joining condition using AND operator.
ORDER BY clause. Column names referenced here should be prefixed with '??.'.
the parameters that are to be bound to the condition. The keys are parameter placeholder names, and the values are parameter values.
list of column 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 '??.'.
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.
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
|
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.