PHP Class Eduardokum\LaravelBoleto\Boleto\AbstractBoleto

Inheritance: implements Eduardokum\LaravelBoleto\Contracts\Boleto\Boleto
Exibir arquivo Open project: eduardokum/laravel-boleto Class Usage Examples

Public Properties

Property Type Description
$variaveis_adicionais array Variáveis adicionais.

Protected Properties

Property Type Description
$aceite string Campo de aceite
$agencia integer Agência
$agencia string Agência
$agenciaDv string Dígito da agência
$agenciaDv string | integer Dígito da agência
$beneficiario Eduardokum\LaravelBoleto\Contracts\Pessoa Entidade beneficiario (quem emite o boleto)
$campoCodigoBarras string Cache do codigo de barras para evitar processamento desnecessário.
$campoLinhaDigitavel string Cache da linha digitabel para evitar processamento desnecessário.
$campoLivre string Cache do campo livre para evitar processamento desnecessário.
$campoNossoNumero string Cache do nosso numero para evitar processamento desnecessário.
$carteira integer Modalidade de cobrança do cliente, geralmente Cobrança Simples ou Registrada
$carteira string Modalidade de cobrança do cliente, geralmente Cobrança Simples ou Registrada
$carteiras array Define as carteiras disponíveis para cada banco
$carteirasNomes array Define as carteiras disponíveis para cada banco
$codigoBanco string Código do banco
$conta integer Conta
$conta string Conta
$contaDv integer Dígito da conta
$contaDv string Dígito da conta
$dataDocumento Carbon\Carbon Data do documento
$dataProcessamento Carbon\Carbon Data de emissão
$dataVencimento Carbon\Carbon Data de vencimento
$descontosAbatimentos float Valor de descontos e abatimentos
$descricaoDemonstrativo array Array com as linhas do demonstrativo (descrição do pagamento)
$diasProtesto float Dias para protesto
$especieDoc string Espécie do documento, geralmente DM (Duplicata Mercantil)
$especiesCodigo string Espécie do documento, coódigo para remessa
$instrucoes array Array com as linhas de instruções
$juros float Valor para mora juros
$jurosApos float Dias apos vencimento do juros
$jurosApos integer Dias apos vencimento do juros
$localPagamento string Linha de local de pagamento
$logo string Localização do logotipo do banco, referente ao diretório de imagens
$moeda integer Moeda
$multa float Valor para multa
$numero integer Define o número definido pelo cliente para compor o Nosso Número
$numeroDocumento integer Número do documento
$outrasDeducoes float Valor para outras deduções
$outrosAcrescimos float Valor para outros acréscimos
$pagador Eduardokum\LaravelBoleto\Contracts\Pessoa Entidade pagadora (de quem se cobra o boleto)
$quantidade Campo quantidade
$sacadorAvalista Eduardokum\LaravelBoleto\Contracts\Pessoa Entidade sacador avalista
$status integer Status do boleto, se vai criar alterar ou baixa no banco.
$usoBanco string Campo de uso do banco no boleto
$valor float Valor total do boleto
$valorCobrado Valor cobrado
$valorUnitario Campo valor do boleto

Public Methods

