Merge branch 'feature/issue-11' into develop

Author: mikaelcom

CHANGELOG.md

@@ -1,13 +1,20 @@
 # CHANGELOG
 
+## 4.0.0 - 2021/02/xx
+- issue #11 - Allow class property to be typed
+- Clear, refactor and review code
+- Introduce `AccessRestrictedElementInterface`, `AssignedValueElementInterface` and `TypeHintedElementInterface`
+- Introduce `AccessRestrictedElementTrait`, `AssignedValueElementTrait` and `TypeHintedElementTrait`
+- Version 3.0 is no more maintained
+
 ## 3.0.2 - 2021/01/28
 - Update Travis CI badge and settings
 
 ## 3.0.1 - 2021/01/26
 - Fix typo
 
 ## 3.0.0 - 2021/01/26
-- use `splitbrain/phpfarm:jessie` as Docker image and fix docker image settings
+- Use `splitbrain/phpfarm:jessie` as Docker image and fix docker image settings
 - Code requires PHP >= 7.4
 - Code cleaning
 - BC:

UPGRADE-4.0.md

@@ -0,0 +1,6 @@
+# UPGRADE FROM 3.* to 4.*
+
+The main change is that `PhpProperty` are now type hinted in addition to internal methods removal and introduction of Interfaces and Traits
+- `WsdlToPhp\PhpGenerator\Element\PhpProperty::__construct` has a new parameter in the end named `$type` which can be any of the regular PHP types, or any existing PHP class or a PhpClass element or a string or a null value
+
+Apart from that, the usage did not change, the inner classes has changed which should not be an issue if you did not inherit from them. Otherwise, launch your unit tests ;).

src/Component/AbstractComponent.php

@@ -25,19 +25,9 @@ public function __toString(): string
 
     public function toString(): string
     {
-        $content = [];
-        foreach ($this->getElements() as $element) {
-            $content[] = $this->getElementString($element);
-        }
-
-        return implode('', $content);
+        return (string) $this->mainElement;
     }
 
-    /**
-     * @return AbstractElement[]|string[]
-     */
-    abstract public function getElements(): array;
-
     public function setMainElement(AbstractElement $element): self
     {
         if ($element instanceof PhpFileElement || $element instanceof PhpClassElement) {
@@ -49,14 +39,6 @@ public function setMainElement(AbstractElement $element): self
         return $this;
     }
 
-    /**
-     * @return PhpClassElement|PhpFileElement
-     */
-    public function getMainElement(): AbstractElement
-    {
-        return $this->mainElement;
-    }
-
     public function addConstantElement(PhpConstantElement $constant): self
     {
         if (!$constant->getClass() instanceof PhpClassElement && $this->mainElement instanceof PhpClassElement) {
@@ -69,8 +51,6 @@ public function addConstantElement(PhpConstantElement $constant): self
 
     /**
      * @param mixed $value
-     *
-     * @return AbstractComponent
      */
     public function addConstant(string $name, $value = null, ?PhpClassElement $class = null): self
     {
@@ -86,8 +66,6 @@ public function addAnnotationBlockElement(PhpAnnotationBlockElement $annotationB
 
     /**
      * @param array|PhpAnnotationBlockElement|string $annotations
-     *
-     * @return AbstractComponent
      */
     public function addAnnotationBlock($annotations): self
     {
@@ -96,20 +74,10 @@ public function addAnnotationBlock($annotations): self
         ]));
     }
 
-    /**
-     * @param AbstractElement|string $element
-     *
-     * @throws InvalidArgumentException
-     */
-    protected function getElementString($element): string
+    public function addString(string $string = ''): self
     {
-        $string = '';
-        if (is_scalar($element)) {
-            $string = $element;
-        } elseif ($element instanceof AbstractElement) {
-            $string = $element->toString();
-        }
+        $this->mainElement->addChild($string);
 
-        return $string;
+        return $this;
     }
 }

src/Component/PhpClass.php

@@ -15,34 +15,27 @@ public function __construct(string $name, bool $abstract = false, ?string $exten
         $this->setMainElement(new PhpClassElement($name, $abstract, $extends, $interfaces));
     }
 
-    public function addMethodElement(PhpMethodElement $method): AbstractComponent
+    public function addMethodElement(PhpMethodElement $method): self
     {
         $this->mainElement->addChild($method);
 
         return $this;
     }
 
-    public function addMethod(string $name, array $parameters = [], ?string $returnType = null, string $access = PhpMethodElement::ACCESS_PUBLIC, bool $abstract = false, bool $static = false, bool $final = false, bool $hasBody = true): AbstractComponent
+    public function addMethod(string $name, array $parameters = [], ?string $returnType = null, string $access = PhpMethodElement::ACCESS_PUBLIC, bool $abstract = false, bool $static = false, bool $final = false, bool $hasBody = true): self
     {
         return $this->addMethodElement(new PhpMethodElement($name, $parameters, $returnType, $access, $abstract, $static, $final, $hasBody));
     }
 
-    public function addPropertyElement(PhpPropertyElement $property): AbstractComponent
+    public function addPropertyElement(PhpPropertyElement $property): self
     {
         $this->mainElement->addChild($property);
 
         return $this;
     }
 
-    public function addProperty(string $name, $value = null, string $access = PhpPropertyElement::ACCESS_PUBLIC): AbstractComponent
+    public function addProperty(string $name, $value = null, string $access = PhpPropertyElement::ACCESS_PUBLIC, $type = null): self
     {
-        return $this->addPropertyElement(new PhpPropertyElement($name, $value, $access));
-    }
-
-    public function getElements(): array
-    {
-        return [
-            $this->getMainElement(),
-        ];
+        return $this->addPropertyElement(new PhpPropertyElement($name, $value, $access, $type));
     }
 }

