Merge branch 'release/1.0.10'

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

@@ -2,13 +2,13 @@ language: php
 
 sudo: false
 
-php:
-    - 5.3
-    - 5.4
-    - 5.5
-    - 5.6
-    - 7.0
-    - 7.1
+matrix:
+  include:
+    - php: 5.4
+    - php: 5.5
+    - php: 5.6
+    - php: 7.0
+    - php: 7.1
 
 before_install:
     - composer self-update

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.0.10
+- Issue #10 - Improve AbstractStructArrayBase class
+- Issue #13 - Feature request: AbstractStructBase implement JsonSerializable
+- Add Code of Conduct and Contributing files
+
 ## 1.0.9
 - Improve code, remove @ usage in generic __set_State method, add SensioLabs Insight badge
 

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+We accept contributions via pull requests on [Github].
+Please make all pull requests to the `develop` branch, not the `master` branch.
+
+## Pull Requests
+
+- **Create an issue** - Explain as detailed as possible the issue you encountered so we can understand the context of your pull request
+- **[Symfony Coding Standard]** - The easiest way to apply the conventions is to run `composer lint`
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+- **Create feature branches** - Don't ask us to pull from your master branch.
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
+
+## Running Tests
+
+``` bash
+$ composer test
+```
+
+**Happy coding**!
+
+[Github]: https://github.com/wsdltophp/packagebase
+[Symfony Coding Standard]: http://symfony.com/doc/current/contributing/code/standards.html

README.md

@@ -1,4 +1,7 @@
 # Package Base
+
+> Classes that are used by the classes generated by the [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator) project to ease the SoapClient UX.
+
 [![Latest Stable Version](https://poser.pugx.org/wsdltophp/packagebase/version.png)](https://packagist.org/packages/wsdltophp/packagebase)
 [![Total Downloads](https://poser.pugx.org/wsdltophp/packagebase/downloads)](https://packagist.org/packages/wsdltophp/packagebase)
 [![Build Status](https://api.travis-ci.org/WsdlToPhp/PackageBase.svg)](https://travis-ci.org/WsdlToPhp/PackageBase)
@@ -9,8 +12,11 @@
 [![StyleCI](https://styleci.io/repos/38760239/shield)](https://styleci.io/repos/38760239)
 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/bfbc0c8f-5793-489b-8151-36ea149ec98d/mini.png)](https://insight.sensiolabs.com/projects/bfbc0c8f-5793-489b-8151-36ea149ec98d)
 
+The goal is to provide generic and useful classes that are on top of the classes generated by the [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator) project.
+
+For example, it allows to easily loop through the array elements of a SOAP result object property, it allows to easily set HTTP and SOAP headers for a SOAP request and it allows to easily populate an object from its array state representation.
+
 ## Main features
-This project contains base classes used as parent class by the generated classes from [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator):
 - [Interfaces](#the-interfaces)
     - [StructInterface](#structinterface)
     - [StructArrayInterface](#structarrayinterface)
@@ -93,10 +99,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,11 +21,15 @@
         "email" : "[email protected]"
     },
     "require": {
-        "php" : ">=5.3.3"
+        "php" : ">=5.4"
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "lint": "vendor/bin/php-cs-fixer fix"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "~2.0",
-        "phpunit/phpunit": "~4.0"
+        "phpunit/phpunit": "^4.8 || ^6.0"
     },
     "autoload": {
         "psr-4": {

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);