Merge branch 'release/4.0.0'

Author: mikaelcom

.php_cs

@@ -6,16 +6,8 @@ $finder = PhpCsFixer\Finder::create()
     ->in(__DIR__);
 
 return PhpCsFixer\Config::create()
-	->setUsingCache(false)
-    ->setRules([
-        '@PSR2' => true,
-        'array_syntax' => [
-            'syntax' => 'short',
-        ],
-        'binary_operator_spaces' => true,
-        'no_whitespace_in_blank_line' => true,
-        'ternary_operator_spaces' => true,
-        'cast_spaces' => true,
-        'trailing_comma_in_multiline_array' => true
-	])
+    ->setUsingCache(false)
+    ->setRules(array(
+        '@PhpCsFixer' => true,
+    ))
     ->setFinder($finder);

CHANGELOG.md

@@ -1,13 +1,20 @@
 # CHANGELOG
 
+## 4.0.0 - 2021/02/04
+- 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:
@@ -25,7 +32,7 @@
 
 ## 2.0.0
 - Use PHP 7.1 features
-- Refactore code
+- Refactor code
 - Fix typos
 
 ## 1.2.1
@@ -44,7 +51,7 @@
 - First major release
 
 ## 1.0.0RC01
-- Major: update source code structure, put Component and Element fodlers under ```src``` fodler, update composer and phpunit accordingly
+- Major: update source code structure, put Component and Element folders under ```src``` folder, update composer and phpunit accordingly
 
 ## 0.0.16
 - Minor: correct annotation
@@ -62,13 +69,13 @@
 - Refactoring : Use statements and Namespace are contained by a file not a class as each element should only knows what it contains not what that is around itself.
 
 ## 0.0.11
-- Issue : allow backslash within class name for namespace
+- Issue : allow a backslash within class name for namespace
 
 ## 0.0.10
-- Allow to provide annotation max length to use
+- Allow providing annotation max length to use
 
 ## 0.0.9
-- Fix issue : within a class, the additonal multi lines are not indented correcly
+- Fix issue : within a class, the additional multi lines are not indented correctly
 
 ## 0.0.8
 - Fix issue: workaround for known var_export issue with float value
@@ -80,7 +87,7 @@
 - Improvement: improve lisiblity and extensibility for PhpVariable and PhpFunctionParameter
 
 ## 0.0.5
-- Fix issue: function parameter type is not tooken into account
+- Fix issue: function parameter type is not token into account
 
 ## 0.0.4
 - Fix issue regarding property/variable that has no value but always has a null value assigned with an assignment sign

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

@@ -6,15 +6,15 @@
 
 use InvalidArgumentException;
 use WsdlToPhp\PhpGenerator\Element\AbstractElement;
-use WsdlToPhp\PhpGenerator\Element\PhpFile as PhpFileElement;
+use WsdlToPhp\PhpGenerator\Element\PhpAnnotationBlock as PhpAnnotationBlockElement;
 use WsdlToPhp\PhpGenerator\Element\PhpClass as PhpClassElement;
 use WsdlToPhp\PhpGenerator\Element\PhpConstant as PhpConstantElement;
-use WsdlToPhp\PhpGenerator\Element\PhpAnnotationBlock as PhpAnnotationBlockElement;
+use WsdlToPhp\PhpGenerator\Element\PhpFile as PhpFileElement;
 
 abstract class AbstractComponent implements GenerateableInterface
 {
     /**
-     * @var PhpFileElement|PhpClassElement
+     * @var PhpClassElement|PhpFileElement
      */
     protected $mainElement;
 
@@ -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,31 +39,6 @@ public function setMainElement(AbstractElement $element): self
         return $this;
     }
 
