CHasManyRelation
| Package | system.db.ar |
|---|---|
| Inheritance | class CHasManyRelation » CActiveRelation » CBaseActiveRelation » CComponent |
| Subclasses | CManyManyRelation |
| Since | 1.0 |
| Version | $Id: CActiveRecord.php 2230 2010-06-25 20:16:41Z qiang.xue $ |
CHasManyRelation represents the parameters specifying a HAS_MANY relation.
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 |
| index | string | the name of the column that should be used as the key for storing related objects. | CHasManyRelation |
| join | string | how to join with other tables. | CBaseActiveRelation |
| joinType | string | join type. | CActiveRelation |
| limit | integer | limit of the rows to be selected. | CHasManyRelation |
| name | string | name of the related object | CBaseActiveRelation |
| offset | integer | offset of the rows to be selected. | CHasManyRelation |
| 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. | CHasManyRelation |
| 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. | CHasManyRelation |
| raiseEvent() | Raises an event. | CComponent |
Property Details
index
property
(available since v1.0.7)
public string $index;
the name of the column that should be used as the key for storing related objects. Defaults to null, meaning using zero-based integer IDs.
limit
property
public integer $limit;
limit of the rows to be selected. It is effective only for lazy loading this related object. Defaults to -1, meaning no limit.
offset
property
public integer $offset;
offset of the rows to be selected. It is effective only for lazy loading this related object. Defaults to -1, meaning no offset.
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. Defaults to true, meaning the table will be joined together with the primary table. Note that in version 1.0.x, the default value of this property was false.
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.