Method Description
__construct ( array $params = [] ) Construtor
addDescricaoDemonstrativo ( string $descricaoDemonstrativo ) : AbstractBoleto Adiciona um demonstrativo (máximo 5)
addInstrucao ( string $instrucao ) : AbstractBoleto Adiciona uma instrução (máximo 5)
alterarBoleto ( ) : AbstractBoleto Marca o boleto para ser alterado no banco
baixarBoleto ( ) : AbstractBoleto Marca o boleto para ser baixado no banco
getAceite ( ) : string Retorna o campo aceite
getAgencia ( ) : integer Retorna a agência
getAgencia ( ) : string Retorna a agência
getAgenciaCodigoBeneficiario ( ) : string Retorna o campo Agência/Beneficiário do boleto
getAgenciaDv ( ) : string Retorna o dígito da agência
getAgenciaDv ( ) : string | integer Retorna o dígito da agência
getBeneficiario ( ) : Eduardokum\LaravelBoleto\Contracts\Pessoa Retorna a entidade beneficiario
getCarteira ( ) : string Retorna o código da carteira (Com ou sem registro)
getCarteiraNome ( ) : string Retorna o nome da carteira para impressão no boleto
getCarteiras ( ) : array Retorna as carteiras disponíveis para este banco
getCip ( ) : integer Retorna o número cip para o bradesco
getCodigoBanco ( ) : string Retorna o código do banco
getCodigoBancoComDv ( ) : string Retorna o código do banco com o dígito verificador
getCodigoBarras ( ) : string Retorna o codigo de barras
getConta ( ) : integer Retorna o número da conta
getConta ( ) : string Retorna o número da conta
getContaDv ( ) : integer Retorna o dígito verificador da conta
getContaDv ( ) : string Retorna o dígito verificador da conta
getDataDocumento ( ) : Carbon\Carbon Retorna a data do documento
getDataProcessamento ( ) : Carbon\Carbon Retorna a data de geração do boleto
getDataVencimento ( ) : Carbon\Carbon Retorna a data de vencimento
getDescontosAbatimentos ( ) : float Retorna o campo Descontos / Abatimentos
getDescontosAbatimentos ( ) : string Retorna o campo Descontos / Abatimentos
getDescricaoDemonstrativo ( ) : array Retorna um array com a descrição do demonstrativo (máximo 5)
getDiasProtesto ( ) : double Retorna os diasProtesto
getDiasProtesto ( boolean $default = false ) : float Retorna os diasProtesto
getEspecieDoc ( ) : string Retorna o campo Espécie Doc, geralmente DM (Duplicata Mercantil)
getEspecieDocCodigo ( ) : string Retorna o codigo da Espécie Doc
getEspecieDocCodigo ( $default = 99 ) : string Retorna o codigo da Espécie Doc
getInstrucoes ( ) : array Retorna um array com instruções (máximo 8) para pagamento
getJuros ( ) : float Retorna % juros
getJurosApos ( boolean $default = false ) : float Retorna a quantidade de dias apos o vencimento que cobrar a juros
getJurosApos ( ) : integer Retorna a quantidade de dias apos o vencimento que cobrar a juros
getLinhaDigitavel ( ) : string Retorna a linha digitável do boleto
getLocalPagamento ( ) : string Retorna o local de pagamento do boleto
getLogo ( ) : string Retorna a localização do logotipo
getLogoBanco ( ) : string Retorna a localização do logotipo do banco relativo à pasta de imagens
getLogoBancoBase64 ( ) : string Retorna o logotipo do banco em Base64, pronto para ser inserido na página
getLogoBase64 ( ) : string Retorna o logotipo em Base64, pronto para ser inserido na página
getMoeda ( ) : integer Retorna a moeda utilizada pelo boleto
getMulta ( ) : float Retorna % de multa
getNossoNumero ( boolean $incluirFormatacao = true ) : string Retorna o Nosso Número calculado.
getNossoNumeroBoleto ( ) : string Método que retorna o nosso numero usado no boleto. alguns bancos possuem algumas diferenças.
getNumero ( ) : integer Retorna o número definido pelo cliente para compor o nosso número
getNumeroDocumento ( ) : integer Retorna o campo Número do documento
getOutrasDeducoes ( ) : float Retorna o campo outras deduções do boleto
getOutrosAcrescimos ( ) : float Retorna o campo outros acréscimos do boleto
getPagador ( ) : Eduardokum\LaravelBoleto\Contracts\Pessoa Retorna o objeto do pagador
getQuantidade ( ) : integer Retorna o campo quantidade do boleto
getSacadorAvalista ( ) : Eduardokum\LaravelBoleto\Contracts\Pessoa Retorna o objeto sacador avalista do boleto
getStatus ( ) : integer
getUsoBanco ( ) : string Retorna o campo Uso do banco
getValor ( ) : float Retorna o valor total do boleto (incluindo taxas)
getValor ( ) : string Retorna o valor total do boleto (incluindo taxas)
getValorCobrado ( ) : float Retorna o campo valor cobrado do boleto
getValorCobrado ( ) : string Retorna o campo valor cobrado do boleto
getValorUnitario ( ) : float Retorna o campo "valor" do boleto
getValorUnitario ( ) : string Retorna o campo "valor" do boleto
isValid ( ) : boolean Método que valida se o banco tem todos os campos obrigadotorios preenchidos
renderHTML ( ) : string Render HTML
renderHTML ( boolean $print = false ) : string Render HTML
renderPDF ( boolean $print = false ) : string Render PDF
setAceite ( string $aceite ) : AbstractBoleto Define o campo aceite
setAgencia ( integer $agencia ) : AbstractBoleto Define a agência
setAgencia ( string $agencia ) : AbstractBoleto Define a agência
setAgenciaDv ( string $agenciaDv ) : AbstractBoleto Define o dígito da agência
setAgenciaDv ( string | integer $agenciaDv ) : AbstractBoleto Define o dígito da agência
setBeneficiario ( Eduardokum\LaravelBoleto\Contracts\Pessoa $beneficiario ) : AbstractBoleto Define a entidade beneficiario
setCarteira ( string $carteira ) : AbstractBoleto Define o código da carteira (Com ou sem registro)
setConta ( integer $conta ) : AbstractBoleto Define o número da conta
setConta ( string $conta ) : AbstractBoleto Define o número da conta
setContaDv ( integer $contaDv ) : AbstractBoleto Define o dígito verificador da conta
setContaDv ( string $contaDv ) : AbstractBoleto Define o dígito verificador da conta
setDataDocumento ( Carbon\Carbon $dataDocumento ) : AbstractBoleto Define a data do documento
setDataProcessamento ( Carbon\Carbon $dataProcessamento ) : AbstractBoleto Define a data de geração do boleto
setDataVencimento ( Carbon\Carbon $dataVencimento ) : AbstractBoleto Define a data de vencimento
setDescontosAbatimentos ( float $descontosAbatimentos ) : AbstractBoleto Define o campo Descontos / Abatimentos
setDescricaoDemonstrativo ( array $descricaoDemonstrativo ) : AbstractBoleto Define um array com a descrição do demonstrativo (máximo 5)
setDiasProtesto ( float $diasProtesto ) : AbstractBoleto Seta dias para protesto
setDiasProtesto ( integer $diasProtesto ) : AbstractBoleto Seta dias para protesto
setEspecieDoc ( string $especieDoc ) : AbstractBoleto Define o campo Espécie Doc, geralmente DM (Duplicata Mercantil)
setInstrucoes ( array $instrucoes ) : AbstractBoleto Define um array com instruções (máximo 8) para pagamento
setJuros ( float $juros ) : AbstractBoleto Seta a % de juros
setJurosApos ( float $jurosApos ) : AbstractBoleto Seta a quantidade de dias apos o vencimento que cobra o juros
setJurosApos ( integer $jurosApos ) : AbstractBoleto Seta a quantidade de dias apos o vencimento que cobra o juros
setLocalPagamento ( string $localPagamento ) : AbstractBoleto Define o local de pagamento do boleto
setLogo ( string $logo ) : AbstractBoleto Define a localização do logotipo
setMoeda ( integer $moeda ) : AbstractBoleto Define a moeda utilizada pelo boleto
setMulta ( float $multa ) : AbstractBoleto Seta a % de multa
setNossoNumero ( ) Mostra exception ao erroneamente tentar setar o nosso número
setNumero ( integer $numero ) : AbstractBoleto Define o número definido pelo cliente para compor o nosso número
setNumeroDocumento ( integer $numeroDocumento ) : AbstractBoleto Define o campo Número do documento
setOutrasDeducoes ( float $outrasDeducoes ) : AbstractBoleto Define o campo outras deduções do boleto
setOutrosAcrescimos ( float $outrosAcrescimos ) : AbstractBoleto Define o campo outros acréscimos do boleto
setPagador ( Eduardokum\LaravelBoleto\Contracts\Pessoa $pagador ) : AbstractBoleto Define o objeto do pagador
setQuantidade ( $quantidade ) : AbstractBoleto Define o campo quantidade do boleto
setSacadorAvalista ( Eduardokum\LaravelBoleto\Contracts\Pessoa $sacadorAvalista ) : AbstractBoleto Define o objeto sacador avalista do boleto
setUsoBanco ( string $usoBanco ) : AbstractBoleto Define o campo Uso do banco
setValor ( float $valor ) : AbstractBoleto Define o valor total do boleto (incluindo taxas)
setValor ( string $valor ) : AbstractBoleto Define o valor total do boleto (incluindo taxas)
setValorCobrado ( $valorCobrado ) : AbstractBoleto Define o campo valor cobrado do boleto
setValorUnitario ( $valorUnitario ) : AbstractBoleto Define o campo "valor" do boleto
toArray ( ) : array Return Boleto Array.

