Merge branch 'develop' into feature/issue-3

Author: mikaelcom

CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 1.0.6
+- Pull request #4: Rename $optioName to $optionName
+
+## 1.0.5
+- Update readme
+
+## 1.0.4
+- Issue #2 - Var name change request from $methoName to $methodName
+
 ## 1.0.3
 - Add utility methods **getStreamContext()** and **getStreamContextOptions()** to AbstractSoapClientbase class
 

README.md

@@ -1,5 +1,6 @@
 # Package Base
 [![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)
 [![PHP 7 ready](http://php7ready.timesplinter.ch/WsdlToPhp/PackageBase/badge.svg)](https://travis-ci.org/WsdlToPhp/PackageBase)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/WsdlToPhp/PackageBase/badges/quality-score.png)](https://scrutinizer-ci.com/g/WsdlToPhp/PackageBase/)
@@ -33,10 +34,10 @@ There is at least/most one method that must be implemented so it's pretty fast t
 
 ### StructArrayInterface
 #### Description
-This interface must be used to define a new ArrayType class. The goal is to provide utility methods around Array Structs defined by the Wsdl in order to ease the handling of its content. Therefore, this interface inherits from our [StructInterface](#structinterface) interface interface plus the native [ArrayAccess](http://php.net/manual/en/class.arrayaccess.php), [Iterator](http://php.net/manual/en/class.iterator.php) and [Countable](http://php.net/manual/en/class.countable.php) PHP interfaces
+This interface must be used to define a new ArrayType class. The goal is to provide utility methods around Array Structs defined by the Wsdl in order to ease the handling of its content. Therefore, this interface inherits from our [StructInterface](#structinterface) interface plus the native [ArrayAccess](http://php.net/manual/en/class.arrayaccess.php), [Iterator](http://php.net/manual/en/class.iterator.php) and [Countable](http://php.net/manual/en/class.countable.php) PHP interfaces
 
 #### What has to be implemented?
-The only method that must implement would be **getAttributeName** but be aware that it is implemented in every generated ArrayType class so no need to define it. It's just a reminder of what is available in ArrayType classes.
+The only method that must be implemented would be **getAttributeName** but be aware that it is implemented in every generated ArrayType class so no need to define it. It's just a reminder of what is available in ArrayType classes.
 
 So, basically, you MUST at least override the methods declared by the PHP interfaces from which this interface inherits
 
@@ -81,7 +82,7 @@ Here are the methods that must be implemented and why:
 - **getSoapClient()**: must return the [SoapClient](http://php.net/manual/en/class.soapclient.php) object that is responsible fo sending the requests.
 - **setSoapHeader($nameSpace, $name, $data, $mustUnderstand = false, $actor = null)**: look to [AbstractSoapClientBase](#abstractsoapclientbase) part that details this method. Basically, it allows to define [SoapHeader](http://php.net/manual/en/class.soapheader.php)s for the request
 - **getLastError()**: must return the last error, its format is up to you
-- **saveLastError($methoName, \SoapFault $soapFault)**: look to [AbstractSoapClientBase](#abstractsoapclientbase) part that details this method. Basically, it must allow to store a catched [Soapfault](http://php.net/manual/en/class.soapfault.php) object when a request has failed
+- **saveLastError($methodName, \SoapFault $soapFault)**: look to [AbstractSoapClientBase](#abstractsoapclientbase) part that details this method. Basically, it must allow to store a catched [Soapfault](http://php.net/manual/en/class.soapfault.php) object when a request has failed
 - **getResult()**: should return the Soap Web Service response, it's up to you
 - **setResult($result)**: must accept any parameter type as it should received the Soap Web Service response
 
@@ -201,7 +202,7 @@ $items->initInternArray(array(
 #### Description
 This class is the base class for any ```ServiceType``` class generated by [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator).
 Its goal is to provide utility/handful methods by implementing our [SoapClientInterface](#soapclientinterface) interface.
-It's basically a decorator design pattern as the class has the [SoapClient](http://php.net/manual/en/class.soapclient.php) object as a static property in order to be able apply methods on it. It is static property in order to have a singleton between multiple calls. It can be reset by passing true as the second parameter.
+It's basically a decorator design pattern as the class has the [SoapClient](http://php.net/manual/en/class.soapclient.php) object as a static property in order to be able to apply methods on it. It is a static property in order to have a singleton between multiple calls (allowing to send cookies automatically between calls). It can be reset by passing true as the second parameter.
 
 #### Usage
 Let's say you have this type of generate ```ServiceType``` class:
@@ -241,7 +242,7 @@ Then call any of these base methods:
 - **getLastRequestHeaders($asArray = false)**: returns either the HTTP request's headers as a string or as an array (each HTTP header is parsed)
 - **getLastResponseHeaders($asArray = false)**: returns either the HTTP response's headers as a string or as an array
 - **getLastError**: automatically populated with an error when ```$this->saveLastError(__METHOD__, $soapFault)``` is called
-- **getLastErrorForMethod($methoName)** : returns the error associated to the called method. It should return a ```SoapFault``` object
+- **getLastErrorForMethod($methodName)** : returns the error associated to the called method. It should return a ```SoapFault``` object
 ```php
 $result = $update->UpdateBulkOrder(new \Api\StructType\ApiUpdateBulkOrder())
 if ($result !== false) {

composer.json

@@ -10,6 +10,11 @@
             "name": "Mikaël DELSOL",
             "email": "[email protected]",
             "role": "Owner"
+        },
+        {
+            "name": "Luke Rodgers",
+            "email": "[email protected]",
+            "role": "Contributor"
         }
     ],
     "support" : {

src/AbstractSoapClientBase.php

@@ -67,11 +67,11 @@ public function initSoapClient(array $options)
     {
         $wsdlOptions = array();
         $defaultWsdlOptions = static::getDefaultWsdlOptions();
-        foreach ($defaultWsdlOptions as $optioName => $optionValue) {
-            if (array_key_exists($optioName, $options) && !empty($options[$optioName])) {
-                $wsdlOptions[str_replace(self::OPTION_PREFIX, '', $optioName)] = $options[$optioName];
+        foreach ($defaultWsdlOptions as $optionName => $optionValue) {
+            if (array_key_exists($optionName, $options) && !empty($options[$optionName])) {
+                $wsdlOptions[str_replace(self::OPTION_PREFIX, '', $optionName)] = $options[$optionName];
             } elseif (!empty($optionValue)) {
-                $wsdlOptions[str_replace(self::OPTION_PREFIX, '', $optioName)] = $optionValue;
+                $wsdlOptions[str_replace(self::OPTION_PREFIX, '', $optionName)] = $optionValue;
             }
         }
         if (array_key_exists(str_replace(self::OPTION_PREFIX, '', self::WSDL_URL), $wsdlOptions)) {
@@ -131,29 +131,30 @@ public function getSoapClientClassName($soapClientClassName = null)
     public static function getDefaultWsdlOptions()
     {
         return array(
-                    self::WSDL_CLASSMAP => null,
-                    self::WSDL_CACHE_WSDL => WSDL_CACHE_NONE,
-                    self::WSDL_COMPRESSION => null,
-                    self::WSDL_CONNECTION_TIMEOUT => null,
-                    self::WSDL_ENCODING => null,
-                    self::WSDL_EXCEPTIONS => true,
-                    self::WSDL_FEATURES => SOAP_SINGLE_ELEMENT_ARRAYS | SOAP_USE_XSI_ARRAY_TYPE,
-                    self::WSDL_LOGIN => null,
-                    self::WSDL_PASSWORD => null,
-                    self::WSDL_SOAP_VERSION => null,
-                    self::WSDL_STREAM_CONTEXT => null,
-                    self::WSDL_TRACE => true,
-                    self::WSDL_TYPEMAP => null,
-                    self::WSDL_URL => null,
-                    self::WSDL_USER_AGENT => null,
-                    self::WSDL_PROXY_HOST => null,
-                    self::WSDL_PROXY_PORT => null,
-                    self::WSDL_PROXY_LOGIN => null,
-                    self::WSDL_PROXY_PASSWORD => null,
-                    self::WSDL_LOCAL_CERT => null,
-                    self::WSDL_PASSPHRASE => null,
-                    self::WSDL_AUTHENTICATION => null,
-                    self::WSDL_SSL_METHOD => null);
+            self::WSDL_CLASSMAP => null,
+            self::WSDL_CACHE_WSDL => WSDL_CACHE_NONE,
+            self::WSDL_COMPRESSION => null,
+            self::WSDL_CONNECTION_TIMEOUT => null,
+            self::WSDL_ENCODING => null,
+            self::WSDL_EXCEPTIONS => true,
+            self::WSDL_FEATURES => SOAP_SINGLE_ELEMENT_ARRAYS | SOAP_USE_XSI_ARRAY_TYPE,
+            self::WSDL_LOGIN => null,
+            self::WSDL_PASSWORD => null,
+            self::WSDL_SOAP_VERSION => null,
+            self::WSDL_STREAM_CONTEXT => null,
+            self::WSDL_TRACE => true,
+            self::WSDL_TYPEMAP => null,
+            self::WSDL_URL => null,
+            self::WSDL_USER_AGENT => null,
+            self::WSDL_PROXY_HOST => null,
+            self::WSDL_PROXY_PORT => null,
+            self::WSDL_PROXY_LOGIN => null,
+            self::WSDL_PROXY_PASSWORD => null,
+            self::WSDL_LOCAL_CERT => null,
+            self::WSDL_PASSPHRASE => null,
+            self::WSDL_AUTHENTICATION => null,
+            self::WSDL_SSL_METHOD => null,
+        );
     }
     /**
      * Allows to set the SoapClient location to call
@@ -410,23 +411,23 @@ private function setLastError($lastError)
     }
     /**
      * Method saving the last error returned by the SoapClient
-     * @param string $methoName the method called when the error occurred
+     * @param string $methodName the method called when the error occurred
      * @param \SoapFault $soapFault l'objet de l'erreur
      * @return AbstractSoapClientBase
      */
-    public function saveLastError($methoName, \SoapFault $soapFault)
+    public function saveLastError($methodName, \SoapFault $soapFault)
     {
-        $this->lastError[$methoName] = $soapFault;
+        $this->lastError[$methodName] = $soapFault;
         return $this;
     }
     /**
      * Method getting the last error for a certain method
-     * @param string $methoName method name to get error from
+     * @param string $methodName method name to get error from
      * @return \SoapFault|null
      */
-    public function getLastErrorForMethod($methoName)
+    public function getLastErrorForMethod($methodName)
     {
-        return array_key_exists($methoName, $this->lastError) ? $this->lastError[$methoName] : null;
+        return array_key_exists($methodName, $this->lastError) ? $this->lastError[$methodName] : null;
     }
     /**
      * Method returning current result from Soap call

src/SoapClientInterface.php

@@ -163,11 +163,11 @@ public function setSoapHeader($nameSpace, $name, $data, $mustUnderstand = false,
     public function getLastError();
     /**
      * Method saving the last error returned by the SoapClient
-     * @param string $methoName the method called when the error occurred
+     * @param string $methodName the method called when the error occurred
      * @param \SoapFault $soapFault l'objet de l'erreur
      * @return SoapClientInterface
      */
-    public function saveLastError($methoName, \SoapFault $soapFault);
+    public function saveLastError($methodName, \SoapFault $soapFault);
     /**
      * Method returning current result from Soap call
      * @return mixed

tests/SoapClientTest.php

@@ -2,7 +2,6 @@
 
 namespace WsdlToPhp\PackageBase\Tests;
 
-
 use WsdlToPhp\PackageBase\Utils;
 use WsdlToPhp\PackageBase\Tests\SoapClient;
 
@@ -326,7 +325,7 @@ public function testGetStreamContext()
     /**
      *
      */
-    public function testGetStreamContextAsNill()
+    public function testGetStreamContextAsNull()
     {
         $soapClient = new SoapClient(array(
             SoapClient::WSDL_URL => __DIR__ . '/resources/bingsearch.wsdl',