issue #33 - auto initialize internArray

in order to be able to loop on the object without having to call manually initInternArray

Author: mikaelcom

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 5.0.0 - 2021/02/xx
+- Issue #13 - Auto initialize AbstractStructArrayBase::internArray
+- BC: read [UPGRADE-5.0.md](/UPGRADE-5.0.md)
+
 ## 4.0.0 - 2021/02/03
 - BC:
   - `WsdlToPhp\PackageBase\AbstractStructBase::_set` has been renamed to `WsdlToPhp\PackageBase\AbstractStructBase::setPropertyValue`

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,83 @@ 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:
+- You can even reset the items:
 ```php
-$items->initInternArray(array(
-    \Api\StructType\Item::__set_state(array(
+$items->initInternArray([
+    \Api\StructType\Item::__set_state([
         'id' => 0,
         'name' => 'Entity #0',
         'label' => 'Entity #0',
         '_href' => 'http://www.entity-0.com',
-    ),
-    \Api\StructType\Item::__set_state(array(
+    ]),
+    \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',
-    ),
-));
+    ]),
+]);
 ```
 
 ### AbstractSoapClientBase
@@ -246,7 +242,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 +254,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 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.