Merge pull request #1 from open-code-modeling/feature/typed-property

Add support for typed properties

Author: sandrokeil

src/Code/PropertyGenerator.php

@@ -10,6 +10,7 @@
 
 namespace OpenCodeModeling\CodeAst\Code;
 
+use PhpParser\Comment\Doc;
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Property;
 
@@ -23,6 +24,11 @@
  */
 final class PropertyGenerator extends AbstractMemberGenerator
 {
+    /**
+     * @var TypeGenerator|null
+     */
+    private $type;
+
     /**
      * @var ValueGenerator
      */
@@ -31,37 +37,61 @@ final class PropertyGenerator extends AbstractMemberGenerator
     /**
      * @var bool
      */
-    private $omitDefaultValue = false;
+    private $typed = false;
 
-    /**
-     * @param string $name
-     * @param ValueGenerator|string|array $defaultValue
-     * @param int $flags
-     */
-    public function __construct($name = null, $defaultValue = null, $flags = self::FLAG_PRIVATE)
-    {
+    public function __construct(
+        string $name = null,
+        string $type = null,
+        $defaultValue = null,
+        bool $typed = false,
+        int $flags = self::FLAG_PRIVATE
+    ) {
         if (null !== $name) {
             $this->setName($name);
         }
+
+        if (null !== $type) {
+            $this->setType($type);
+        }
+
         if (null !== $defaultValue) {
             $this->setDefaultValue($defaultValue);
         }
+
+        $this->typed = $typed;
+
         if ($flags !== self::FLAG_PUBLIC) {
             $this->setFlags($flags);
         }
     }
 
+    /**
+     * @param string $type
+     * @return ParameterGenerator
+     */
+    public function setType($type): self
+    {
+        $this->type = TypeGenerator::fromTypeString($type);
+
+        return $this;
+    }
+
+    public function getType(): TypeGenerator
+    {
+        return $this->type;
+    }
+
     /**
      * @param ValueGenerator|mixed $defaultValue
-     * @param string                       $defaultValueType
+     * @param string $defaultValueType
      *
      * @return PropertyGenerator
      */
     public function setDefaultValue(
         $defaultValue,
         $defaultValueType = ValueGenerator::TYPE_AUTO
     ): self {
-        if (! $defaultValue instanceof ValueGenerator) {
+        if (!$defaultValue instanceof ValueGenerator) {
             $defaultValue = new ValueGenerator($defaultValue, $defaultValueType);
         }
 
@@ -80,14 +110,27 @@ public function getDefaultValue(): ValueGenerator
 
     public function generate(): Property
     {
+        $propComment = <<<EOF
+/**
+ * @var {$this->type->type()}
+ */
+EOF;
+        $attributes = [];
+
+        if ($this->typed === false) {
+            $attributes = ['comments' => [new Doc($propComment)]];
+        }
+
         return new Property(
             $this->flags,
             [
                 new Node\Stmt\PropertyProperty(
                     $this->name,
                     $this->defaultValue ? $this->defaultValue->generate() : null
                 ),
-            ]
+            ],
+            $attributes,
+            $this->typed ? $this->type->type() : null
         );
     }
 }

src/Code/TypeGenerator.php

@@ -108,6 +108,11 @@ private function __construct()
     {
     }
 
+    public function type(): string
+    {
+        return $this->type;
+    }
+
     public function generate(): NodeAbstract
     {
         $nullable = $this->nullable ? '?' : '';