Protected Methods

Method Description
gerarNossoNumero ( ) : string Método onde o Boleto deverá gerar o Nosso Número.
getCampoLivre ( ) : string Método onde qualquer boleto deve extender para gerar o código da posição de 20 a 44

Method Details

__construct() public method

Construtor
public __construct ( array $params = [] )
$params array Parâmetros iniciais para construção do objeto

addDescricaoDemonstrativo() public method

Adiciona um demonstrativo (máximo 5)
public addDescricaoDemonstrativo ( string $descricaoDemonstrativo ) : AbstractBoleto
$descricaoDemonstrativo string
return AbstractBoleto

addInstrucao() public method

Adiciona uma instrução (máximo 5)
public addInstrucao ( string $instrucao ) : AbstractBoleto
$instrucao string
return AbstractBoleto

alterarBoleto() public method

Marca o boleto para ser alterado no banco
public alterarBoleto ( ) : AbstractBoleto
return AbstractBoleto

baixarBoleto() public method

Marca o boleto para ser baixado no banco
public baixarBoleto ( ) : AbstractBoleto
return AbstractBoleto

gerarNossoNumero() abstract protected method

Método onde o Boleto deverá gerar o Nosso Número.
abstract protected gerarNossoNumero ( ) : string
return string

getAceite() public method

