DolPhpCollector.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2023 Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2024   MDW             <mdeweerd@users.noreply.github.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
use DebugBar\DataCollector\DataCollector;
use DebugBar\DataCollector\Renderable;
 
class PhpCollector extends DataCollector implements Renderable
{
  protected $name;
 
  protected $messages = [];
 
  public function __construct($name = 'Error handler')
  {
    $this->name = $name;
    set_error_handler([$this, 'errorHandler'], E_ALL);
  }
 
  public function collect()
  {
    $messages = $this->getMessages();
    return [
      'count' => count($messages),
      'messages' => $messages,
    ];
  }
 
  public function getMessages()
  {
    $messages = $this->messages;
 
    usort(
      $messages,
      static function ($itemA, $itemB) {
        if ($itemA['time'] === $itemB['time']) {
          return 0;
        }
        return $itemA['time'] < $itemB['time'] ? -1 : 1;
      }
    );
 
    return $messages;
  }
 
  public function getWidgets()
  {
    $name = $this->getName();
    return [
      $name => [
        'icon' => 'list',
        'widget' => 'PhpDebugBar.Widgets.MessagesWidget',
        'map' => "$name.messages",
        'default' => '[]',
      ],
      "$name:badge" => [
        'map' => "$name.count",
        'default' => 'null',
      ],
    ];
  }
 
  public function getName()
  {
    return $this->name;
  }
 
  public function errorHandler($severity, $message, $fileName, $line)
  {
    for ($i = 0; $i < 15; $i++) {
      if ($type = $severity & (1 << $i)) {
        $label = $this->friendlyErrorType($type);
        $this->messages[] = [
          'message' => $message . ' (' . $fileName . ':' . $line . ')',
          'message_html' => null,
          'is_string' => true,
          'label' => $label,
          'time' => microtime(true),
        ];
      }
    }
  }
 
  private function friendlyErrorType($type)
  {
    $errors = [
      E_ERROR => 'ERROR',
      E_WARNING => 'WARNING',
      E_PARSE => 'PARSE',
      E_NOTICE => 'NOTICE',
      E_CORE_ERROR => 'CORE_ERROR',
      E_CORE_WARNING => 'CORE_WARNING',
      E_COMPILE_ERROR => 'COMPILE_ERROR',
      E_COMPILE_WARNING => 'COMPILE_WARNING',
      E_USER_ERROR => 'USER_ERROR',
      E_USER_WARNING => 'USER_WARNING',
      E_USER_NOTICE => 'USER_NOTICE',
      E_STRICT => 'STRICT',
      E_RECOVERABLE_ERROR => 'RECOVERABLE_ERROR',
      E_DEPRECATED => 'DEPRECATED',
      E_USER_DEPRECATED => 'USER_DEPRECATED',
    ];
 
    $result = '';
    if (isset($errors[$type])) {
      $result = $errors[$type];
    }
 
    return $result;
  }
}