Merge branch 'release/1.0.1'

Author: mikaelcom

CHANGELOG.md

@@ -1,27 +1,24 @@
-CHANGELOG
-=========
+# CHANGELOG
 
-1.0.0
----------
+## 1.0.1
+- Interfaces' methods has been well declared as public
+- Minor readme typo updates
+
+## 1.0.0
 - First major release, code coverage improved to reach 100% from the 1.0.0RC02 release.
 
-1.0.0RC02
----------
+## 1.0.0RC02
 - Major: update source code structure, put all classes under ```src``` folder, rename Tests to tests, update composer and phpunit accordingly
 
-1.0.0RC01
----------
+## 1.0.0RC01
 - Update Readme
 - Define interfaces that must be used as interfaces in order to be able to define a usable top class for any generated ServiceType/StructType/ArrayType class by the [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator)
 
-0.0.3
------
+## 0.0.3
 - Update dependency badge
 
-0.0.2
------
+## 0.0.2
 - use top level namespace for SoapHeader class
 
-0.0.1
------
+## 0.0.1
 - Initial version

README.md

@@ -4,6 +4,7 @@
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/WsdlToPhp/PackageBase/badges/quality-score.png)](https://scrutinizer-ci.com/g/WsdlToPhp/PackageBase/)
 [![Code Coverage](https://scrutinizer-ci.com/g/WsdlToPhp/PackageBase/badges/coverage.png)](https://scrutinizer-ci.com/g/WsdlToPhp/PackageBase/)
 [![Dependency Status](https://www.versioneye.com/user/projects/55b10586643533001c00010f/badge.svg)](https://www.versioneye.com/user/projects/55b10586643533001c00010f)
+[![StyleCI](https://styleci.io/repos/38760239/shield)](https://styleci.io/repos/38760239)
 
 ## Main features
 This project contains base classes used as parent class by the generated classes from [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator):
@@ -31,7 +32,7 @@ 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 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.
@@ -85,10 +86,10 @@ Here are the methods that must be implemented and why:
 
 **If you do not want to implement all these methods, you can too create your own class that inherits from our [AbstractSoapClientBase](#abstractsoapclientbase) class.**
 
-## How tos
+## The abstract classes
 ### AbstractStructBase
 #### Description
-This class is the base class for any ```StructType``` class generated by [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator). It implements our [StructInteface](#structinteface) interface.
+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:
 - **__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.
@@ -107,7 +108,7 @@ $item = \Api\StructType\Item::__set_state(array(
 
 ### AbstractStructArrayBase
 #### Description
-This class is the base class for any ```ArrayType``` class generated by [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator). It implements our [StructArrayInteface](#structarrayinterface) interface.
+This class is the base class for any ```ArrayType``` class generated by [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator). It implements our [StructArrayInterface](#structarrayinterface) interface.
 
 #### Usage
 As soon as you have an element that is an array of items such as:
@@ -205,7 +206,7 @@ It's basically a decorator design pattern as the class has the [SoapClient](http
 Let's say you have this type of generate ```ServiceType``` class:
 ```php
 namespace Api\ServiceType;
-use \WsdlToPhp\PackageBase\AbstractSoapClientBase
+use \WsdlToPhp\PackageBase\AbstractSoapClientBase;
 class ApiUpdate extends AbstractSoapClientBase
 {
     public function UpdateBulkOrder(\Api\StructType\ApiUpdateBulkOrder $parameters)
@@ -275,4 +276,4 @@ You can run the unit tests with the following command:
     $ cd /path/to/src/WsdlToPhp/PackageBase/
     $ composer install
     $ phpunit
-```
+```

src/SoapClientInterface.php

@@ -139,12 +139,12 @@ interface SoapClientInterface
      * @param array $wsdlOptions
      * @param bool $resetSoapClient allows to disable the SoapClient redefinition
      */
-    function __construct(array $wsdlOptions = array(), $resetSoapClient = true);
+    public function __construct(array $wsdlOptions = array(), $resetSoapClient = true);
     /**
      * Static method getting current SoapClient
      * @return \SoapClient
      */
-    static function getSoapClient();
+    public static function getSoapClient();
     /**
      * Sets a SoapHeader to send
      * For more information, please read the online documentation on {@link http://www.php.net/manual/en/class.soapheader.php}
@@ -155,28 +155,28 @@ static function getSoapClient();
      * @param string $actor
      * @return SoapClientInterface
      */
-    function setSoapHeader($nameSpace, $name, $data, $mustUnderstand = false, $actor = null);
+    public function setSoapHeader($nameSpace, $name, $data, $mustUnderstand = false, $actor = null);
     /**
      * Method returning last errors occured during the calls
      * @return array
      */
-    function getLastError();
+    public function getLastError();
     /**
      * Method saving the last error returned by the SoapClient
      * @param string $methoName the method called when the error occurred
      * @param \SoapFault $soapFault l'objet de l'erreur
      * @return SoapClientInterface
      */
-    function saveLastError($methoName, \SoapFault $soapFault);
+    public function saveLastError($methoName, \SoapFault $soapFault);
     /**
      * Method returning current result from Soap call
      * @return mixed
      */
-    function getResult();
+    public function getResult();
     /**
      * Method setting current result from Soap call
      * @param mixed $result
      * @return SoapClientInterface
      */
-    function setResult($result);
+    public function setResult($result);
 }

src/StructArrayInterface.php

@@ -9,5 +9,5 @@ interface StructArrayInterface extends StructInterface, \ArrayAccess, \Iterator,
      * This method has been overridden in real-array struct class
      * @return string
      */
-    function getAttributeName();
+    public function getAttributeName();
 }

src/StructInterface.php

@@ -11,5 +11,5 @@ interface StructInterface
      * @param array $array the exported values
      * @return Struct
      */
-    static function __set_state(array $array);
+    public static function __set_state(array $array);
 }