Retorna o campo aceite
public getAceite ( ) : string
return string

getAgencia() public method

Retorna a agência
public getAgencia ( ) : integer
return integer

getAgencia() public method

Retorna a agência
public getAgencia ( ) : string
return string

getAgenciaCodigoBeneficiario() public method

Retorna o campo Agência/Beneficiário do boleto
public getAgenciaCodigoBeneficiario ( ) : string
return string

getAgenciaDv() public method

Retorna o dígito da agência
public getAgenciaDv ( ) : string
return string

getAgenciaDv() public method

Retorna o dígito da agência
public getAgenciaDv ( ) : string | integer
return string | integer

getBeneficiario() public method

Retorna a entidade beneficiario
public getBeneficiario ( ) : Eduardokum\LaravelBoleto\Contracts\Pessoa
return Eduardokum\LaravelBoleto\Contracts\Pessoa

getCampoLivre() abstract protected method

Método onde qualquer boleto deve extender para gerar o código da posição de 20 a 44
abstract protected getCampoLivre ( ) : string
return string

getCarteira() public method

Retorna o código da carteira (Com ou sem registro)
public getCarteira ( ) : string
return string

getCarteiraNome() public method

Caso o nome da carteira a ser impresso no boleto seja diferente do número Então crie uma variável na classe do banco correspondente $carteirasNomes sendo uma array cujos índices sejam os números das carteiras e os valores seus respectivos nomes
public getCarteiraNome ( ) : string
return string

getCarteiras() public method

Retorna as carteiras disponíveis para este banco
public getCarteiras ( ) : array
return array

getCip() public method

Retorna o número cip para o bradesco
public getCip ( ) : integer
return integer

getCodigoBanco() public method

Retorna o código do banco
public getCodigoBanco ( ) : string
return string

getCodigoBancoComDv() public method

Retorna o código do banco com o dígito verificador
public getCodigoBancoComDv ( ) : string
return string

getCodigoBarras() public method

Retorna o codigo de barras
public getCodigoBarras ( ) : string
return string

getConta() public method

Retorna o número da conta
public getConta ( ) : integer
return integer

getConta() public method

Retorna o número da conta
public getConta ( ) : string
return string

getContaDv() public method

Retorna o dígito verificador da conta
public getContaDv ( ) : integer
return integer

getContaDv() public method

Retorna o dígito verificador da conta
public getContaDv ( ) : string
return string

getDataDocumento() public method

Retorna a data do documento
public getDataDocumento ( ) : Carbon\Carbon
return Carbon\Carbon

getDataProcessamento() public method

Retorna a data de geração do boleto
public getDataProcessamento ( ) : Carbon\Carbon
return Carbon\Carbon

getDataVencimento() public method

Retorna a data de vencimento
public getDataVencimento ( ) : Carbon\Carbon
return Carbon\Carbon

getDescontosAbatimentos() public method

Retorna o campo Descontos / Abatimentos
public getDescontosAbatimentos ( ) : float
return float

getDescontosAbatimentos() public method

Retorna o campo Descontos / Abatimentos
public getDescontosAbatimentos ( ) : string
return string

getDescricaoDemonstrativo() public method

Retorna um array com a descrição do demonstrativo (máximo 5)
public getDescricaoDemonstrativo ( ) : array
return array

getDiasProtesto() public method

