Merge branch 'feature/issue-13' into develop

Author: mikaelcom

.php_cs

@@ -9,6 +9,9 @@ return PhpCsFixer\Config::create()
 	->setUsingCache(false)
     ->setRules(array(
         '@PSR2' => true,
+        'array_syntax' => [
+            'syntax' => 'short',
+        ],
         'binary_operator_spaces' => true,
         'no_whitespace_in_blank_line' => true,
         'ternary_operator_spaces' => true,

.travis.yml

@@ -1,12 +1,9 @@
 language: php
 
 sudo: false
-dist: trusty
 
 matrix:
   include:
-    - php: 5.3
-      dist: precise
     - php: 5.4
     - php: 5.5
     - php: 5.6

README.md

@@ -93,10 +93,11 @@ Here are the methods that must be implemented and why:
 ### AbstractStructBase
 #### Description
 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 three methods:
+It defines four 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
+- **_get($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.
 
 #### Usage
 ```php

composer.json

@@ -21,7 +21,7 @@
         "email" : "[email protected]"
     },
     "require": {
-        "php" : ">=5.3.3"
+        "php" : ">=5.4"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "~2.0",

src/AbstractSoapClientBase.php

@@ -26,9 +26,9 @@ abstract class AbstractSoapClientBase implements SoapClientInterface
      * @param array $wsdlOptions
      * @param bool $resetSoapClient allows to disable the SoapClient redefinition
      */
-    public function __construct(array $wsdlOptions = array(), $resetSoapClient = true)
+    public function __construct(array $wsdlOptions = [], $resetSoapClient = true)
     {
-        $this->setLastError(array());
+        $this->setLastError([]);
         /**
          * Init soap Client
          * Set default values
@@ -65,7 +65,7 @@ public static function setSoapClient(\SoapClient $soapClient)
      */
     public function initSoapClient(array $options)
     {
-        $wsdlOptions = array();
+        $wsdlOptions = [];
         $defaultWsdlOptions = static::getDefaultWsdlOptions();
         foreach ($defaultWsdlOptions as $optionName => $optionValue) {
             if (array_key_exists($optionName, $options) && !empty($options[$optionName])) {
@@ -131,7 +131,7 @@ public function getSoapClientClassName($soapClientClassName = null)
      */
     public static function getDefaultWsdlOptions()
     {
-        return array(
+        return [
             self::WSDL_CLASSMAP => null,
             self::WSDL_CACHE_WSDL => WSDL_CACHE_NONE,
             self::WSDL_COMPRESSION => null,
@@ -156,7 +156,7 @@ public static function getDefaultWsdlOptions()
             self::WSDL_PASSPHRASE => null,
             self::WSDL_AUTHENTICATION => null,
             self::WSDL_SSL_METHOD => null,
-        );
+        ];
     }
     /**
      * Allows to set the SoapClient location to call
@@ -270,7 +270,7 @@ public static function getFormatedXml($string, $asDomDocument = false)
     public static function convertStringHeadersToArray($headers)
     {
         $lines = explode("\r\n", $headers);
-        $headers = array();
+        $headers = [];
         foreach ($lines as $line) {
             if (strpos($line, ':')) {
                 $headerParts = explode(':', $line);
@@ -294,7 +294,7 @@ public static function convertStringHeadersToArray($headers)
     public function setSoapHeader($nameSpace, $name, $data, $mustUnderstand = false, $actor = null)
     {
         if (static::getSoapClient()) {
-            $defaultHeaders = (isset(static::getSoapClient()->__default_headers) && is_array(static::getSoapClient()->__default_headers)) ? static::getSoapClient()->__default_headers : array();
+            $defaultHeaders = (isset(static::getSoapClient()->__default_headers) && is_array(static::getSoapClient()->__default_headers)) ? static::getSoapClient()->__default_headers : [];
             foreach ($defaultHeaders as $index => $soapHeader) {
                 if ($soapHeader->name === $name) {
                     unset($defaultHeaders[$index]);
@@ -326,13 +326,13 @@ public function setHttpHeader($headerName, $headerValue)
         if (static::getSoapClient() && !empty($headerName)) {
             $streamContext = $this->getStreamContext();
             if ($streamContext === null) {
-                $options = array();
-                $options['http'] = array();
+                $options = [];
+                $options['http'] = [];
                 $options['http']['header'] = '';
             } else {
                 $options = stream_context_get_options($streamContext);
                 if (!array_key_exists('http', $options) || !is_array($options['http'])) {
-                    $options['http'] = array();
+                    $options['http'] = [];
                     $options['http']['header'] = '';
                 } elseif (!array_key_exists('header', $options['http'])) {
                     $options['http']['header'] = '';
@@ -343,7 +343,7 @@ public function setHttpHeader($headerName, $headerValue)
                 /**
                  * Ensure there is only one header entry for this header name
                  */
-                $newLines = array();
+                $newLines = [];
                 foreach ($lines as $line) {
                     if (!empty($line) && strpos($line, $headerName) === false) {
                         array_push($newLines, $line);
@@ -386,7 +386,7 @@ public function getStreamContext()
      */
     public function getStreamContextOptions()
     {
-        $options = array();
+        $options = [];
         $context = $this->getStreamContext();
         if ($context !== null) {
             $options = stream_context_get_options($context);

src/AbstractStructArrayBase.php

@@ -21,7 +21,7 @@ abstract class AbstractStructArrayBase extends AbstractStructBase implements Str
     protected $internArrayOffset;
     /**
      * Method alias to count
-     * @uses ApiWsdlClass::count()
+     * @uses AbstractStructArrayBase::count()
      * @return int
      */
     public function length()
@@ -30,8 +30,8 @@ public function length()
     }
     /**
      * Method returning item length, alias to length
-     * @uses ApiWsdlClass::getInternArray()
-     * @uses ApiWsdlClass::getInternArrayIsArray()
+     * @uses AbstractStructArrayBase::getInternArray()
+     * @uses AbstractStructArrayBase::getInternArrayIsArray()
      * @return int
      */
     public function count()
@@ -40,7 +40,7 @@ public function count()
     }
     /**
      * Method returning the current element
-     * @uses ApiWsdlClass::offsetGet()
+     * @uses AbstractStructArrayBase::offsetGet()
      * @return mixed
      */
     public function current()
@@ -49,8 +49,8 @@ public function current()
     }
     /**
      * Method moving the current position to the next element
-     * @uses ApiWsdlClass::getInternArrayOffset()
-     * @uses ApiWsdlClass::setInternArrayOffset()
+     * @uses AbstractStructArrayBase::getInternArrayOffset()
+     * @uses AbstractStructArrayBase::setInternArrayOffset()
      * @return AbstractStructArrayBase
      */
     public function next()
@@ -59,7 +59,7 @@ public function next()
     }
     /**
      * Method resetting itemOffset
-     * @uses ApiWsdlClass::setInternArrayOffset()
+     * @uses AbstractStructArrayBase::setInternArrayOffset()
      * @return int
      */
     public function rewind()
@@ -68,8 +68,8 @@ public function rewind()
     }
     /**
      * Method checking if current itemOffset points to an existing item
-     * @uses ApiWsdlClass::getInternArrayOffset()
-     * @uses ApiWsdlClass::offsetExists()
+     * @uses AbstractStructArrayBase::getInternArrayOffset()
+     * @uses AbstractStructArrayBase::offsetExists()
      * @return bool
      */
     public function valid()
@@ -78,7 +78,7 @@ public function valid()
     }
     /**
      * Method returning current itemOffset value, alias to getInternArrayOffset
-     * @uses ApiWsdlClass::getInternArrayOffset()
+     * @uses AbstractStructArrayBase::getInternArrayOffset()
      * @return int
      */
     public function key()
@@ -87,8 +87,8 @@ public function key()
     }
     /**
      * Method alias to offsetGet
-     * @see ApiWsdlClass::offsetGet()
-     * @uses ApiWsdlClass::offsetGet()
+     * @see AbstractStructArrayBase::offsetGet()
+     * @uses AbstractStructArrayBase::offsetGet()
      * @param int $index
      * @return mixed
      */
@@ -98,13 +98,13 @@ public function item($index)
     }
     /**
      * Default method adding item to array
-     * @uses ApiWsdlClass::getAttributeName()
-     * @uses ApiWsdlClass::__toString()
-     * @uses ApiWsdlClass::_set()
-     * @uses ApiWsdlClass::_get()
-     * @uses ApiWsdlClass::setInternArray()
-     * @uses ApiWsdlClass::setInternArrayIsArray()
-     * @uses ApiWsdlClass::setInternArrayOffset()
+     * @uses AbstractStructArrayBase::getAttributeName()
+     * @uses AbstractStructArrayBase::__toString()
+     * @uses AbstractStructArrayBase::_set()
+     * @uses AbstractStructArrayBase::_get()
+     * @uses AbstractStructArrayBase::setInternArray()
+     * @uses AbstractStructArrayBase::setInternArrayIsArray()
+     * @uses AbstractStructArrayBase::setInternArrayOffset()
      * @param mixed $item value
      * @return AbstractStructArrayBase
      */
@@ -115,7 +115,7 @@ public function add($item)
              * init array
              */
             if (!is_array($this->_get($this->getAttributeName()))) {
-                $this->_set($this->getAttributeName(), array());
+                $this->_set($this->getAttributeName(), []);
             }
             /**
              * current array
@@ -132,7 +132,7 @@ public function add($item)
     }
     /**
      * Method returning the first item
-     * @uses ApiWsdlClass::item()
+     * @uses AbstractStructArrayBase::item()
      * @return mixed
      */
     public function first()
@@ -141,8 +141,8 @@ public function first()
     }
     /**
      * Method returning the last item
-     * @uses ApiWsdlClass::item()
-     * @uses ApiWsdlClass::length()
+     * @uses AbstractStructArrayBase::item()
+     * @uses AbstractStructArrayBase::length()
      * @return mixed
      */
     public function last()
@@ -151,8 +151,8 @@ public function last()
     }
     /**
      * Method testing index in item
-     * @uses ApiWsdlClass::getInternArrayIsArray()
-     * @uses ApiWsdlClass::getInternArray()
+     * @uses AbstractStructArrayBase::getInternArrayIsArray()
+     * @uses AbstractStructArrayBase::getInternArray()
      * @param int $offset
      * @return bool
      */
@@ -162,7 +162,7 @@ public function offsetExists($offset)
     }
     /**
      * Method returning the item at "index" value
-     * @uses ApiWsdlClass::offsetExists()
+     * @uses AbstractStructArrayBase::offsetExists()
      * @param int $offset
      * @return mixed
      */
@@ -222,17 +222,17 @@ public function getInternArrayOffset()
     }
     /**
      * Method initiating internArray
-     * @uses ApiWsdlClass::setInternArray()
-     * @uses ApiWsdlClass::setInternArrayOffset()
-     * @uses ApiWsdlClass::setInternArrayIsArray()
-     * @uses ApiWsdlClass::getAttributeName()
-     * @uses ApiWsdlClass::initInternArray()
-     * @uses ApiWsdlClass::__toString()
+     * @uses AbstractStructArrayBase::setInternArray()
+     * @uses AbstractStructArrayBase::setInternArrayOffset()
+     * @uses AbstractStructArrayBase::setInternArrayIsArray()
+     * @uses AbstractStructArrayBase::getAttributeName()
+     * @uses AbstractStructArrayBase::initInternArray()
+     * @uses AbstractStructArrayBase::__toString()
      * @param array $array the array to iterate trough
      * @param bool $internCall indicates that methods is calling itself
      * @return AbstractStructArrayBase
      */
-    public function initInternArray($array = array(), $internCall = false)
+    public function initInternArray($array = [], $internCall = false)
     {
         if (stripos(get_called_class(), 'array') !== false) {
             if (is_array($array) && count($array) > 0) {

src/AbstractStructBase.php

@@ -2,12 +2,20 @@
 
 namespace WsdlToPhp\PackageBase;
 
-abstract class AbstractStructBase implements StructInterface
+abstract class AbstractStructBase implements StructInterface, \JsonSerializable
 {
+    /**
+     * Returns the properties of this object
+     * @return mixed[]
+     */
+    public function jsonSerialize()
+    {
+        return \get_object_vars($this);
+    }
     /**
      * Generic method called when an object has been exported with var_export() functions
      * It allows to return an object instantiated with the values
-     * @uses ApiWsdlClass::_set()
+     * @uses AbstractStructBase::_set()
      * @param array $array the exported values
      * @return Struct
      */

src/SoapClientInterface.php

@@ -144,7 +144,7 @@ interface SoapClientInterface
      * @param array $wsdlOptions
      * @param bool $resetSoapClient allows to disable the SoapClient redefinition
      */
-    public function __construct(array $wsdlOptions = array(), $resetSoapClient = true);
+    public function __construct(array $wsdlOptions = [], $resetSoapClient = true);
     /**
      * Static method getting current SoapClient
      * @return \SoapClient

src/StructInterface.php

@@ -7,9 +7,8 @@ interface StructInterface
     /**
      * Generic method called when an object has been exported with var_export() functions
      * It allows to return an object instantiated with the values
-     * @uses ApiWsdlClass::_set()
      * @param array $array the exported values
-     * @return Struct
+     * @return StructInterface
      */
     public static function __set_state(array $array);
 }

tests/StructBaseTest.php

@@ -51,4 +51,15 @@ public function testSetGetWithException()
             ->setFoo('bar');
         $object->_get('sample');
     }
+    public function testJsonSerialize()
+    {
+        $object = new StructObject();
+        $object
+            ->setBar('foo')
+            ->setFoo('bar');
+        $this->assertSame([
+            'foo' => 'bar',
+            'bar' => 'foo',
+        ], $object->jsonSerialize());
+    }
 }