-    /**
-     * @return PhpFileElement|PhpClassElement
-     */
-    public function getMainElement(): AbstractElement
-    {
-        return $this->mainElement;
-    }
-
-    /**
-     * @throws InvalidArgumentException
-     * @param string|AbstractElement $element
-     * @return string
-     */
-    protected function getElementString($element): string
-    {
-        $string = '';
-        if (is_scalar($element)) {
-            $string = $element;
-        } elseif ($element instanceof AbstractElement) {
-            $string = $element->toString();
-        }
-
-        return $string;
-    }
-
     public function addConstantElement(PhpConstantElement $constant): self
     {
         if (!$constant->getClass() instanceof PhpClassElement && $this->mainElement instanceof PhpClassElement) {
@@ -85,10 +50,7 @@ public function addConstantElement(PhpConstantElement $constant): self
     }
 
     /**
-     * @param string $name
      * @param mixed $value
-     * @param PhpClassElement|null $class
-     * @return AbstractComponent
      */
     public function addConstant(string $name, $value = null, ?PhpClassElement $class = null): self
     {
@@ -103,13 +65,19 @@ public function addAnnotationBlockElement(PhpAnnotationBlockElement $annotationB
     }
 
     /**
-     * @param array|string|PhpAnnotationBlockElement $annotations
-     * @return AbstractComponent
+     * @param array|PhpAnnotationBlockElement|string $annotations
      */
     public function addAnnotationBlock($annotations): self
     {
         return $this->addAnnotationBlockElement(new PhpAnnotationBlockElement(is_array($annotations) ? $annotations : [
             $annotations,
         ]));
     }
+
+    public function addString(string $string = ''): self
+    {
+        $this->mainElement->addChild($string);
+
+        return $this;
+    }
 }

src/Component/GenerateableInterface.php

@@ -8,11 +8,10 @@ interface GenerateableInterface
 {
     const BREAK_LINE_CHAR = "\n";
 
+    public function __toString(): string;
+
     /**
-     * Must return the strict representation for the current element
-     * @return string
+     * Must return the strict representation for the current element.
      */
     public function toString(): string;
-
-    public function __toString(): string;
 }

src/Component/PhpClass.php

@@ -5,49 +5,37 @@
 namespace WsdlToPhp\PhpGenerator\Component;
 
 use WsdlToPhp\PhpGenerator\Element\PhpClass as PhpClassElement;
-use WsdlToPhp\PhpGenerator\Element\PhpProperty as PhpPropertyElement;
 use WsdlToPhp\PhpGenerator\Element\PhpMethod as PhpMethodElement;
+use WsdlToPhp\PhpGenerator\Element\PhpProperty as PhpPropertyElement;
 
 class PhpClass extends AbstractComponent
 {
-    /**
-     * @param string $name
-     * @param bool $abstract
-     * @param string|null $extends
-     * @param array $interfaces
-     */
     public function __construct(string $name, bool $abstract = false, ?string $extends = null, array $interfaces = [])
     {
         $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
-    {
-        return $this->addPropertyElement(new PhpPropertyElement($name, $value, $access));
-    }
-
-    public function getElements(): array
+    public function addProperty(string $name, $value = null, string $access = PhpPropertyElement::ACCESS_PUBLIC, $type = null): self
     {
-        return [
-            $this->getMainElement(),
-        ];
+        return $this->addPropertyElement(new PhpPropertyElement($name, $value, $access, $type));
     }
 }

src/Component/PhpFile.php

@@ -4,12 +4,12 @@
 
 namespace WsdlToPhp\PhpGenerator\Component;
 
+use WsdlToPhp\PhpGenerator\Component\PhpClass as PhpClassComponent;
+use WsdlToPhp\PhpGenerator\Component\PhpInterface as PhpInterfaceComponent;
 use WsdlToPhp\PhpGenerator\Element\PhpDeclare;
 use WsdlToPhp\PhpGenerator\Element\PhpFile as PhpFileElement;
-use WsdlToPhp\PhpGenerator\Element\PhpVariable as PhpVariableElement;
 use WsdlToPhp\PhpGenerator\Element\PhpFunction as PhpFunctionElement;
-use WsdlToPhp\PhpGenerator\Component\PhpClass as PhpClassComponent;
-use WsdlToPhp\PhpGenerator\Component\PhpInterface as PhpInterfaceComponent;
+use WsdlToPhp\PhpGenerator\Element\PhpVariable as PhpVariableElement;
 
 class PhpFile extends AbstractComponent
 {
@@ -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());
@@ -68,7 +58,7 @@ public function addFunction(string $name, array $parameters = []): self
 
     public function addUse(string $use, string $as = null, bool $last = false): self
     {
-        $expression = empty($as) ? "use %1\$s;%3\$s" : "use %1\$s as %2\$s;%3\$s";
+        $expression = empty($as) ? 'use %1$s;%3$s' : 'use %1$s as %2$s;%3$s';
         $this->mainElement->addChild(sprintf($expression, $use, $as, $last ? self::BREAK_LINE_CHAR : ''));
 
         return $this;
@@ -90,7 +80,7 @@ public function setNamespace(string $namespace): self
     {
         $this->mainElement->addChild(
             sprintf(
-                "%snamespace %s;%s",
+                '%snamespace %s;%s',
                 self::BREAK_LINE_CHAR,
                 $namespace,
                 self::BREAK_LINE_CHAR

src/Component/PhpInterface.php

@@ -5,8 +5,8 @@
 namespace WsdlToPhp\PhpGenerator\Component;
 
 use WsdlToPhp\PhpGenerator\Element\PhpInterface as PhpInterfaceElement;
-use WsdlToPhp\PhpGenerator\Element\PhpProperty as PhpPropertyElement;
 use WsdlToPhp\PhpGenerator\Element\PhpMethod as PhpMethodElement;
+use WsdlToPhp\PhpGenerator\Element\PhpProperty as PhpPropertyElement;
 
 class PhpInterface extends PhpClass
 {
@@ -15,25 +15,26 @@ 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);
         }
+
         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;
     }