Added ApiRenderer::renderDefaultValue, fixed #38

close #122

Author: hiqsol

CHANGELOG.md

@@ -4,7 +4,7 @@ Yii Framework 2 apidoc extension Change Log
 2.1.1 under development
 -----------------------
 
-- no changes in this release.
+- Enh #38: Fixed display of default values given as octal or hex notation (hiqsol)
 
 
 2.1.0 November 22, 2016

templates/html/ApiRenderer.php

@@ -247,7 +247,7 @@ public function renderPropertySignature($property, $context = null)
         return '<span class="signature-defs">' . implode(' ', $definition) . '</span> '
             . '<span class="signature-type">' . $this->createTypeLink($property->types, $context) . '</span>'
             . ' ' . $this->createSubjectLink($property, $property->name) . ' '
-            . ApiMarkdown::highlight('= ' . ($property->defaultValue === null ? 'null' : $property->defaultValue), 'php');
+            . ApiMarkdown::highlight('= ' . $this->renderDefaultValue($property->defaultValue), 'php');
     }
 
     /**
@@ -262,7 +262,7 @@ public function renderMethodSignature($method, $context = null)
                 . ($param->isPassedByReference ? '<b>&</b>' : '')
                 . ApiMarkdown::highlight(
                     $param->name
-                    . ($param->isOptional ? ' = ' . $param->defaultValue : ''),
+                    . ($param->isOptional ? ' = ' . $this->renderDefaultValue($param->defaultValue) : ''),
                     'php'
                 );
         }
@@ -283,6 +283,38 @@ public function renderMethodSignature($method, $context = null)
             . str_replace('  ', ' ', ' ( ' . implode(', ', $params) . ' )');
     }
 
+    /**
+     * Renders the default value.
+     * @param mixed $value
+     * @return string
+     * @since 2.1.1
+     */
+    public function renderDefaultValue($value)
+    {
+        if ($value === null) {
+            return 'null';
+        }
+
+        // special numbers which are usually used in octal or hex notation
+        static $specials = [
+            // file permissions
+            '420' => '0644',
+            '436' => '0664',
+            '438' => '0666',
+            '493' => '0755',
+            '509' => '0775',
+            '511' => '0777',
+            // colors used in yii\captcha\CaptchaAction
+            '2113696' => '0x2040A0',
+            '16777215' => '0xFFFFFF',
+        ];
+        if (isset($specials[$value])) {
+            return $specials[$value];
+        }
+
+        return $value;
+    }
+
     /**
      * @inheritdoc
      */