CallablePlugin::renderClosure() - Code Metrics - Inspection of "MethodObject: Don't make docstring representations..." - jnvsor/kint - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — test ( 528f91...abcbcc )

by Jonathan

created 2018-01-09 19:00 UTC

CallablePlugin::renderClosure() B

↳ Parent: CallablePlugin

Complexity

Conditions	6
Paths	12

Size

Total Lines	23
Code Lines	12

Duplication

Lines	9
Ratio	39.13 %

Importance

Changes

Metric	Value
cc	6
eloc	12
nc	12
nop	1
dl	9
loc	23
rs	8.5906
c	0
b	0
f	0

<?php

namespace Kint\Renderer\Rich;

use Kint\Object\BasicObject;
use Kint\Object\BlobObject;
use Kint\Object\ClosureObject;
use Kint\Object\MethodObject;
use Kint\Renderer\RichRenderer;

class CallablePlugin extends Plugin implements ObjectPluginInterface
{
    protected static $method_cache = array();


    public function renderObject(BasicObject $o)

    {
        if ($o instanceof MethodObject) {
            return $this->renderMethod($o);
        } elseif ($o instanceof ClosureObject) {
            return $this->renderClosure($o);
        } else {
            return $this->renderCallable($o);
        }
    }

    protected function renderClosure(ClosureObject $o)

    {
        $children = $this->renderer->renderChildren($o);

        $header = '';

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

            $header .= '<var>'.$s.'</var> ';
        }

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

            $header .= '<dfn>'.$this->renderer->escape($s).'('.$this->renderer->escape($o->getParams()).')</dfn>';
        }

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

            if (RichRenderer::$strlen_max && BlobObject::strlen($s) > RichRenderer::$strlen_max) {
                $s = substr($s, 0, RichRenderer::$strlen_max).'...';
            }
            $header .= ' '.$this->renderer->escape($s);
        }

        return '<dl>'.$this->renderer->renderHeaderWrapper($o, (bool) strlen($children), $header).$children.'</dl>';
    }

    protected function renderCallable(BasicObject $o)

    {
        $children = $this->renderer->renderChildren($o);

        $header = '';

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

            $header .= '<var>'.$s.'</var> ';
        }

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

            $header .= '<dfn>'.$this->renderer->escape($s).'</dfn>';
        }

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

            if (RichRenderer::$strlen_max && BlobObject::strlen($s) > RichRenderer::$strlen_max) {
                $s = substr($s, 0, RichRenderer::$strlen_max).'...';
            }
            $header .= ' '.$this->renderer->escape($s);
        }

        return '<dl>'.$this->renderer->renderHeaderWrapper($o, (bool) strlen($children), $header).$children.'</dl>';
    }

    protected function renderMethod(MethodObject $o)

    {
        if (!empty(self::$method_cache[$o->owner_class][$o->name])) {
            $children = self::$method_cache[$o->owner_class][$o->name]['children'];

            $header = $this->renderer->renderHeaderWrapper(
                $o,
                (bool) strlen($children),
                self::$method_cache[$o->owner_class][$o->name]['header']
            );

            return '<dl>'.$header.$children.'</dl>';
        }

        $children = $this->renderer->renderChildren($o);

        $header = '';

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

            $header .= '<var>'.$s;

            if ($o->return_reference) {
                if ($s) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    $header .= ' ';
                }
                $header .= $this->renderer->escape('&');
            }

            $header .= '</var> ';
        }

        if (($s = $o->getName()) !== null) {
            $function = $this->renderer->escape($s).'('.$this->renderer->escape($o->getParams()).')';

            if (($url = $o->getPhpDocUrl()) !== null) {

                $function = '<a href="'.$url.'" target=_blank>'.$function.'</a>';
            }

            $header .= '<dfn>'.$function.'</dfn>';
        }

        if (!empty($o->returntype)) {
            $header .= ': <var>';

            if ($o->return_reference) {
                $header .= $this->renderer->escape('&');
            }

            $header .= $this->renderer->escape($o->returntype).'</var>';
        } elseif ($o->docstring) {
            if (preg_match('/@return\s+(.*)\r?\n/m', $o->docstring, $matches)) {
                if (trim($matches[1])) {
                    $header .= ': <var>'.$this->renderer->escape(trim($matches[1])).'</var>';
                }
            }
        }

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

            if (RichRenderer::$strlen_max && BlobObject::strlen($s) > RichRenderer::$strlen_max) {
                $s = substr($s, 0, RichRenderer::$strlen_max).'...';
            }
            $header .= ' '.$this->renderer->escape($s);
        }

        if ($o instanceof MethodObject && strlen($o->owner_class) && strlen($o->name)) {
            $cache = array(
                'header' => $header,
                'children' => $children,
            );

            if (!isset(self::$method_cache[$o->owner_class])) {
                self::$method_cache[$o->owner_class] = array($o->name => $cache);
            } elseif (!isset(self::$method_cache[$o->owner_class][$o->name])) {
                self::$method_cache[$o->owner_class][$o->name] = $cache;
            }
        }

        $header = $this->renderer->renderHeaderWrapper($o, (bool) strlen($children), $header);

        return '<dl>'.$header.$children.'</dl>';
    }
}


