HtmlDescriptor.php

Namespace

Symfony\Component\VarDumper\Command\Descriptor
File

vendor/symfony/var-dumper/Command/Descriptor/HtmlDescriptor.php
View source
<?php


/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\VarDumper\Command\Descriptor;

use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\VarDumper\Cloner\Data;
use Symfony\Component\VarDumper\Dumper\HtmlDumper;

/**
 * Describe collected data clones for html output.
 *
 * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
 *
 * @final
 */
class HtmlDescriptor implements DumpDescriptorInterface {
    private bool $initialized = false;
    public function __construct(HtmlDumper $dumper) {
    }
    public function describe(OutputInterface $output, Data $data, array $context, int $clientId) : void {
        if (!$this->initialized) {
            $styles = file_get_contents(__DIR__ . '/../../Resources/css/htmlDescriptor.css');
            $scripts = file_get_contents(__DIR__ . '/../../Resources/js/htmlDescriptor.js');
            $output->writeln("<style>{$styles}</style><script>{$scripts}</script>");
            $this->initialized = true;
        }
        $title = '-';
        if (isset($context['request'])) {
            $request = $context['request'];
            $controller = "<span class='dumped-tag'>{$this->dumper->dump($request['controller'], true, [
                'maxDepth' => 0,
            ])}</span>";
            $title = \sprintf('<code>%s</code> <a href="%s">%s</a>', $request['method'], $uri = $request['uri'], $uri);
            $dedupIdentifier = $request['identifier'];
        }
        elseif (isset($context['cli'])) {
            $title = '<code>$ </code>' . $context['cli']['command_line'];
            $dedupIdentifier = $context['cli']['identifier'];
        }
        else {
            $dedupIdentifier = bin2hex(random_bytes(4));
        }
        $sourceDescription = '';
        if (isset($context['source'])) {
            $source = $context['source'];
            $projectDir = $source['project_dir'] ?? null;
            $sourceDescription = \sprintf('%s on line %d', $source['name'], $source['line']);
            if (isset($source['file_link'])) {
                $sourceDescription = \sprintf('<a href="%s">%s</a>', $source['file_link'], $sourceDescription);
            }
        }
        $isoDate = $this->extractDate($context, 'c');
        $tags = array_filter([
            'controller' => $controller ?? null,
            'project dir' => $projectDir ?? null,
        ]);
        $output->writeln(<<<HTML
<article data-dedup-id="{<span class="php-variable">$dedupIdentifier</span>}">
    <header>
        <div class="row">
            <h2 class="col">{<span class="php-variable">$title</span>}</h2>
            <time class="col text-small" title="{<span class="php-variable">$isoDate</span>}" datetime="{<span class="php-variable">$isoDate</span>}">
                {<span class="php-variable">$this</span>-&gt;<span class="php-function-or-constant function member-of-self">extractDate</span>(<span class="php-variable">$context</span>)}
            </time>
        </div>
        {<span class="php-variable">$this</span>-&gt;<span class="php-function-or-constant function member-of-self">renderTags</span>(<span class="php-variable">$tags</span>)}
    </header>
    <section class="body">
        <p class="text-small">
            {<span class="php-variable">$sourceDescription</span>}
        </p>
        {<span class="php-variable">$this</span>-&gt;<span class="php-function-or-constant property member-of-self">dumper</span>
            -&gt;<span class="php-function-or-constant function member-of-variable">dump</span>(<span class="php-variable">$data</span>, <span class="php-function-or-constant">true</span>)}
    </section>
</article>
HTML
);
    }
    private function extractDate(array $context, string $format = 'r') : string {
        return date($format, (int) $context['timestamp']);
    }
    private function renderTags(array $tags) : string {
        if (!$tags) {
            return '';
        }
        $renderedTags = '';
        foreach ($tags as $key => $value) {
            $renderedTags .= \sprintf('<li><span class="badge">%s</span>%s</li>', $key, $value);
        }
        return <<<HTML
<div class="row">
    <ul class="tags">
        {<span class="php-variable">$renderedTags</span>}
    </ul>
</div>
HTML;
    }

}
Classes

Title	Deprecated	Summary
HtmlDescriptor		Describe collected data clones for html output.