CStatRelation
| Package | system.db.ar |
|---|---|
| Inheritance | class CStatRelation » CBaseActiveRelation » CComponent |
| Source Code | framework/db/ar/CActiveRecord.php |
CStatRelation represents a statistical relational query.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| className | string | name of the related active record class | CBaseActiveRelation |
| condition | string | WHERE clause. | CBaseActiveRelation |
| defaultValue | mixed | the default value to be assigned to those records that do not receive a statistical query result. | CStatRelation |
| 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 |
| 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 |
| scopes | mixed | scopes to apply Can be set to the one of the following:
|
CStatRelation |
| select | string | the statistical expression. | CStatRelation |
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. | CStatRelation |
| raiseEvent() | Raises an event. | CComponent |
Property Details
defaultValue property
public mixed $defaultValue;the default value to be assigned to those records that do not receive a statistical query result. Defaults to 0.
scopes property (available since v1.1.16)
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').
select property
public string $select;the statistical expression. Defaults to 'COUNT(*)', meaning the count of child objects.
Method Details
mergeWith() method
|
||
| $criteria | array | the dynamically specified criteria |
| $fromScope | boolean | whether the criteria to be merged is from scopes |
Source Code: framework/db/ar/CActiveRecord.php#2119 (show)
public function mergeWith($criteria,$fromScope=false)
{
if($criteria instanceof CDbCriteria)
$criteria=$criteria->toArray();
parent::mergeWith($criteria,$fromScope);
if(isset($criteria['defaultValue']))
$this->defaultValue=$criteria['defaultValue'];
}Merges this relation with a criteria specified dynamically.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CStatRelation