PHP Class Eduardokum\LaravelBoleto\Boleto\Banco\Sicredi

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

Protected Properties

Property Type Description
$byte integer Byte que compoe o nosso número.
$carteiras array Define as carteiras disponíveis para este banco
$codigoBanco string Código do banco
$especiesCodigo string Espécie do documento, coódigo para remessa
$localPagamento string Local de pagamento
$posto integer Código do posto do cliente no banco.
$registro boolean Se possui registro o boleto (tipo = 1 com registro e 3 sem registro)

Public Methods

Method Description
getAgenciaCodigoBeneficiario ( ) : string Retorna o campo Agência/Beneficiário do boleto
getByte ( ) : integer Retorna o byte
getNossoNumeroBoleto ( ) : string Método que retorna o nosso numero usado no boleto. alguns bancos possuem algumas diferenças.
getPosto ( ) : integer Retorna o posto do cliente
isComRegistro ( ) : boolean Retorna se é com registro.
isValid ( ) Método que valida se o banco tem todos os campos obrigadotorios preenchidos
setByte ( integer $byte ) Define o byte
setComRegistro ( boolean $registro ) Define se possui ou não registro
setPosto ( integer $posto ) Define o posto do cliente

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

getAgenciaCodigoBeneficiario() public method

Retorna o campo Agência/Beneficiário do boleto

getByte() public method

Retorna o byte
public getByte ( ) : integer
return integer

getCampoLivre() protected method

Método para gerar o código da posição de 20 a 44
protected getCampoLivre ( ) : 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

getPosto() public method

Retorna o posto do cliente
public getPosto ( ) : integer
return integer

isComRegistro() public method

Retorna se é com registro.
public isComRegistro ( ) : boolean
return boolean

isValid() public method

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

setByte() public method

Define o byte
public setByte ( integer $byte )
$byte integer

setComRegistro() public method

Define se possui ou não registro
public setComRegistro ( boolean $registro )
$registro boolean

setPosto() public method

Define o posto do cliente
public setPosto ( integer $posto )
$posto integer

Property Details

$byte protected property

Byte que compoe o nosso número.
protected int $byte
return integer

$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

$especiesCodigo protected property

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

$localPagamento protected property

Local de pagamento
protected string $localPagamento
return string

$posto protected property

Código do posto do cliente no banco.
protected int $posto
return integer

$registro protected property

Se possui registro o boleto (tipo = 1 com registro e 3 sem registro)
protected bool $registro
return boolean