Retorna os diasProtesto
public getDiasProtesto ( ) : double
return double

getDiasProtesto() public method

Retorna os diasProtesto
public getDiasProtesto ( boolean $default = false ) : float
$default boolean
return float

getEspecieDoc() public method

Retorna o campo Espécie Doc, geralmente DM (Duplicata Mercantil)
public getEspecieDoc ( ) : string
return string

getEspecieDocCodigo() public method

Retorna o codigo da Espécie Doc
public getEspecieDocCodigo ( ) : string
return string

getEspecieDocCodigo() public method

Retorna o codigo da Espécie Doc
public getEspecieDocCodigo ( $default = 99 ) : string
return string

getInstrucoes() public method

Retorna um array com instruções (máximo 8) para pagamento
public getInstrucoes ( ) : array
return array

getJuros() public method

Retorna % juros
public getJuros ( ) : float
return float

getJurosApos() public method

Retorna a quantidade de dias apos o vencimento que cobrar a juros
public getJurosApos ( boolean $default = false ) : float
$default boolean
return float

getJurosApos() public method

Retorna a quantidade de dias apos o vencimento que cobrar a juros
public getJurosApos ( ) : integer
return integer

getLinhaDigitavel() public method

Retorna a linha digitável do boleto
public getLinhaDigitavel ( ) : string
return string

getLocalPagamento() public method

Retorna o local de pagamento do boleto
public getLocalPagamento ( ) : string
return string

getLogoBanco() public method

Retorna a localização do logotipo do banco relativo à pasta de imagens
public getLogoBanco ( ) : string
return string

getLogoBancoBase64() public method

Retorna o logotipo do banco em Base64, pronto para ser inserido na página
public getLogoBancoBase64 ( ) : string
return string

getLogoBase64() public method

Retorna o logotipo em Base64, pronto para ser inserido na página
public getLogoBase64 ( ) : string
return string

getMoeda() public method

Retorna a moeda utilizada pelo boleto
public getMoeda ( ) : integer
return integer

getMulta() public method

Retorna % de multa
public getMulta ( ) : float
return float

getNossoNumero() public method

Retorna o Nosso Número calculado.
public getNossoNumero ( boolean $incluirFormatacao = true ) : string
$incluirFormatacao boolean Incluir formatação ou não (pontuação, espaços e barras)
return string

getNossoNumeroBoleto() public method

Método que retorna o nosso numero usado no boleto. alguns bancos possuem algumas diferenças.
public getNossoNumeroBoleto ( ) : string
return string

getNumero() public method

Retorna o número definido pelo cliente para compor o nosso número
public getNumero ( ) : integer
return integer

getNumeroDocumento() public method

Retorna o campo Número do documento
public getNumeroDocumento ( ) : integer
return integer

getOutrasDeducoes() public method

Retorna o campo outras deduções do boleto
public getOutrasDeducoes ( ) : float
return float

getOutrosAcrescimos() public method

Retorna o campo outros acréscimos do boleto
public getOutrosAcrescimos ( ) : float
return float

getPagador() public method

Retorna o objeto do pagador
public getPagador ( ) : Eduardokum\LaravelBoleto\Contracts\Pessoa
return Eduardokum\LaravelBoleto\Contracts\Pessoa

getQuantidade() public method

Retorna o campo quantidade do boleto
public getQuantidade ( ) : integer
return integer

getSacadorAvalista() public method

Retorna o objeto sacador avalista do boleto
public getSacadorAvalista ( ) : Eduardokum\LaravelBoleto\Contracts\Pessoa
return Eduardokum\LaravelBoleto\Contracts\Pessoa

getStatus() public method

public getStatus ( ) : integer
return integer

getUsoBanco() public method

Retorna o campo Uso do banco
public getUsoBanco ( ) : string
return string

getValor() public method

Retorna o valor total do boleto (incluindo taxas)
public getValor ( ) : float
return float

getValor() public method

Retorna o valor total do boleto (incluindo taxas)
public getValor ( ) : string
return string

getValorCobrado() public method

Retorna o campo valor cobrado do boleto
public getValorCobrado ( ) : float
return float

getValorCobrado() public method

Retorna o campo valor cobrado do boleto
public getValorCobrado ( ) : string
return string

getValorUnitario() public method

Retorna o campo "valor" do boleto
public getValorUnitario ( ) : float
return float

getValorUnitario() public method

Retorna o campo "valor" do boleto
public getValorUnitario ( ) : string
return string

