lekoala / silverstripe-debugbar

code/Extension/ControllerExtension.php

<?php

namespace LeKoala\DebugBar\Extension;

use LeKoala\DebugBar\DebugBar;
use SilverStripe\Control\Controller;
use SilverStripe\Core\Extension;
use LeKoala\DebugBar\Collector\HeaderCollector;
use LeKoala\DebugBar\Collector\SilverStripeCollector;

/**
 * A controller extension to log times and render the Debug Bar
 */
class ControllerExtension extends Extension
{
    public function onBeforeInit()
    {
        DebugBar::withDebugBar(function (\DebugBar\DebugBar $debugbar) {
            // We must set the current controller when it's available and before it's pushed out of stack
            /** @var \LeKoala\DebugBar\Collector\SilverStripeCollector $ssCollector */
            $ssCollector =  $debugbar->getCollector('silverstripe');
            $ssCollector->setController(Controller::curr());

            /** @var DebugBar\DataCollector\TimeDataCollector $timeData */
            $timeData = $debugbar->getCollector('time');
            if (!$timeData) {

$timeData is of type LeKoala\DebugBar\DebugBar\DataCollector\TimeDataCollector, thus it always evaluated to true.

                return;
            }
            if ($timeData->hasStartedMeasure('pre_request')) {
                $timeData->stopMeasure("pre_request");
            }
            $timeData->startMeasure("init", get_class($this->owner) . ' init');
        });
    }

    public function onAfterInit()
    {
        // Avoid requirements being called to early due to RootURLController/ModelAsController
        if ($this->owner instanceof \SilverStripe\CMS\Controllers\RootURLController) {

The type SilverStripe\CMS\Controllers\RootURLController was not found. Maybe you did not declare it correctly or list all dependencies?

            return;
        }
        if ($this->owner instanceof \SilverStripe\CMS\Controllers\ModelAsController) {

The type SilverStripe\CMS\Controllers\ModelAsController was not found. Maybe you did not declare it correctly or list all dependencies?

            return;
        }
        DebugBar::includeRequirements();

        DebugBar::withDebugBar(function (\DebugBar\DebugBar $debugbar) {
            // Add the headers Collector
            if (!$debugbar->hasCollector('Headers') && DebugBar::config()->get('header_collector')) {
                $debugbar->addCollector(new HeaderCollector($this->owner));
            }
            /** @var DebugBar\DataCollector\TimeDataCollector $timeData */
            $timeData = $debugbar->getCollector('time');
            if (!$timeData) {

$timeData is of type LeKoala\DebugBar\DebugBar\DataCollector\TimeDataCollector, thus it always evaluated to true.

                return;
            }
            if ($timeData->hasStartedMeasure("cms_init")) {
                $timeData->stopMeasure("cms_init");
            }
            if ($timeData->hasStartedMeasure("init")) {
                $timeData->stopMeasure("init");
            }
            $timeData->startMeasure("handle", get_class($this->owner) . ' handle request');
        });
    }

    /**
     * @param HTTPRequest $request

The type LeKoala\DebugBar\Extension\HTTPRequest was not found. Did you mean HTTPRequest? If so, make sure to prefix the type with \.

     * @param string $action
     */
    public function beforeCallActionHandler($request, $action)
    {
        // If we don't have an action, getViewer will be called immediatly
        // If we have custom routes, request action is different than action
        $allParams     = $request->allParams();
        $requestAction = null;
        if (!empty($allParams['Action'])) {
            $requestAction = $allParams['Action'];
        }
        if (!$this->owner->hasMethod($action) || ($requestAction && $requestAction != $action)) {
            self::clearBuffer();
        }

        DebugBar::withDebugBar(function (\DebugBar\DebugBar $debugBar) use ($action) {
            /** @var DebugBar\DataCollector\TimeDataCollector $timeData */
            $timeData = $debugBar->getCollector('time');
            if (!$timeData) {

$timeData is of type LeKoala\DebugBar\DebugBar\DataCollector\TimeDataCollector, thus it always evaluated to true.

                return;
            }
            if ($timeData->hasStartedMeasure("handle")) {
                $timeData->stopMeasure("handle");
            }
            $timeData->startMeasure("action", get_class($this->owner) . " action $action");
        });
    }

    /**
     * @param HTTPRequest $request
     * @param string $action
     * @param mixed $result
     */
    public function afterCallActionHandler($request, $action, $result)

The parameter $result is not used and could be removed.

The parameter $request is not used and could be removed.

    {
        self::clearBuffer();

        DebugBar::withDebugBar(function (\DebugBar\DebugBar $debugBar) use ($action) {
            /** @var DebugBar\DataCollector\TimeDataCollector $timeData */
            $timeData = $debugBar->getCollector('time');
            if (!$timeData) {

$timeData is of type LeKoala\DebugBar\DebugBar\DataCollector\TimeDataCollector, thus it always evaluated to true.

                return;
            }
            if ($timeData->hasStartedMeasure("action")) {
                $timeData->stopMeasure("action");
            }
            $timeData->startMeasure(
                "after_action",
                get_class($this->owner) . " after action $action"
            );
        });
    }

    protected static function clearBuffer()
    {
        if (!DebugBar::$bufferingEnabled) {
            return;
        }
        $buffer = ob_get_clean();
        if (!empty($buffer)) {
            unset($_REQUEST['debug_request']); // Disable further messages that we can't intercept
            SilverStripeCollector::setDebugData($buffer);
        }
    }
}