kint\inc\KintParser

Complexity

Total Complexity

112

Size/Duplication

Total Lines	773
Duplicated Lines	1.16 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

40.63%

Importance

Changes	5
Bugs	2	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	_checkDepth()	0	4	2
	_parse()	0	1	?
A	_parse_boolean()	0	5	2
A	_parse_double()	0	6	1
A	_parse_integer()	0	6	1
A	_parse_null()	0	5	1
B	_parse_resource()	0	26	6
A	_parse_unknown()	0	6	2
C	_decorateCell()	0	35	7
D	_parse_array()	0	152	28
F	_parse_object()	9	132	20
C	_isArrayTabular()	0	37	11
C	_parse_string()	0	43	7
C	escape()	0	35	7
D	factory()	0	112	16
A	reset()	0	5	1

<?php

namespace kint\inc;

use kint\decorators\Kint_Decorators_Rich;
use kint\Kint;
use voku\helper\UTF8;

/**
 * Class KintParser
 */
abstract class KintParser extends KintVariableData
{
  /**
   * @var int
   */
  private static $_level = 0;

  /**
   * @var bool
   */
  private static $_dealingWithGlobals = false;

  /**
   * @var bool
   */
  private static $_placeFullStringInValue = false;

  /**
   * @var array
   */
  private static $_customDataTypes = array(
      'ClassMethods',
      'ClassStatics',
      'Color',
      'FsPath',
      'Json',
      'Microtime',
      'ObjectIterateable',
      'SplObjectStorage',
      'Timestamp',
      'Xml',
  );

  /**
   * @var array
   */
  private static $_objectParsers = array(
      'Closure',
      'Smarty',
      'SplFileInfo',
  );

  /**
   * @var array
   */
  private static $_objects = array();

  /**
   * @var mixed
   */
  private static $_marker;

  /**
   * @var bool
   */
  private static $_skipAlternatives = false;

  /**
   * @return bool
   */
  private static function _checkDepth()
  {
    return Kint::$maxLevels != 0 && self::$_level >= Kint::$maxLevels;
  }

  /**
   * @param KintVariableData $kintVar
   *
   * @return string
   */
  private static function _decorateCell(KintVariableData $kintVar)
  {
    if ($kintVar->extendedValue !== null || !empty($kintVar->_alternatives)) {
      return '<td>' . Kint_Decorators_Rich::decorate($kintVar) . '</td>';
    }

    $output = '<td';

    if ($kintVar->value !== null) {
      $output .= ' title="' . $kintVar->type;

      if ($kintVar->size !== null) {
        $output .= ' (' . $kintVar->size . ')';
      }

      $output .= '">' . $kintVar->value;
    } else {
      $output .= '>';

      if ($kintVar->type !== 'NULL') {
        $output .= '<u>' . $kintVar->type;

        if ($kintVar->size !== null) {
          $output .= '(' . $kintVar->size . ')';
        }

        $output .= '</u>';
      } else {
        $output .= '<u>NULL</u>';
      }
    }


    return $output . '</td>';
  }

  /**
   * @param array $variable
   *
   * @return array|bool
   */
  private static function _isArrayTabular(array &$variable)
  {
    if (Kint::enabled() !== Kint::MODE_RICH) {
      return false;
    }

    $arrayKeys = array();
    $keys = null;
    $closeEnough = false;
    foreach ($variable as $row) {
      if (!is_array($row) || empty($row)) {
        return false;
      }

      foreach ($row as $col) {
        if (!empty($col) && !is_scalar($col)) {
          return false;
        } // TODO: add tabular "tolerance"
      }

      if (isset($keys) && !$closeEnough) {
        # let's just see if the first two rows have same keys, that's faster and has the
        # positive side effect of easily spotting missing keys in later rows
        if ($keys !== array_keys($row)) {
          return false;
        }

        $closeEnough = true;
      } else {
        $keys = array_keys($row);
      }

      $arrayKeys = array_unique(array_merge($arrayKeys, $keys));
    }

    return $arrayKeys;
  }

