TextRenderer::boxText() - Code Metrics - Inspection of "Move object property sorting to Renderers" - jnvsor/kint - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — test ( 3bf7a5...16e845 )

by Jonathan

created 2018-03-30 17:47 UTC

TextRenderer::boxText() A

↳ Parent: TextRenderer

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	8
nc	2
nop	2
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0

<?php

namespace Kint\Renderer;

use Kint\Kint;
use Kint\Object\BasicObject;
use Kint\Object\BlobObject;
use Kint\Object\InstanceObject;

class TextRenderer extends Renderer

{
    /**
     * TextRenderer plugins should be instances of Kint\Renderer\Text\Plugin.
     */
    public static $plugins = array(
        'blacklist' => 'Kint\\Renderer\\Text\\BlacklistPlugin',
        'depth_limit' => 'Kint\\Renderer\\Text\\DepthLimitPlugin',
        'nothing' => 'Kint\\Renderer\\Text\\NothingPlugin',
        'recursion' => 'Kint\\Renderer\\Text\\RecursionPlugin',
        'trace' => 'Kint\\Renderer\\Text\\TracePlugin',
    );

    /**
     * Parser plugins must be instanceof one of these or
     * it will be removed for performance reasons.
     */
    public static $parser_plugin_whitelist = array(

        'Kint\\Parser\\BlacklistPlugin',
        'Kint\\Parser\\StreamPlugin',
        'Kint\\Parser\\TracePlugin',
    );

    /**
     * The maximum length of a string before it is truncated.
     *
     * Falsey to disable
     *
     * @var int
     */
    public static $strlen_max = 0;


    /**
     * The default width of the terminal for headers.
     *
     * @var int
     */
    public static $default_width = 80;


    /**
     * Indentation width.
     *
     * @var int
     */
    public static $default_indent = 4;


    /**
     * Decorate the header and footer.
     *
     * @var bool
     */
    public static $decorations = true;

    /**
     * Sort mode for object properties.
     *
     * @var int
     */
    public static $sort = self::SORT_NONE;

    public $header_width = 80;

    public $indent_width = 4;


    protected $plugin_objs = array();

    protected $previous_caller;

    protected $callee;
    protected $show_minitrace = true;


    public function __construct(array $params = array())
    {
        parent::__construct($params);

        $params += array(
            'callee' => null,
            'caller' => null,
        );

        $this->callee = $params['callee'];
        $this->previous_caller = $params['caller'];
        $this->show_minitrace = !empty($params['settings']['display_called_from']);
        $this->header_width = self::$default_width;
        $this->indent_width = self::$default_indent;
    }

    public function render(BasicObject $o)

    {
        if ($plugin = $this->getPlugin(self::$plugins, $o->hints)) {
            if (strlen($output = $plugin->render($o))) {
                return $output;
            }
        }

        $out = '';

        if ($o->depth == 0) {
            $out .= $this->colorTitle($this->renderTitle($o)).PHP_EOL;
        }

        $out .= $this->renderHeader($o);
        $out .= $this->renderChildren($o).PHP_EOL;

        return $out;
    }

    public function boxText($text, $width)
    {
        if (BlobObject::strlen($text) > $width - 4) {
            $text = BlobObject::substr($text, 0, $width - 7).'...';

        }

        $text .= str_repeat(' ', $width - 4 - BlobObject::strlen($text));

        $out = '┌'.str_repeat('─', $width - 2).'┐'.PHP_EOL;
        $out .= '│ '.$this->escape($text).' │'.PHP_EOL;
        $out .= '└'.str_repeat('─', $width - 2).'┘';

        return $out;
    }

    public function renderTitle(BasicObject $o)

    {
        if (($name = $o->getName()) === null) {
            $name = 'literal';
        }

        if (self::$decorations) {
            return $this->boxText($name, $this->header_width);
        } elseif (BlobObject::strlen($name) > $this->header_width) {
            return BlobObject::substr($name, 0, $this->header_width - 3).'...';
        } else {
            return $name;
        }
    }

    public function renderHeader(BasicObject $o)

    {
        $output = array();

        if ($o->depth) {
            if (($s = $o->getModifiers()) !== null) {

                $output[] = $s;
            }

            if ($o->name !== null) {
                $output[] = $this->escape(var_export($o->name, true));

                if (($s = $o->getOperator()) !== null) {
                    $output[] = $this->escape($s);
                }
            }
        }

        if (($s = $o->getType()) !== null) {
            if ($o->reference) {
                $s = '&'.$s;
            }

            $output[] = $this->colorType($this->escape($s));
        }

        if (($s = $o->getSize()) !== null) {

            $output[] = '('.$this->escape($s).')';
        }

        if (($s = $o->getValueShort()) !== null) {

            if (self::$strlen_max && BlobObject::strlen($s) > self::$strlen_max) {
                $s = substr($s, 0, self::$strlen_max).'...';
            }
            $output[] = $this->colorValue($this->escape($s));
        }

        return str_repeat(' ', $o->depth * $this->indent_width).implode(' ', $output);
    }

    public function renderChildren(BasicObject $o)

