Melhorias gerais e adequação de padrões

Author: fabiojaniolima

README.md

@@ -114,7 +114,12 @@ if(!$erro = $obj->doRequest('nomeServico', $args)) {
     
     // Retorna uma string contendo o cabeçalho da resposta http
     // Obs: Só retorna valor se doRequest já tiver sido chamado
-    // $obj->getHeader();
+    /**
+     * Retorna uma string contendo o cabeçalho da resposta http do webservice. Deve vir depois de doRequest()
+     *
+     * @see http://php.net/manual/pt_BR/function.nl2br.php Documentação para a função nlb2br.
+     */
+    echo nl2br($obj->getHeader());
 } else {
     echo $erro;
 }

src/ClienteGenerico.php

@@ -21,7 +21,7 @@ class ClienteGenerico implements iRequestXML
     /**
      * Armazena uma instância de Curl.
      * 
-     * @var object
+     * @var resource
      */
     private $curl;
 
@@ -40,14 +40,14 @@ class ClienteGenerico implements iRequestXML
     private $info;
 
     /**
-     * Cabeçalho a ser enviado
+     * Cabeçalho a ser enviado.
      *
      * @var array
      */
     private $header;
 
     /**
-     * Conteúdo (xml) bruto a ser enviado
+     * Conteúdo (xml) bruto a ser enviado.
      *
      * @var string
      */
@@ -71,9 +71,9 @@ public function __construct()
     }
 
     /**
-     * Define o tempo máximo do pedido
+     * Define o tempo máximo do pedido.
      *
-     * @param   int     $timeout    Em segundos
+     * @param   int     $timeout    Em segundos.
      *
      * @return  \Crphp\Webservice\ClienteGenerico
      */    
@@ -194,7 +194,7 @@ public function getHeader()
     }
 
     /**
-     * Retorna o xml submetido
+     * Retorna o xml submetido.
      *
      * @return string
      */
@@ -206,7 +206,7 @@ public function getRequest()
     /**
      * Retorna o output devolvido pelo servidor alvo.
      * 
-     * @return  null|string     Em caso de sucesso retorna vazio, para erro retorna string
+     * @return  null|string     Em caso de sucesso retorna vazio, para erro retorna string.
      */
     public function getResponse()
     {

src/Soap.php

@@ -35,7 +35,7 @@ class Soap implements iRequestXML
      * @param   array       $header
      * @param   array       $increment
      *
-     * @return  void|string  void = sucesso, string = erro
+     * @return  void|string  void = sucesso, string = erro.
      */
     public function setRequest($wsdl, array $header = null, array $increment = null)
     {
@@ -46,7 +46,7 @@ public function setRequest($wsdl, array $header = null, array $increment = null)
                 'user_agent' => 'PHP/SOAP',
                 'trace' => 1,
                 'encoding' => 'UTF-8',
-                // Corrige um problema onde era retornado o erro: Could not connect to host
+                /** @internal Corrige um problema onde era retornado o erro: Could not connect to host */
                 'location' => substr($wsdl, 0, -5)
             ];
         }
@@ -61,14 +61,14 @@ public function setRequest($wsdl, array $header = null, array $increment = null)
             return $e->getMessage();
         }
     }
-        
+
     /**
      * Dispara a consulta contra o serviço informado.
-     * 
+     *
      * @param   string          $service
      * @param   string|array    $arguments
      *
-     * @return  void|string     null = sucesso, string = erro
+     * @return  void|string     null = sucesso, string = erro.
      */
     public function doRequest($service, $arguments)
     {
@@ -78,21 +78,7 @@ public function doRequest($service, $arguments)
             }
 
             if (is_string($arguments)) {
-                /* @see http://php.net/manual/pt_BR/function.libxml-use-internal-errors.php */
-                libxml_use_internal_errors(true);
-                $xml = simplexml_load_string($arguments);
-
-                if ($xml === false) {
-                    foreach (libxml_get_errors() as $error) {
-                        throw new Exception('Ocorreu um erro ao processar o XML de envio: ' . $error->message);
-                    }
-                }
-
-                if ($xml = $xml->children('soapenv', true)) {
-                    $arguments = $xml->Body->children()->asXML();
-                }
-
-                $arguments = [new SoapVar($arguments, XSD_ANYXML)];
+                $arguments = [$this->xmlToArray($arguments)];
             }
 
             $this->client->__soapCall($service, $arguments);
@@ -104,25 +90,20 @@ public function doRequest($service, $arguments)
     /**
      * Retorna o cabeçalho HTTP da resposta enviada pelo webservice.
      *
-     * @param   bool          $nl2br
-     *
      * @return  null|string
      */
-    public function getHeader($nl2br = true)
+    public function getHeader()
     {
         if ($this->client) {
-            $responseHeader = $this->client->__getLastResponseHeaders();
-
-            /* @see http://php.net/manual/pt_BR/function.nl2br.php Documentação para a função nlb2br */
-            return ($nl2br) ? nl2br($responseHeader) : $responseHeader;
+            return $this->client->__getLastResponseHeaders();
         }
 
         return null;
     }
 
     /**
      * Retorna os métodos expostos pelo WSDL.
-     * 
+     *
      * @return  array|void
      */
     public function getMethods()
@@ -139,8 +120,8 @@ public function getMethods()
 
     /**
      * Retorna o XML enviado.
-     * 
-     * @return  string|null  Em caso de sucesso retorna string, para erro retorna null
+     *
+     * @return  string|null  Em caso de sucesso retorna string, para erro retorna null.
      */
     public function getRequest()
     {
@@ -149,11 +130,39 @@ public function getRequest()
 
     /**
      * Retorna o XML recebido.
-     * 
-     * @return string|null  Em caso de sucesso retorna string, para erro retorna null
+     *
+     * @return string|null  Em caso de sucesso retorna string, para erro retorna null.
      */
     public function getResponse()
     {
         return ($this->client) ? $this->client->__getLastResponse() : null;
     }
+
+    /**
+     * Transforma a string XML em um objeto \SoapVar.
+     *
+     * @param string $arguments
+     *
+     * @throws \Exception Dispara uma exception caso ocorra algum erro no processamento da string xml
+     *
+     * @return \SoapVar|null
+     */
+    public function xmlToArray($arguments)
+    {
+        /* @see http://php.net/manual/pt_BR/function.libxml-use-internal-errors.php */
+        libxml_use_internal_errors(true);
+        $xml = simplexml_load_string($arguments);
+
+        if ($xml === false) {
+            foreach (libxml_get_errors() as $error) {
+                throw new Exception('Ocorreu um erro ao processar o XML de envio: ' . $error->message);
+            }
+        }
+
+        if ($xml = $xml->children('soapenv', true)) {
+            $arguments = $xml->Body->children()->asXML();
+        }
+
+        return new SoapVar($arguments, XSD_ANYXML);
+    }
 }

src/Traits/FormatarXML.php

@@ -11,7 +11,7 @@ trait FormatarXML {
      *
      * @param string $xml
      *
-     * @return null|string  Se não tiver dado para transformação retorna null
+     * @return null|string  Se não tiver dado para transformação retorna null.
      */
     public function formatXML($xml)
     {