Spiral\Debug\Dumper\Style

Complexity

Total Complexity

10

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

95%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	wrapContainer()	0	4	1
A	indent()	0	8	2
A	apply()	0	11	2
A	getStyle()	0	16	5

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

namespace Spiral\Debug\Dumper;

/**
 * Dump Styler responsible for dump styling.
 */
class Style
{
    /**
     * Container element used to inject dump into, usually pre elemnt with some styling.
     *
     * @var string
     */
    protected $container = '<pre style="background-color: white; font-family: monospace;">{dump}</pre>';

    /**
     * Every dumped element is wrapped using this pattern.
     *
     * @var string
     */
    protected $element = '<span style="{style};">{element}</span>';

    /**
     * Default indent string.
     *
     * @var string
     */
    protected $indent = '&middot;    ';

    /**
     * Set of styles associated with different dumping properties.
     *
     * @var array
     */
    protected $styles = [
        'common'   => 'color: black',
        'name'     => 'color: black',
        'dynamic'  => 'color: purple;',
        'maxLevel' => 'color: #ff9900',
        'syntax'   => [
            'common' => 'color: #666',
            '['      => 'color: black',
            ']'      => 'color: black',
            '('      => 'color: black',
            ')'      => 'color: black',
        ],
        'value'    => [
            'string'  => 'color: green',
            'integer' => 'color: red',
            'double'  => 'color: red',
            'boolean' => 'color: purple; font-weight: bold;',
        ],
        'type'     => [
            'common'   => 'color: #666',
            'object'   => 'color: #333',
            'array'    => 'color: #333',
            'null'     => 'color: #666; font-weight: bold;',
            'resource' => 'color: #666; font-weight: bold;',
        ],
        'access'   => [
            'common'    => 'color: #666',
            'public'    => 'color: #8dc17d',
            'private'   => 'color: #c18c7d',
            'protected' => 'color: #7d95c1',
        ],
    ];

    /**
     * Inject dumped value into dump container.
     *
     * @param string $dump
     *
     * @return string
     */
    public function wrapContainer(string $dump): string
    {
        return \Spiral\interpolate($this->container, compact('dump'));
    }

    /**
     * Set indent to line based on it's level.
     *
     * @param int $level
     *
     * @return string
     */
    public function indent(int $level): string
    {
        if ($level == 0) {
            return '';
        }

        return $this->apply(str_repeat($this->indent, $level), 'indent');
    }

    /**
     * Stylize content using pre-defined style.
     *
     * @param string|null $element
     * @param string      $type
     * @param string      $context
     *
     * @return string
     */
    public function apply($element, string $type, string $context = ''): string
    {
        if (!empty($style = $this->getStyle($type, $context))) {
            return \Spiral\interpolate(
                $this->element,
                compact('style', 'element')
            );
        }

        return $element;
    }

    /**
     * Get valid stype based on type and context/.
     *
     * @param string $type
     * @param string $context
     *
     * @return string
     */
    private function getStyle(string $type, string $context): string
    {
        if (isset($this->styles[$type][$context])) {
            return $this->styles[$type][$context];
        }

        if (isset($this->styles[$type]['common'])) {
            return $this->styles[$type]['common'];
        }

        if (isset($this->styles[$type]) && is_string($this->styles[$type])) {
            return $this->styles[$type];
        }

        return $this->styles['common'];
    }
}