Mass export ability added to docgen.

photonstorm · photonstorm · commit e945defb86ad · 2014-09-18T16:58:47.000+01:00
diff --git a/docgen/export.php b/docgen/export.php
@@ -1,11 +1,4 @@
 <?php
-    $src = "loader/Cache.js";
-
-    if (isset($_GET['src']))
-    {
-        $src = $_GET['src'];
-    }
-
     require 'src/Block.php';
     require 'src/ClassDesc.php';
     require 'src/Constant.php';
@@ -14,10 +7,36 @@
     require 'src/Property.php';
     require 'src/ReturnType.php';
     require 'src/Processor.php';
+    require 'src/PhaserDocGen.php';
 
-    $data = new Processor("../src/$src");
+    $gen = new PhaserDocGen();
+?>
+<!doctype html>
+<html>
+    <head>
+        <meta charset="UTF-8" />
+        <title>Phaser Documentation Generator</title>
+        <style type="text/css">
+            body {
+                font-family: Arial;
+                font-size: 14px;
+                background-color: #fff;
+                color: #000;
+            }
 
-    header('Content-Type: application/json');
+            textarea {
+                width: 100%;
+                height: 1000px;
+            }
+        </style>
+    </head>
+    <body>
+
+    <pre>
+<?php
+    $gen->start();
+?>
+    </pre>
 
-    echo $data->getJSON();
-?>
+</body>
+</html>
diff --git a/docgen/index.php b/docgen/index.php
@@ -19,6 +19,8 @@
     </head>
     <body>
 
+    <a href="export.php">Export</a>
+
 <?php
     // http://uk1.php.net/manual/en/class.splfileinfo.php
 
