Класс Debugger

__construct()source public

__construct( )

Конструктор.

_array()source protected static

_array( array $var , integer $depth , integer $indent )

Экспорт объекта типа массив. Фильтрует ключи, используемые в конфигурации источника данных.

Следующие ключи заменяются на ***:

• password
• login
• host
• database
• port
• prefix
• schema

Параметры

массив $var

Массив для экспорта.

целое число $depth

Текущая глубина, используемая для отслеживания рекурсии.

целое число $indent

Текущий уровень отступа.

Возвращает

строка
Экспортированный массив.

_export()source protected static

_export( mixed $var , integer $depth , integer $indent )

Защищённая функция экспорта, используемая для отслеживания отступов и рекурсии.

Параметры

смешанное $var

Переменная для вывода.

целое число $depth

Остаток глубины.

целое число $indent

Текущий уровень отступа.

Возвращает

строка
Вывод переменной.

_highlight()source protected static

_highlight( string $str )

Оборачивает функцию highlight_string, на случай, если серверная API не реализует эту функцию, как это происходит в случае интерпретатора HipHop.

Параметры

строка $str

Строка для преобразования.

Возвращает

строка

_object()source protected static

_object( string $var , integer $depth , integer $indent )

Обработка преобразования объекта в строку.

Параметры

строка $var

Объект для преобразования.

целое число $depth

Текущая глубина, используемая для отслеживания рекурсии.

целое число $indent

Текущий уровень отступа.

Возвращает

строка

См. также

\Cake\Error\Debugger::exportVar()

addFormat()source public static

addFormat( string $format , array $strings )

Добавить формат вывода или обновить формат в Debugger.

Debugger::addFormat('custom', $data);

Где $data — массив строк, использующих замену переменных Text::insert(). Переменные шаблона должны быть в формате {:id}. Форматтер ошибок может иметь следующие ключи:

• 'error' — используется для контейнера сообщения об ошибке. Получает следующие переменные шаблона: id, error, code, description, path, line, links, info
• 'info' — сочетание code, context и trace. Будет заполняться содержимым других ключей шаблона.
• 'trace' — контейнер для трассировки стека. Получает следующие переменные шаблона: trace
• 'context' — контейнер для переменных контекста. Получает следующие шаблоны: id, context
• 'links' — массив HTML-ссылок, используемых для создания ссылок на другие ресурсы. Обычно используется для создания javascript-ссылок для открытия других разделов. Ключи ссылок: code, context, help. См. пример формата вывода js.
• 'traceLine' — используется для создания строк в трассировке стека. Получает следующие переменные шаблона: reference, path, line

В качестве альтернативы, если вы хотите использовать пользовательский обратный вызов для форматирования, вы можете использовать ключ callback и указать вызываемый объект:

