Merge pull request #1 from shavounet/v3.0-dev

Added the possibility to configure Soap Headers for call

Author: VincentChalnot

Client/Client.php

@@ -28,6 +28,12 @@ class Client implements ClientInterface
     /** @var array */
     private $options;
 
+    /** @var array */
+    private $soapOptions;
+
+    /** @var null|\SoapHeader[] */
+    private $soapHeaders;
+
     /** @var LoggerInterface */
     private $logger;
 
@@ -115,6 +121,38 @@ public function setOptions(array $options): void
         $this->options = $options;
     }
 
+    /**
+     * @return array|null
+     */
+    public function getSoapOptions(): ?array
+    {
+        return $this->soapOptions;
+    }
+
+    /**
+     * @param array|null $soapOptions
+     */
+    public function setSoapOptions(array $soapOptions = null): void
+    {
+        $this->soapOptions = $soapOptions;
+    }
+
+    /**
+     * @return \SoapHeader[]|null
+     */
+    public function getSoapHeaders(): ?array
+    {
+        return $this->soapHeaders;
+    }
+
+    /**
+     * @param \SoapHeader[]|null $soapHeaders
+     */
+    public function setSoapHeaders(array $soapHeaders = null): void
+    {
+        $this->soapHeaders = $soapHeaders;
+    }
+
     /**
      * @return \SoapClient|null
      */
@@ -134,63 +172,63 @@ public function setSoapClient(\SoapClient $soapClient): void
     /**
      * @return string
      */
-    public function getLastRequest(): string
+    public function getLastRequest(): ?string
     {
         return $this->lastRequest;
     }
 
     /**
      * @param string $lastRequest
      */
-    public function setLastRequest(string $lastRequest): void
+    public function setLastRequest(?string $lastRequest): void
     {
         $this->lastRequest = $lastRequest;
     }
 
     /**
      * @return string
      */
-    public function getLastRequestHeaders(): string
+    public function getLastRequestHeaders(): ?string
     {
         return $this->lastRequestHeaders;
     }
 
     /**
      * @param string $lastRequestHeaders
      */
-    public function setLastRequestHeaders(string $lastRequestHeaders): void
+    public function setLastRequestHeaders(?string $lastRequestHeaders): void
     {
         $this->lastRequestHeaders = $lastRequestHeaders;
     }
 
     /**
      * @return string
      */
-    public function getLastResponse(): string
+    public function getLastResponse(): ?string
     {
         return $this->lastResponse;
     }
 
     /**
      * @param string $lastResponse
      */
-    public function setLastResponse(string $lastResponse): void
+    public function setLastResponse(?string $lastResponse): void
     {
         $this->lastResponse = $lastResponse;
     }
 
     /**
      * @return string
      */
-    public function getLastResponseHeaders(): string
+    public function getLastResponseHeaders(): ?string
     {
         return $this->lastResponseHeaders;
     }
 
     /**
      * @param string $lastResponseHeaders
      */
-    public function setLastResponseHeaders(string $lastResponseHeaders): void
+    public function setLastResponseHeaders(?string $lastResponseHeaders): void
     {
         $this->lastResponseHeaders = $lastResponseHeaders;
     }
@@ -226,7 +264,7 @@ protected function doSoapCall(string $method, array $input = [])
             throw new \InvalidArgumentException('Soap client is not initialized');
         }
         try {
-            $result = $this->getSoapClient()->__soapCall($method, [$input]);
+            $result = $this->getSoapClient()->__soapCall($method, $input, $this->getSoapOptions(), $this->getSoapHeaders());
         } /** @noinspection PhpRedundantCatchClauseInspection */ catch (\SoapFault $e) {
             $this->getLastRequestTrace();
             $this->getLogger()->alert(

Client/ClientInterface.php

@@ -60,25 +60,65 @@ public function getOptions(): array;
      */
     public function setOptions(array $options): void;
 
+    /**
+     * Return the Soap call options
+     *
+     * @see https://www.php.net/manual/en/soapclient.soapcall.php
+     *
+     * @return array|null
+     */
+    public function getSoapOptions(): ?array;
+
+    /**
+     * Set the Soap call options
+     *
+     * @see https://www.php.net/manual/en/soapclient.soapcall.php
+     *
+     * @param array|null $options
+     *
+     * @return void
+     */
+    public function setSoapOptions(array $options = null): void;
+
+    /**
+     * Return the Soap call headers
+     *
+     * @see https://www.php.net/manual/en/soapclient.soapcall.php
+     *
+     * @return \SoapHeader[]|null
+     */
+    public function getSoapHeaders(): ?array;
+
+    /**
+     * Set the Soap call headers
+     *
+     * @see https://www.php.net/manual/en/soapclient.soapcall.php
+     *
+     * @param \SoapHeader[]|null $headers
+     *
+     * @return void
+     */
+    public function setSoapHeaders(array $headers = null): void;
+
     /**
      * @return string
      */
-    public function getLastRequest(): string;
+    public function getLastRequest(): ?string;
 
     /**
      * @return string
      */
-    public function getLastRequestHeaders(): string;
+    public function getLastRequestHeaders(): ?string;
 
     /**
      * @return string
      */
-    public function getLastResponse(): string;
+    public function getLastResponse(): ?string;
 
     /**
      * @return string
      */
-    public function getLastResponseHeaders(): string;
+    public function getLastResponseHeaders(): ?string;
 
     /**
      * Call Soap method

Task/RequestTask.php

@@ -15,6 +15,7 @@
 use CleverAge\ProcessBundle\Model\ProcessState;
 use CleverAge\SoapProcessBundle\Registry\ClientRegistry;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\OptionsResolver\Options;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
@@ -54,6 +55,9 @@ public function execute(ProcessState $state): void
 
         $input = $state->getInput() ?: [];
 
+        $client->setSoapOptions($this->getOption($state, 'soap_call_options'));
+        $client->setSoapHeaders($this->getOption($state, 'soap_call_headers'));
+
         $result = $client->call($options['method'], $input);
 
         // Handle empty results
@@ -91,7 +95,38 @@ protected function configureOptions(OptionsResolver $resolver): void
                 'method',
             ]
         );
+        $resolver->setDefaults(
+            [
+                'soap_call_options' => null,
+                'soap_call_headers' => null,
+            ]
+        );
         $resolver->setAllowedTypes('client', ['string']);
         $resolver->setAllowedTypes('method', ['string']);
+        $resolver->setAllowedTypes('soap_call_options', ['array', 'null']);
+        $resolver->setAllowedTypes('soap_call_headers', ['array', 'null']);
+
+        $resolver->setNormalizer('soap_call_headers', function (Options $options, $headers) {
+            if ($headers === null) {
+                return null;
+            }
+
+            $headerResolver = new OptionsResolver();
+            $this->configureSoapCallHeaderOption($headerResolver);
+
+            $resolvedHeaders = [];
+            foreach ($headers as $name => $header) {
+                $resolvedHeader = $headerResolver->resolve($header);
+                $resolvedHeaders[] = new \SoapHeader($resolvedHeader['namespace'], $name, $resolvedHeader['data']);
+            }
+
+            return $resolvedHeaders;
+        });
+    }
+
+    protected function configureSoapCallHeaderOption(OptionsResolver $resolver)
+    {
+        $resolver->setRequired('namespace');
+        $resolver->setRequired('data');
     }
 }