Merge branch 'release/4.0.0'

Author: mikaelcom

CHANGELOG.md

@@ -1,10 +1,17 @@
 # CHANGELOG
 
-## 3.0.1 - 2021-01-28
+## 4.0.0 - 2021/02/03
+- BC:
+  - `WsdlToPhp\PackageBase\AbstractStructBase::_set` has been renamed to `WsdlToPhp\PackageBase\AbstractStructBase::setPropertyValue`
+  - `WsdlToPhp\PackageBase\AbstractStructBase::_set` has been renamed to `WsdlToPhp\PackageBase\AbstractStructBase::getPropertyValue`
+- Improve `WsdlToPhp\PackageBase\AbstractStructBase::__set_state` method using `ReflectionClass`
+- Review .php_cs settings, apply PHP CS Fixer
+
+## 3.0.1 - 2021/01/28
 - Update Travis CI badge and settings
 
-## 3.0.0 - 2021-01-28
-- Issue #32 - Migrate to PHp >= 7.4
+## 3.0.0 - 2021/01/28
+- Issue #32 - Migrate to PHP >= 7.4
   - use `splitbrain/phpfarm:jessie` as Docker image and fix docker image settings
   - Code requires PHP >= 7.4
   - Code cleaning
@@ -17,30 +24,30 @@
   - Update LICENSE file
   - Version 1.0 is no more maintained
 
-## 2.2.0 - 2020-09-11
+## 2.2.0 - 2020/09/11
 - Issue #31 - Add output headers to SoapClient in order to be able to store them
 
-## 2.1.0 - 2020-05-14
+## 2.1.0 - 2020/05/14
 - Pull request #29 - Transform HTTP headers from stream context options to array
 - Update Travis CI PHP Matrix
 - Use better Docker configuration
 - Introduce StructEnumInterface and AbstractStructEnumBase from which generated Enum classes should inherit
 - Add __toString method to AbstractStructBase and AbstractSoapClientBase classes
 
-## 2.0.3 - 2019-01-10
+## 2.0.3 - 2019/01/10
 - Issue #25 - Enhancement: Improve output from running php-cs-fixer
 - Issue #26 - Enhancement: Keep packages sorted in composer.json
 - Issue #28 - Add the URI as an option in the soapClient parameters
 
 
-## 2.0.2 - 2018-07-23
+## 2.0.2 - 2018/07/23
 - Issue #22 / Pull request #23 - Add support to invoke getLastRequest without throwing an InvalidArgumentException if the request is not executed
 
-## 2.0.1 - 2018-05-08
+## 2.0.1 - 2018/05/08
 - Issue #19 - WSDL_CACHE_WSDL does not work!
     - Code reviewed as it was not complete, default options were not taken into account properly too, it's working right from now on!
 
-## 2.0.0 - 2018-04-17
+## 2.0.0 - 2018/04/17
 - Issue #15 - AbstractSoapClientBase should not define static SoapClient instance
 
 ## 1.0.11

README.md

