CWebLogRoute
| Пакет | system.logging |
|---|---|
| Наследование | class CWebLogRoute » CLogRoute » CComponent |
| Подклассы | CProfileLogRoute |
| С версии | 1.0 |
| Исходный код | framework/logging/CWebLogRoute.php |
Содержимое лога может отображаться в конце текущей веб-страницы или в окне консоли FireBug (если showInFireBug установлено в true).
Свойства public
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| categories | mixed | массив категорий или строчный список, разделенный запятыми или пробелами. | CLogRoute |
| collapsedInFireBug | boolean | указывает, должно ли содержимое лога быть свернуто по умолчанию в Firebug. | CWebLogRoute |
| enabled | boolean | включено ли отображение лога. | CLogRoute |
| except | mixed | массив категорий или строчный список, разделенный запятыми или пробелами, которые ИСКЛЮЧАЮТСЯ из логов. | CLogRoute |
| filter | mixed | дополнительный фильтр (например, CLogFilter), который может быть применен к сообщениям лога. | CLogRoute |
| ignoreAjaxInFireBug | boolean | указывает, должен ли лог игнорироваться в FireBug для AJAX-запросов. | CWebLogRoute |
| ignoreFlashInFireBug | boolean | указывает, должен ли лог игнорироваться в FireBug для вызовов Flash/Flex. | CWebLogRoute |
| levels | string | список уровней, разделенных запятыми или пробелами. | CLogRoute |
| logs | array | логи, собранные до настоящего момента этим маршрутом логов. | CLogRoute |
| showInFireBug | boolean | указывает, должен ли лог отображаться в FireBug вместо окна браузера. | CWebLogRoute |
Методы public
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод, который не является методом класса. | CComponent |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| asa() | Возвращает объект поведения с заданным именем. | CComponent |
| attachBehavior() | Присоединяет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Присоединяет список поведений к компоненту. | CComponent |
| attachEventHandler() | Присоединяет обработчик событий к событию. | CComponent |
| canGetProperty() | Определяет, можно ли прочитать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| collectLogs() | Получает отфильтрованные сообщения лога из логгера для дальнейшей обработки. | CLogRoute |
| 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 |
| init() | Инициализирует маршрут. | CLogRoute |
| processLogs() | Отображает сообщения лога. | CWebLogRoute |
| raiseEvent() | Вызывает событие. | CComponent |
Методы protected
| Метод | Описание | Определено в |
|---|---|---|
| formatLogMessage() | Форматирует сообщение лога, учитывая различные поля. | CLogRoute |
| render() | Отображает представление. | CWebLogRoute |
Подробности свойств
collapsedInFireBug свойство (доступно с версии 1.1.13.)
public boolean $collapsedInFireBug;
указывает, должно ли содержимое лога быть свернуто по умолчанию в Firebug. По умолчанию false.
ignoreAjaxInFireBug свойство
public boolean $ignoreAjaxInFireBug;
указывает, должен ли лог игнорироваться в FireBug для AJAX-запросов. По умолчанию true. Этот параметр следует использовать с осторожностью, так как AJAX-запрос возвращает все данные в результате. Например, если AJAX-запрос ожидает результат типа JSON, любой вывод из логгера может привести к сбою AJAX-запроса.
ignoreFlashInFireBug свойство (доступно с версии 1.1.11)
public boolean $ignoreFlashInFireBug;
указывает, должен ли лог игнорироваться в FireBug для вызовов Flash/Flex. По умолчанию true. Этот параметр следует использовать с осторожностью, так как Flash/Flex вызов возвращает все данные в результате. Например, если вызов Flash/Flex ожидает результат типа XML, любой вывод из логгера может привести к сбою вызова Flash/Flex.
showInFireBug свойство
public boolean $showInFireBug;
указывает, должен ли лог отображаться в FireBug вместо окна браузера. По умолчанию false.
Подробности методов
processLogs() метод
public void processLogs(array $logs) | ||
| $logs | массив | список сообщений журнала |
public function processLogs($logs)
{
$this->render('log',$logs);
}
Отображает сообщения журнала.
render() метод
protected void render(string $view, array $data) | ||
| $view | строка | имя представления (имя файла без расширения). Файл предполагается расположенным в папке framework/data/views. |
| $data | массив | данные, которые будут переданы представлению |
protected function render($view,$data)
{
$app=Yii::app();
$isAjax=$app->getRequest()->getIsAjaxRequest();
$isFlash=$app->getRequest()->getIsFlashRequest();
if($this->showInFireBug)
{
// do not output anything for ajax and/or flash requests if needed
if($isAjax && $this->ignoreAjaxInFireBug || $isFlash && $this->ignoreFlashInFireBug)
return;
$view.='-firebug';
if(($userAgent=$app->getRequest()->getUserAgent())!==null && preg_match('/msie [5-9]/i',$userAgent))
{
echo '<script type="text/javascript">';
echo file_get_contents(dirname(__FILE__).'/../vendors/console-normalizer/normalizeconsole.min.js');
echo "</script>\n";
}
}
elseif(!($app instanceof CWebApplication) || $isAjax || $isFlash)
return;
$viewFile=YII_PATH.DIRECTORY_SEPARATOR.'views'.DIRECTORY_SEPARATOR.$view.'.php';
include($app->findLocalizedFile($viewFile,'en'));
}
Отображает представление.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CWebLogRoute