isValid() public method

Método que valida se o banco tem todos os campos obrigadotorios preenchidos
public isValid ( ) : boolean
return boolean

renderHTML() public method

Render HTML
public renderHTML ( ) : string
return string

renderHTML() public method

Render HTML
public renderHTML ( boolean $print = false ) : string
$print boolean
return string

renderPDF() public method

Render PDF
public renderPDF ( boolean $print = false ) : string
$print boolean
return string

setAceite() public method

Define o campo aceite
public setAceite ( string $aceite ) : AbstractBoleto
$aceite string
return AbstractBoleto

setAgencia() public method

Define a agência
public setAgencia ( integer $agencia ) : AbstractBoleto
$agencia integer
return AbstractBoleto

setAgencia() public method

Define a agência
public setAgencia ( string $agencia ) : AbstractBoleto
$agencia string
return AbstractBoleto

setAgenciaDv() public method

Define o dígito da agência
public setAgenciaDv ( string $agenciaDv ) : AbstractBoleto
$agenciaDv string
return AbstractBoleto

setAgenciaDv() public method

Define o dígito da agência
public setAgenciaDv ( string | integer $agenciaDv ) : AbstractBoleto
$agenciaDv string | integer
return AbstractBoleto

setBeneficiario() public method

Define a entidade beneficiario
public setBeneficiario ( Eduardokum\LaravelBoleto\Contracts\Pessoa $beneficiario ) : AbstractBoleto
$beneficiario Eduardokum\LaravelBoleto\Contracts\Pessoa
return AbstractBoleto

setCarteira() public method

Define o código da carteira (Com ou sem registro)
public setCarteira ( string $carteira ) : AbstractBoleto
$carteira string
return AbstractBoleto

setConta() public method

Define o número da conta
public setConta ( integer $conta ) : AbstractBoleto
$conta integer
return AbstractBoleto

setConta() public method

Define o número da conta
public setConta ( string $conta ) : AbstractBoleto
$conta string
return AbstractBoleto

setContaDv() public method

Define o dígito verificador da conta
public setContaDv ( integer $contaDv ) : AbstractBoleto
$contaDv integer
return AbstractBoleto

setContaDv() public method

Define o dígito verificador da conta
public setContaDv ( string $contaDv ) : AbstractBoleto
$contaDv string
return AbstractBoleto

setDataDocumento() public method

Define a data do documento
public setDataDocumento ( Carbon\Carbon $dataDocumento ) : AbstractBoleto
$dataDocumento Carbon\Carbon
return AbstractBoleto

setDataProcessamento() public method

Define a data de geração do boleto
public setDataProcessamento ( Carbon\Carbon $dataProcessamento ) : AbstractBoleto
$dataProcessamento Carbon\Carbon
return AbstractBoleto

setDataVencimento() public method

Define a data de vencimento
public setDataVencimento ( Carbon\Carbon $dataVencimento ) : AbstractBoleto
$dataVencimento Carbon\Carbon
return AbstractBoleto

setDescontosAbatimentos() public method

Define o campo Descontos / Abatimentos
public setDescontosAbatimentos ( float $descontosAbatimentos ) : AbstractBoleto
$descontosAbatimentos float
return AbstractBoleto

setDescricaoDemonstrativo() public method

Define um array com a descrição do demonstrativo (máximo 5)
public setDescricaoDemonstrativo ( array $descricaoDemonstrativo ) : AbstractBoleto
$descricaoDemonstrativo array
return AbstractBoleto

setDiasProtesto() public method

Seta dias para protesto
public setDiasProtesto ( float $diasProtesto ) : AbstractBoleto
$diasProtesto float
return AbstractBoleto

setDiasProtesto() public method

Seta dias para protesto
public setDiasProtesto ( integer $diasProtesto ) : AbstractBoleto
$diasProtesto integer
return AbstractBoleto

setEspecieDoc() public method

Define o campo Espécie Doc, geralmente DM (Duplicata Mercantil)
public setEspecieDoc ( string $especieDoc ) : AbstractBoleto
$especieDoc string
return AbstractBoleto

setInstrucoes() public method

Define um array com instruções (máximo 8) para pagamento
public setInstrucoes ( array $instrucoes ) : AbstractBoleto
$instrucoes array
return AbstractBoleto

setJuros() public method

Seta a % de juros
public setJuros ( float $juros ) : AbstractBoleto
$juros float
return AbstractBoleto

