mazinsw / nfe-api

api/NFe/Task/Envio.php

Doc Comments +6 added lines

@@ -59,6 +59,9 @@ 
         $this->fromArray($envio);
     }
 
+    /**
+     * @return string
+     */
     public function getServico($normalize = false)
     {
         if (!$normalize) {
@@ -143,6 +146,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getVersao()
     {
         $config = SEFAZ::getInstance()->getConfiguracao();

api/NFe/Task/Evento.php

Doc Comments +12 added lines

@@ -81,6 +81,7 @@ 
     /**
      * Código do órgão de recepção do Evento. Utilizar a Tabela do IBGE
      * extendida, utilizar 91 para identificar o Ambiente Nacional
+     * @return string|null
      */
     public function getOrgao($normalize = false)
     {
@@ -175,6 +176,7 @@ 
      * eventos será 1, nos casos em que possa existir mais de um evento, como é
      * o caso da carta de correção, o autor do evento deve numerar de forma
      * seqüencial.
+     * @return string|null
      */
     public function getSequencia($normalize = false)
     {
@@ -192,6 +194,7 @@ 
 
     /**
      * Descrição do Evento
+     * @return string|null
      */
     public function getDescricao($normalize = false)
     {
@@ -211,6 +214,7 @@ 
      * Número do Protocolo de Status da NF-e. 1 posição (1 – Secretaria de
      * Fazenda Estadual 2 – Receita Federal); 2 posições ano; 10 seqüencial no
      * ano.
+     * @return string|null
      */
     public function getNumero($normalize = false)
     {
@@ -228,6 +232,7 @@ 
 
     /**
      * Justificativa do cancelamento
+     * @return string|null
      */
     public function getJustificativa($normalize = false)
     {
@@ -422,6 +427,9 @@ 
         return $id;
     }
 
+    /**
+     * @param string $name
+     */
     public function getNode($name = null)
     {
         $this->setID($this->gerarID());
@@ -512,6 +520,9 @@ 
         return $element;
     }
 
+    /**
+     * @param string $name
+     */
     public function loadNode($element, $name = null)
     {
         $name = is_null($name)?'infEvento':$name;
@@ -661,6 +672,7 @@ 
 
     /**
      * Assina o XML com a assinatura eletrônica do tipo A1
+     * @param \DOMDocument $dom
      */
     public function assinar($dom = null)
     {

api/NFe/Task/Inutilizacao.php

Doc Comments +22 added lines

@@ -92,6 +92,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getCNPJ($normalize = false)
     {
         if (!$normalize) {
@@ -120,6 +123,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getSerie($normalize = false)
     {
         if (!$normalize) {
@@ -134,6 +140,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getInicio($normalize = false)
     {
         if (!$normalize) {
@@ -148,6 +157,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getFinal($normalize = false)
     {
         if (!$normalize) {
@@ -162,6 +174,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getJustificativa($normalize = false)
     {
         if (!$normalize) {
@@ -176,6 +191,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getNumero($normalize = false)
     {
         if (!$normalize) {
@@ -284,6 +302,9 @@ 
         return $id;
     }
 
+    /**
+     * @param string $name
+     */
     public function getNode($name = null)
     {
         $this->setID($this->gerarID());
@@ -423,6 +444,7 @@ 
 
     /**
      * Assina o XML com a assinatura eletrônica do tipo A1
+     * @param \DOMDocument $dom
      */
     public function assinar($dom = null)
     {

api/NFe/Task/Protocolo.php

Doc Comments +6 added lines

@@ -49,6 +49,7 @@ 
      * Chaves de acesso da NF-e, compostas por: UF do emitente, AAMM da emissão
      * da NFe, CNPJ do emitente, modelo, série e número da NF-e e código
      * numérico+DV.
+     * @return string|null
      */
     public function getChave($normalize = false)
     {
@@ -67,6 +68,7 @@ 
     /**
      * Digest Value da NF-e processada. Utilizado para conferir a integridade
      * da NF-e original.
+     * @return string|null
      */
     public function getValidacao($normalize = false)
     {
@@ -86,6 +88,7 @@ 
      * Número do Protocolo de Status da NF-e. 1 posição (1 – Secretaria de
      * Fazenda Estadual 2 – Receita Federal); 2 - códiga da UF - 2 posições
      * ano; 10 seqüencial no ano.
+     * @return string|null
      */
     public function getNumero($normalize = false)
     {
@@ -136,6 +139,9 @@ 
         return $this;
     }
 
+    /**
+     * @param string $name
+     */
     public function loadNode($element, $name = null)
     {
         $name = is_null($name)?'infProt':$name;

api/NFe/Task/Recibo.php

Doc Comments +2 added lines

@@ -48,6 +48,7 @@ 
 
     /**
      * Número do Recibo
+     * @return string|null
      */
     public function getNumero($normalize = false)
     {
@@ -269,6 +270,7 @@ 
 
     /**
      * Valida o documento após assinar
+     * @param \DOMDocument $dom
      */
     public function validar($dom)
     {

api/NFe/Task/Situacao.php

Doc Comments +2 added lines

@@ -45,6 +45,7 @@ 
      * Chaves de acesso da NF-e, compostas por: UF do emitente, AAMM da emissão
      * da NFe, CNPJ do emitente, modelo, série e número da NF-e e código
      * numérico+DV.
+     * @return string|null
      */
     public function getChave($normalize = false)
     {
@@ -171,6 +172,7 @@ 
 
     /**
      * Valida o documento após assinar
+     * @param \DOMDocument $dom
      */
     public function validar($dom)
     {

api/NFe/Task/Status.php

Doc Comments +2 added lines

@@ -84,6 +84,7 @@ 
 
     /**
      * Versão do Aplicativo que processou a NF-e
+     * @return string|null
      */
     public function getVersao($normalize = false)
     {
@@ -118,6 +119,7 @@ 
 
     /**
      * Descrição literal do status do serviço solicitado.
+     * @return string|null
      */
     public function getMotivo($normalize = false)
     {

api/util/Curl/Curl.php

Doc Comments +11 added lines, -11 removed lines

@@ -222,7 +222,7 @@ 
      * Progress
      *
      * @access public
-     * @param  $callback
+     * @param  \Closure $callback
      */
     public function progress($callback)
     {
@@ -438,7 +438,7 @@ 
      * Get Info
      *
      * @access public
-     * @param  $opt
+     * @param  integer $opt
      *
      * @return mixed
      */
@@ -458,7 +458,7 @@ 
      * Get Opt
      *
      * @access public
-     * @param  $option
+     * @param  integer $option
      *
      * @return mixed
      */
@@ -794,7 +794,7 @@ 
      * Set Connect Timeout
      *
      * @access public
-     * @param  $seconds
+     * @param  integer $seconds
      */
     public function setConnectTimeout($seconds)
     {
@@ -981,7 +981,7 @@ 
      * Set XML Decoder
      *
      * @access public
-     * @param  $function
+     * @param  \Closure $function
      */
     public function setXmlDecoder($function)
     {
@@ -1087,7 +1087,7 @@ 
      * Set User Agent
      *
      * @access public
-     * @param  $user_agent
+     * @param  string $user_agent
      */
     public function setUserAgent($user_agent)
     {
@@ -1130,7 +1130,7 @@ 
      * Using `curl -H "Host:" ...' is equivalent to $curl->removeHeader('Host');.
      *
      * @access public
-     * @param  $key
+     * @param  string $key
      */
     public function removeHeader($key)
     {
@@ -1263,7 +1263,7 @@ 
      * @access private
      * @param  $raw_headers
      *
-     * @return array
+     * @return CaseInsensitiveArray
      */
     private function parseRequestHeaders($raw_headers)
     {
@@ -1280,7 +1280,7 @@ 
      * Parse Response
      *
      * @access private
-     * @param  $response_headers
+     * @param  CaseInsensitiveArray $response_headers
      * @param  $raw_response
      *
      * @return mixed
@@ -1317,9 +1317,9 @@ 
      * Parse Response Headers
      *
      * @access private
-     * @param  $raw_response_headers
+     * @param  string $raw_response_headers
      *
-     * @return array
+     * @return CaseInsensitiveArray
      */
     private function parseResponseHeaders($raw_response_headers)
     {

api/util/Curl/MultiCurl.php

Doc Comments +13 added lines, -13 removed lines

@@ -46,7 +46,7 @@ 
      * @param  $query_parameters
      * @param  $data
      *
-     * @return object
+     * @return Curl
      */
     public function addDelete($url, $query_parameters = array(), $data = array())
     {
@@ -70,7 +70,7 @@ 
      * @param  $url
      * @param  $mixed_filename
      *
-     * @return object
+     * @return Curl
      */
     public function addDownload($url, $mixed_filename)
     {
@@ -104,7 +104,7 @@ 
      * @param  $url
      * @param  $data
      *
-     * @return object
+     * @return Curl
      */
     public function addGet($url, $data = array())
     {
@@ -127,7 +127,7 @@ 
      * @param  $url
      * @param  $data
      *
-     * @return object
+     * @return Curl
      */
     public function addHead($url, $data = array())
     {
@@ -150,7 +150,7 @@ 
      * @param  $url
      * @param  $data
      *
-     * @return object
+     * @return Curl
      */
     public function addOptions($url, $data = array())
     {
@@ -173,7 +173,7 @@ 
      * @param  $url
      * @param  $data
      *
-     * @return object
+     * @return Curl
      */
     public function addPatch($url, $data = array())
     {
@@ -200,7 +200,7 @@ 
      *     If true, will cause 303 redirections to be followed using GET requests (default: false).
      *     Note: Redirections are only followed if the CURLOPT_FOLLOWLOCATION option is set to true.
      *
-     * @return object
+     * @return Curl
      */
     public function addPost($url, $data = array(), $follow_303_with_post = false)
     {
@@ -239,7 +239,7 @@ 
      * @param  $url
      * @param  $data
      *
-     * @return object
+     * @return Curl
      */
     public function addPut($url, $data = array())
     {
@@ -266,7 +266,7 @@ 
      * @param  $url
      * @param  $data
      *
-     * @return object
+     * @return Curl
      */
     public function addSearch($url, $data = array())
     {
@@ -294,7 +294,7 @@ 
      * @access public
      * @param  $curl
      *
-     * @return object
+     * @return Curl
      */
     public function addCurl(Curl $curl)
     {
@@ -441,7 +441,7 @@ 
      * @access public
      * @param  $string
      *
-     * @return bool
+     * @return boolean|null
      */
     public function setCookieString($string)
     {
@@ -477,7 +477,7 @@ 
      *
      * @access public
      * @param  $key
-     * @param  $value
+     * @param  string $value
      */
     public function setHeader($key, $value)
     {
@@ -733,7 +733,7 @@ 
      * Queue Handle
      *
      * @access private
-     * @param  $curl
+     * @param  Curl $curl
      */
     private function queueHandle($curl)
     {