Recca0120\LaravelTracy\Panels\HtmlValidatorPanel

Complexity

Total Complexity

5

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

96.88%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setHtml()	0	6	1
A	normalize()	0	12	1
A	normalizeNewLines()	0	4	1
A	getAttributes()	0	25	1
A	subscribe()	0	7	1

<?php

namespace Recca0120\LaravelTracy\Panels;

use DOMDocument;
use LibXMLError;
use Recca0120\LaravelTracy\Contracts\IAjaxPanel;
use Recca0120\LaravelTracy\Events\BeforeBarRender;

class HtmlValidatorPanel extends AbstractSubscriablePanel implements IAjaxPanel
{
    /**
     * $html.
     *
     * @var string
     */
    protected $html;

    /**
     * $ignoreErrors.
     *
     * @var array
     */
    protected static $ignoreErrors = [
        // XML_ERR_ENTITYREF_SEMICOL_MISSING
        23,
        // XML_HTML_UNKNOWN_TAG
        801,
    ];

    /**
     * $severenity.
     *
     * @var array
     */
    protected static $severenity = [
        LIBXML_ERR_WARNING => 'Warning',
        LIBXML_ERR_ERROR => 'Error',
        LIBXML_ERR_FATAL => 'Fatal error',
    ];

    /**
     * setHTML.
     *
     * @param string $html
     * @return $this
     */
    public function setHtml($html)
    {
        $this->html = $html;

        return $this;
    }

    /**
     * Removes special controls characters and normalizes line endings and spaces.
     *
     * @param string $str
     * @return string
     */
    protected static function normalize($str)
    {
        $str = static::normalizeNewLines($str);
        // remove control characters; leave \t + \n
        $str = preg_replace('#[\x00-\x08\x0B-\x1F\x7F-\x9F]+#u', '', $str);
        // right trim
        $str = preg_replace('#[\t ]+$#m', '', $str);
        // leading and trailing blank lines
        $str = trim($str, "\n");

        return $str;
    }

    /**
     * Standardize line endings to unix-like.
     *
     * @param string $s
     * @return string
     */
    protected static function normalizeNewLines($s)
    {
        return str_replace(["\r\n", "\r"], "\n", $s);
    }

    /**
     * getAttributes.
     *
     * @return array
     */
    protected function getAttributes()
    {
        libxml_use_internal_errors(true);
        $dom = new DOMDocument('1.0', 'UTF-8');
        $dom->resolveExternals = false;
        $dom->validateOnParse = true;
        $dom->preserveWhiteSpace = false;
        $dom->strictErrorChecking = true;
        $dom->recover = true;

        @$dom->loadHTML($this->normalize($this->html));

        $errors = array_filter(libxml_get_errors(), function (LibXMLError $error) {
            return in_array((int) $error->code, static::$ignoreErrors, true) === false;
        });

        libxml_clear_errors();

        return [
            'severenity' => static::$severenity,
            'counter' => count($errors),
            'errors' => $errors,
            'html' => $this->html,
        ];
    }

    /**
     * subscribe.
     **/
    protected function subscribe()
    {
        $events = $this->laravel['events'];
        $events->listen(BeforeBarRender::class, function ($barRender) {
            $this->setHtml($barRender->response->getContent());
        });
    }
}