setJurosApos() public method

Seta a quantidade de dias apos o vencimento que cobra o juros
public setJurosApos ( float $jurosApos ) : AbstractBoleto
$jurosApos float
return AbstractBoleto

setJurosApos() public method

Seta a quantidade de dias apos o vencimento que cobra o juros
public setJurosApos ( integer $jurosApos ) : AbstractBoleto
$jurosApos integer
return AbstractBoleto

setLocalPagamento() public method

Define o local de pagamento do boleto
public setLocalPagamento ( string $localPagamento ) : AbstractBoleto
$localPagamento string
return AbstractBoleto

setMoeda() public method

Define a moeda utilizada pelo boleto
public setMoeda ( integer $moeda ) : AbstractBoleto
$moeda integer
return AbstractBoleto

setMulta() public method

Seta a % de multa
public setMulta ( float $multa ) : AbstractBoleto
$multa float
return AbstractBoleto

setNossoNumero() final public method

Mostra exception ao erroneamente tentar setar o nosso número
final public setNossoNumero ( )

setNumero() public method

Define o número definido pelo cliente para compor o nosso número
public setNumero ( integer $numero ) : AbstractBoleto
$numero integer
return AbstractBoleto

setNumeroDocumento() public method

Define o campo Número do documento
public setNumeroDocumento ( integer $numeroDocumento ) : AbstractBoleto
$numeroDocumento integer
return AbstractBoleto

setOutrasDeducoes() public method

Define o campo outras deduções do boleto
public setOutrasDeducoes ( float $outrasDeducoes ) : AbstractBoleto
$outrasDeducoes float
return AbstractBoleto

setOutrosAcrescimos() public method

Define o campo outros acréscimos do boleto
public setOutrosAcrescimos ( float $outrosAcrescimos ) : AbstractBoleto
$outrosAcrescimos float
return AbstractBoleto

setPagador() public method

Define o objeto do pagador
public setPagador ( Eduardokum\LaravelBoleto\Contracts\Pessoa $pagador ) : AbstractBoleto
$pagador Eduardokum\LaravelBoleto\Contracts\Pessoa
return AbstractBoleto

setQuantidade() public method

Define o campo quantidade do boleto
public setQuantidade ( $quantidade ) : AbstractBoleto
$quantidade
return AbstractBoleto

setSacadorAvalista() public method

Define o objeto sacador avalista do boleto
public setSacadorAvalista ( Eduardokum\LaravelBoleto\Contracts\Pessoa $sacadorAvalista ) : AbstractBoleto
$sacadorAvalista Eduardokum\LaravelBoleto\Contracts\Pessoa
return AbstractBoleto

setUsoBanco() public method

Define o campo Uso do banco
public setUsoBanco ( string $usoBanco ) : AbstractBoleto
$usoBanco string
return AbstractBoleto

setValor() public method

Define o valor total do boleto (incluindo taxas)
public setValor ( float $valor ) : AbstractBoleto
$valor float
return AbstractBoleto

setValor() public method

Define o valor total do boleto (incluindo taxas)
public setValor ( string $valor ) : AbstractBoleto
$valor string
return AbstractBoleto

setValorCobrado() public method

Define o campo valor cobrado do boleto
public setValorCobrado ( $valorCobrado ) : AbstractBoleto
$valorCobrado
return AbstractBoleto

setValorUnitario() public method

Define o campo "valor" do boleto
public setValorUnitario ( $valorUnitario ) : AbstractBoleto
$valorUnitario
return AbstractBoleto

toArray() public method

Return Boleto Array.
public toArray ( ) : array
return array

Property Details

$aceite protected_oe property

Campo de aceite
protected string $aceite
return string

$agencia protected_oe property

Agência
protected int $agencia
return integer

$agencia protected_oe property

Agência
protected string $agencia
return string

$agenciaDv protected_oe property

Dígito da agência
protected string $agenciaDv
return string

$agenciaDv protected_oe property

Dígito da agência
protected string|int $agenciaDv
return string | integer

$beneficiario protected_oe property

Entidade beneficiario (quem emite o boleto)
protected Pessoa,Eduardokum\LaravelBoleto\Contracts $beneficiario
return Eduardokum\LaravelBoleto\Contracts\Pessoa

$campoCodigoBarras protected_oe property

Cache do codigo de barras para evitar processamento desnecessário.
protected string $campoCodigoBarras
return string