diff --git a/docgen/src/ClassDesc.php b/docgen/src/ClassDesc.php
@@ -1,6 +1,7 @@
 <?php
     class ClassDesc
     {
+        public $processor;
         public $name; // Phaser.Sprite
         public $parameters = []; // an array containing the parameters
         public $help = [];
@@ -9,15 +10,21 @@ class ClassDesc
         public $hasConstructor = false;
         public $isStatic = false;
 
-        public function __construct($block)
+        public function __construct($processor, $block)
         {
+            $this->processor = $processor;
+
             $this->name = $block->getLineContent('@class');
 
+            $this->processor->log("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv");
+            $this->processor->log("Class: $this->name");
+            $this->processor->log("^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
+
             $params = $block->getLines('@param');
 
             for ($i = 0; $i < count($params); $i++)
             {
-                $this->parameters[] = new Parameter($params[$i]);
+                $this->parameters[] = new Parameter($this->processor, $params[$i]);
             }
 
             if ($block->getTypeBoolean('@extends'))
diff --git a/docgen/src/Constant.php b/docgen/src/Constant.php
@@ -1,13 +1,16 @@
 <?php
     class Constant
     {
+        public $processor;
         public $name; // TEXTURE_ATLAS_JSON_ARRAY, PHYSICS_PHASER_JSON, etc
         public $types = []; // an array containing the one single type the const can be
         public $help = [];
         public $line; // number, line number in the source file this is found on?
 
-        public function __construct($block)
+        public function __construct($processor, $block)
         {
+            $this->processor = $processor;
+
             //  Because zero offset + allowing for final line
             $this->line = $block->end + 2;
 
diff --git a/docgen/src/Method.php b/docgen/src/Method.php
@@ -1,6 +1,7 @@
 <?php
     class Method
     {
+        public $processor;
         public $line; // number, line number in the source file this is found on?
         public $name; // bringToTop, kill, etc
         public $title = [];
@@ -14,8 +15,10 @@ class Method
 
         public $isStatic = false;
 
-        public function __construct($block)
+        public function __construct($processor, $block)
         {
+            $this->processor = $processor;
+
             //  Because zero offset + allowing for final line
             $this->line = $block->end + 2;
 
@@ -47,13 +50,17 @@ public function __construct($block)
                 }
             }
 
+            $this->processor->log("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv");
+            $this->processor->log("Method: $name");
+            $this->processor->log("^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
+
             $this->name = $name;
 
             $params = $block->getLines('@param');
 
             for ($i = 0; $i < count($params); $i++)
             {
-                $this->parameters[] = new Parameter($params[$i]);
+                $this->parameters[] = new Parameter($this->processor, $params[$i]);
             }
 
             if ($block->getTypeBoolean('@protected'))
diff --git a/docgen/src/Parameter.php b/docgen/src/Parameter.php
@@ -1,24 +1,32 @@
 <?php
     class Parameter
     {
+        public $processor;
         public $name; // rect, copy, etc
         public $types = []; // an array containing all possible types it can be: string, number, etc
         public $help = [];
         public $optional = false;
         public $default = null; // assigned value is the default value
         public $debug = '';
 
-        public function __construct($line)
+        public function __construct($processor, $line)
         {
+            $this->processor = $processor;
+
             preg_match("/.*(@param)\s?{(\S*)} (\S*)( - ?)?(.*)/", $line, $output);
 
+            // $this->processor->log("Parameter count: " . count($output));
+
             if (count($output) > 2)
             {
+                // $this->processor->log("parsePhaser parameter");
                 $this->parsePhaser($output);
             }
             else
             {
                 preg_match("/(@param)\s(\S*)\s{(\S*)}\s?(.*)?/", $line, $output);
+
+                // $this->processor->log("parsePixi parameter");
                 $this->parsePixi($output);
             }
 
@@ -27,6 +35,8 @@ public function __construct($line)
         public function parsePhaser($output)
         {
             $name = $output[3];
+            
+            $this->processor->log("parameter: $name");
 
             if ($name[0] === '[')
             {
@@ -75,6 +85,8 @@ public function parsePixi($output)
             $this->name = $output[2];
             $this->types[] = $output[3];
 
+            $this->processor->log("parameter: $this->name");
+
             if (isset($output[4]))
             {
                 $this->help[] = $output[4];
diff --git a/docgen/src/PhaserDocGen.php b/docgen/src/PhaserDocGen.php
@@ -0,0 +1,79 @@
+<?php
+    class PhaserDocGen
+    {
+        private $src;
+        private $ignore = array('.', '..');
+        private $fileIgnore = array('p2.js');
+
+        public $log;
+        public $files;
+        public $classes;
+
+        /**
+        * Processes the Phaser / Pixi source code
+        * 
+        * @return PhaserDocGen
+        */
+        public function __construct()
+        {
+            $this->src = realpath('../src');
+
+            $this->classes = [];
+
+        }
+
+        public function start()
+        {
+            ob_start();
+
+            $this->files = $this->dirToArray($this->src);
+
+            ob_end_flush();
+        }
+
+        private function dirToArray($dir)
+        {
+            //  set timeout
+            set_time_limit(60);
+
+            $result = [];
+            $root = scandir($dir); 
+            $dirs = array_diff($root, $this->ignore);
+
+            foreach ($dirs as $key => $value) 
+            { 
+                $path = realpath($dir . DIRECTORY_SEPARATOR . $value);
+
+                if (is_dir($path)) 
+                {
+                    $result[$value] = $this->dirToArray($path); 
+                } 
+                else 
+                {
+                    if (substr($value, -3) === '.js')
+                    {
+                        if (!in_array($value, $this->fileIgnore))
+                        {
+                            $index = str_replace($this->src, "", $path);
+                            $index = substr($index, 1);
+                            $result[substr($value, 0, -3)] = $index;
+
+                            $this->classes[substr($value, 0, -3)] = new Processor("../src/$index");
+
+                            //  Dump to log
+                            echo $index . "\n";
+
+                            ob_flush();
+                            // $this->log[] = $value;
+                        }
+                    }
+                } 
+            } 
+
+            return $result; 
+
+        }
+
+    }
+
+?>
diff --git a/docgen/src/Processor.php b/docgen/src/Processor.php
@@ -9,6 +9,8 @@ class Processor
         public $methods;
         public $properties;
 
+        public $processLog;
+
         /**
         * Processes the given JS source file.
         * 
@@ -25,6 +27,19 @@ public function __construct($file)
             $this->scanFile();
         }
 
+        public function log($text) {
+
+            $this->processLog[] = $text;
+
+        }
+
+        public function getLog() {
+
+            return $this->processLog;
+            // return array_reverse($this->processLog);
+
+        }
+
         /**
         * Scans the given JS source file and extracts blocks from it
         */
@@ -77,21 +92,23 @@ private function scanFile() {
             {
                 if ($this->blocks[$i]->isClass)
                 {
-                    $this->class = new ClassDesc($this->blocks[$i]);
+                    $this->class = new ClassDesc($this, $this->blocks[$i]);
                 }
                 else if ($this->blocks[$i]->isConst)
                 {
-                    $tempConst = new Constant($this->blocks[$i]);
+                    $tempConst = new Constant($this, $this->blocks[$i]);
+
                     $this->consts[$tempConst->name] = $tempConst;
                 }
                 else if ($this->blocks[$i]->isMethod)
                 {
-                    $tempMethod = new Method($this->blocks[$i]);
+                    $tempMethod = new Method($this, $this->blocks[$i]);
+
                     $this->methods[$tempMethod->name] = $tempMethod;
                 }
                 else if ($this->blocks[$i]->isProperty)
                 {
-                    $tempProperty = new Property($this->blocks[$i]);
+                    $tempProperty = new Property($this, $this->blocks[$i]);
 
                     if ($tempProperty->corrupted === false)
                     {
diff --git a/docgen/src/Property.php b/docgen/src/Property.php
@@ -1,6 +1,7 @@
 <?php
     class Property
     {
+        public $processor;
         public $line;               // number, line number in the source file this is found on
         public $name;               // visible, name, parent
         public $types = [];         // an array containing all possible types it can be: string, number, etc
@@ -15,8 +16,10 @@ class Property
 
         public $corrupted = false;
 
-        public function __construct($block)
+        public function __construct($processor, $block)
         {
+            $this->processor = $processor;
+
             //  Because zero offset + allowing for final line
             $this->line = $block->end + 2;
 
diff --git a/docgen/view.php b/docgen/view.php
@@ -56,6 +56,10 @@
     <h1><?php echo $src ?></h1>
 
 <?php
+    echo "<pre>";
+    print_r($data->getLog());
+    echo "</pre>";
+
     echo "<pre>";
     print_r($data->class->getArray());
     echo "</pre>";

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`<?php`
`2`	`2`	`class Method`
`3`	`3`	`{`
	`4`	`+ public $processor;`
`4`	`5`	`public $line; // number, line number in the source file this is found on?`
`5`	`6`	`public $name; // bringToTop, kill, etc`
`6`	`7`	`public $title = [];`
`@@ -14,8 +15,10 @@ class Method`
`14`	`15`
`15`	`16`	`public $isStatic = false;`
`16`	`17`
`17`		`- public function __construct($block)`
	`18`	`+ public function __construct($processor, $block)`
`18`	`19`	`{`
	`20`	`+ $this->processor = $processor;`
	`21`	`+`
`19`	`22`	`// Because zero offset + allowing for final line`
`20`	`23`	`$this->line = $block->end + 2;`
`21`	`24`
`@@ -47,13 +50,17 @@ public function __construct($block)`
`47`	`50`	`}`
`48`	`51`	`}`
`49`	`52`
	`53`	`+ $this->processor->log("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv");`
	`54`	`+ $this->processor->log("Method: $name");`
	`55`	`+ $this->processor->log("^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^");`
	`56`	`+`
`50`	`57`	`$this->name = $name;`
`51`	`58`
`52`	`59`	`$params = $block->getLines('@param');`
`53`	`60`
`54`	`61`	`for ($i = 0; $i < count($params); $i++)`
`55`	`62`	`{`
`56`		`- $this->parameters[] = new Parameter($params[$i]);`
	`63`	`+ $this->parameters[] = new Parameter($this->processor, $params[$i]);`
`57`	`64`	`}`
`58`	`65`
`59`	`66`	`if ($block->getTypeBoolean('@protected'))`
Original file line number	Diff line number	Diff line change
`@@ -1,24 +1,32 @@`
`1`	`1`	`<?php`
`2`	`2`	`class Parameter`
`3`	`3`	`{`
	`4`	`+ public $processor;`
`4`	`5`	`public $name; // rect, copy, etc`
`5`	`6`	`public $types = []; // an array containing all possible types it can be: string, number, etc`
`6`	`7`	`public $help = [];`
`7`	`8`	`public $optional = false;`
`8`	`9`	`public $default = null; // assigned value is the default value`
`9`	`10`	`public $debug = '';`
`10`	`11`
`11`		`- public function __construct($line)`
	`12`	`+ public function __construct($processor, $line)`
`12`	`13`	`{`
	`14`	`+ $this->processor = $processor;`
	`15`	`+`
`13`	`16`	`preg_match("/.(@param)\s?{(\S)} (\S)( - ?)?(.)/", $line, $output);`
`14`	`17`
	`18`	`+ // $this->processor->log("Parameter count: " . count($output));`
	`19`	`+`
`15`	`20`	`if (count($output) > 2)`
`16`	`21`	`{`
	`22`	`+ // $this->processor->log("parsePhaser parameter");`
`17`	`23`	`$this->parsePhaser($output);`
`18`	`24`	`}`
`19`	`25`	`else`
`20`	`26`	`{`
`21`	`27`	`preg_match("/(@param)\s(\S)\s{(\S)}\s?(.*)?/", $line, $output);`
	`28`	`+`
	`29`	`+ // $this->processor->log("parsePixi parameter");`
`22`	`30`	`$this->parsePixi($output);`
`23`	`31`	`}`
`24`	`32`
`@@ -27,6 +35,8 @@ public function __construct($line)`
`27`	`35`	`public function parsePhaser($output)`
`28`	`36`	`{`
`29`	`37`	`$name = $output[3];`
	`38`	`+`
	`39`	`+ $this->processor->log("parameter: $name");`
`30`	`40`
`31`	`41`	`if ($name[0] === '[')`
`32`	`42`	`{`
`@@ -75,6 +85,8 @@ public function parsePixi($output)`
`75`	`85`	`$this->name = $output[2];`
`76`	`86`	`$this->types[] = $output[3];`
`77`	`87`
	`88`	`+ $this->processor->log("parameter: $this->name");`
	`89`	`+`
`78`	`90`	`if (isset($output[4]))`
`79`	`91`	`{`
`80`	`92`	`$this->help[] = $output[4];`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@ class Processor`
`9`	`9`	`public $methods;`
`10`	`10`	`public $properties;`
`11`	`11`
	`12`	`+ public $processLog;`
	`13`	`+`
`12`	`14`	`/**`
`13`	`15`	`* Processes the given JS source file.`
`14`	`16`	`*`
`@@ -25,6 +27,19 @@ public function __construct($file)`
`25`	`27`	`$this->scanFile();`
`26`	`28`	`}`
`27`	`29`
	`30`	`+ public function log($text) {`
	`31`	`+`
	`32`	`+ $this->processLog[] = $text;`
	`33`	`+`
	`34`	`+ }`
	`35`	`+`
	`36`	`+ public function getLog() {`
	`37`	`+`
	`38`	`+ return $this->processLog;`
	`39`	`+ // return array_reverse($this->processLog);`
	`40`	`+`
	`41`	`+ }`
	`42`	`+`
`28`	`43`	`/**`
`29`	`44`	`* Scans the given JS source file and extracts blocks from it`
`30`	`45`	`*/`
`@@ -77,21 +92,23 @@ private function scanFile() {`
`77`	`92`	`{`
`78`	`93`	`if ($this->blocks[$i]->isClass)`
`79`	`94`	`{`
`80`		`- $this->class = new ClassDesc($this->blocks[$i]);`
	`95`	`+ $this->class = new ClassDesc($this, $this->blocks[$i]);`
`81`	`96`	`}`
`82`	`97`	`else if ($this->blocks[$i]->isConst)`
`83`	`98`	`{`
`84`		`- $tempConst = new Constant($this->blocks[$i]);`
	`99`	`+ $tempConst = new Constant($this, $this->blocks[$i]);`
	`100`	`+`
`85`	`101`	`$this->consts[$tempConst->name] = $tempConst;`
`86`	`102`	`}`
`87`	`103`	`else if ($this->blocks[$i]->isMethod)`
`88`	`104`	`{`
`89`		`- $tempMethod = new Method($this->blocks[$i]);`
	`105`	`+ $tempMethod = new Method($this, $this->blocks[$i]);`
	`106`	`+`
`90`	`107`	`$this->methods[$tempMethod->name] = $tempMethod;`
`91`	`108`	`}`
`92`	`109`	`else if ($this->blocks[$i]->isProperty)`
`93`	`110`	`{`
`94`		`- $tempProperty = new Property($this->blocks[$i]);`
	`111`	`+ $tempProperty = new Property($this, $this->blocks[$i]);`
`95`	`112`
`96`	`113`	`if ($tempProperty->corrupted === false)`
`97`	`114`	`{`