Merge branch 'release/2.1.0'

Author: mikaelcom

.docker/Dockerfile

@@ -1,10 +1,6 @@
-FROM php:7.2-apache
-
-RUN apt-get update \
-    && apt-get install -y libxml2-dev git zip zlib1g \
-    && docker-php-ext-install soap
+FROM splitbrain/phpfarm:jessie
 
 COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
-COPY . /var/www/html
+COPY . /var/www/
 
-WORKDIR /var/www/html
+WORKDIR /var/www/

.travis.yml

@@ -5,11 +5,16 @@ sudo: false
 matrix:
   include:
     - php: 5.4
+      dist: trusty
     - php: 5.5
+      dist: trusty
     - php: 5.6
+      dist: trusty
     - php: 7.0
     - php: 7.1
     - php: 7.2
+    - php: 7.3
+    - php: 7.4
 
 install:
     - composer install

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 2.0.4 - 2020-05-14
+- Pull request #29 - Transform HTTP headers from stream context options to array
+- Update Travis CI PHP Matrix
+- Use better Docker configuration
+- Introduce StructEnumInterface and AbstractStructEnumBase from which generated Enum classes should inherit
+- Add __toString method to AbstractStructBase and AbstractSoapClientBase classes
+
 ## 2.0.3 - 2019-01-10
 - Issue #25 - Enhancement: Improve output from running php-cs-fixer
 - Issue #26 - Enhancement: Keep packages sorted in composer.json

README.md

