Merge branch 'feature/issue-28' into develop

mikaelcom · mikaelcom · commit 7fb8a3b85346 · 2019-01-08T16:14:15.000+01:00
diff --git a/README.md b/README.md
@@ -57,6 +57,9 @@ Here are the constants/options defined by this interface and their utility:
 - **DEFAULT_SOAP_CLIENT_CLASS = '\SoapClient'**: this is the default [SoapClient](http://php.net/manual/en/class.soapclient.php) class that is used to send the request. Feel free to override it if you want to use another [SoapClient](http://php.net/manual/en/class.soapclient.php) class
 - **OPTION_PREFIX**: this is the prefix used for any constant's option name
 - **WSDL_URL**: option index used to pass the WSDL url
+- **WSDL_URI**: option index used to pass the target namespace of the SOAP service (required for non-WSDL-mode with with the `location`)
+- **WSDL_USE**: option index used to pass  non-WSDL-mode option use
+- **WSDL_STYLE**: option index used to pass non-WSDL-mode option style
 - **WSDL_CLASSMAP**: the classmap's array
 - **WSDL_LOGIN**: the basic authentication's login
 - **WSDL_PASSWORD**: the basic authentication's password
@@ -285,5 +288,5 @@ You can run the unit tests with the following command:
 ```
     $ cd /path/to/src/WsdlToPhp/PackageBase/
     $ composer install
-    $ phpunit
+    $ composer test
 ```
diff --git a/src/AbstractSoapClientBase.php b/src/AbstractSoapClientBase.php
@@ -60,6 +60,7 @@ public static function setSoapClient(\SoapClient $soapClient)
      * @uses AbstractSoapClientBase::getDefaultWsdlOptions()
      * @uses AbstractSoapClientBase::getSoapClientClassName()
      * @uses AbstractSoapClientBase::setSoapClient()
+     * @uses AbstractSoapClientBase::OPTION_PREFIX
      * @param array $options WSDL options
      * @return void
      */
@@ -74,20 +75,42 @@ public function initSoapClient(array $options)
                 $wsdlOptions[str_replace(self::OPTION_PREFIX, '', $optionName)] = $optionValue;
             }
         }
-        if (array_key_exists(str_replace(self::OPTION_PREFIX, '', self::WSDL_URL), $wsdlOptions)) {
-            $wsdlUrl = $wsdlOptions[str_replace(self::OPTION_PREFIX, '', self::WSDL_URL)];
-            unset($wsdlOptions[str_replace(self::OPTION_PREFIX, '', self::WSDL_URL)]);
+        if (self::canInstantiateSoapClientWithOptions($wsdlOptions)) {
+            $wsdlUrl = null;
+            if (array_key_exists(str_replace(self::OPTION_PREFIX, '', self::WSDL_URL), $wsdlOptions)) {
+                $wsdlUrl = $wsdlOptions[str_replace(self::OPTION_PREFIX, '', self::WSDL_URL)];
+                unset($wsdlOptions[str_replace(self::OPTION_PREFIX, '', self::WSDL_URL)]);
+            }
             $soapClientClassName = $this->getSoapClientClassName();
             static::setSoapClient(new $soapClientClassName($wsdlUrl, $wsdlOptions));
         }
     }
+    /**
+     * Checks if the provided options are sufficient to instantiate a SoapClient:
+     *  - WSDL-mode : only the WSDL is required
+     *  - non-WSDL-mode : URI and LOCATION are required, WSDL url can be empty then
+     * @uses AbstractSoapClientBase::OPTION_PREFIX
+     * @param $wsdlOptions
+     * @return bool
+     */
+    protected static function canInstantiateSoapClientWithOptions($wsdlOptions)
+    {
+        return (
+            array_key_exists(str_replace(self::OPTION_PREFIX, '', self::WSDL_URL), $wsdlOptions) ||
+            (
+                array_key_exists(str_replace(self::OPTION_PREFIX, '', self::WSDL_URI), $wsdlOptions) &&
+                array_key_exists(str_replace(self::OPTION_PREFIX, '', self::WSDL_LOCATION), $wsdlOptions)
+            )
+        );
+    }
     /**
      * Returns the SoapClient class name to use to create the instance of the SoapClient.
      * The SoapClient class is determined based on the package name.
      * If a class is named as {Api}SoapClient, then this is the class that will be used.
      * Be sure that this class inherits from the native PHP SoapClient class and this class has been loaded or can be loaded.
      * The goal is to allow the override of the SoapClient without having to modify this generated class.
      * Then the overridding SoapClient class can override for example the SoapClient::__doRequest() method if it is needed.
+     * @uses AbstractSoapClientBase::DEFAULT_SOAP_CLIENT_CLASS
      * @return string
      */
     public function getSoapClientClassName($soapClientClassName = null)
