DolHooksCollector.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2024 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\RequestDataCollector;
 
class DolHooksCollector extends RequestDataCollector
{
  public function collect()
  {
    global $hookmanager;
 
    $data = ['hooks' => [], 'nb_of_hooks' => 0];
    if (empty($hookmanager->hooksHistory)) {
      return $data;
    }
    $i = 0;
    foreach ($hookmanager->hooksHistory as $key => $hookHistory) {
      $i++;
      $hookHistory['contexts'] = implode(', ', $hookHistory['contexts']);
      $data['hooks']["[$i] {$hookHistory['name']}"] = $hookHistory;
 
      //            $data["[$key] {$hookHistory['name']}"] = "{$hookHistory['file']} (L{$hookHistory['line']}). Contexts: "
      //                . implode(', ', $hookHistory['contexts']);
    }
    $data['nb_of_hooks'] = count($data['hooks']);
 
    return $data;
  }
 
  public function getWidgets()
  {
    global $langs;
 
    $langs->load("other");
 
    return [
      $langs->transnoentities('Hooks') => [
        "icon" => "tags",
        "widget" => "PhpDebugBar.Widgets.HookListWidget",
        "map" => "hooks.hooks",
        "default" => "{}"
      ],
      "{$langs->transnoentities('Hooks')}:badge" => [
        "map" => "hooks.nb_of_hooks",
        "default" => 0
      ]
    ];
  }
 
  public function getName()
  {
    return 'hooks';
  }
}