added ability to add sort functions

Author: schmittjoh

src/CG/Core/DefaultGeneratorStrategy.php

@@ -2,23 +2,42 @@
 
 namespace CG\Core;
 
+use CG\Generator\DefaultVisitorInterface;
 use CG\Generator\PhpClass;
 use CG\Generator\DefaultVisitor;
 use CG\Generator\DefaultNavigator;
 
 class DefaultGeneratorStrategy implements GeneratorStrategyInterface
 {
-    public function generate(PhpClass $class)
+    private $navigator;
+    private $visitor;
+
+    public function __construct(DefaultVisitorInterface $visitor = null)
     {
-        static $navigator;
+        $this->navigator = new DefaultNavigator();
+        $this->visitor = $visitor ?: new DefaultVisitor();
+    }
 
-        if (empty($navigator)) {
-            $navigator = new DefaultNavigator();
-        }
+    public function setConstantSortFunc(\Closure $func = null)
+    {
+        $this->navigator->setConstantSortFunc($func);
+    }
 
-        $visitor = new DefaultVisitor();
-        $navigator->accept($visitor, $class);
+    public function setMethodSortFunc(\Closure $func = null)
+    {
+        $this->navigator->setMethodSortFunc($func);
+    }
+
+    public function setPropertySortFunc(\Closure $func = null)
+    {
+        $this->navigator->setPropertySortFunc($func);
+    }
+
+    public function generate(PhpClass $class)
+    {
+        $this->visitor->reset();
+        $this->navigator->accept($this->visitor, $class);
 
-        return $visitor->getContent();
+        return $this->visitor->getContent();
     }
 }

src/CG/Generator/DefaultNavigator.php

@@ -4,12 +4,33 @@
 
 class DefaultNavigator
 {
+    private $constantSortFunc;
+    private $propertySortFunc;
+    private $methodSortFunc;
+
+    public function setConstantSortFunc(\Closure $func = null)
+    {
+        $this->constantSortFunc = $func;
+    }
+
+    public function setPropertySortFunc(\Closure $func = null)
+    {
+        $this->propertySortFunc = $func;
+    }
+
+    public function setMethodSortFunc(\Closure $func = null)
+    {
+        $this->methodSortFunc = $func;
+    }
+
     public function accept(DefaultVisitorInterface $visitor, PhpClass $class)
     {
         $visitor->startVisitingClass($class);
 
         $constants = $class->getConstants();
         if (!empty($constants)) {
+            uksort($constants, $this->getConstantSortFunc());
+
             $visitor->startVisitingConstants();
             foreach ($constants as $name => $value) {
                 $visitor->visitConstant($name, $value);
@@ -19,6 +40,8 @@ public function accept(DefaultVisitorInterface $visitor, PhpClass $class)
 
         $properties = $class->getProperties();
         if (!empty($properties)) {
+            usort($properties, $this->getPropertySortFunc());
+
             $visitor->startVisitingProperties();
             foreach ($properties as $property) {
                 $visitor->visitProperty($property);
@@ -28,6 +51,8 @@ public function accept(DefaultVisitorInterface $visitor, PhpClass $class)
 
         $methods = $class->getMethods();
         if (!empty($methods)) {
+            usort($methods, $this->getMethodSortFunc());
+
             $visitor->startVisitingMethods();
             foreach ($methods as $method) {
                 $visitor->visitMethod($method);
@@ -37,4 +62,69 @@ public function accept(DefaultVisitorInterface $visitor, PhpClass $class)
 
         $visitor->endVisitingClass($class);
     }
+
+    private function getConstantSortFunc()
+    {
+        return $this->constantSortFunc ?: 'strcasecmp';
+    }
+
+    private function getMethodSortFunc()
+    {
+        if (null !== $this->methodSortFunc) {
+            return $this->methodSortFunc;
+        }
+
+        static $defaultSortFunc;
+        if (empty($defaultSortFunc)) {
+            $defaultSortFunc = function($a, $b) {
+                if ($a->isStatic() !== $isStatic = $b->isStatic()) {
+                    return $isStatic ? 1 : -1;
+                }
+
+                if (($aV = $a->getVisibility()) !== $bV = $b->getVisibility()) {
+                    $aV = 'public' === $aV ? 3 : ('protected' === $aV ? 2 : 1);
+                    $bV = 'public' === $bV ? 3 : ('protected' === $bV ? 2 : 1);
+
+                    return $aV > $bV ? -1 : 1;
+                }
+
+                $rs = strcasecmp($a->getName(), $b->getName());
+                if (0 === $rs) {
+                    return 0;
+                }
+
+                return $rs > 0 ? -1 : 1;
+            };
+        }
+
+        return $defaultSortFunc;
+    }
+
+    private function getPropertySortFunc()
+    {
+        if (null !== $this->propertySortFunc) {
+            return $this->propertySortFunc;
+        }
+
+        static $defaultSortFunc;
+        if (empty($defaultSortFunc)) {
+            $defaultSortFunc = function($a, $b) {
+                if (($aV = $a->getVisibility()) !== $bV = $b->getVisibility()) {
+                    $aV = 'public' === $aV ? 3 : ('protected' === $aV ? 2 : 1);
+                    $bV = 'public' === $bV ? 3 : ('protected' === $bV ? 2 : 1);
+
+                    return $aV > $bV ? -1 : 1;
+                }
+
+                $rs = strcasecmp($a->getName(), $b->getName());
+                if (0 === $rs) {
+                    return 0;
+                }
+
+                return $rs > 0 ? -1 : 1;
+            };
+        }
+
+        return $defaultSortFunc;
+    }
 }

src/CG/Generator/DefaultVisitor.php

@@ -11,6 +11,11 @@ public function __construct()
         $this->writer = new Writer();
     }
 
+    public function reset()
+    {
+        $this->writer->reset();
+    }
+
     public function startVisitingClass(PhpClass $class)
     {
         if ($namespace = $class->getNamespace()) {

src/CG/Generator/DefaultVisitorInterface.php

@@ -4,6 +4,7 @@
 
 interface DefaultVisitorInterface
 {
+    function reset();
     function startVisitingClass(PhpClass $class);
     function startVisitingConstants();
     function visitConstant($name, $value);

src/CG/Generator/NavigatorInterface.php

@@ -11,11 +11,6 @@ class LazyInitializingEntity extends \CG\Tests\Proxy\Fixture\Entity
     private $__CG__lazyInitializer;
     private $__CG__initialized = false;
 
-    public function __CG__setLazyInitializer(\CG\Proxy\LazyInitializerInterface $initializer)
-    {
-        $this->__CG__lazyInitializer = $initializer;
-    }
-
     public function getName()
     {
         if (false === $this->__CG__initialized) {
@@ -25,6 +20,11 @@ class LazyInitializingEntity extends \CG\Tests\Proxy\Fixture\Entity
         return \CG\Tests\Proxy\Fixture\Entity::getName();
     }
 
+    public function __CG__setLazyInitializer(\CG\Proxy\LazyInitializerInterface $initializer)
+    {
+        $this->__CG__lazyInitializer = $initializer;
+    }
+
     private function __CG__initialize()
     {
         if (null === $this->__CG__lazyInitializer) {