@@ -124,8 +124,8 @@ It defines two methods:
 This class is the base class for any ```StructType``` class generated by [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator). It implements our [StructInterface](#structinterface) interface.
 It defines five methods:
 - **__set_state($array)**: Useful when you load the string representation of an object that you stored using ```var_export```. It also allows you to ease the instanciation of an object that contains many properties which would be hard to instanciate using the ```__construct``` method. You can see ```__set_state``` as an hydratation method.
-- **_set($name, $value)**: As magic method ```__set``` but used by the ```__set_state``` method. Plus, defining ```__set``` method on used class by the classmap option for the [SoapClient](http://php.net/manual/en/class.soapclient.php) breaks the correct hydratation of your received objects.
-- **_get($name)**: As magic method ```__get```. Used by our [AbstractStructArrayBase](#abstractstructarraybase) class.
+- **setPropertyValue(string $name, $value)**: As magic method ```__set``` but used by the ```__set_state``` method. Plus, defining ```__set``` method on used class by the classmap option for the [SoapClient](http://php.net/manual/en/class.soapclient.php) breaks the correct hydratation of your received objects.
+- **getPropertyValue(string $name)**: As magic method ```__get```. Used by our [AbstractStructArrayBase](#abstractstructarraybase) class.
 - **jsonSerialize()**: by implementing the [\JsonSerializable](http://php.net/manual/en/class.jsonserializable.php) interface, it implements this method that allows to pass the object to the [json_encode](http://php.net/manual/en/function.json-encode.php) method so it will return the properties of the current object in an array.
 - **__toString()**: see [__toString](http://php.net/manual/en/language.oop5.magic.php#object.tostring) definition
 

UPGRADE-4.0.md

@@ -0,0 +1,21 @@
+# UPGRADE FROM 3.0 to 4.0
+
+The previsouly `_set` and `_get` methods are to be used internally and are not intended to be used externally, at your own risks ;)
+
+**Previously**:
+```php
+/** @var WsdlToPhp\PackageBase\AbstractStructBase|WsdlToPhp\PackageBase\AbstractStructArrayBase $o */
+$o = new Struct();
+$o->_set('name', 'the name');
+$theName = $o->_get('name');
+```
+
+Same remark as previously, methods are renamed and marked as internal from now on ;)
+
+**Now**:
+```php
+/** @var WsdlToPhp\PackageBase\AbstractStructBase|WsdlToPhp\PackageBase\AbstractStructArrayBase $o */
+$o = new Struct();
+$o->setPropertyValue('name', 'the name');
+$theName = $o->getPropertyValue('name');
+```

src/AbstractStructArrayBase.php

@@ -105,15 +105,15 @@ public function item($index)
     public function add($item): self
     {
         // init array
-        if (!is_array($this->_get($this->getAttributeName()))) {
-            $this->_set($this->getAttributeName(), []);
+        if (!is_array($this->getPropertyValue($this->getAttributeName()))) {
+            $this->setPropertyValue($this->getAttributeName(), []);
         }
 
         // current array
-        $currentArray = $this->_get($this->getAttributeName());
+        $currentArray = $this->getPropertyValue($this->getAttributeName());
         $currentArray[] = $item;
         $this
-            ->_set($this->getAttributeName(), $currentArray)
+            ->setPropertyValue($this->getAttributeName(), $currentArray)
             ->setInternArray($currentArray)
             ->setInternArrayIsArray(true)
             ->setInternArrayOffset(0);
@@ -169,7 +169,7 @@ public function offsetSet($offset, $value): self
     {
         $this->internArray[$offset] = $value;
 
-        return $this->_set($this->getAttributeName(), $this->internArray);
+        return $this->setPropertyValue($this->getAttributeName(), $this->internArray);
     }
 
     /**
@@ -181,7 +181,7 @@ public function offsetUnset($offset): self
     {
         if ($this->offsetExists($offset)) {
             unset($this->internArray[$offset]);
-            $this->_set($this->getAttributeName(), $this->internArray);
+            $this->setPropertyValue($this->getAttributeName(), $this->internArray);
         }
 
         return $this;
@@ -231,7 +231,7 @@ public function initInternArray(array $array = [], bool $internCall = false): se
                 ->setInternArrayOffset(0)
                 ->setInternArrayIsArray(true);
         } elseif (!$internCall && property_exists($this, $this->getAttributeName())) {
-            $this->initInternArray($this->_get($this->getAttributeName()), true);
+            $this->initInternArray($this->getPropertyValue($this->getAttributeName()), true);
         }
 
         return $this;

src/AbstractStructBase.php

@@ -6,6 +6,7 @@
 
 use InvalidArgumentException;
 use JsonSerializable;
+use ReflectionClass;
 
 abstract class AbstractStructBase implements StructInterface, JsonSerializable
 {
@@ -26,10 +27,10 @@ public function jsonSerialize(): array
      */
     public static function __set_state(array $array): StructInterface
     {
-        $className = get_called_class();
-        $object = new $className();
+        $reflection = new ReflectionClass(get_called_class());
+        $object = $reflection->newInstance();
         foreach ($array as $name => $value) {
-            $object->_set($name, $value);
+            $object->setPropertyValue($name, $value);
         }
 
         return $object;
@@ -41,8 +42,9 @@ public static function __set_state(array $array): StructInterface
      * @param string $name property name to set
      * @param mixed $value property value to use
      * @return self
+     * @internal
      */
-    public function _set(string $name, $value): self
+    public function setPropertyValue(string $name, $value): self
     {
         $setMethod = 'set' . ucfirst($name);
         if (method_exists($this, $setMethod)) {
@@ -59,8 +61,9 @@ public function _set(string $name, $value): self
      * @throws InvalidArgumentException
      * @param string $name property name to get
      * @return mixed
+     * @internal
      */
-    public function _get(string $name)
+    public function getPropertyValue(string $name)
     {
         $getMethod = 'get' . ucfirst($name);
         if (method_exists($this, $getMethod)) {

tests/StructBaseTest.php

@@ -38,7 +38,7 @@ public function testSetGet()
         $object
             ->setBar('foo')
             ->setFoo('bar');
-        $this->assertSame('foo', $object->_get('bar'));
+        $this->assertSame('foo', $object->getPropertyValue('bar'));
     }
 
     public function testSetGetWithException()
@@ -49,7 +49,7 @@ public function testSetGetWithException()
         $object
             ->setBar('foo')
             ->setFoo('bar');
-        $object->_get('sample');
+        $object->getPropertyValue('sample');
     }
 
     public function testJsonSerialize()