CStatRelation
| Пакет | system.db.ar |
|---|---|
| Наследование | class CStatRelation » CBaseActiveRelation » CComponent |
| Исходный код | framework/db/ar/CActiveRecord.php |
CStatRelation представляет статистический реляционный запрос.
Свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| className | string | имя связанного класса активной записи | CBaseActiveRelation |
| condition | string | Запрос WHERE. | CBaseActiveRelation |
| defaultValue | mixed | значение по умолчанию, которое будет присвоено записям, не получившим результат статистического запроса. По умолчанию 0. | CStatRelation |
| foreignKey | mixed | внешний ключ в этом соотношении | CBaseActiveRelation |
| group | string | Запрос GROUP BY. | CBaseActiveRelation |
| having | string | Запрос HAVING. | CBaseActiveRelation |
| join | string | как присоединять к другим таблицам. | CBaseActiveRelation |
| joinOptions | string|array | свойство для задания операций после JOIN, таких как USE INDEX. | CBaseActiveRelation |
| name | string | имя связанного объекта | CBaseActiveRelation |
| order | string | Запрос ORDER BY. | CBaseActiveRelation |
| params | array | параметры, которые нужно связать с условием. | CBaseActiveRelation |
| scopes | mixed | применяемые области видимости. Могут быть заданы следующим образом:
| CStatRelation |
| select | string | статистическое выражение. | CStatRelation |
Методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CBaseActiveRelation |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства пустым. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| asa() | Возвращает объект поведения с указанным именем. | CComponent |
| attachBehavior() | Присоединяет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Присоединяет список поведений к компоненту. | CComponent |
| attachEventHandler() | Присоединяет обработчик событий к событию. | CComponent |
| canGetProperty() | Определяет, можно ли прочитать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| detachBehavior() | Отсоединяет поведение от компонента. | CComponent |
| detachBehaviors() | Отсоединяет все поведения от компонента. | CComponent |
| detachEventHandler() | Отсоединяет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает присоединенное поведение. | CComponent |
| disableBehaviors() | Отключает все присоединенные поведения к этому компоненту. | CComponent |
| enableBehavior() | Включает присоединенное поведение. | CComponent |
| enableBehaviors() | Включает все присоединенные поведения к этому компоненту. | CComponent |
| evaluateExpression() | Вычисляет выражение PHP или обратный вызов в контексте этого компонента. | CComponent |
| getEventHandlers() | Возвращает список присоединенных обработчиков событий для события. | CComponent |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, имеются ли присоединенные обработчики для события с заданным именем. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| mergeWith() | Объединяет это соотношение с динамически заданным критерием. | CStatRelation |
| raiseEvent() | Вызывает событие. | CComponent |
Подробное описание свойств
defaultValue свойство
public mixed $defaultValue;
значение по умолчанию, которое будет присвоено записям, не получившим результат статистического запроса. По умолчанию 0.
scopes свойство (доступно начиная с v1.1.16)
public mixed $scopes;
применяемые области видимости. Могут быть заданы следующим образом:
- Единая область видимости: 'scopes'=>'scopeName'.
- Несколько областей видимости: 'scopes'=>array('scopeName1','scopeName2').
select свойство
public string $select;
статистическое выражение. По умолчанию 'COUNT(*)', что означает количество дочерних объектов.
Подробное описание методов
mergeWith() метод
public void mergeWith(array $criteria, boolean $fromScope=false) | ||
| $criteria | array | динамически заданные критерии |
| $fromScope | boolean | являются ли критерии из областей видимости |
Исходный код: framework/db/ar/CActiveRecord.php#2119 (показать)
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'];
}
Объединяет это соотношение с динамически заданным критерием.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CStatRelation
