Как дебажить PHP - История изменений

Vitaliks в 13:42, 2 октября 2020

2020-10-02T13:42:58Z

Vitaliks в 14:04, 21 января 2020

2020-01-21T14:04:09Z

Vitaliks: Добавлен раздел получения информации об используемом классе, методе или функции

2020-01-21T14:03:03Z

Добавлен раздел получения информации об используемом классе, методе или функции

Vitaliks в 14:32, 15 января 2020

2020-01-15T14:32:44Z

Vitaliks: ¯\_(ツ)_/¯

2018-07-31T13:20:14Z

¯\_(ツ)_/¯

Новая страница

===Отладка ошибки 500 при помощи register_shutdown_function===

Иногда причину 500 ошибки можно определить при помощи вывода последней ошибки, которая произошла перед завершением скрипта. Для ее вывода в начало выполняемого PHP файла необходимо добавить следующий код:

<source lang="php">
register_shutdown_function(function(){
if (error_get_last()) {
var_export(error_get_last());
}
});
</source>

Данный код регистрирует функцию, которая будет выполняться по завершении скрипта. В функции происходит вывод последней ошибки, которая была зафиксирована при выполнении скрипта.

[http://php.net/manual/ru/function.register-shutdown-function.php Документация по register_shutdown_function]

===Вывод данных отладки в браузере===
Наиболее простой способ вывести любую переменную это функции '''print_r()''', '''var_dump()''' и '''var_export()'''

'''print_r()''' - выводит структуру переменной в удобочитаемом виде

[http://php.net/manual/ru/function.print-r.php Документация по print_r]

'''var_dump()''' - также выводит тип данных для всех переменных

[http://php.net/manual/ru/function.var-dump.php Документация по var_dump]

'''var_export()''' - выводит структуру переменно в формате пригодным для выполнения в PHP

[http://php.net/manual/ru/function.var-export.php Документация var_export]

По умолчанию выводы этих функций используют '\n' в качестве переносов на новую строку.

Так как в браузере эти символы удаляются, то для того, чтобы результат было удобно читать, можно поместить его в тег <pre>

<source lang="php">
echo '<pre>';
print_r($var);
echo '</pre>';
</source>
или так
<source lang="php">
echo '<pre>' . print_r($var, true) . '</pre>';
</source>
В качестве второго аргумента для функций '''print_r()''' и '''var_export()''' можно указать true, если необходимо, чтобы функция возвращала результат, а не выводила его.

Код:
<source lang="php">
echo '<pre>';
print_r($variables['user']);
var_dump($variables['user']);
var_export($variables['user']);
echo '</pre>';
</source>

Результат вывода:

<source lang="php">
Array
(
[id] => 3
[type] => guest
)
array(2) {
["id"]=>
int(3)
["type"]=>
string(5) "guest"
}
array (
'id' => 3,
'type' => 'guest',
)
</source>

Иногда необходимо вывести все доступные в текущей области видимости переменные, в этом случае можно воспользоваться функцией get_defined_vars

[http://php.net/manual/ru/function.get-defined-vars.php Документация по get_defined_vars]

===Вывод данных отладки в файл===

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

Для записи данных отладки в файл нам поможет функция file_put_contents, можно использовать ее со следующими аргументами:

<source lang="php">
file_put_contents("umitest", print_r($variable, true)."\n", FILE_APPEND | LOCK_EX);
</source>

В результате выполнения данной функции рядом с файлом, из которого было запущено выполнение PHP (обычно это index.php в корне сайта), будет создан файл umitest в который запишется содержимое переменной $variable.

FILE_APPEND - сообщает о том, что данные необходимо записывать в конец файла, без него файл будет каждый раз перезаписываться.

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

Можно вывести в файл все переменные, доступные в текущей области видимости:

<source lang="php">
file_put_contents("umitest", print_r(get_defined_vars(), true)."\n", FILE_APPEND | LOCK_EX);
</source>

или только некоторые из них

<source lang="php">
file_put_contents("umitest", print_r([$var1,$var2], true)."\n", FILE_APPEND | LOCK_EX);
</source>

[http://php.net/manual/ru/function.file-put-contents.php Документация по file_put_contents]

===Получить стек вызова функции при помощи debug_backtrace===

Данная функция может помочь нам, если мы знаем, какая функция вызывается, но не знаем, откуда она вызывается, а также просто проследить цепочку вызова функций.
При вызове этой функции без параметров можно легко получить переполнение памяти, поэтому необходимо вызвать эту функцию с указанием первого аргумента DEBUG_BACKTRACE_IGNORE_ARGS

<source lang="php">
$debug_arr = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS)
</source>

Также в качестве второго аргумента можно указать глубину стека.

Стек вызова можно вывести как в браузер:

<source lang="php">
echo '<pre>' . print_r(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS), true) . '</pre>';
</source>

так и записывать в файл:

<source lang="php">
file_put_contents("umitest", print_r(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS), true), FILE_APPEND | LOCK_EX);
</source>

[http://php.net/manual/ru/function.debug-backtrace.php Документация по debug_backtrace]

===Время выполнения скрипта===

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

<source lang="php">
$start = microtime(true);
// тут код время выполнения которого необходимо посчитать
$stop = microtime(true) - $start;
file_put_contents("umitest", print_r($stop, true)."\n", FILE_APPEND | LOCK_EX);
</source>

[http://php.net/manual/ru/function.microtime.php Документация по microtime]

[[category:Решение проблем и ошибок]][[Категория:Вопросы и уроки разработки сайтов на UMI.CMS]]

@@ Строка 85: / Строка 85: @@
 <source lang="php">
-file_put_contents("umitest", print_r([__FILE__.' '.__LINE__, $variable], true)."\n", FILE_APPEND | LOCK_EX);
+file_put_contents("umitest", print_r([__FILE__.' '.__LINE__, $variable], true).PHP_EOL, FILE_APPEND | LOCK_EX);
 </source>
@@ Строка 107: / Строка 107: @@
 <source lang="php">
-file_put_contents("umitest", print_r([__FILE__.' '.__LINE__, get_defined_vars()], true)."\n", FILE_APPEND | LOCK_EX);
+file_put_contents("umitest", print_r([__FILE__.' '.__LINE__, get_defined_vars()], true).PHP_EOL, FILE_APPEND | LOCK_EX);
 </source>
@@ Строка 113: / Строка 113: @@
 <source lang="php">
-file_put_contents("umitest", print_r([__FILE__.' '.__LINE__, $var1, $var2], true)."\n", FILE_APPEND | LOCK_EX);
+file_put_contents("umitest", print_r([__FILE__.' '.__LINE__, $var1, $var2], true).PHP_EOL, FILE_APPEND | LOCK_EX);
 </source>
@@ Строка 201: / Строка 201: @@
 // тут код время выполнения которого необходимо посчитать
 $stop = microtime(true) - $start;
-file_put_contents("umitest", print_r([__FILE__.' '.__LINE__, $stop], true)."\n", FILE_APPEND | LOCK_EX);
+file_put_contents("umitest", print_r([__FILE__.' '.__LINE__, $stop], true).PHP_EOL, FILE_APPEND | LOCK_EX);
 </source>

@@ Строка 145: / Строка 145: @@
 ===Получить расположение используемого класса, метода или функции===
-Стек вызовов дает информацию откуда была вызвана функция, но иногда необходимо узнать где находится используемый в коде класс, метод или функция. Для решения этой задачи в PHP есть специальные классы ReflectionMethod, методы которого дают возможность получить всю необходимую для этого информацию.
+Стек вызовов дает информацию откуда была вызвана функция, но иногда необходимо узнать где находится используемый в коде класс, метод или функция. Для решения этой задачи в PHP есть специальные классы ReflectionFunction, ReflectionClass и ReflectionMethod, методы которых дают возможность получить всю необходимую для этого информацию.
 ====Информация о функции====

← Предыдущая		Версия 14:03, 21 января 2020
Строка 142:		Строка 142:

	[http://php.net/manual/ru/function.debug-backtrace.php Документация по debug_backtrace]		[http://php.net/manual/ru/function.debug-backtrace.php Документация по debug_backtrace]
		+
		+	===Получить расположение используемого класса, метода или функции===
		+
		+	Стек вызовов дает информацию откуда была вызвана функция, но иногда необходимо узнать где находится используемый в коде класс, метод или функция. Для решения этой задачи в PHP есть специальные классы ReflectionMethod, методы которого дают возможность получить всю необходимую для этого информацию.
		+
		+	====Информация о функции====
		+
		+	<source lang="php">
		+	$reflectionMethod = new ReflectionFunction('function_name');
		+	file_put_contents("umitest", print_r([__FILE__.' '.__LINE__, $reflectionMethod->getFileName(), $reflectionMethod->getStartLine()], true), FILE_APPEND \| LOCK_EX);
		+	</source>
		+
		+	Этот код запишет в файл umitest путь до файла и номер строки в нем в которой находится функция 'function_name'.
		+
		+	[https://www.php.net/manual/ru/class.reflectionfunction.php Документация по ReflectionFunction]
		+
		+	====Информация о классе====
		+
		+	<source lang="php">
		+	$reflectionClass = new ReflectionClass('class_name');
		+	file_put_contents("umicheck", print_r([__FILE__.' '.__LINE__, $reflectionClass->getFileName(), $reflectionClass->getStartLine()], true), FILE_APPEND \| LOCK_EX);
		+	</source>
		+
		+	Этот код запишет в файл umitest путь до файла и номер строки в нем в которой находится класс 'class_name'.
		+
		+	[https://www.php.net/manual/ru/class.reflectionclass.php Документация по ReflectionClass]
		+
		+	====Информация о методе====
		+
		+	<source lang="php">
		+	$reflectionMethod = new ReflectionMethod('class_name', 'method_name');
		+	file_put_contents("umicheck", print_r([__FILE__.' '.__LINE__, $reflectionMethod->getFileName(), $reflectionMethod->getStartLine()], true), FILE_APPEND \| LOCK_EX);
		+	</source>
		+
		+	Этот код запишет в файл umitest путь до файла и номер строки в нем в которой находится метод 'method_name' класса 'class_name'.
		+
		+	Первым аргументом при создании ReflectionMethod можно передавать не только имя класса, но и его экземпляр, например:
		+
		+	<source lang="php">
		+	namespace DebugNamespace;
		+
		+	$className = new class_name();
		+	$reflectionMethod = new \ReflectionMethod($className, 'method_name');
		+	file_put_contents("umicheck", print_r([__FILE__.' '.__LINE__, $reflectionMethod->getFileName(), $reflectionMethod->getStartLine()], true), FILE_APPEND \| LOCK_EX);
		+	</source>
		+
		+	Обратите внимание, что в данном случае в файле задан namespace 'DebugNamespace', поэтому при получении экземпляра класса \ReflectionMethod необходимо наличие косой черты в начале иначе произойдет ошибка:
		+	Ошибка (Error): Class 'DebugNamespace\ReflectionMethod' not found
		+
		+	[https://www.php.net/manual/ru/class.reflectionmethod.php Документация по ReflectionMethod]

	===Время выполнения скрипта===		===Время выполнения скрипта===