Kint_Object_Representation_Docstring

Complexity

Total Complexity

3

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	docstringWithoutComments()	0	11	2

<?php

class Kint_Object_Representation_Docstring extends Kint_Object_Representation

Kint_Object_Representation_Docstring does not seem to conform to the naming convention (^[A-Z][a-zA-Z0-9]*$).

{
    public $file = null;
    public $line = null;
    public $class = null;
    public $hints = array('docstring');

    public function __construct($docstring, $file, $line, $class = null)
    {
        parent::__construct('Docstring');

        $this->file = $file;
        $this->line = $line;
        $this->class = $class;
        $this->contents = $docstring;
    }

    /**
     * Returns the representation's docstring without surrounding comments.
     *
     * Note that this will not work flawlessly.
     *
     * On comments with whitespace after the stars the lines will begin with
     * whitespace, since we can't accurately guess how much of an indentation
     * is required.
     *
     * And on lines without stars on the left this may eat bullet points.
     *
     * Long story short: If you want the docstring read the contents. If you
     * absolutely must have it without comments (ie renderValueShort) this will
     * probably do.
     *
     * @return string Docstring with comments stripped

Should the return type not be null|string?

     */
    public function docstringWithoutComments()
    {
        if (!$this->contents) {

The expression $this->contents of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            return null;
        }

        $string = substr($this->contents, 3, -2);
        $string = preg_replace('/^\s*\*\s*?(\S|$)/m', '\1', $string);

        return trim($string);
    }
}