src/Component/PhpFile.php

@@ -18,16 +18,6 @@ public function __construct(string $name)
         $this->setMainElement(new PhpFileElement($name));
     }
 
-    /**
-     * @return PhpFileElement[]
-     */
-    public function getElements(): array
-    {
-        return [
-            $this->getMainElement(),
-        ];
-    }
-
     public function addClassComponent(PhpClassComponent $class): self
     {
         $this->mainElement->addChild($class->toString());

src/Component/PhpInterface.php

@@ -15,7 +15,7 @@ public function __construct(string $name, bool $abstract = false, ?string $exten
         $this->setMainElement(new PhpInterfaceElement($name, $abstract, $extends, $interfaces));
     }
 
-    public function addMethodElement(PhpMethodElement $method): AbstractComponent
+    public function addMethodElement(PhpMethodElement $method): self
     {
         if ($method->getHasBody()) {
             $method->setHasBody(false);
@@ -24,17 +24,17 @@ public function addMethodElement(PhpMethodElement $method): AbstractComponent
         return parent::addMethodElement($method);
     }
 
-    public function addMethod(string $name, array $parameters = [], ?string $returnType = null, string $access = PhpMethodElement::ACCESS_PUBLIC, bool $abstract = false, bool $static = false, bool $final = false, bool $hasBody = true): AbstractComponent
+    public function addMethod(string $name, array $parameters = [], ?string $returnType = null, string $access = PhpMethodElement::ACCESS_PUBLIC, bool $abstract = false, bool $static = false, bool $final = false, bool $hasBody = true): self
     {
         return $this->addMethodElement(new PhpMethodElement($name, $parameters, $returnType, $access, $abstract, $static, $final, false));
     }
 
-    public function addPropertyElement(PhpPropertyElement $property): AbstractComponent
+    public function addPropertyElement(PhpPropertyElement $property): self
     {
         return $this;
     }
 
-    public function addProperty(string $name, $value = null, string $access = PhpPropertyElement::ACCESS_PUBLIC): AbstractComponent
+    public function addProperty(string $name, $value = null, string $access = PhpPropertyElement::ACCESS_PUBLIC, $type = null): self
     {
         return $this;
     }

src/Element/AbstractAccessRestrictedElement.php

@@ -13,15 +13,13 @@ abstract class AbstractElement implements GenerateableInterface
     /**
      * @var AbstractElement[]|mixed[]
      */
-    protected array $children;
+    protected array $children = [];
 
-    protected int $indentation;
+    protected int $indentation = 0;
 
     public function __construct(string $name)
     {
         $this->setName($name);
-        $this->children = [];
-        $this->indentation = 0;
     }
 
     public function __toString(): string
@@ -47,7 +45,7 @@ public function getName(): string
     public static function nameIsValid(string $name, bool $allowBackslash = false): bool
     {
         $pattern = '/[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/';
-        if (true === $allowBackslash) {
+        if ($allowBackslash) {
             $pattern = '/[a-zA-Z_\x7f-\xff\\\][a-zA-Z0-9_\x7f-\xff\\\]*/';
         }
 
@@ -61,7 +59,7 @@ public static function stringIsValid($string, bool $checkName = true, bool $allo
 
     public static function objectIsValid($object, ?string $checkClass = null): bool
     {
-        return is_object($object) && (null === $checkClass || get_class($object) === $checkClass);
+        return is_object($object) && (is_null($checkClass) || get_class($object) === $checkClass);
     }
 
     public function toString(?int $indentation = null): string
@@ -78,7 +76,7 @@ public function toString(?int $indentation = null): string
         }
         $lines[] = $this->getToStringAfterChildren($indentation);
 
-        return implode(self::BREAK_LINE_CHAR, self::cleanArrayToString($lines));
+        return implode(self::BREAK_LINE_CHAR, static::cleanArrayToString($lines));
     }
 
     public function getPhpName(): string
@@ -152,7 +150,7 @@ public function useBracketsForChildren(): bool
     public function getBracketBeforeChildren(?int $indentation = null): string
     {
         $line = $this->getIndentedString(self::OPEN_BRACKET, $indentation);
-        $this->setIndentation((null === $indentation ? $this->getIndentation() : $indentation) + 1);
+        $this->setIndentation((is_null($indentation) ? $this->getIndentation() : $indentation) + 1);
 
         return $line;
     }
@@ -162,7 +160,7 @@ public function getBracketBeforeChildren(?int $indentation = null): string
      */
     public function getBracketAfterChildren(?int $indentation = null): string
     {
-        $this->setIndentation((null === $indentation ? $this->getIndentation() : $indentation) - 1);
+        $this->setIndentation((is_null($indentation) ? $this->getIndentation() : $indentation) - 1);
 
         return $this->getIndentedString(self::CLOSE_BRACKET, $indentation);
     }
@@ -181,7 +179,7 @@ public function getIndentation(): int
 
     public function getIndentationString(?int $indentation = null): string
     {
-        return str_repeat(self::INDENTATION_CHAR, null === $indentation ? $this->getIndentation() : $indentation);
+        return str_repeat(self::INDENTATION_CHAR, is_null($indentation) ? $this->getIndentation() : $indentation);
     }
 
     public function getIndentedString(string $string, ?int $indentation = null): string
@@ -205,7 +203,7 @@ protected function getChildContent($child, int $indentation = null): string
         if (is_string($child)) {
             $content = $this->getIndentedString($child, $indentation);
         } elseif ($child instanceof AbstractElement) {
-            $content = $child->toString(null === $indentation ? $this->getIndentation() : $indentation);
+            $content = $child->toString(is_null($indentation) ? $this->getIndentation() : $indentation);
         }
 
         return $content;
@@ -258,9 +256,11 @@ private static function cleanArrayToString(array $array): array
     {
         $newArray = [];
         foreach ($array as $line) {
-            if (null !== $line) {
-                $newArray[] = $line;
+            if (is_null($line)) {
+                continue;
             }
+
+            $newArray[] = $line;
         }
 
         return $newArray;

src/Element/AbstractElement.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WsdlToPhp\PhpGenerator\Element;
+
+interface AccessRestrictedElementInterface
+{
+    const ACCESS_PRIVATE = 'private';
+
+    const ACCESS_PROTECTED = 'protected';
+
+    const ACCESS_PUBLIC = 'public';
+
+    const ACCESSES = [
+        self::ACCESS_PRIVATE,
+        self::ACCESS_PROTECTED,
+        self::ACCESS_PUBLIC,
+    ];
+
+    public function setAccess(?string $access): AbstractElement;
+
+    public function getAccess(): string;
+
+    public static function accessIsValid(?string $access): bool;
+}