docgen is now adding inherited classes into the results properly.

Author: photonstorm

docgen/export.php

@@ -34,8 +34,15 @@
 <?php
     $gen = new PhaserDocGen();
     $gen->start();
+
+    $sprite = $gen->get('Phaser.Sprite');
+
+    echo $sprite;
+
     $gen->extend('Phaser.Sprite');
 
+    echo $sprite;
+
 
 
     // foreach ($gen->classes as $key => $processor)

docgen/src/ClassDesc.php

@@ -44,7 +44,7 @@ public function __construct($processor, $block)
             {
                 $this->extends = $block->getLineContent('@extends');
 
-                if (substr($this->extends, 0, 6) !== 'Phaser')
+                if (substr($this->extends, 0, 6) !== 'Phaser' && substr($this->extends, 0, 4) !== 'PIXI')
                 {
                     $this->extends = 'PIXI.' . $this->extends;
                 }

docgen/src/Method.php

@@ -8,6 +8,7 @@ class Method
         public $parameters = []; // an array containing the parameters
         public $help = [];
         public $returns = null;
+        public $inherited = false;
 
         public $isPublic = true;
         public $isProtected = false;

docgen/src/PhaserDocGen.php

@@ -19,24 +19,19 @@ public function __construct()
             $this->src = realpath('../src');
 
             $this->classes = [];
-
         }
 
         public function start()
         {
-            ob_start();
-
             $this->files = $this->dirToArray($this->src);
-
-            ob_end_flush();
         }
 
         public function extend($classKey = '')
         {
             if ($classKey !== '')
             {
                 echo "Extending $classKey\n";
-                $this->classes[classKey]->extend();
+                $this->classes[$classKey]->extend();
             }
             else
             {
@@ -46,12 +41,21 @@ public function extend($classKey = '')
                     $processor->extend();
 
                     echo "Extended $key\n";
-                    ob_flush();
                 }
             }
 
         }
 
+        public function get($classKey)
+        {
+            if (array_key_exists($classKey, $this->classes))
+            {
+                return $this->classes[$classKey];
+            }
+
+            return null;
+        }
+
         private function dirToArray($dir)
         {
             set_time_limit(60);
@@ -101,7 +105,6 @@ private function dirToArray($dir)
 
                             //  Dump to log
                             // echo $index . "\n";
-                            ob_flush();
                         }
                     }
                 } 

docgen/src/Processor.php

@@ -172,18 +172,16 @@ private function scanFile() {
 
         }
 
-        public function __toString()
+        public function getPublicProperties()
         {
-            if ($this->corrupted)
-            {
-                return "JSDoc Corrupted Class";
-            }
-            else
-            {
-                return "Class: " . $this->class->name . ", Methods: " . count($this->methods['public']);
-            }
+            return $this->properties['public'];
         }
-        
+
+        public function getPublicMethods()
+        {
+            return $this->methods['public'];
+        }
+       
         public function getArray()
         {
             $consts = [];
@@ -233,23 +231,63 @@ public function getConstsArray()
 
         public function extend()
         {
-            //  Need to iterate through all of the classes this may extend from, in order, and build it up
+            //  Quick bailout
+            if (!$this->class->extendsFrom())
+            {
+                echo "quick bailout\n";
+                return;
+            }
 
             $proc = $this;
-            $parents = [];
 
-            // while ($proc->class->extendsFrom)
-            // {
-            //     $parents[$proc->class->name] = $proc->getArray();
-            //     $proc = $this->docgen->get();
+            do
+            {
+                $extends = $proc->class->extends;
+                $proc = $this->docgen->get($extends);
+                echo "\n\nextend found: " . $proc->getName() . "\n";
+
+                $this->merge($proc);
+            }
+            while ($proc->class->extendsFrom());
+
+        }
+
+        public function merge($processor)
+        {
+            echo "Merging ...\n\n";
+
+            //  We only want to merge in public methods and properties.
+            //  Technically JavaScript merges in bloody everything, but for the sake of docs we'll keep them #public# only.
+
+            echo "Methods\n";
+            echo "-------\n";
 
-            // }
+            $inheritedMethods = $processor->getPublicMethods();
 
-            //  Is there anything to extend anyway?
-            if ($this->class->extendsFrom)
+            //  Flag them as inherited!
+            foreach ($inheritedMethods as $key => $method)
             {
+                echo $method->name . "\n";
+                $method->inherited = true;
+            }
+
+            $this->methods['public'] = array_merge($this->methods['public'], $inheritedMethods);
+
+            echo "\n";
+            echo "Properties\n";
+            echo "----------\n";
 
+            $inheritedProperties = $processor->getPublicProperties();
+
+            //  Flag them as inherited!
+            foreach ($inheritedProperties as $key => $property)
+            {
+                echo $property->name . "\n";
+                $property->inherited = true;
             }
+
+            $this->properties['public'] = array_merge($this->properties['public'], $inheritedProperties);
+
         }
 
         /**
@@ -273,5 +311,23 @@ public function getLog() {
 
         }
 
+        public function getName() {
+
+            return $this->class->name;
+
+        }
+
+        public function __toString()
+        {
+            if ($this->corrupted)
+            {
+                return "JSDoc Corrupted Class";
+            }
+            else
+            {
+                return "Class: " . $this->class->name . ", Methods: " . count($this->methods['public']) . ", Properties: " . count($this->properties['public']) . "\n";
+            }
+        }
+
     }
 ?>

docgen/src/Property.php

@@ -8,6 +8,7 @@ class Property
         public $default = null;     // assigned value is the default value
         public $help = [];
         public $inlineHelp = '';
+        public $inherited = false;
 
         public $isPublic = true;
         public $isProtected = false;