add description for field

Author: liquetsoft

src/EntityField/BaseEntityField.php

@@ -16,6 +16,11 @@ class BaseEntityField implements EntityField
      */
     protected $name;
 
+    /**
+     * @var string
+     */
+    protected $description;
+
     /**
      * @var string
      */
@@ -59,6 +64,7 @@ class BaseEntityField implements EntityField
     public function __construct(array $p)
     {
         $this->name = $this->extractStringFromOptions($p, 'name', true);
+        $this->description = $this->extractStringFromOptions($p, 'description');
         $this->type = $this->extractStringFromOptions($p, 'type', true);
         $this->subType = $this->extractStringFromOptions($p, 'subType');
         $this->length = isset($p['length']) ? (int) $p['length'] : null;
@@ -82,6 +88,14 @@ public function getName(): string
         return $this->name;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getDescription(): string
+    {
+        return $this->description;
+    }
+
     /**
      * @inheritdoc
      */

src/EntityField/EntityField.php

@@ -16,6 +16,13 @@ interface EntityField
      */
     public function getName(): string;
 
+    /**
+     * Возвращает описание поля.
+     *
+     * @return string
+     */
+    public function getDescription(): string;
+
     /**
      * Возвращает тип поля.
      *

tests/src/EntityField/BaseEntityFieldTest.php

@@ -27,13 +27,27 @@ public function testGetName()
         $this->assertSame($name, $field->getName());
     }
 
+    /**
+     * Проверяет, что объект правильно вернет описание поля.
+     */
+    public function testGetDescription()
+    {
+        $description = $this->createFakeData()->word;
+
+        $field = $this->createField([
+            'description' => $description,
+        ]);
+
+        $this->assertSame($description, $field->getDescription());
+    }
+
     /**
      * Проверяет, что объект правильно выбросит исключение, если имя не задано.
      */
     public function testEmptyNameException()
     {
         $this->expectException(InvalidArgumentException::class);
-        $field = $this->createField([
+        $this->createField([
             'name' => null,
         ]);
     }