• Главная
• Eduardokum
• LaravelBoleto
• Boleto
• AbstractBoleto

PHP Класс Eduardokum\LaravelBoleto\Boleto\AbstractBoleto

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$variaveis_adicionais	array	Variáveis adicionais.

Защищенные свойства (Protected)

Свойство	Тип	Описание
$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

Открытые методы

Метод	Описание
__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.

Защищенные методы

Метод	Описание
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

Описание методов

Описание свойств