  /**
   * main and usually single method a custom parser must implement
   *
   * @param mixed $variable
   *
   * @return mixed [!!!] false is returned if the variable is not of current type
   */
  abstract protected function _parse(&$variable);

  /** @noinspection PhpUnusedPrivateMethodInspection */
  /**
   * @param mixed            $variable
   * @param KintVariableData $variableData
   *
   * @return bool|void
   */
  private static function _parse_array(&$variable, KintVariableData $variableData)
  {
    isset(self::$_marker) or self::$_marker = "\x00" . uniqid('kint', true);

Using logical operators such as or instead of || is generally not recommended.

    # naturally, $GLOBALS variable is an intertwined recursion nightmare, use black magic
    $globalsDetector = false;
    if (
        isset($variable['GLOBALS'])
        &&
        is_array($variable['GLOBALS'])
    ) {
      $globalsDetector = "\x01" . uniqid('kint', true);

      $variable['GLOBALS'][$globalsDetector] = true;
      if (isset($variable[$globalsDetector])) {
        unset($variable[$globalsDetector]);
        self::$_dealingWithGlobals = true;
      } else {
        unset($variable['GLOBALS'][$globalsDetector]);
        $globalsDetector = false;
      }
    }

    $variableData->type = 'array';
    $variableData->size = count($variable);

    if ($variableData->size === 0) {
      /** @noinspection PhpInconsistentReturnPointsInspection */
      return;
    }

    if (isset($variable[self::$_marker])) { # recursion; TODO: mayhaps show from where
      if (self::$_dealingWithGlobals) {
        $variableData->value = '*RECURSION*';
      } else {
        unset($variable[self::$_marker]);
        $variableData->value = self::$_marker;
      }

      return false;
    }
    if (self::_checkDepth()) {
      $variableData->extendedValue = '*DEPTH TOO GREAT*';

It seems like '*DEPTH TOO GREAT*' of type string is incompatible with the declared type array<integer,object<kint\inc\KintVariableData>> of property $extendedValue.

      return false;
    }

    $isSequential = self::_isSequential($variable);

    if (
        $variableData->size > 1
        &&
        ($arrayKeys = self::_isArrayTabular($variable)) !== false
    ) {
      $variable[self::$_marker] = true; # this must be AFTER _isArrayTabular
      $firstRow = true;
      $extendedValue = '<table class="kint-report"><thead>';

      foreach ($variable as $rowIndex => &$row) {
        # display strings in their full length
        self::$_placeFullStringInValue = true;

        if ($rowIndex === self::$_marker) {
          continue;
        }

        if (isset($row[self::$_marker])) {
          $variableData->value = '*RECURSION*';

          return false;
        }

        $extendedValue .= '<tr>';
        if ($isSequential) {
          $output = '<td>' . '#' . ($rowIndex + 1) . '</td>';
        } else {
          $output = self::_decorateCell(self::factory($rowIndex));
        }
        if ($firstRow) {
          $extendedValue .= '<th>&nbsp;</th>';
        }

        # we iterate the known full set of keys from all rows in case some appeared at later rows,
        # as we only check the first two to assume
        foreach ($arrayKeys as $key) {
          if ($firstRow) {
            $extendedValue .= '<th>' . self::escape($key) . '</th>';
          }

          if (!isset($row[$key])) {
            $output .= '<td class="kint-empty"></td>';
            continue;
          }

          $var = self::factory($row[$key]);

          if ($var->value === self::$_marker) {
            $variableData->value = '*RECURSION*';

            return false;
          } elseif ($var->value === '*RECURSION*') {
            $output .= '<td class="kint-empty"><u>*RECURSION*</u></td>';
          } else {
            $output .= self::_decorateCell($var);
          }
          unset($var);
        }

        if ($firstRow) {
          $extendedValue .= '</tr></thead><tr>';
          $firstRow = false;
        }

        $extendedValue .= $output . '</tr>';
      }
      unset($row);
      self::$_placeFullStringInValue = false;

      $variableData->extendedValue = $extendedValue . '</table>';

It seems like $extendedValue . '</table>' of type string is incompatible with the declared type array<integer,object<kint\inc\KintVariableData>> of property $extendedValue.

    } else {
      $variable[self::$_marker] = true;
      $extendedValue = array();

      foreach ($variable as $key => &$val) {
        if ($key === self::$_marker) {
          continue;
        }

        $output = self::factory($val);
        if ($output->value === self::$_marker) {
          $variableData->value = '*RECURSION*'; // recursion occurred on a higher level, thus $this is recursion
          return false;
        }
        if (!$isSequential) {
          $output->operator = '=>';
        }
        $output->name = $isSequential ? null : "'" . $key . "'";
        $extendedValue[] = $output;
      }
      unset($val);
      $variableData->extendedValue = $extendedValue;
    }

    if ($globalsDetector) {

The expression $globalsDetector of type string|false is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

      self::$_dealingWithGlobals = false;
    }

    unset($variable[self::$_marker]);

    return true;
  }