Debugger::addFormat('custom', ['callback' => [$foo, 'outputError']];

Обратный вызов может ожидать два параметра. Первый — массив всех данных об ошибке. Второй — отформатированные строки, сгенерированные с использованием других строк шаблона. Ключи, такие как info, links, code, context и trace, будут присутствовать в зависимости от других шаблонов в типе формата.

Параметры

строка $format

Используемый формат, включая 'js' для JavaScript-обогащённого HTML, 'html' для простого HTML-вывода или 'txt' для неформатированного текста.

массив $strings

Строки шаблона или обратный вызов, используемый для формата вывода.

Возвращает

массив
Набор установленных строк формата.

checkSecurityKeys()source public static

checkSecurityKeys( )

Проверяет, что соль и значение начального цикла приложения были изменены с значения по умолчанию.

dump()source public static

dump( mixed $var , integer $depth 3 )

Рекурсивно форматирует и выводит содержимое переданной переменной.

Параметры

смешанный $var

Переменная для вывода.

целое число $depth необязательно 3

Глубина вывода. По умолчанию 3.

См. также

\Cake\Error\Debugger::exportVar()

Ссылка

http://book.cakephp.org/3.0/ru/development/debugging.html#outputting-values

excerpt()source public static

excerpt( string $file , integer $line , integer $context 2 )

Извлекает фрагмент из файла и выделяет указанную строку кода.

Использование:

Debugger::excerpt('/path/to/file', 100, 4);

Выше приведен пример, который вернёт массив из 8 элементов. Четвёртый элемент будет предоставленной строкой, заключённой в <span class="code-highlight"></span>. Все строки также обрабатываются с помощью highlight_string(), поэтому они имеют базовую подсветку синтаксиса PHP.

Параметры

строка $file

Полный путь к файлу PHP.

целое число $line

Номер строки для выделения.

целое число $context необязательно 2

Количество строк контекста, извлекаемых выше и ниже $line.

Возвращает

массив
Набор выделенных строк

См. также

http://php.net/highlight_string

Ссылка

http://book.cakephp.org/3.0/ru/development/debugging.html#getting-an-excerpt-from-a-file

exportVar()source public static

exportVar( string $var , integer $depth 3 )

Преобразует переменную в строку для вывода отладки.

Примечание: следующие ключи будут иметь своё содержимое заменённое на *****:

• password
• login
• host
• database
• port
• prefix
• schema

Это делается для защиты данных для подключения к базе данных, которые могут случайно отобразиться в сообщении об ошибке, если CakePHP развернут в режиме разработки.

Параметры

строка $var

Переменная для преобразования.

целое число $depth необязательно 3

Глубина вывода. По умолчанию 3.

Возвращает

строка
Переменная в формате строки

formatTrace()source public static

formatTrace( array|Exception $backtrace , array $options [] )

Форматирует трассировку стека на основе переданных параметров.

Параметры

• depth - Количество кадров стека для возврата. По умолчанию 999
• format - Формат для возврата. По умолчанию — текущий выбранный формат. Если формат 'array' или 'points', результат будет массивом.
• args - Показывать аргументы функций? Если true, будут отображены аргументы каждого вызова метода.
• start - Кадр стека для начала генерации трассировки. По умолчанию 0

Параметры

массив|Исключение $backtrace

Трассировка как массив или объект исключения.

массив $options необязательно []

Формат для вывода трассировки стека.

Возвращает

смешанный
Отформатированная трассировка стека.

Ссылка

http://book.cakephp.org/3.0/ru/development/debugging.html#generating-stack-traces

getInstance()source public static

getInstance( string|null $class null )

Возвращает ссылку на объект синглтона Debugger.

Параметры

строка|null $class необязательно null

Имя класса.

Возвращает

объект

getType()source public static

getType( mixed $var )

Получает тип заданной переменной. Вернёт имя класса для объектов.

Параметры

смешанный $var

Переменная, тип которой нужно получить.

Возвращает

строка
Тип переменной.

log()source public static

log( mixed $var , integer|string $level 'debug' , integer $depth 3 )

Создаёт запись в файле журнала. Запись журнала будет содержать трассировку стека от места вызова, а также экспортирует переменную с использованием exportVar. По умолчанию журнал записывается в лог отладки.

Параметры

смешанный $var

Переменная или содержимое для записи в журнал.

целое число|строка $level необязательно 'debug'

Тип журнала. По умолчанию 'debug'.

целое число $depth необязательно 3

Глубина вывода. По умолчанию 3.

outputAs()source public static

outputAs( string|null $format null )

Получение/установка формата вывода для Debugger при отображении ошибок.

Параметры

строка|null $format необязательно null

Формат вывода ошибок. Если null, возвращается текущий формат.

Возвращает

строка|null
Возвращает null при установке. Возвращает текущий формат при получении.

Исключения

InvalidArgumentException
При выборе формата, которого не существует.

outputError()source public

outputError( string $data )

Принимает обработанный массив данных из ошибки и отображает его в выбранном формате.

Параметры

строка $data

Данные для вывода.

printVar()source public static

printVar( mixed $var , array $location [] , boolean|null $showHtml null )

Выводит отладочную информацию о заданной переменной.

Параметры

mixed $var

Переменная, для которой требуется показать отладочную информацию.

array $location необязательно []

Если содержит ключи "file" и "line", их значения будут использованы для отображения информации о местоположении.

boolean|null $showHtml необязательно null

Если установлено в true, метод выводит отладочные данные в удобном для браузера формате.

trace()source public static

trace( array $options [] )

Выводит трассировку стека, основанную на предоставленных параметрах.

Параметры

• depth - Количество кадров стека для возврата. По умолчанию 999
• format - Формат возвращаемого значения. По умолчанию используется текущий выбранный формат. Если формат 'array' или 'points', возвращаемое значение будет массивом.
• args - Показывать аргументы функций? Если true, будут отображаться аргументы каждого вызова метода.
• start - Кадр стека, с которого начинается генерация трассировки. По умолчанию 0

Параметры

array $options необязательно []

Формат для вывода трассировки стека.

Возвращает

mixed
Отформатированная трассировка стека.

Ссылка

http://book.cakephp.org/3.0/ru/development/debugging.html#generating-stack-traces

trimPath()source public static

trimPath( string $path )

Укорачивает пути к файлам, заменяя путь к корневой папке приложения на 'APP', а путь к ядру CakePHP на 'CORE'.

Параметры

string $path

Путь для укорачивания.

Возвращает

string
Нормализованный путь

[]

'js'

[
    'log' => [
        'trace' => '{:reference} - {:path}, line {:line}',
        'error' => "{:error} ({:code}): {:description} in [{:file}, line {:line}]"
    ],
    'js' => [
        'error' => '',
        'info' => '',
        'trace' => '<pre class="stack-trace">{:trace}</pre>',
        'code' => '',
        'context' => '',
        'links' => [],
        'escapeContext' => true,
    ],
    'html' => [
        'trace' => '<pre class="cake-error trace"><b>Trace</b> <p>{:trace}</p></pre>',
        'context' => '<pre class="cake-error context"><b>Context</b> <p>{:context}</p></pre>',
        'escapeContext' => true,
    ],
    'txt' => [
        'error' => "{:error}: {:code} :: {:description} on line {:line} of {:path}\n{:info}",
        'code' => '',
        'info' => ''
    ],
    'base' => [
        'traceLine' => '{:reference} - {:path}, line {:line}',
        'trace' => "Trace:\n{:trace}\n",
        'context' => "Context:\n{:context}\n",
    ]
]

[]