kint-php / kint

src/Parser/Xml.php

<?php

class Kint_Parser_Xml extends Kint_Parser_Plugin

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

The property $parse_method is not named in camelCase.

{
    /**
     * Which method to parse the variable with.
     *
     * DOMDocument provides more information including the text between nodes,
     * however it's memory usage is very high and it takes longer to parse and
     * render. Plus it's a pain to work with. So SimpleXML is the default.
     *
     * @var string
     */
    public static $parse_method = 'SimpleXML';

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

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

    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 (substr($var, 0, 5) !== '<?xml') {
            return;
        }

        if (!method_exists(get_class($this), 'xmlTo'.self::$parse_method)) {
            return;
        }

        $xml = call_user_func(array(get_class($this), 'xmlTo'.self::$parse_method), $var, $o->access_path);

        if (empty($xml)) {
            return;
        }

        list($xml, $access_path, $name) = $xml;

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

        $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 + 1;

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

        $base_obj->name = $name;

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

        $base_obj->access_path = $access_path;

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

        $r = new Kint_Object_Representation('XML');

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

        $r->contents = $this->parser->parse($xml, $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($xml, $base_obj) of type object<Kint_Object> is incompatible with the declared type array of property $contents.

        $o->addRepresentation($r, 0);
    }

    protected static function xmlToSimpleXML($var, $parent_path)

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

The parameter $parent_path is not named in camelCase.

    {
        try {
            $errors = libxml_use_internal_errors(true);
            $xml = simplexml_load_string($var);
            libxml_use_internal_errors($errors);
        } catch (Exception $e) {
            if (isset($errors)) {
                libxml_use_internal_errors($errors);
            }

            return;
        }

        if (!$xml) {
            return;
        }

        if ($parent_path === null) {

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

This code seems to be duplicated across your project.

            $access_path = null;

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

        } else {
            $access_path = 'simplexml_load_string('.$parent_path.')';

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

        }

        $name = $xml->getName();

        return array($xml, $access_path, $name);

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

    }

    /**
     * Get the DOMDocument info.
     *
     * The documentation of DOMDocument::loadXML() states that while you can
     * call it statically, it will give an E_STRICT warning. On my system it
     * actually gives an E_DEPRECATED warning, but it works so we'll just add
     * an error-silencing '@' to the access path.
     *
     * If it errors loading then we wouldn't have gotten this far in the first place.
     *
     * @param string $var         The XML string
     * @param string $parent_path The path to the parent, in this case the XML string
     *
     * @return array The root element DOMNode, the access path, and the root element name

Should the return type not be null|array?

     */
    protected static function xmlToDOMDocument($var, $parent_path)

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

The parameter $parent_path is not named in camelCase.

    {
        // There's no way to check validity in DOMDocument without making errors. For shame!
        if (!self::xmlToSimpleXML($var, $parent_path)) {

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

            return;
        }

        $xml = new DOMDocument();
        $xml->loadXML($var);
        $xml = $xml->firstChild;

        if ($parent_path === null) {

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

This code seems to be duplicated across your project.

            $access_path = null;

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

        } else {
            $access_path = '@DOMDocument::loadXML('.$parent_path.')->firstChild';

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

        }

        $name = $xml->nodeName;

        return array($xml, $access_path, $name);

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

    }
}