@@ -100,62 +123,68 @@ public function getSoapClientClassName($soapClientClassName = null)
     }
     /**
      * Method returning all default options values
-     * @uses AbstractSoapClientBase::WSDL_CLASSMAP
+     * @uses AbstractSoapClientBase::WSDL_AUTHENTICATION
      * @uses AbstractSoapClientBase::WSDL_CACHE_WSDL
+     * @uses AbstractSoapClientBase::WSDL_CLASSMAP
      * @uses AbstractSoapClientBase::WSDL_COMPRESSION
      * @uses AbstractSoapClientBase::WSDL_CONNECTION_TIMEOUT
      * @uses AbstractSoapClientBase::WSDL_ENCODING
      * @uses AbstractSoapClientBase::WSDL_EXCEPTIONS
      * @uses AbstractSoapClientBase::WSDL_FEATURES
+     * @uses AbstractSoapClientBase::WSDL_LOCAL_CERT
      * @uses AbstractSoapClientBase::WSDL_LOCATION
      * @uses AbstractSoapClientBase::WSDL_LOGIN
+     * @uses AbstractSoapClientBase::WSDL_PASSPHRASE
      * @uses AbstractSoapClientBase::WSDL_PASSWORD
+     * @uses AbstractSoapClientBase::WSDL_PROXY_HOST
+     * @uses AbstractSoapClientBase::WSDL_PROXY_LOGIN
+     * @uses AbstractSoapClientBase::WSDL_PROXY_PASSWORD
+     * @uses AbstractSoapClientBase::WSDL_PROXY_PORT
      * @uses AbstractSoapClientBase::WSDL_SOAP_VERSION
+     * @uses AbstractSoapClientBase::WSDL_SSL_METHOD
      * @uses AbstractSoapClientBase::WSDL_STREAM_CONTEXT
+     * @uses AbstractSoapClientBase::WSDL_STYLE
      * @uses AbstractSoapClientBase::WSDL_TRACE
      * @uses AbstractSoapClientBase::WSDL_TYPEMAP
      * @uses AbstractSoapClientBase::WSDL_URL
-     * @uses AbstractSoapClientBase::VALUE_WSDL_URL
+     * @uses AbstractSoapClientBase::WSDL_URI
+     * @uses AbstractSoapClientBase::WSDL_USE
      * @uses AbstractSoapClientBase::WSDL_USER_AGENT
-     * @uses AbstractSoapClientBase::WSDL_PROXY_HOST
-     * @uses AbstractSoapClientBase::WSDL_PROXY_PORT
-     * @uses AbstractSoapClientBase::WSDL_PROXY_LOGIN
-     * @uses AbstractSoapClientBase::WSDL_PROXY_PASSWORD
-     * @uses AbstractSoapClientBase::WSDL_LOCAL_CERT
-     * @uses AbstractSoapClientBase::WSDL_PASSPHRASE
-     * @uses AbstractSoapClientBase::WSDL_AUTHENTICATION
-     * @uses AbstractSoapClientBase::WSDL_SSL_METHOD
+     * @uses WSDL_CACHE_NONE
      * @uses SOAP_SINGLE_ELEMENT_ARRAYS
      * @uses SOAP_USE_XSI_ARRAY_TYPE
      * @return array
      */
     public static function getDefaultWsdlOptions()
     {
         return [
-            self::WSDL_CLASSMAP => null,
+            self::WSDL_AUTHENTICATION => null,
             self::WSDL_CACHE_WSDL => WSDL_CACHE_NONE,
+            self::WSDL_CLASSMAP => null,
             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_LOCAL_CERT => null,
             self::WSDL_LOCATION => null,
             self::WSDL_LOGIN => null,
+            self::WSDL_PASSPHRASE => null,
             self::WSDL_PASSWORD => null,
+            self::WSDL_PROXY_HOST => null,
+            self::WSDL_PROXY_LOGIN => null,
+            self::WSDL_PROXY_PASSWORD => null,
+            self::WSDL_PROXY_PORT => null,
             self::WSDL_SOAP_VERSION => null,
+            self::WSDL_SSL_METHOD => null,
             self::WSDL_STREAM_CONTEXT => null,
+            self::WSDL_STYLE => null,
             self::WSDL_TRACE => true,
             self::WSDL_TYPEMAP => null,
             self::WSDL_URL => null,
+            self::WSDL_URI => null,
+            self::WSDL_USE => 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,
         ];
     }
     /**
diff --git a/src/SoapClientInterface.php b/src/SoapClientInterface.php
@@ -117,6 +117,11 @@ interface SoapClientInterface
      * @var string
      */
     const WSDL_STREAM_CONTEXT = 'wsdl_stream_context';