  /** @noinspection PhpUnusedPrivateMethodInspection */
  /**
   * @param mixed            $variable
   * @param KintVariableData $variableData
   */
  private static function _parse_boolean(&$variable, KintVariableData $variableData)
  {
    $variableData->type = 'bool';
    $variableData->value = $variable ? 'TRUE' : 'FALSE';
  }

  /** @noinspection PhpUnusedPrivateMethodInspection */
  /**
   * @param mixed            $variable
   * @param KintVariableData $variableData
   */
  private static function _parse_double(&$variable, KintVariableData $variableData)
  {
    $variableData->type = 'float';
    /** @noinspection ReferenceMismatchInspection */
    $variableData->value = $variable;
  }

  /** @noinspection PhpUnusedPrivateMethodInspection */
  /**
   * @param mixed            $variable
   * @param KintVariableData $variableData
   */
  private static function _parse_integer(&$variable, KintVariableData $variableData)
  {
    $variableData->type = 'integer';
    /** @noinspection ReferenceMismatchInspection */
    $variableData->value = $variable;
  }


  /** @noinspection PhpUnusedPrivateMethodInspection */
  /**
   * @param mixed            $variable
   * @param KintVariableData $variableData
   */
  private static function _parse_null(/** @noinspection PhpUnusedParameterInspection */
      &$variable, KintVariableData $variableData)

The parameter $variable is not used and could be removed.

  {
    $variableData->type = 'NULL';
  }

