mazinsw / nfe-api

api/NFe/Common/CurlSoap.php

Doc Comments +3 added lines

@@ -109,6 +109,9 @@
         return $this->response->getElementsByTagName('Body')->item(0);
     }
 
+    /**
+     * @param \DOMDocument $body
+     */
     public function send($url, $body, $header = '', $action = null)
     {
         $this->setOpt(CURLOPT_SSLCERT, $this->getCertificate());

api/NFe/Common/Evento.php

Doc Comments +16 added lines

@@ -35,21 +35,25 @@ 
 
     /**
      * Chamado quando o XML da nota foi gerado
+     * @return void
      */
     public function onNotaGerada($nota, $xml);
 
     /**
      * Chamado após o XML da nota ser assinado
+     * @return void
      */
     public function onNotaAssinada($nota, $xml);
 
     /**
      * Chamado após o XML da nota ser validado com sucesso
+     * @return void
      */
     public function onNotaValidada($nota, $xml);
 
     /**
      * Chamado antes de enviar a nota para a SEFAZ
+     * @return void
      */
     public function onNotaEnviando($nota, $xml);
 
@@ -57,29 +61,34 @@ 
      * Chamado quando a forma de emissão da nota fiscal muda para contigência,
      * aqui deve ser decidido se o número da nota deverá ser pulado e se esse
      * número deve ser cancelado ou inutilizado
+     * @return void
      */
     public function onNotaContingencia($nota, $offline, $exception);
 
     /**
      * Chamado quando a nota foi enviada e aceita pela SEFAZ
+     * @return void
      */
     public function onNotaAutorizada($nota, $xml, $retorno);
 
     /**
      * Chamado quando a emissão da nota foi concluída com sucesso independente
      * da forma de emissão
+     * @return void
      */
     public function onNotaCompleto($nota, $xml);
 
     /**
      * Chamado quando uma nota é rejeitada pela SEFAZ, a nota deve ser
      * corrigida para depois ser enviada novamente
+     * @return void
      */
     public function onNotaRejeitada($nota, $xml, $retorno);
 
     /**
      * Chamado quando a nota é denegada e não pode ser utilizada (outra nota
      * deve ser gerada)
+     * @return void
      */
     public function onNotaDenegada($nota, $xml, $retorno);
 
@@ -87,37 +96,44 @@ 
      * Chamado após tentar enviar uma nota e não ter certeza se ela foi
      * recebida ou não (problemas técnicos), deverá ser feito uma consulta pela
      * chave para obter o estado da nota
+     * @return void
      */
     public function onNotaPendente($nota, $xml, $exception);
 
     /**
      * Chamado quando uma nota é enviada, mas não retornou o protocolo que será
      * consultado mais tarde
+     * @return void
      */
     public function onNotaProcessando($nota, $xml, $retorno);
 
     /**
      * Chamado quando uma nota autorizada é cancelada na SEFAZ
+     * @return void
      */
     public function onNotaCancelada($nota, $xml, $retorno);
 
     /**
      * Chamado quando ocorre um erro nas etapas de geração e envio da nota
+     * @return void
      */
     public function onNotaErro($nota, $exception);
 
     /**
      * Chamado quando um ou mais números de notas forem inutilizados
+     * @return void
      */
     public function onInutilizado($inutilizacao, $xml);
 
     /**
      * Chamado quando uma tarefa é executada
+     * @return void
      */
     public function onTarefaExecutada($tarefa, $retorno);
 
     /**
      * Chamado quando ocorre uma falha na execução de uma tarefa
+     * @return void
      */
     public function onTarefaErro($tarefa, $exception);
 }

api/NFe/Core/Nota.php

Doc Comments +19 added lines

@@ -157,6 +157,9 @@ 
         $this->fromArray($nota);
     }
 
