kint-php / kint

src/Parser/Iterator.php

<?php

class Kint_Parser_Iterator extends Kint_Parser_Plugin

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

{
    /**
     * List of classes and interfaces to blacklist.
     *
     * Certain classes (Such as PDOStatement) irreversibly lose information
     * when traversed. Others are just huge. Either way, put them in here
     * and you won't have to worry about them being parsed.
     *
     * @var array
     */
    public static $blacklist = array(
        'PDOStatement',
        'DOMNodeList',
        'DOMNamedNodeMap',
    );

    public function getTypes()
    {
        return array('object');
    }

    public function getTriggers()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return Kint_Parser::TRIGGER_SUCCESS;
    }

    public function parse(&$var, Kint_Object &$o, $trigger)

Avoid variables with short names like $o. Configured minimum length is 3.

    {
        if (!$var instanceof Traversable) {
            return;
        }

        foreach (self::$blacklist as $class) {
            if ($var instanceof $class) {
                $b = new Kint_Object();
                $b->name = $class.' Iterator Contents';
                $b->access_path = 'iterator_to_array('.$o->access_path.', true)';
                $b->depth = $o->depth + 1;
                $b->hints[] = 'blacklist';

                $r = new Kint_Object_Representation('Iterator');
                $r->contents = array($b);

                $o->addRepresentation($r);

                return;
            }
        }

        $data = iterator_to_array($var);

        if ($data === false) {
            return;
        }

        $base_obj = new Kint_Object();

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

        $base_obj->depth = $o->depth;

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

        if ($o->access_path) {

The expression $o->access_path 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.

            $base_obj->access_path = 'iterator_to_array('.$o->access_path.')';

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

        }

        $r = new Kint_Object_Representation('Iterator');
        $r->contents = $this->parser->parse($data, $base_obj);

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

It seems like $this->parser->parse($data, $base_obj) of type object<Kint_Object> is incompatible with the declared type array of property $contents.

        $r->contents = $r->contents->value->contents;

        $primary = reset($o->representations);
        if ($primary && $primary === $o->value && $primary->contents === array()) {
            $o->addRepresentation($r, 0);
        } else {
            $o->addRepresentation($r);
        }
    }
}