  /** @noinspection PhpUnusedPrivateMethodInspection */
  /**
   * @param mixed            $variable
   * @param KintVariableData $variableData
   *
   * @return bool
   */
  private static function _parse_object(&$variable, KintVariableData $variableData)
  {
    if (function_exists('spl_object_hash')) {
      $hash = spl_object_hash($variable);
    } else {
      ob_start();
      /** @noinspection ForgottenDebugOutputInspection */
      /** @noinspection ReferenceMismatchInspection */
      var_dump($variable);

var_dump($variable); looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data.

      preg_match('[#(\d+)]', ob_get_clean(), $match);
      $hash = $match[1];
    }

    $castedArray = (array)$variable;
    $variableData->type = get_class($variable);
    $variableData->size = count($castedArray);

    if (isset(self::$_objects[$hash])) {
      $variableData->value = '*RECURSION*';

      return false;
    }
    if (self::_checkDepth()) {
      $variableData->extendedValue = '*DEPTH TOO GREAT*';

It seems like '*DEPTH TOO GREAT*' of type string is incompatible with the declared type array<integer,object<kint\inc\KintVariableData>> of property $extendedValue.

      return false;
    }

    # ArrayObject (and maybe ArrayIterator, did not try yet) unsurprisingly consist of mainly dark magic.
    # What bothers me most, var_dump sees no problem with it, and ArrayObject also uses a custom,
    # undocumented serialize function, so you can see the properties in internal functions, but
    # can never iterate some of them if the flags are not STD_PROP_LIST. Fun stuff.
    if (
        $variableData->type === 'ArrayObject'
        ||
        is_subclass_of($variable, 'ArrayObject')
    ) {

      /* @var $variable \ArrayObject */

      $arrayObjectFlags = $variable->getFlags();
      $variable->setFlags(\ArrayObject::STD_PROP_LIST);
    }

    self::$_objects[$hash] = true; // TODO: store reflectorObject here for alternatives cache
    $reflector = new \ReflectionObject($variable);

    # add link to definition of user-land objects
    if (
        Kint::$fileLinkFormat
        &&
        Kint::enabled() === Kint::MODE_RICH
        &&
        $reflector->isUserDefined()
    ) {
      $url = Kint::getIdeLink($reflector->getFileName(), $reflector->getStartLine());

      $class = (strpos($url, 'http://') === 0) ? 'class="kint-ide-link" ' : '';
      $variableData->type = "<a {$class}href=\"{$url}\">{$variableData->type}</a>";
    }
    $variableData->size = 0;

    $extendedValue = array();
    $encountered = array();

    # copy the object as an array as it provides more info than Reflection (depends)
    foreach ($castedArray as $key => $value) {
      /* casting object to array:
       * integer properties are inaccessible;
       * private variables have the class name prepended to the variable name;
       * protected variables have a '*' prepended to the variable name.
       * These prepended values have null bytes on either side.
       * http://www.php.net/manual/en/language.types.array.php#language.types.array.casting
       */
      if ($key[0] === "\x00") {

        $access = $key[1] === '*' ? 'protected' : 'private';

        // Remove the access level from the variable name.
        $key = substr($key, strrpos($key, "\x00") + 1);
      } else {
        $access = 'public';
      }

      $encountered[$key] = true;

      $output = self::factory($value, self::escape($key));
      $output->access = $access;
      $output->operator = '->';
      $extendedValue[] = $output;
      $variableData->size++;
    }

    foreach ($reflector->getProperties() as $property) {
      $name = $property->name;
      if (
          isset($encountered[$name])
          ||
          $property->isStatic()
      ) {
        continue;
      }

      if ($property->isProtected()) {

This code seems to be duplicated across your project.

        $property->setAccessible(true);
        $access = 'protected';
      } elseif ($property->isPrivate()) {
        $property->setAccessible(true);
        $access = 'private';
      } else {
        $access = 'public';
      }

      $value = $property->getValue($variable);

      $output = self::factory($value, self::escape($name));
      $output->access = $access;
      $output->operator = '->';
      $extendedValue[] = $output;
      $variableData->size++;
    }

    if (isset($arrayObjectFlags)) {
      $variable->setFlags($arrayObjectFlags);
    }

    if ($variableData->size) {
      $variableData->extendedValue = $extendedValue;
    }

    return true;
  }

  /** @noinspection PhpUnusedPrivateMethodInspection */
  /**
   * @param mixed            $variable
   * @param KintVariableData $variableData
   */
  private static function _parse_resource(&$variable, KintVariableData $variableData)
  {
    $resourceType = get_resource_type($variable);
    $variableData->type = "resource ({$resourceType})";

    if (
        $resourceType === 'stream'
        &&
        $meta = stream_get_meta_data($variable)
    ) {

      /** @noinspection NestedPositiveIfStatementsInspection */
      if (isset($meta['uri'])) {
        $file = $meta['uri'];

        if (function_exists('stream_is_local')) {
          // Only exists on PHP >= 5.2.4
          if (stream_is_local($file)) {
            $file = Kint::shortenPath($file);
          }
        }

        $variableData->value = $file;
      }
    }
  }