@@ -16,17 +16,29 @@ For example, it allows to easily loop through the array elements of a SOAP resul
 
 ## Main features
 - [Interfaces](#the-interfaces)
+    - [StructEnumInterface](#structenuminterface)
     - [StructInterface](#structinterface)
     - [StructArrayInterface](#structarrayinterface)
     - [SoapClientInterface](#soapclientinterface)
 - [Abstract classes](#the-abstract-classes)
+    - [AbstractStructEnumBase](#abstractstructenumbase)
     - [AbstractStructBase](#abstractstructbase)
     - [AbstractStructArrayBase](#abstractstructarraybase)
     - [AbstractSoapClientBase](#abstractsoapclientbase)
 
 ## The interfaces
 The defined interfaces must be used in order to be able to match the requirements for the [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator) generated classes.
 
+### StructEnumInterface
+#### Description
+This interface must be used to define a new EnumType class.
+
+#### What has to be implemented?
+There is at least/most one method that must be implemented so it's pretty fast to implement it even if you don't see the goal of it:
+- **valueIsValid($value)**: this method must ensure that the passed `$value` is valid. This can be done using the array of string returned by the `getValidValues` method always present in the generated Enum classes. 
+
+**If you do not want to implement this method, you can too create your own class that inherits from our [AbstractStructEnumBase](#abstractstructenumbase) class.**
+
 ### StructInterface
 #### Description
 This interface must be used to define a new StructType class.
@@ -97,14 +109,24 @@ 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.**
 
 ## The abstract classes
+
+### AbstractStructEnumBase
+#### Description
+This class is the base class for any ```EnumType``` class generated by [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator). It implements our [StructEnumInterface](#structenuminterface) interface.
+It defines two methods:
+- **valueIsValid($value)**: It defines the default behaviour in order to validate a value that must be based on the current EnumType class constants returned by the `getValidValues` method.
+- **__toString()**: see [__toString](http://php.net/manual/en/language.oop5.magic.php#object.tostring) definition
+
+
 ### 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 four methods:
+It defines five 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.
 - **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.
+- **__toString()**: see [__toString](http://php.net/manual/en/language.oop5.magic.php#object.tostring) definition
 
 #### Usage
 ```php
@@ -283,10 +305,33 @@ public function setSoapHeaderCSPCHD(\Api\StructType\ApiCSPCHD $cSPCHD, $nameSpac
 ## Need improvements for these classes?
 Feel free to make some pull requests. We'll study them and let you know when it can be integrated.
 
-## Unit tests
+## Testing
 You can run the unit tests with the following command:
 ```
-    $ cd /path/to/src/WsdlToPhp/PackageBase/
-    $ composer install
-    $ composer test
+$ cd /path/to/src/WsdlToPhp/PackageBase/
+$ composer install
+$ composer test
+```
+
+## Testing using [Docker](https://www.docker.com/)
+Thanks to the [Docker image](https://hub.docker.com/r/splitbrain/phpfarm) of [phpfarm](https://github.com/fpoirotte/phpfarm), tests can be run locally under *any* PHP version using the cli:
+- php-5.4
+- php-5.5
+- php-5.6
+- php-7.0
+- php-7.1
+- php-7.2
+- php-7.3
+
+First of all, you need to create your container which you can do using [docker-compose](https://docs.docker.com/compose/) by running the below command line from the root directory of the project:
+```bash
+$ docker-compose up -d --build
+```
+
+You then have a container named `package_base` in which you can run `composer` commands and `php cli` commands such as:
+```bash
+# install deps in container (using update ensure it does use the composer.lock file if there is any)
+$ docker exec -it package_base php-7.2 /usr/bin/composer update
+# run tests in container
+$ docker exec -it package_base php-7.2 -dmemory_limit=-1 vendor/bin/phpunit
 ```

composer.json

@@ -34,6 +34,11 @@
         {
             "name": "hordijk",
             "role": "Contributor"
+        },
+        {
+            "name": "Jacob Dreesen",
+            "email": "[email protected]",
+            "role": "Contributor"
         }
     ],
     "support" : {

docker-compose.yml

@@ -6,5 +6,5 @@ services:
       context: .
       dockerfile: .docker/Dockerfile
     volumes:
-      - .:/var/www/html:rw
+      - .:/var/www:rw
     container_name: package_base

src/AbstractSoapClientBase.php

@@ -416,6 +416,9 @@ public function getStreamContextOptions()
         $context = $this->getStreamContext();
         if ($context !== null) {
             $options = stream_context_get_options($context);
+            if (isset($options['http']['header']) && is_string($options['http']['header'])) {
+                $options['http']['header'] = array_filter(array_map('trim', explode(PHP_EOL, $options['http']['header'])));
+            }
         }
         return $options;
     }
@@ -475,4 +478,12 @@ public function setResult($result)
         $this->result = $result;
         return $this;
     }
+    /**
+     * Default string representation of current object. Don't want to expose any sensible data
+     * @return string
+     */
+    public function __toString()
+    {
+        return get_called_class();
+    }
 }

src/AbstractStructBase.php

@@ -17,7 +17,7 @@ public function jsonSerialize()
      * It allows to return an object instantiated with the values
      * @uses AbstractStructBase::_set()
      * @param array $array the exported values
-     * @return Struct
+     * @return self
      */
     public static function __set_state(array $array)
     {
@@ -33,7 +33,7 @@ public static function __set_state(array $array)
      * @throws \InvalidArgumentException
      * @param string $name property name to set
      * @param mixed $value property value to use
-     * @return Struct
+     * @return self
      */
     public function _set($name, $value)
     {
@@ -59,4 +59,12 @@ public function _get($name)
         }
         throw new \InvalidArgumentException(sprintf('Getter does not exist for "%s" property', $name));
     }
+    /**
+     * Default string representation of current object. Don't want to expose any sensible data
+     * @return string
+     */
+    public function __toString()
+    {
+        return get_called_class();
+    }
 }

src/AbstractStructEnumBase.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace WsdlToPhp\PackageBase;
+
+abstract class AbstractStructEnumBase implements StructEnumInterface
+{
+    /**
+     * Return true if value is allowed
+     * @uses self::getValidValues()
+     * @param mixed $value value
+     * @return bool true|false
+     */
+    public static function valueIsValid($value)
+    {
+        return ($value === null) || in_array($value, static::getValidValues(), true);
+    }
+    /**
+     * Default string representation of current object. Don't want to expose any sensible data
+     * @return string
+     */
+    public function __toString()
+    {
+        return get_called_class();
+    }
+}

src/StructEnumInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace WsdlToPhp\PackageBase;
+
+interface StructEnumInterface
+{
+    /**
+     * Return true if value is allowed
+     * @uses self::getValidValues()
+     * @param mixed $value value
+     * @return bool true|false
+     */
+    public static function valueIsValid($value);
+    /**
+     * Return allowed values
+     * @return string[]
+     */
+    public static function getValidValues();
+}