StringUtil::prettyJson() - handle JSON_ERROR_INVALID_PROPERTY_NAME error

ObjectAbstraction unserialize backwards compatibility enhancement

Author: bkdotcom

README.md

@@ -31,7 +31,7 @@ Log, Debug, Inspect
   * errors (even fatal) are captured / logged / displayed
   * optionally send error notices via email (throttled as to not to send out a flood of emails)
 * password protected
-* send debug log via email
+* send debug log via email / Discord / Slack / MS Teams
 
 ![Screenshot of PHPDebugConsole's Output](http://www.bradkent.com/images/php/screenshot_1.4.png)
 
@@ -59,7 +59,7 @@ See <http://www.bradkent.com/php/debug>
 
 ## PSR-3 Usage
 
-PHPDebugConsole includes a [PSR-3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md) implementation (which can be used as a [monolog](https://github.com/Seldaek/monolog) PSR handler).  If you're using a application or library that uses these standards, drop PHPDebugConsole right in.
+PHPDebugConsole includes a [PSR-3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md) implementation (which can be used as a [monolog](https://github.com/Seldaek/monolog) PSR handler).  If you're using an application or library that uses these standards, drop PHPDebugConsole right in.
 
 (this library includes neither psr/log or monolog/monolog.  Include separately if needed.)
 

src/Debug/Abstraction/AbstractObject.php

@@ -175,7 +175,7 @@ class AbstractObject extends AbstractComponent
         'cfgFlags' => 0, // will default to everything sans "brief" & 'virtualValueCollect'
         'className' => '',
         'debugMethod' => '',
-        'interfacesCollapse' => array(),  // cfg.interfacesCollapse
+        'interfacesCollapse' => array(),  // cfg.interfacesCollapse (intersected with reflector::getInterfaceNames())
         'isExcluded' => false,  // don't exclude if we're debugging directly
         'isLazy' => false,
         'isMaxDepth' => false,
@@ -211,6 +211,9 @@ public function __construct(Abstracter $abstracter)
             $subscriber = new Subscriber($this);
             $abstracter->debug->eventManager->addSubscriberInterface($subscriber);
         }
+
+        self::$values['sectionOrder'] = $abstracter->getCfg('objectSectionOrder');
+        self::$values['sort'] = $abstracter->getCfg('objectSort');
     }
 
     /**
@@ -326,8 +329,7 @@ private function doAbstraction(ObjectAbstraction $abs)
      */
     protected function getAbstractionValues(ReflectionClass $reflector, $obj, $method = null, array $hist = array())
     {
-        return \array_merge(
-            self::$values,
+        return static::buildValues(\array_merge(
             array(
                 'cfgFlags' => $this->getCfgFlags($reflector),
                 'className' => $this->helper->getClassName($reflector),
@@ -351,7 +353,7 @@ protected function getAbstractionValues(ReflectionClass $reflector, $obj, $metho
                 'propertyOverrideValues' => array(),
                 'reflector' => $reflector,
             )
-        );
+        ));
     }
 
     /**

src/Debug/Abstraction/AbstractString.php

@@ -326,7 +326,7 @@ private function getMaxLen($cat, $strlen)
         $stringMaxLen = $this->cfg['brief']
             ? $this->cfg['stringMaxLenBrief']
             : $this->cfg['stringMaxLen'];
-        $maxLen =  \array_key_exists($cat, $stringMaxLen)
+        $maxLen = \array_key_exists($cat, $stringMaxLen)
             ? $stringMaxLen[$cat]
             : $stringMaxLen['other'];
 

src/Debug/Abstraction/Object/Abstraction.php

@@ -14,6 +14,12 @@
 
 use bdk\Debug\Abstraction\Abstracter;
 use bdk\Debug\Abstraction\Abstraction as BaseAbstraction;
+use bdk\Debug\Abstraction\AbstractObject;
+use bdk\Debug\Abstraction\Object\Constants;
+use bdk\Debug\Abstraction\Object\Definition;
+use bdk\Debug\Abstraction\Object\MethodParams;
+use bdk\Debug\Abstraction\Object\Methods;
+use bdk\Debug\Abstraction\Object\Properties;
 use bdk\Debug\Abstraction\Type;
 use bdk\Debug\Utility\ArrayUtil;
 use bdk\PubSub\ValueStore;
@@ -80,9 +86,8 @@ public function __toString()
      */
     public function __unserialize(array $data)
     {
-        $this->inherited = isset($data['inherited'])
-            ? $data['inherited']
-            : new ValueStore();
+        $data = $this->unserializeDataPrep($data);
+        $this->inherited = $data['inherited'];
         unset($data['inherited']);
         $this->values = $data;
     }
@@ -209,11 +214,42 @@ public function offsetExists($key)
     #[\ReturnTypeWillChange]
     public function &offsetGet($key)
     {
+        if ($key === 'inherited') {
+            return $this->inherited;
+        }
         // update our local and return it as a reference
         $this->values[$key] = $this->getCombinedValue($key);
         return $this->values[$key];
     }
 
+    /**
+     * Make sure property and method info contains expected keys
+     *
+     * @param \ArrayAccess $data Either instance data or inherited data
+     *
+     * @return array
+     */
+    public static function unserializeBuildValues($data)
+    {
+        $data['constants'] = \array_map(static function (array $info) {
+            return Constants::buildValues($info);
+        }, $data['constants']);
+
+        $data['properties'] = \array_map(static function (array $info) {
+            return Properties::buildValues($info);
+        }, $data['properties']);
+
+        $data['methods'] = \array_map(static function (array $info) {
+            $info = Methods::buildValues($info);
+            $info['params'] = \array_map(static function (array $paramInfo) {
+                return MethodParams::buildValues($paramInfo);
+            }, $info['params']);
+            return $info;
+        }, $data['methods']);
+
+        return $data;
+    }
+
     /**
      * Get merged class & instance value
      *
@@ -299,4 +335,52 @@ protected function sortData(array $array)
         }
         return $sortData;
     }
+
+    /**
+     * Ensure data contains all expected keys
+     *
+     * @param array $data Serialized data
+     *
+     * @return array
+     */
+    private function unserializeDataPrep(array $data)
+    {
+        if (empty($data['definition'])) {
+            // we are instance values
+            $data = AbstractObject::buildValues($data);
+        }
+
+        if (empty($data['className'])) {
+            unset($data['className']);
+        }
+
+        $data['inherited'] = $this->unserializeDataInherited($data);
+
+        return $data;
+    }
+
+    /**
+     * Get inherited ValueStore
+     *
+     * @param array $data Serialized data
+     *
+     * @return ValueStore
+     */
+    private function unserializeDataInherited(array &$data)
+    {
+        if (isset($data['inherited'])) {
+            $inherited = $data['inherited'];
+            unset($data['inherited']);
+            return $this->unserializeBuildValues($inherited);
+        }
+        if (isset($data['classDefinition'])) {
+            // maintain backwards compatibility - v3.1 used 'classDefinition'
+            $inherited = $data['classDefinition'];
+            unset($data['classDefinition']);
+            return $this->unserializeBuildValues($inherited);
+        }
+        // maintain backwards compatibility - v3.0 did not inherit
+        $data = $this->unserializeBuildValues($data);
+        return new ValueStore(AbstractObject::buildValues(Definition::buildValues()));
+    }
 }

src/Debug/Abstraction/Object/Definition.php

@@ -151,14 +151,7 @@ public function getValueStoreDefault()
         if ($this->default) {
             return $this->default;
         }
-        $values = self::buildValues(array(
-            'isExcluded' => false,
-            'sectionOrder' => $this->object->getCfg('objectSectionOrder'),
-            'sort' => $this->object->getCfg('objectSort'),
-            'stringified' => null,
-            'traverseValues' => array(),
-            'viaDebugInfo' => false,
-        ));
+        $values = $this->object->buildValues(static::buildValues());
         $classValueStore = new ValueStore($values);
         $this->default = $classValueStore;
         $this->debug->data->set([

src/Debug/Collector/Doctrine/Statement.php

@@ -70,7 +70,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING): void
     public function execute($params = null): ResultInterface
     {
         $info = new StatementInfo($this->sql, $this->params, $this->types);
-        $result  = parent::execute();
+        $result = parent::execute();
 
         $exception = null;
         $result = false;

src/Debug/ConfigNormalizer.php

@@ -218,7 +218,7 @@ private function normalizePathFind($path)
             return $path;
         }
         $pathNew = $this->debug->arrayUtil->searchRecursive($path[0], $this->configKeys, true);
-        $pathNew =  $pathNew
+        $pathNew = $pathNew
             ? $pathNew
             : \array_merge(['debug'], $path);
         if (\end($pathNew) !== \end($path)) {

src/Debug/Dump/AbstractValue.php

@@ -393,7 +393,7 @@ protected function parseIdentifier($val, $what = 'className')
             $parts['classname'] = $val[0];
             $parts['operator'] = '::';
             $parts['name'] = $val[1];
-        } elseif (\preg_match('/^(.+)(::|->)(.+)$/', $val, $matches)) {
+        } elseif (\preg_match('/^(.+)(::|->)(.+)$/', (string) $val, $matches)) {
             $parts['classname'] = $matches[1];
             $parts['operator'] = $matches[2];
             $parts['name'] = $matches[3];

src/Debug/Dump/Html/HtmlString.php

@@ -189,7 +189,7 @@ private function dumpAbs(Abstraction $abs)
             $this->valDumper->optionSet('visualWhiteSpace', false);
             $this->valDumper->optionSet('postDump', $this->buildPrettifiedPostDump($abs));
         }
-        $val = $this->doDump((string) $abs);
+        $val = $this->doDump($abs);
         $strLenDiff = $abs['strlen'] - $abs['strlenValue'];
         if ($strLenDiff) {
             $val .= '<span class="maxlen">&hellip; ' . $this->debug->i18n->trans('string.more-bytes', array('bytes' => $strLenDiff)) . '</span>';
@@ -285,6 +285,7 @@ private function buildPrettifiedPostDump(Abstraction $abs)
     private function doDump($val)
     {
         $opts = $this->valDumper->optionGet();
+        $val = (string) $val;
         if ($opts['sanitize']) {
             $val = \htmlspecialchars($val);
         }

src/Debug/Dump/Html/HtmlStringBinary.php

@@ -130,7 +130,7 @@ private function dumpPost(Abstraction $abs, $tagName)
             $lis[] = $dumped
                 ? '<li class="t_string">' . $dumped . '</li>'
                 : '<li>' . $this->debug->i18n->trans('string.binary-not-collected') . '</li>';
-            $wrapped =  '<span class="t_keyword">string</span><span class="text-muted">(binary)</span>' . "\n"
+            $wrapped = '<span class="t_keyword">string</span><span class="text-muted">(binary)</span>' . "\n"
                 . $this->debug->html->buildTag(
                     'ul',
                     \array_filter(array(