+    /**
+     * Option key to define WSDL style
+     * @var string
+     */
+    const WSDL_STYLE = 'wsdl_style';
     /**
      * Option key to define WSDL trace option
      * @var string
@@ -132,6 +137,16 @@ interface SoapClientInterface
      * @var string
      */
     const WSDL_URL = 'wsdl_url';
+    /**
+     * Option key to define WSDL uri
+     * @var string
+     */
+    const WSDL_URI = 'wsdl_uri';
+    /**
+     * Option key to define WSDL use
+     * @var string
+     */
+    const WSDL_USE = 'wsdl_use';
     /**
      * Option key to define WSDL user_agent
      * @var string
diff --git a/tests/SoapClientTest.php b/tests/SoapClientTest.php
@@ -49,20 +49,20 @@ public function testSetLocation()
 
         $soapClient->setLocation('http://api.bing.net:80/soap.asm');
 
-        $this->assertSAme('http://api.bing.net:80/soap.asm', $soapClient->getSoapClient()->location);
+        $this->assertSame('http://api.bing.net:80/soap.asm', $soapClient->getSoapClient()->location);
     }
     /**
      *
      */
-    public function testLocationOotion()
+    public function testLocationOption()
     {
         $soapClient = new SoapClient(array(
             SoapClient::WSDL_URL => __DIR__ . '/resources/bingsearch.wsdl',
             SoapClient::WSDL_CLASSMAP => self::classMap(),
             SoapClient::WSDL_LOCATION => 'http://api.bing.net:80/soap.asm',
         ));
 
-        $this->assertSAme('http://api.bing.net:80/soap.asm', $soapClient->getSoapClient()->location);
+        $this->assertSame('http://api.bing.net:80/soap.asm', $soapClient->getSoapClient()->location);
     }
     /**
      *
@@ -481,4 +481,52 @@ public static function classMap()
             'WebSearchTag' => 'ApiStructWebSearchTag',
         );
     }
+    /**
+     *
+     */
+    public function testInvalidNonWsdlModeMustNotCreateASoapInstanceForMissingUriAndLocationOptions()
+    {
+        $soapClient = new SoapClient(array(
+            SoapClient::WSDL_URL => null,
+        ));
+
+        $this->assertNull($soapClient->getSoapClient());
+    }
+    /**
+     *
+     */
+    public function testInvalidNonWsdlModeMustNotCreateASoapInstanceForMissingLocationOption()
+    {
+        $soapClient = new SoapClient(array(
+            SoapClient::WSDL_URL => null,
+            SoapClient::WSDL_URI => 'http://api.bing.net:80/soap.asmx',
+        ));
+
+        $this->assertNull($soapClient->getSoapClient());
+    }
+    /**
+     *
+     */
+    public function testInvalidNonWsdlModeMustNotCreateASoapInstanceForMissingUriOption()
+    {
+        $soapClient = new SoapClient(array(
+            SoapClient::WSDL_URL => null,
+            SoapClient::WSDL_LOCATION => 'http://api.bing.net:80/soap.asmx',
+        ));
+
+        $this->assertNull($soapClient->getSoapClient());
+    }
+    /**
+     *
+     */
+    public function testInvalidNonWsdlModeMustCreateASoapInstanceWithUriAndLocationOptions()
+    {
+        $soapClient = new SoapClient(array(
+            SoapClient::WSDL_URL => null,
+            SoapClient::WSDL_LOCATION => 'http://api.bing.net:80/soap.asmx',
+            SoapClient::WSDL_URI => 'http://api.bing.net:80/soap.asmx',
+        ));
+
+        $this->assertInstanceOf('\SoapClient', $soapClient->getSoapClient());
+    }
 }