$campoLinhaDigitavel protected_oe property

Cache da linha digitabel para evitar processamento desnecessário.
protected string $campoLinhaDigitavel
return string

$campoLivre protected_oe property

Cache do campo livre para evitar processamento desnecessário.
protected string $campoLivre
return string

$campoNossoNumero protected_oe property

Cache do nosso numero para evitar processamento desnecessário.
protected string $campoNossoNumero
return string

$carteira protected_oe property

Modalidade de cobrança do cliente, geralmente Cobrança Simples ou Registrada
protected int $carteira
return integer

$carteira protected_oe property

Modalidade de cobrança do cliente, geralmente Cobrança Simples ou Registrada
protected string $carteira
return string

$carteiras protected_oe property

Define as carteiras disponíveis para cada banco
protected array $carteiras
return array

$carteirasNomes protected_oe property

Define as carteiras disponíveis para cada banco
protected array $carteirasNomes
return array

$codigoBanco protected_oe property

Código do banco
protected string $codigoBanco
return string

$conta protected_oe property

Conta
protected int $conta
return integer

$conta protected_oe property

Conta
protected string $conta
return string

$contaDv protected_oe property

Dígito da conta
protected int $contaDv
return integer

$contaDv protected_oe property

Dígito da conta
protected string $contaDv
return string

$dataDocumento protected_oe property

Data do documento
protected Carbon,Carbon $dataDocumento
return Carbon\Carbon

$dataProcessamento protected_oe property

Data de emissão
protected Carbon,Carbon $dataProcessamento
return Carbon\Carbon

$dataVencimento protected_oe property

Data de vencimento
protected Carbon,Carbon $dataVencimento
return Carbon\Carbon

$descontosAbatimentos protected_oe property

Valor de descontos e abatimentos
protected float $descontosAbatimentos
return float

$descricaoDemonstrativo protected_oe property

Array com as linhas do demonstrativo (descrição do pagamento)
protected array $descricaoDemonstrativo
return array

$diasProtesto protected_oe property

Dias para protesto
protected float $diasProtesto
return float

$especieDoc protected_oe property

Espécie do documento, geralmente DM (Duplicata Mercantil)
protected string $especieDoc
return string

$especiesCodigo protected_oe property

Espécie do documento, coódigo para remessa
protected string $especiesCodigo
return string

$instrucoes protected_oe property

Array com as linhas de instruções
protected array $instrucoes
return array

$juros protected_oe property

Valor para mora juros
protected float $juros
return float

$jurosApos protected_oe property

Dias apos vencimento do juros
protected float $jurosApos
return float

$jurosApos protected_oe property

Dias apos vencimento do juros
protected int $jurosApos
return integer

$localPagamento protected_oe property

Linha de local de pagamento
protected string $localPagamento
return string

$moeda protected_oe property

Moeda
protected int $moeda
return integer

$multa protected_oe property

Valor para multa
protected float $multa
return float

$numero protected_oe property

Define o número definido pelo cliente para compor o Nosso Número
protected int $numero
return integer

$numeroDocumento protected_oe property

Número do documento
protected int $numeroDocumento
return integer

$outrasDeducoes protected_oe property

Valor para outras deduções
protected float $outrasDeducoes
return float

$outrosAcrescimos protected_oe property

Valor para outros acréscimos
protected float $outrosAcrescimos
return float

$pagador protected_oe property

Entidade pagadora (de quem se cobra o boleto)
protected Pessoa,Eduardokum\LaravelBoleto\Contracts $pagador
return Eduardokum\LaravelBoleto\Contracts\Pessoa

$quantidade protected_oe property

Campo quantidade
protected $quantidade

$sacadorAvalista protected_oe property

Entidade sacador avalista
protected Pessoa,Eduardokum\LaravelBoleto\Contracts $sacadorAvalista
return Eduardokum\LaravelBoleto\Contracts\Pessoa

$status protected_oe property

Status do boleto, se vai criar alterar ou baixa no banco.
protected int $status
return integer

$usoBanco protected_oe property

Campo de uso do banco no boleto
protected string $usoBanco
return string

$valor protected_oe property

Valor total do boleto
protected float $valor
return float

$valorCobrado protected_oe property

Valor cobrado
protected $valorCobrado

$valorUnitario protected_oe property

Campo valor do boleto
protected $valorUnitario

$variaveis_adicionais public_oe property

Variáveis adicionais.
public array $variaveis_adicionais
return array