Merge pull request #9 from PaVeL-Ekt/feature/add-sorted-fields

Добавил поддержку полей сортировки

README.md

@@ -141,6 +141,10 @@ Example:
 
 Use @restdoc-extraField and @restdoc-extraLink for extra fields.
 
+### Sort fields
+
+Use @restdoc-sortField to sort field according to your code.
+
 ## Integrate With Slate
 
 [Slate](https://github.com/tripit/slate) is probably one of the best tools to generate nice API. So you can 

models/ModelDoc.php

@@ -16,6 +16,8 @@ class ModelDoc extends Doc
 
     private $_fields = [];
 
+    private $_sortFields = [];
+
     private $_parent = null;
 
     private $_properties = [];
@@ -63,6 +65,14 @@ public function addExtraField($name, $type = '', $description = '')
         $this->_addField($this->_extraFields, $name, $type, $description);
     }
 
+    /**
+     * @param $name
+     */
+    public function addSortField($name)
+    {
+        $this->_addField($this->_sortFields, $name);
+    }
+
     /**
      * Adds scenario info
      *
@@ -90,6 +100,14 @@ public function getFields()
         return $this->_fields;
     }
 
+    /**
+     * @return \pahanini\restdoc\models\FieldDoc[]
+     */
+    public function getSortFields()
+    {
+        return $this->_sortFields;
+    }
+
     /**
      * @return \pahanini\restdoc\models\ControllerDoc
      */
@@ -161,6 +179,14 @@ public function hasFields()
         return !empty($this->_fields);
     }
 
+    /**
+     * @return bool If model has sort fields
+     */
+    public function hasSortFields()
+    {
+        return !empty($this->_sortFields);
+    }
+
     /**
      * @param string $name
      * @return bool
@@ -200,6 +226,11 @@ public function prepare()
             $this->addExtraField($name, $tag->getType(), $tag->getDescription());
         }
 
+        foreach ($this->getTagsByName('sortField') as $tag) {
+            $name = trim($tag->getContent(), '$');
+            $this->addSortField($name);
+        }
+
         foreach($this->getTagsByName('link') as $tag) {
             $name = trim($tag->getVariableName(), '$');
             $propertyName = $tag->getType() ? trim($tag->getType(), '\\') : $name;
@@ -238,6 +269,9 @@ public function prepare()
         foreach ($this->_extraFields as $field) {
             $field->prepare();
         }
+        foreach ($this->_sortFields as $field) {
+            $field->prepare();
+        }
     }
 
     public function setParent(Doc $value)

tests/models/Product.php

@@ -14,6 +14,7 @@ class Product extends ActiveRecord
     /**
      * @restdoc-field int $id
      * @restdoc-field string $title
+     * @restdoc-sortField $title
      */
     public function fields()
     {

tests/models/SpecialOffer.php

@@ -19,6 +19,7 @@ class SpecialOffer extends Product
      * @restdoc-field string $title
      * @restdoc-link comment $text
      * @restdoc-link $comment
+     * @restdoc-sortField $text
      */
     public function fields()
     {

tests/unit/models/ModelParserTest.php

@@ -23,6 +23,7 @@ public function testSimple()
 
         $this->assertTrue($doc->hasFields());
         $this->assertFalse($doc->hasExtraFields());
+        $this->assertTrue($doc->hasSortFields());
 
     }
 
@@ -55,6 +56,10 @@ public function testInherit()
         $this->assertEquals('string', $doc->fields['note']->type);
         $this->assertEquals('string', $doc->fields['text']->type);
 
+        $this->assertEquals(2, count($doc->sortFields));
+        $this->assertEquals('title', $doc->sortFields['title']->name);
+        $this->assertEquals('text', $doc->sortFields['text']->name);
+
         $this->assertTrue($doc->fields['id']->isInScenario('api-create'));
         $this->assertFalse($doc->fields['id']->isInScenario('api-update'));
 
@@ -63,6 +68,6 @@ public function testInherit()
 
         $this->assertTrue($doc->hasFields());
         $this->assertTrue($doc->hasExtraFields());
+        $this->assertTrue($doc->hasSortFields());
     }
-
 }