    {
        if ($o->type === 'array') {
            $output = ' [';
        } elseif ($o->type === 'object') {
            $output = ' (';
        } else {
            return '';
        }

        $children = '';

        if ($o->value && is_array($o->value->contents)) {
            if ($o instanceof InstanceObject) {

                foreach (self::sortContents($o->value->contents, self::$sort) as $obj) {
                    $output .= $this->render($obj);
                }
            } else {
                foreach ($o->value->contents as $child) {
                    $children .= $this->render($child);
                }
            }
        }

        if ($children) {
            $output .= PHP_EOL.$children;
            $output .= str_repeat(' ', $o->depth * $this->indent_width);
        }

        if ($o->type === 'array') {
            $output .= ']';
        } elseif ($o->type === 'object') {
            $output .= ')';
        }

        return $output;
    }

    public function colorValue($string)

    {
        return $string;
    }

    public function colorType($string)

    {
        return $string;
    }

    public function colorTitle($string)

    {
        return $string;
    }

    public function postRender()

    {
        if (self::$decorations) {
            $output = str_repeat('═', $this->header_width);
        } else {
            $output = '';
        }

        if (!$this->show_minitrace) {
            return $this->colorTitle($output);
        } else {
            if ($output) {
                $output .= PHP_EOL;
            }

            return $this->colorTitle($output.$this->calledFrom().PHP_EOL);
        }
    }

    public function parserPlugins(array $plugins)
    {
        $return = array();

        foreach ($plugins as $index => $plugin) {
            foreach (self::$parser_plugin_whitelist as $whitelist) {
                if ($plugin instanceof $whitelist) {
                    $return[] = $plugin;
                    continue 2;
                }
            }
        }

        return $return;
    }

    protected function calledFrom()
    {
        $output = '';

        if (isset($this->callee['file'])) {
            $output .= 'Called from '.$this->ideLink($this->callee['file'], $this->callee['line']);
        }

        $caller = '';

        if (isset($this->previous_caller['class'])) {
            $caller .= $this->previous_caller['class'];
        }
        if (isset($this->previous_caller['type'])) {
            $caller .= $this->previous_caller['type'];
        }
        if (isset($this->previous_caller['function'])

            && !in_array(
                $this->previous_caller['function'],
                array('include', 'include_once', 'require', 'require_once')
            )
        ) {
            $caller .= $this->previous_caller['function'].'()';
        }

        if ($caller) {
            $output .= ' ['.$caller.']';
        }

        return $output;
    }

    public function ideLink($file, $line)
    {
        return $this->escape(Kint::shortenPath($file)).':'.$line;
    }

    protected function getPlugin(array $plugins, array $hints)

    {
        if ($plugins = $this->matchPlugins($plugins, $hints)) {

            $plugin = end($plugins);

            if (!isset($this->plugin_objs[$plugin])) {
                $this->plugin_objs[$plugin] = new $plugin($this);
            }

            return $this->plugin_objs[$plugin];
        }
    }

    public function escape($string, $encoding = false)

    {
        return $string;
    }
}


1			<?php
2
3			namespace Kint\Renderer;
4
5			use Kint\Kint;
6			use Kint\Object\BasicObject;
7			use Kint\Object\BlobObject;
8			use Kint\Object\InstanceObject;
9
10			class TextRenderer extends Renderer
			0 ignored issues – show Coding Style introduced 2018-01-13 16:08 UTC by Report Bug Copy Issue Report The property $parser_plugin_whitelist is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-13 16:08 UTC by Report Bug Copy Issue Report The property $strlen_max is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-13 16:08 UTC by Report Bug Copy Issue Report The property $default_width is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-13 16:08 UTC by Report Bug Copy Issue Report The property $default_indent is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-13 16:08 UTC by Report Bug Copy Issue Report The property $header_width is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-13 16:08 UTC by Report Bug Copy Issue Report The property $indent_width is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-13 16:08 UTC by Report Bug Copy Issue Report The property $plugin_objs is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-13 16:08 UTC by Report Bug Copy Issue Report The property $previous_caller is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2018-01-13 16:08 UTC by Report Bug Copy Issue Report The property $show_minitrace is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
11			{
12			/**
13			* TextRenderer plugins should be instances of Kint\Renderer\Text\Plugin.
14			*/
15			public static $plugins = array(
16			'blacklist' => 'Kint\\Renderer\\Text\\BlacklistPlugin',
17			'depth_limit' => 'Kint\\Renderer\\Text\\DepthLimitPlugin',
18			'nothing' => 'Kint\\Renderer\\Text\\NothingPlugin',
19			'recursion' => 'Kint\\Renderer\\Text\\RecursionPlugin',
20			'trace' => 'Kint\\Renderer\\Text\\TracePlugin',
21			);
22
23			/**
24			* Parser plugins must be instanceof one of these or
25			* it will be removed for performance reasons.
26			*/
27			public static $parser_plugin_whitelist = array(
			0 ignored issues – show Coding Style introduced 2018-01-09 18:27 UTC by Report Bug Copy Issue Report `$parser_plugin_whitelist` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history... Comprehensibility Naming introduced 2018-01-09 18:27 UTC by Report Bug Copy Issue Report The variable name `$parser_plugin_whitelist` exceeds the maximum configured length of `20`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
28			'Kint\\Parser\\BlacklistPlugin',
29			'Kint\\Parser\\StreamPlugin',
30			'Kint\\Parser\\TracePlugin',
31			);
32
33			/**
34			* The maximum length of a string before it is truncated.
35			*
36			* Falsey to disable
37			*
38			* @var int

jnvsor / kint

Push — test ( 3bf7a5...16e845 )

TextRenderer::boxText() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like