PHP Class Eduardokum\LaravelBoleto\Boleto\Banco\Bb

Inheritance: extends Eduardokum\LaravelBoleto\Boleto\AbstractBoleto, implements Eduardokum\LaravelBoleto\Boleto\Contracts\Banco\Bb
Show file Open project: eduardokum/laravel-boleto

Protected Properties

Property Type Description
$carteiras array Define as carteiras disponíveis para este banco
$codigoBanco string Código do banco
$convenio string Define o número do convênio (4, 6 ou 7 caracteres)
$especiesCodigo string Espécie do documento, coódigo para remessa
$variacao_carteira string Defgine o numero da variação da carteira.

Public Methods

Method Description
getConvenio ( ) : string Retorna o número do convênio
getNossoNumeroBoleto ( ) : string Método que retorna o nosso numero usado no boleto. alguns bancos possuem algumas diferenças.
getVariacaoCarteira ( ) : string Retorna o número da variacao de carteira
isValid ( ) Método que valida se o banco tem todos os campos obrigadotorios preenchidos
setConvenio ( string $convenio ) : BancoDoBrasil Define o número do convênio. Sempre use string pois a quantidade de caracteres é validada.
setVariacaoCarteira ( string $variacao_carteira ) : BancoDoBrasil Define o número da variação da carteira, para saber quando utilizar o nosso numero de 17 posições.

Protected Methods

Method Description
gerarNossoNumero ( ) : string Gera o Nosso Número.
getCampoLivre ( ) : string Método para gerar o código da posição de 20 a 44

Method Details

gerarNossoNumero() protected method

Gera o Nosso Número.
protected gerarNossoNumero ( ) : string
return string

getCampoLivre() protected method

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

getConvenio() public method

Retorna o número do convênio
public getConvenio ( ) : string
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

getVariacaoCarteira() public method

Retorna o número da variacao de carteira
public getVariacaoCarteira ( ) : string
return string

isValid() public method

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

setConvenio() public method

Define o número do convênio. Sempre use string pois a quantidade de caracteres é validada.
public setConvenio ( string $convenio ) : BancoDoBrasil
$convenio string
return BancoDoBrasil

setVariacaoCarteira() public method

Define o número da variação da carteira, para saber quando utilizar o nosso numero de 17 posições.
public setVariacaoCarteira ( string $variacao_carteira ) : BancoDoBrasil
$variacao_carteira string
return BancoDoBrasil

Property Details

$carteiras protected property

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

$codigoBanco protected property

Código do banco
protected string $codigoBanco
return string

$convenio protected property

Define o número do convênio (4, 6 ou 7 caracteres)
protected string $convenio
return string

$especiesCodigo protected property

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

$variacao_carteira protected property

Defgine o numero da variação da carteira.
protected string $variacao_carteira
return string