  /** @noinspection PhpUnusedPrivateMethodInspection */
  /**
   * @param mixed            $variable
   * @param KintVariableData $variableData
   */
  private static function _parse_string(&$variable, KintVariableData $variableData)
  {
    $variableData->type = 'string';

    $encoding = self::_detectEncoding($variable);
    if ($encoding) {

The expression $encoding of type false|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

      $variableData->type .= ' [' . $encoding . ']';
    }

    $variableData->size = UTF8::strlen($variable);
    if (Kint::enabled() !== Kint::MODE_RICH) {
      $variableData->value = '"' . self::escape($variable, $encoding) . '"';

      return;
    }

    if (!self::$_placeFullStringInValue) {

      $strippedString = preg_replace('[\s+]', ' ', $variable);
      if (
          Kint::$maxStrLength
          &&
          $variableData->size > Kint::$maxStrLength
      ) {

        $tmpStrippedString = self::_substr($strippedString, 0, Kint::$maxStrLength, $encoding);

It seems like $encoding defined by self::_detectEncoding($variable) on line 558 can also be of type false; however, kint\inc\KintVariableData::_substr() does only seem to accept string|null, did you maybe forget to handle an error condition?

        // encode and truncate
        $variableData->value = '"' . self::escape($tmpStrippedString, $encoding) . '…"';
        $variableData->extendedValue = self::escape($variable, $encoding);

It seems like self::escape($variable, $encoding) of type string or null is incompatible with the declared type array<integer,object<kint\inc\KintVariableData>> of property $extendedValue.

        return;
      } elseif ($variable !== $strippedString) { // omit no data from display

        $variableData->value = '"' . self::escape($variable, $encoding) . '"';
        $variableData->extendedValue = self::escape($variable, $encoding);

        return;
      }
    }

    $variableData->value = '"' . self::escape($variable, $encoding) . '"';
  }

  /** @noinspection PhpUnusedPrivateMethodInspection */
  /**
   * @param mixed            $variable
   * @param KintVariableData $variableData
   */
  private static function _parse_unknown(&$variable, KintVariableData $variableData)
  {
    $type = gettype($variable);
    $variableData->type = 'UNKNOWN' . (!empty($type) ? " ({$type})" : '');
    $variableData->value = var_export($variable, true);
  }

  /**
   * @param mixed             $value
   * @param null|false|string $encoding
   *
   * @return string|null
   */
  public static function escape(&$value, $encoding = null)
  {
    if (empty($value)) {
      return $value;
    }

    $kintEnabled = Kint::enabled();

    if ($kintEnabled === Kint::MODE_CLI) {
      $value = str_replace("\x1b", '\\x1b', $value);
    }

    if (
        $kintEnabled === Kint::MODE_CLI
        ||
        $kintEnabled === Kint::MODE_WHITESPACE
    ) {
      return $value;
    }

    if (!$encoding) {
      $encoding = self::_detectEncoding($value);
    }

    $value = htmlspecialchars($value, ENT_NOQUOTES, $encoding === 'ASCII' ? 'UTF-8' : $encoding);

    // TODO: we could make the symbols hover-title show the code for the invisible symbol
    # when possible force invisible characters to have some sort of display (experimental)
    $value = UTF8::remove_invisible_characters($value, '?');

'?' is of type string, but the function expects a boolean.

    # this call converts all non-ASCII characters into html chars of format
    $value = UTF8::html_encode($value, true, $encoding);

It seems like $encoding can also be of type false; however, voku\helper\UTF8::html_encode() does only seem to accept string, did you maybe forget to handle an error condition?

    return $value;
  }