1		<?php
2
3		namespace Kint\Renderer\Rich;
4
5		use Kint\Object\BasicObject;
6		use Kint\Object\BlobObject;
7		use Kint\Object\ClosureObject;
8		use Kint\Object\MethodObject;
9		use Kint\Renderer\RichRenderer;
10
11		class CallablePlugin extends Plugin implements ObjectPluginInterface
12		{
13		protected static $method_cache = array();
		0 ignored issues – show Coding Style introduced 2018-01-09 18:27 UTC by Report Bug Copy Issue Report `$method_cache` 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...
14
15		public function renderObject(BasicObject $o)
		0 ignored issues – show Comprehensibility introduced 2018-01-09 19:03 UTC by Report Bug Copy Issue Report Avoid variables with short names like $o. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
16		{
17		if ($o instanceof MethodObject) {
18		return $this->renderMethod($o);
19		} elseif ($o instanceof ClosureObject) {
20		return $this->renderClosure($o);
21		} else {
22		return $this->renderCallable($o);
23		}
24		}
25
26		protected function renderClosure(ClosureObject $o)
		0 ignored issues – show Comprehensibility introduced 2018-01-09 19:03 UTC by Report Bug Copy Issue Report Avoid variables with short names like $o. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
27		{
28		$children = $this->renderer->renderChildren($o);
29
30		$header = '';
31
32		if (($s = $o->getModifiers()) !== null) {
		0 ignored issues – show Comprehensibility introduced 2018-01-09 18:27 UTC by Report Bug Copy Issue Report Avoid variables with short names like $s. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
33		$header .= '<var>'.$s.'</var> ';
34		}
35
36	View Code Duplication	if (($s = $o->getName()) !== null) {
		0 ignored issues – show Duplication introduced 2018-01-06 10:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
37		$header .= '<dfn>'.$this->renderer->escape($s).'('.$this->renderer->escape($o->getParams()).')</dfn>';
38		}
39
40	View Code Duplication	if (($s = $o->getValueShort()) !== null) {
		0 ignored issues – show Duplication introduced 2018-01-06 10:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
41		if (RichRenderer::$strlen_max && BlobObject::strlen($s) > RichRenderer::$strlen_max) {
42		$s = substr($s, 0, RichRenderer::$strlen_max).'...';
43		}
44		$header .= ' '.$this->renderer->escape($s);
45		}
46
47		return '<dl>'.$this->renderer->renderHeaderWrapper($o, (bool) strlen($children), $header).$children.'</dl>';
48		}
49
50		protected function renderCallable(BasicObject $o)
		0 ignored issues – show Comprehensibility introduced 2018-01-09 19:03 UTC by Report Bug Copy Issue Report Avoid variables with short names like $o. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
51		{
52		$children = $this->renderer->renderChildren($o);
53
54		$header = '';
55
56		if (($s = $o->getModifiers()) !== null) {
		0 ignored issues – show Comprehensibility introduced 2018-01-09 18:27 UTC by Report Bug Copy Issue Report Avoid variables with short names like $s. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
57		$header .= '<var>'.$s.'</var> ';
58		}
59
60	View Code Duplication	if (($s = $o->getName()) !== null) {
		0 ignored issues – show Duplication introduced 2018-01-06 10:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
61		$header .= '<dfn>'.$this->renderer->escape($s).'</dfn>';
62		}
63
64	View Code Duplication	if (($s = $o->getValueShort()) !== null) {
		0 ignored issues – show Duplication introduced 2018-01-06 10:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
65		if (RichRenderer::$strlen_max && BlobObject::strlen($s) > RichRenderer::$strlen_max) {
66		$s = substr($s, 0, RichRenderer::$strlen_max).'...';
67		}
68		$header .= ' '.$this->renderer->escape($s);
69		}
70
71		return '<dl>'.$this->renderer->renderHeaderWrapper($o, (bool) strlen($children), $header).$children.'</dl>';
72		}
73
74		protected function renderMethod(MethodObject $o)
		0 ignored issues – show Comprehensibility introduced 2018-01-09 19:03 UTC by Report Bug Copy Issue Report Avoid variables with short names like $o. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
75		{
76		if (!empty(self::$method_cache[$o->owner_class][$o->name])) {
77		$children = self::$method_cache[$o->owner_class][$o->name]['children'];
78
79		$header = $this->renderer->renderHeaderWrapper(
80		$o,
81		(bool) strlen($children),
82		self::$method_cache[$o->owner_class][$o->name]['header']
83		);
84
85		return '<dl>'.$header.$children.'</dl>';
86		}
87
88		$children = $this->renderer->renderChildren($o);
89
90		$header = '';
91
92		if (($s = $o->getModifiers()) !== null \|\| $o->return_reference) {
		0 ignored issues – show Comprehensibility introduced 2018-01-09 19:03 UTC by Report Bug Copy Issue Report Avoid variables with short names like $s. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
93		$header .= '<var>'.$s;
94
95		if ($o->return_reference) {
96		if ($s) {
		0 ignored issues – show Bug Best Practice introduced 2018-01-06 10:43 UTC by Report Bug Copy Issue Report The expression `$s` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
97		$header .= ' ';
98		}
99		$header .= $this->renderer->escape('&');
100		}
101
102		$header .= '</var> ';
103		}
104
105		if (($s = $o->getName()) !== null) {
106		$function = $this->renderer->escape($s).'('.$this->renderer->escape($o->getParams()).')';
107
108	View Code Duplication	if (($url = $o->getPhpDocUrl()) !== null) {
		0 ignored issues – show Duplication introduced 2018-01-06 10:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
109		$function = '<a href="'.$url.'" target=_blank>'.$function.'</a>';
110		}
111
112		$header .= '<dfn>'.$function.'</dfn>';
113		}
114
115		if (!empty($o->returntype)) {
116		$header .= ': <var>';
117
118		if ($o->return_reference) {
119		$header .= $this->renderer->escape('&');
120		}
121
122		$header .= $this->renderer->escape($o->returntype).'</var>';
123		} elseif ($o->docstring) {
124		if (preg_match('/@return\s+(.*)\r?\n/m', $o->docstring, $matches)) {
125		if (trim($matches[1])) {
126		$header .= ': <var>'.$this->renderer->escape(trim($matches[1])).'</var>';
127		}
128		}
129		}
130
131	View Code Duplication	if (($s = $o->getValueShort()) !== null) {
		0 ignored issues – show Duplication introduced 2018-01-06 10:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
132		if (RichRenderer::$strlen_max && BlobObject::strlen($s) > RichRenderer::$strlen_max) {
133		$s = substr($s, 0, RichRenderer::$strlen_max).'...';
134		}
135		$header .= ' '.$this->renderer->escape($s);
136		}
137
138		if ($o instanceof MethodObject && strlen($o->owner_class) && strlen($o->name)) {
139		$cache = array(
140		'header' => $header,
141		'children' => $children,
142		);
143
144		if (!isset(self::$method_cache[$o->owner_class])) {
145		self::$method_cache[$o->owner_class] = array($o->name => $cache);
146		} elseif (!isset(self::$method_cache[$o->owner_class][$o->name])) {
147		self::$method_cache[$o->owner_class][$o->name] = $cache;
148		}
149		}
150
151		$header = $this->renderer->renderHeaderWrapper($o, (bool) strlen($children), $header);
152
153		return '<dl>'.$header.$children.'</dl>';
154		}
155		}
156

jnvsor / kint

Push — test ( 528f91...abcbcc )

CallablePlugin::renderClosure() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like