Merge branch 'release/5.0.0'

Author: mikaelcom

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 5.0.0 - 2021/02/05
+- Issue #13 - Auto initialize AbstractStructArrayBase::internArray
+- BC: read [UPGRADE-5.0.md](/UPGRADE-5.0.md)
+
 ## 4.0.1 - 2021/02/05
 - Add deprecation messages for next major release 5
 

README.md

@@ -131,12 +131,12 @@ It defines five methods:
 
 #### Usage
 ```php
-$item = \Api\StructType\Item::__set_state(array(
+$item = \Api\StructType\Item::__set_state([
     'id' => 1,
     'name' => 'Entity #1',
     'label' => 'Entity #1',
     '_href' => 'http://www.entity.com',
-));
+]);
 // $item is now an \Api\StructType\Item object
 ```
 
@@ -147,87 +147,60 @@ This class is the base class for any ```ArrayType``` class generated by [Package
 #### Usage
 As soon as you have an element that is an array of items such as:
 ```php
-$items = \Api\ArrayType\Items::__set_state(array(
-    'items' => array(
-        \Api\StructType\Item::__set_state(array(
+$items = \Api\ArrayType\Items::__set_state([
+    'items' => [
+        \Api\StructType\Item::__set_state([
             'id' => 1,
             'name' => 'Entity #1',
             'label' => 'Entity #1',
             '_href' => 'http://www.entity-1.com',
-        ),
-        \Api\StructType\Item::__set_state(array(
+        ]),
+        \Api\StructType\Item::__set_state([
             'id' => 2,
             'name' => 'Entity #2',
             'label' => 'Entity #2',
             '_href' => 'http://www.entity-2.com',
-        ),
-        \Api\StructType\Item::__set_state(array(
+        ]),
+        \Api\StructType\Item::__set_state([
             'id' => 3,
             'name' => 'Entity #3',
             'label' => 'Entity #3',
             '_href' => 'http://www.entity-3.com',
-        ),
-    )
-));
+        ]),
+    ],
+]);
 // 'items' is the unique property of the object
 // Its name is returned by the getAttributeName method
 // defined in the generated \Api\ArrayType\Items class
 ```
-- **You MUST call first** ```initInternArray``` method on your ArrayType object otherwise you'll get nothing working for the implemented methods:
-```php
-$items->initInternArray();
-```
-- then you can call ```count```, ```length``` methods: gives you the number of items contained by your object
-- you can iterate through the items:
+- **You can call ```count```, ```length``` methods: gives you the number of items contained by your object
+- You can iterate through the items:
 ```php
 foreach ($items as $item) {
     // $items->current() and $item is an \Api\StructType\Item object
     // $items->key() is the current index
 }
 ```
-- you can get the first item:
+- You can get the first item:
 ```php
 $items->first();
 ```
-- you can get the last item:
+- You can get the last item:
 ```php
 $items->last();
 ```
-- you can get any item:
+- You can get any item:
 ```php
 $items->item($index);
 ```
-- you can add a new item:
+- You can add a new item:
 ```php
-$items->add(\Api\StructType\Item::__set_state(array(
+$items->add(\Api\StructType\Item::__set_state([
     'id' => 4,
     'name' => 'Entity #4',
     'label' => 'Entity #4',
     '_href' => 'http://www.entity-4.com',
-)));
-```
-- you can even reset the items:
-```php
-$items->initInternArray(array(
-    \Api\StructType\Item::__set_state(array(
-        'id' => 0,
-        'name' => 'Entity #0',
-        'label' => 'Entity #0',
-        '_href' => 'http://www.entity-0.com',
-    ),
-    \Api\StructType\Item::__set_state(array(
-        'id' => 1,
-        'name' => 'Entity #1',
-        'label' => 'Entity #1',
-        '_href' => 'http://www.entity-1.com',
-    ),
-    \Api\StructType\Item::__set_state(array(
-        'id' => 2,
-        'name' => 'Entity #2',
-        'label' => 'Entity #2',
-        '_href' => 'http://www.entity-2.com',
-    ),
-));
+]));
 ```
 
 ### AbstractSoapClientBase
@@ -246,7 +219,7 @@ class ApiUpdate extends AbstractSoapClientBase
     public function UpdateBulkOrder(\Api\StructType\ApiUpdateBulkOrder $parameters)
     {
         try {
-            $this->setResult(self::getSoapClient()->UpdateBulkOrder($parameters));
+            $this->setResult($this->getSoapClient()->UpdateBulkOrder($parameters));
             return $this->getResult();
         } catch (\SoapFault $soapFault) {
             $this->saveLastError(__METHOD__, $soapFault);
@@ -258,10 +231,10 @@ class ApiUpdate extends AbstractSoapClientBase
 You can do:
 ```php
 use \WsdlToPhp\PackageBase\AbstractSoapClientBase;
-$options = array(
+$options = [
     AbstractSoapClientBase::WSDL_URL => '__WSDL_URL__',
     AbstractSoapClientBase::WSDL_CLASSMAP => \Api\ApiClassMap::classMap(),
-);
+];
 // sets the first instance of SoapClient within  AbstractSoapClientBase
 $update = new \Api\ServiceType\ApiUpdate($options);
 // resets the SoapClient instance

UPGRADE-4.0.md

@@ -1,6 +1,6 @@
 # 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 ;)
+The previously `_set` and `_get` methods are to be used internally and are not intended to be used externally, at your own risks ;)
 
 **Previously**:
 ```php

UPGRADE-5.0.md

@@ -0,0 +1,17 @@
+# UPGRADE FROM 4.0 to 5.0
+
+Internal properties and methods of [AbstractStructArrayBase](/src/AbstractStructArrayBase.php) are now private:
+- Properties:
+  - $internArray
+  - $internArrayIsArray
+  - $internArrayOffset
+- Methods:
+  - getInternArray
+  - setInternArray
+  - getInternArrayOffset
+  - initInternArray
+  - setInternArrayOffset
+  - getInternArrayIsArray
+  - setInternArrayIsArray
+
+You don't have to manually call `initInternArray` before looping on the current object, it's done automatically.

src/AbstractStructArrayBase.php

@@ -10,26 +10,28 @@ abstract class AbstractStructArrayBase extends AbstractStructBase implements Str
      * Array that contains values when only one parameter is set when calling __construct method
      * @var array
      */
-    protected array $internArray = [];
+    private array $internArray = [];
 
     /**
      * Bool that tells if array is set or not
      * @var bool
      */
-    protected bool $internArrayIsArray = false;
+    private bool $internArrayIsArray = false;
 
     /**
      * Items index browser
      * @var int
      */
-    protected int $internArrayOffset = 0;
+    private int $internArrayOffset = 0;
 
     /**
      * Method alias to count
      * @return int
      */
     public function length(): int
     {
+        $this->initInternArray();
+
         return $this->count();
     }
 
@@ -39,6 +41,8 @@ public function length(): int
      */
     public function count(): int
     {
+        $this->initInternArray();
+
         return $this->getInternArrayIsArray() ? count($this->getInternArray()) : -1;
     }
 
@@ -48,6 +52,8 @@ public function count(): int
      */
     public function current()
     {
+        $this->initInternArray();
+
         return $this->offsetGet($this->internArrayOffset);
     }
 
@@ -57,6 +63,8 @@ public function current()
      */
     public function next(): self
     {
+        $this->initInternArray();
+
         return $this->setInternArrayOffset($this->getInternArrayOffset() + 1);
     }
 
@@ -66,6 +74,8 @@ public function next(): self
      */
     public function rewind(): self
     {
+        $this->initInternArray();
+
         return $this->setInternArrayOffset(0);
     }
 
@@ -75,6 +85,8 @@ public function rewind(): self
      */
     public function valid(): bool
     {
+        $this->initInternArray();
+
         return $this->offsetExists($this->getInternArrayOffset());
     }
 
@@ -84,6 +96,8 @@ public function valid(): bool
      */
     public function key(): int
     {
+        $this->initInternArray();
+
         return $this->getInternArrayOffset();
     }
 
@@ -94,6 +108,8 @@ public function key(): int
      */
     public function item($index)
     {
+        $this->initInternArray();
+
         return $this->offsetGet($index);
     }
 
@@ -127,6 +143,8 @@ public function add($item): self
      */
     public function first()
     {
+        $this->initInternArray();
+
         return $this->item(0);
     }
 
@@ -136,6 +154,8 @@ public function first()
      */
     public function last()
     {
+        $this->initInternArray();
+
         return $this->item($this->length() - 1);
     }
 
@@ -146,6 +166,8 @@ public function last()
      */
     public function offsetExists($offset): bool
     {
+        $this->initInternArray();
+
         return ($this->getInternArrayIsArray() && array_key_exists($offset, $this->getInternArray()));
     }
 
@@ -156,6 +178,8 @@ public function offsetExists($offset): bool
      */
     public function offsetGet($offset)
     {
+        $this->initInternArray();
+
         return $this->offsetExists($offset) ? $this->internArray[$offset] : null;
     }
 
@@ -167,6 +191,8 @@ public function offsetGet($offset)
      */
     public function offsetSet($offset, $value): self
     {
+        $this->initInternArray();
+
         $this->internArray[$offset] = $value;
 
         return $this->setPropertyValue($this->getAttributeName(), $this->internArray);
@@ -179,6 +205,8 @@ public function offsetSet($offset, $value): self
      */
     public function offsetUnset($offset): self
     {
+        $this->initInternArray();
+
         if ($this->offsetExists($offset)) {
             unset($this->internArray[$offset]);
             $this->setPropertyValue($this->getAttributeName(), $this->internArray);
@@ -191,7 +219,7 @@ public function offsetUnset($offset): self
      * Method returning intern array to iterate trough
      * @return array
      */
-    public function getInternArray(): array
+    private function getInternArray(): array
     {
         @trigger_error(sprintf('%s() will be private in WsdlToPhp/PackageBase 5.0.', __METHOD__), E_USER_DEPRECATED);
 
@@ -203,7 +231,7 @@ public function getInternArray(): array
      * @param array $internArray
      * @return AbstractStructArrayBase
      */
-    public function setInternArray(array $internArray): self
+    private function setInternArray(array $internArray): self
     {
         @trigger_error(sprintf('%s() will be private in WsdlToPhp/PackageBase 5.0.', __METHOD__), E_USER_DEPRECATED);
 
@@ -216,7 +244,7 @@ public function setInternArray(array $internArray): self
      * Method returns intern array index when iterating trough
      * @return int
      */
-    public function getInternArrayOffset(): int
+    private function getInternArrayOffset(): int
     {
         @trigger_error(sprintf('%s() will be private in WsdlToPhp/PackageBase 5.0.', __METHOD__), E_USER_DEPRECATED);
 
@@ -229,7 +257,7 @@ public function getInternArrayOffset(): int
      * @param bool $internCall indicates that methods is calling itself
      * @return AbstractStructArrayBase
      */
-    public function initInternArray(array $array = [], bool $internCall = false): self
+    private function initInternArray(array $array = [], bool $internCall = false): self
     {
         @trigger_error(sprintf('%s() will be private in WsdlToPhp/PackageBase 5.0.', __METHOD__), E_USER_DEPRECATED);
 
@@ -238,7 +266,7 @@ public function initInternArray(array $array = [], bool $internCall = false): se
                 ->setInternArray($array)
                 ->setInternArrayOffset(0)
                 ->setInternArrayIsArray(true);
-        } elseif (!$internCall && property_exists($this, $this->getAttributeName())) {
+        } elseif (!$this->internArrayIsArray && !$internCall && property_exists($this, $this->getAttributeName())) {
             $this->initInternArray($this->getPropertyValue($this->getAttributeName()), true);
         }
 
@@ -250,7 +278,7 @@ public function initInternArray(array $array = [], bool $internCall = false): se
      * @param int $internArrayOffset
      * @return AbstractStructArrayBase
      */
-    public function setInternArrayOffset(int $internArrayOffset): self
+    private function setInternArrayOffset(int $internArrayOffset): self
     {
         @trigger_error(sprintf('%s() will be private in WsdlToPhp/PackageBase 5.0.', __METHOD__), E_USER_DEPRECATED);
 
@@ -263,7 +291,7 @@ public function setInternArrayOffset(int $internArrayOffset): self
      * Method returning true if intern array is an actual array
      * @return bool
      */
-    public function getInternArrayIsArray(): bool
+    private function getInternArrayIsArray(): bool
     {
         @trigger_error(sprintf('%s() will be private in WsdlToPhp/PackageBase 5.0.', __METHOD__), E_USER_DEPRECATED);
 
@@ -275,7 +303,7 @@ public function getInternArrayIsArray(): bool
      * @param bool $internArrayIsArray
      * @return AbstractStructArrayBase
      */
-    public function setInternArrayIsArray(bool $internArrayIsArray = false): self
+    private function setInternArrayIsArray(bool $internArrayIsArray = false): self
     {
         @trigger_error(sprintf('%s() will be private in WsdlToPhp/PackageBase 5.0.', __METHOD__), E_USER_DEPRECATED);