Отладка PHP кода выполняется самыми разными способами. Можно выводить информацию на экран, с помощью die или var_dump, с помощью файлов журнала, в которые пишутся сообщения об ошибках и предупреждения. Плохо то, что почти все перечисленные методы вносят нарушения в шаблон страниц и сообщения достаточно трудно вычленять в потоке другой информации.
Почему бы не использовать один инструмент для всех скриптов (и PHP и Javascript)? Таким инструментом может стать консоль JavaScript, которую можно использовать и для отладки PHP кода. Консоль входит в набор разработчика, который присутствует практически во всех современных браузерах по умолчанию или доступен в виде удобного дополнения. Она предоставляет собой отличный инструмент для цветного вывода с номером строки и всем, что нужно. А кроме того, можно выводить значения массивов и целых объектов в консоль.
Конечно, есть браузеры, в которых консоль отсутствует (например, IE) и инструмент отладки может нарушить процесс выполнения приложения. Но мы позаботимся, чтобы все проходило отлично.
Вот класс, который выполняет всю работу:
class PHPDebug {
function __construct() {
if (!defined("LOG")) define("LOG",1);
if (!defined("INFO")) define("INFO",2);
if (!defined("WARN")) define("WARN",3);
if (!defined("ERROR")) define("ERROR",4);
define("NL","\r\n");
echo '<script type="text/javascript">'.NL;
/// Данный код предназначен для браузеров без консоли
echo 'if (!window.console) console = {};';
echo 'console.log = console.log || function(){};';
echo 'console.warn = console.warn || function(){};';
echo 'console.error = console.error || function(){};';
echo 'console.info = console.info || function(){};';
echo 'console.debug = console.debug || function(){};';
echo '</script>';
/// Конец секции для браузеров без консоли
}
function debug($name, $var = null, $type = LOG) {
echo '<script type="text/javascript">'.NL;
switch($type) {
case LOG:
echo 'console.log("'.$name.'");'.NL;
break;
case INFO:
echo 'console.info("'.$name.'");'.NL;
break;
case WARN:
echo 'console.warn("'.$name.'");'.NL;
break;
case ERROR:
echo 'console.error("'.$name.'");'.NL;
break;
}
if (!empty($var)) {
if (is_object($var) || is_array($var)) {
$object = json_encode($var);
echo 'var object'.preg_replace('~[^A-Z|0-9]~i',"_",$name).' = \''.str_replace("'","\'",$object).'\';'.NL;
echo 'var val'.preg_replace('~[^A-Z|0-9]~i',"_",$name).' = eval("(" + object'.preg_replace('~[^A-Z|0-9]~i',"_",$name).' + ")" );'.NL;
switch($type) {
case LOG:
echo 'console.debug(val'.preg_replace('~[^A-Z|0-9]~i',"_",$name).');'.NL;
break;
case INFO:
echo 'console.info(val'.preg_replace('~[^A-Z|0-9]~i',"_",$name).');'.NL;
break;
case WARN:
echo 'console.warn(val'.preg_replace('~[^A-Z|0-9]~i',"_",$name).');'.NL;
break;
case ERROR:
echo 'console.error(val'.preg_replace('~[^A-Z|0-9]~i',"_",$name).');'.NL;
break;
}
} else {
switch($type) {
case LOG:
echo 'console.debug("'.str_replace('"','\\"',$var).'");'.NL;
break;
case INFO:
echo 'console.info("'.str_replace('"','\\"',$var).'");'.NL;
break;
case WARN:
echo 'console.warn("'.str_replace('"','\\"',$var).'");'.NL;
break;
case ERROR:
echo 'console.error("'.str_replace('"','\\"',$var).'");'.NL;
break;
}
}
}
echo '</script>'.NL;
}
}
Код достаточно простой и понятный. Основная идея заключается в генерировании JavaScript кода, который выводит значения переменных и сообщения в консоль. Очень просто и эффективно.
Код, который содержится в секции для браузеров без консоли, создает пустые функции-заглушки и браузер будет выполнять скрипт, несмотря на присутствующие вызовы записи сообщений в консоль.
Теперь посмотрим на пример использования. Ниже приведенный код используется в демонстрационной странице:
// Включаем код для отладки и определяем объект
require_once("PHPDebug.php");
$debug = new PHPDebug();
// Простое сообщение на консоль
$debug->debug("Очень простое сообщение на консоль");
// Вывод переменной на консоль
$x = 3;
$y = 5;
$z = $x/$y;
$debug->debug("Переменная Z: ", $z);
// Предупреждение
$debug->debug("Простое предупреждение", null, WARN);
// Информация
$debug->debug("Простое информационное сообщение", null, INFO);
// Ошибка
$debug->debug("Простое сообщение об ошибке", null, ERROR);
// Выводим массив в консоль
$fruits = array("банан", "яблоко", "клубника", "ананас");
$fruits = array_reverse($fruits);
$debug->debug("Массив фруктов:", $fruits);
// Выводим объект на консоль
$book = new stdClass;
$book->title = "Гарри Потный и кто-то из Ашхабада";
$book->author = "Д. K. Роулинг";
$book->publisher = "Arthur A. Levine Books";
$book->amazon_link = "http://www.amazon.com/dp/0439136369/";
$debug->debug("Объект: ", $book);
Чтобы увидеть действие кода, надо открыть консоль JavaScript в браузере и открыть/перегрузить демонстрационную страницу.
В браузерах без консоли в коде появятся элементы div с сообщениями, а код выполнится до конца без перерывов.