+    /**
+     * @return string
+     */
     public function getID($normalize = false)
     {
         if (!$normalize) {
@@ -173,6 +176,7 @@ 
 
     /**
      * Número do Documento Fiscal
+     * @return string|null
      */
     public function getNumero($normalize = false)
     {
@@ -297,6 +301,7 @@ 
 
     /**
      * Informar a Justificativa da entrada em contingência
+     * @return string|null
      */
     public function getJustificativa($normalize = false)
     {
@@ -314,6 +319,7 @@ 
 
     /**
      * Código do modelo do Documento Fiscal. 55 = NF-e; 65 = NFC-e.
+     * @return string|null
      */
     public function getModelo($normalize = false)
     {
@@ -345,6 +351,7 @@ 
 
     /**
      * Tipo do Documento Fiscal (0 - entrada; 1 - saída)
+     * @return string|null
      */
     public function getTipo($normalize = false)
     {
@@ -377,6 +384,7 @@ 
     /**
      * Identificador de Local de destino da operação
      * (1-Interna;2-Interestadual;3-Exterior)
+     * @return string|null
      */
     public function getDestino($normalize = false)
     {
@@ -413,6 +421,7 @@ 
 
     /**
      * Descrição da Natureza da Operação
+     * @return string|null
      */
     public function getNatureza($normalize = false)
     {
@@ -431,6 +440,7 @@ 
     /**
      * Código numérico que compõe a Chave de Acesso. Número aleatório gerado
      * pelo emitente para cada NF-e.
+     * @return string|null
      */
     public function getCodigo($normalize = false)
     {
@@ -449,6 +459,7 @@ 
     /**
      * Indicador da forma de pagamento: 0 – pagamento à vista; 1 – pagamento à
      * prazo; 2 – outros.
+     * @return string|null
      */
     public function getIndicador($normalize = false)
     {
@@ -506,6 +517,7 @@ 
     /**
      * Série do Documento Fiscal: série normal 0-889, Avulsa Fisco 890-899,
      * SCAN 900-999
+     * @return string|null
      */
     public function getSerie($normalize = false)
     {
@@ -525,6 +537,7 @@ 
      * Formato de impressão do DANFE (0-sem DANFE;1-DANFe Retrato; 2-DANFe
      * Paisagem;3-DANFe Simplificado;4-DANFe NFC-e;5-DANFe NFC-e em mensagem
      * eletrônica)
+     * @return string|null
      */
     public function getFormato($normalize = false)
     {
@@ -576,6 +589,7 @@ 
 
     /**
      * Forma de emissão da NF-e
+     * @return string|null
      */
     public function getEmissao($normalize = false)
     {
@@ -607,6 +621,7 @@ 
 
     /**
      * Digito Verificador da Chave de Acesso da NF-e
+     * @return string|null
      */
     public function getDigitoVerificador($normalize = false)
     {
@@ -624,6 +639,7 @@ 
 
     /**
      * Identificação do Ambiente: 1 - Produção, 2 - Homologação
+     * @return string|null
      */
     public function getAmbiente($normalize = false)
     {
@@ -656,6 +672,7 @@ 
     /**
      * Finalidade da emissão da NF-e: 1 - NFe normal, 2 - NFe complementar, 3 -
      * NFe de ajuste, 4 - Devolução/Retorno
+     * @return string|null
      */
     public function getFinalidade($normalize = false)
     {
@@ -697,6 +714,7 @@ 
 
     /**
      * Indica operação com consumidor final (0-Não;1-Consumidor Final)
+     * @return string|null
      */
     public function getConsumidorFinal($normalize = false)
     {
@@ -735,6 +753,7 @@ 
      * de ajuste;1-Operação presencial;2-Não presencial, internet;3-Não
      * presencial, teleatendimento;4-NFC-e entrega em domicílio;9-Não
      * presencial, outros)
+     * @return string|null
      */
     public function getPresenca($normalize = false)
     {

api/NFe/Database/IBPT.php

Doc Comments +6 added lines

@@ -60,6 +60,9 @@ 
         return $data;
     }
 
+    /**
+     * @param string $uf
+     */
     private function getImpostoOffline($ncm, $uf, $ex)
     {
         $data = $this->load($uf);
@@ -76,6 +79,9 @@ 
         return $o;
     }
 
+    /**
+     * @param string $uf
+     */
     private function getImpostoOnline($cnpj, $token, $ncm, $uf, $ex)
     {
         if ($this->offline) {

api/NFe/Entity/Destinatario.php

Doc Comments +5 added lines

@@ -80,6 +80,7 @@ 
 
     /**
      * CPF do cliente
+     * @return string|null
      */
     public function getCPF($normalize = false)
     {
@@ -119,6 +120,7 @@ 
      * vista;
      * 2 – Contribuinte isento de inscrição;
      * 9 – Não Contribuinte
+     * @return string|null
      */
     public function getIndicador($normalize = false)
     {
@@ -213,6 +215,9 @@ 
         return $element;
     }
 
+    /**
+     * @param string $name
+     */
     public function loadNode($element, $name = null)
     {
         $name = is_null($name)?'dest':$name;

api/NFe/Entity/Emitente.php

Doc Comments +4 added lines

@@ -71,6 +71,7 @@ 
      * Código de Regime Tributário. Este campo será obrigatoriamente preenchido
      * com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite
      * de receita bruta; 3 – Regime Normal.
+     * @return string|null
      */
     public function getRegime($normalize = false)
     {
@@ -149,6 +150,9 @@ 
         return $element;
     }
 
+    /**
+     * @param string $name
+     */
     public function loadNode($element, $name = null)
     {
         $name = is_null($name)?'emit':$name;

api/NFe/Entity/Endereco.php

Doc Comments +15 added lines

@@ -59,6 +59,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getCEP($normalize = false)
     {
         if (!$normalize) {
@@ -84,6 +87,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getBairro($normalize = false)
     {
         if (!$normalize) {
@@ -98,6 +104,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getLogradouro($normalize = false)
     {
         if (!$normalize) {
@@ -112,6 +121,9 @@ 
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
     public function getNumero($normalize = false)
     {
         if (!$normalize) {
@@ -252,6 +264,9 @@ 
         return $element;
     }
 
+    /**
+     * @param string $name
+     */
     public function loadNode($element, $name = null)
     {
         $name = is_null($name)?'enderEmit':$name;

api/NFe/Entity/Imposto.php

Doc Comments +2 added lines

@@ -153,6 +153,7 @@ 
 
     /**
      * Código da situação tributária
+     * @return string|null
      */
     public function getTributacao($normalize = false)
     {
@@ -170,6 +171,7 @@ 
 
     /**
      * Porcentagem do imposto
+     * @return string|null
      */
     public function getAliquota($normalize = false)
     {

api/NFe/Entity/Imposto/COFINS/Generico.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
         $this->setTributacao('99');
     }
 
+    /**
+     * @return string|null
+     */
     public function getValor($normalize = false)
     {
         if (!$normalize) {