  /**
   * the only public entry point to return a parsed representation of a variable
   *
   * @static
   *
   * @param mixed       $variable
   * @param null|string $name
   *
   * @return KintParser
   */
  final public static function factory(&$variable, $name = null)
  {
    # save internal data to revert after dumping to properly handle recursions etc
    $revert = array(
        'level'   => self::$_level,
        'objects' => self::$_objects,
    );

    self::$_level++;

    $varData = new KintVariableData();
    $varData->name = $name;

    # first parse the variable based on its type
    $varType = gettype($variable);

    if ($varType === 'unknown type') {
      $varType = 'unknown'; # PHP 5.4 inconsistency
    }

    $methodName = '_parse_' . $varType;

    # objects can be presented in a different way altogether, INSTEAD, not ALONGSIDE the generic parser
    if ($varType === 'object') {
      foreach (self::$_objectParsers as $parserClass) {
        $className = 'kint\parsers\objects\Kint_Objects_' . $parserClass;

        /** @var $object KintObject */
        $object = new $className();
        if (($alternativeTabs = $object->parse($variable)) !== false) {
          self::$_skipAlternatives = true;
          $alternativeDisplay = new KintVariableData();
          $alternativeDisplay->type = $object->name;
          $alternativeDisplay->value = $object->value;
          $alternativeDisplay->name = $name;

          foreach ($alternativeTabs as $nameInner => $values) {
            $alternative = self::factory($values);
            $alternative->type = $nameInner;

It seems like $nameInner can also be of type integer. However, the property $type is declared as type string. Maybe add an additional type check?

            if (Kint::enabled() === Kint::MODE_RICH) {
              empty($alternative->value) and $alternative->value = $alternative->extendedValue;

It seems like $alternative->extendedValue of type array<integer,object<kint\inc\KintVariableData>> is incompatible with the declared type string of property $value.

Using logical operators such as and instead of && is generally not recommended.

              $alternativeDisplay->_alternatives[] = $alternative;
            } else {
              $alternativeDisplay->extendedValue[] = $alternative;
            }
          }

          self::$_skipAlternatives = false;
          self::$_level = $revert['level'];
          self::$_objects = $revert['objects'];

          return $alternativeDisplay;
        }
      }
    }

    # base type parser returning false means "stop processing further": e.g. recursion
    if (self::$methodName($variable, $varData) === false) {
      self::$_level--;

      return $varData;
    }

    if (
        !self::$_skipAlternatives
        &&
        Kint::enabled() === Kint::MODE_RICH
    ) {
      # if an alternative returns something that can be represented in an alternative way, don't :)
      self::$_skipAlternatives = true;

      # now check whether the variable can be represented in a different way
      foreach (self::$_customDataTypes as $parserClass) {
        $className = 'kint\parsers\custom\Kint_Parsers_' . $parserClass;

        /** @var $parser KintParser */

        $parser = new $className();
        $parser->name = $name; # the parser may overwrite the name value, so set it first

        if ($parser->_parse($variable) !== false) {
          $varData->_alternatives[] = $parser;
        }
      }

      # if alternatives exist, push extendedValue to their front and display it as one of alternatives
      if (!empty($varData->_alternatives) && isset($varData->extendedValue)) {
        $_ = new KintVariableData();

        $_->value = $varData->extendedValue;

It seems like $varData->extendedValue of type array<integer,object<kint\inc\KintVariableData>> is incompatible with the declared type string of property $value.

        $_->type = 'contents';
        $_->size = null;

        array_unshift($varData->_alternatives, $_);
        $varData->extendedValue = null;

It seems like null of type null is incompatible with the declared type array<integer,object<kint\inc\KintVariableData>> of property $extendedValue.

      }

      self::$_skipAlternatives = false;
    }

    self::$_level = $revert['level'];
    self::$_objects = $revert['objects'];

    if (strlen($varData->name) > 80) {
      $varData->name =
          self::_substr($varData->name, 0, 37)
          . '...'
          . self::_substr($varData->name, -38, null);
    }

    return $varData;
  }

  /**
   * reset
   */
  public static function reset()
  {
    self::$_level = 0;
    self::$_objects = self::$_marker = null;

It seems like self::$_marker = null of type null is incompatible with the declared type array of property $_objects.

  }

}