PHP Class Eduardokum\LaravelBoleto\Cnab\Remessa\AbstractRemessa

Show file Open project: eduardokum/laravel-boleto Class Usage Examples

Protected Properties

Property	Type	Description
$agencia	integer	Agência
$agenciaDv	string \| integer	Dígito da agência
$beneficiario	Eduardokum\LaravelBoleto\Contracts\Pessoa	Entidade beneficiario (quem esta gerando a remessa)
$carteira		Carteira de cobrança.
$carteiras	array	Define as carteiras disponíveis para cada banco
$codigoBanco	string	Código do banco
$conta	integer	Conta
$contaDv	integer	Dígito da conta
$fimArquivo	null	Caracter de fim de arquivo
$fimLinha	string	Caracter de fim de linha
$iRegistros	integer	Contagem dos registros Detalhes
$idremessa		ID do arquivo remessa, sequencial.

Public Methods

Method	Description
__construct ( array $params = [] )	Construtor
addBoleto ( Eduardokum\LaravelBoleto\Contracts\Boleto\Boleto $detalhe ) : mixed	Função para adicionar detalhe ao arquivo.
addBoletos ( array $boletos )	Função para adicionar multiplos boletos.
gerar ( ) : string	Gera o arquivo, retorna a string.
getAgencia ( ) : integer	Retorna a agência
getAgenciaDv ( ) : string \| integer	Retorna o dígito da agência
getBeneficiario ( ) : Eduardokum\LaravelBoleto\Contracts\Pessoa
getCarteira ( ) : string	Retorna o código da carteira (Com ou sem registro)
getCarteiraNumero ( ) : string	Retorna o código da carteira (Com ou sem registro)
getCarteiras ( ) : array	Retorna as carteiras disponíveis para este banco
getCodigoBanco ( ) : string	Retorna o código do banco
getConta ( ) : integer	Retorna o número da conta
getContaDv ( ) : integer	Retorna o dígito verificador da conta
getIdremessa ( ) : mixed
isValid ( ) : boolean	Método que valida se o banco tem todos os campos obrigadotorios preenchidos
save ( $path ) : mixed	Salva o arquivo no path informado
setAgencia ( integer $agencia ) : AbstractBoleto	Define a agência
setAgencia ( integer $agencia ) : AbstractRemessa	Define a agência
setAgenciaDv ( string \| integer $agenciaDv ) : AbstractBoleto	Define o dígito da agência
setAgenciaDv ( string \| integer $agenciaDv ) : AbstractRemessa	Define o dígito da agência
setBeneficiario ( Eduardokum\LaravelBoleto\Contracts\Pessoa $beneficiario ) : Eduardokum\LaravelBoleto\Cnab\Remessa\AbstractCnab
setBeneficiario ( Eduardokum\LaravelBoleto\Contracts\Pessoa $beneficiario ) : AbstractRemessa
setCarteira ( string $carteira ) : AbstractBoleto	Define o código da carteira (Com ou sem registro)
setCarteira ( string $carteira ) : AbstractRemessa	Define o código da carteira (Com ou sem registro)
setConta ( integer $conta ) : AbstractBoleto	Define o número da conta
setConta ( integer $conta ) : AbstractRemessa	Define o número da conta
setContaDv ( integer $contaDv ) : AbstractBoleto	Define o dígito verificador da conta
setContaDv ( integer $contaDv ) : AbstractRemessa	Define o dígito verificador da conta
setIdremessa ( mixed $idremessa ) : Eduardokum\LaravelBoleto\Cnab\Remessa\AbstractCnab
setIdremessa ( mixed $idremessa ) : AbstractRemessa

Protected Methods

Method	Description
add ( $i, $f, $value ) : array	Função para add valor a linha nas posições informadas.
add ( integer $i, integer $f, $value ) : array	Função para add valor a linha nas posições informadas.
getCount ( ) : integer	Função que mostra a quantidade de linhas do arquivo.
getDetalhes ( ) : Collection	Retorna os detalhes do arquivo
getHeader ( ) : mixed	Retorna o header do arquivo.
getTrailer ( ) : mixed	Retorna o trailer do arquivo.
header ( ) : mixed	Função para gerar o cabeçalho do arquivo.
iniciaDetalhe ( )	Inicia uma nova linha de detalhe e marca com a atual de edição
iniciaHeader ( )	Inicia a edição do header
iniciaTrailer ( )	Inicia a edição do trailer (footer).
trailer ( ) : mixed	Função que gera o trailer (footer) do arquivo.

Private Methods

Method	Description
valida ( array $a ) : string	Valida se a linha esta correta.

Method Details

__construct() public method

Construtor

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

add() protected method

Função para add valor a linha nas posições informadas.

protected add ( $i, $f, $value ) : array
$i
$f
$value
return	array

add() protected method

Função para add valor a linha nas posições informadas.

protected add ( integer $i, integer $f, $value ) : array
$i	integer
$f	integer
$value
return	array

addBoleto() abstract public method

Função para adicionar detalhe ao arquivo.

abstract public addBoleto ( Eduardokum\LaravelBoleto\Contracts\Boleto\Boleto $detalhe ) : mixed
$detalhe	Eduardokum\LaravelBoleto\Contracts\Boleto\Boleto
return	mixed

addBoletos() public method

Função para adicionar multiplos boletos.

public addBoletos ( array $boletos )
$boletos	array

gerar() public method

Gera o arquivo, retorna a string.

public gerar ( ) : string
return	string

getAgencia() public method

Retorna a agência

public getAgencia ( ) : integer
return	integer

getAgenciaDv() public method

Retorna o dígito da agência

public getAgenciaDv ( ) : string \| integer
return	string \| integer

getBeneficiario() public method

public getBeneficiario ( ) : Eduardokum\LaravelBoleto\Contracts\Pessoa
return	Eduardokum\LaravelBoleto\Contracts\Pessoa

getCarteira() public method

Retorna o código da carteira (Com ou sem registro)

public getCarteira ( ) : string
return	string

getCarteiraNumero() public method

Retorna o código da carteira (Com ou sem registro)

public getCarteiraNumero ( ) : string
return	string

getCarteiras() public method

Retorna as carteiras disponíveis para este banco

public getCarteiras ( ) : array
return	array

getCodigoBanco() public method

Retorna o código do banco

public getCodigoBanco ( ) : string
return	string

getConta() public method

Retorna o número da conta

public getConta ( ) : integer
return	integer

getContaDv() public method

Retorna o dígito verificador da conta

public getContaDv ( ) : integer
return	integer

getCount() protected method

Função que mostra a quantidade de linhas do arquivo.

protected getCount ( ) : integer
return	integer

getDetalhes() protected method

Retorna os detalhes do arquivo

protected getDetalhes ( ) : Collection
return	Illuminate\Support\Collection

getHeader() protected method

Retorna o header do arquivo.

protected getHeader ( ) : mixed
return	mixed

getIdremessa() public method

public getIdremessa ( ) : mixed
return	mixed

getTrailer() protected method

Retorna o trailer do arquivo.

protected getTrailer ( ) : mixed
return	mixed

header() abstract protected method

Função para gerar o cabeçalho do arquivo.

abstract protected header ( ) : mixed
return	mixed

iniciaDetalhe() protected method

Inicia uma nova linha de detalhe e marca com a atual de edição

protected iniciaDetalhe ( )

iniciaHeader() protected method

Inicia a edição do header

protected iniciaHeader ( )

iniciaTrailer() protected method

Inicia a edição do trailer (footer).

protected iniciaTrailer ( )

isValid() public method

Método que valida se o banco tem todos os campos obrigadotorios preenchidos

public isValid ( ) : boolean
return	boolean

save() public method

Salva o arquivo no path informado

public save ( $path ) : mixed
$path
return	mixed

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 ( integer $agencia ) : AbstractRemessa
$agencia	integer
return	AbstractRemessa

setAgenciaDv() public method

Define o dígito da agência

public setAgenciaDv ( string \| integer $agenciaDv ) : AbstractBoleto
$agenciaDv	string \| integer
return	AbstractBoleto

setAgenciaDv() public method

Define o dígito da agência

public setAgenciaDv ( string \| integer $agenciaDv ) : AbstractRemessa
$agenciaDv	string \| integer
return	AbstractRemessa

setBeneficiario() public method

public setBeneficiario ( Eduardokum\LaravelBoleto\Contracts\Pessoa $beneficiario ) : Eduardokum\LaravelBoleto\Cnab\Remessa\AbstractCnab
$beneficiario	Eduardokum\LaravelBoleto\Contracts\Pessoa
return	Eduardokum\LaravelBoleto\Cnab\Remessa\AbstractCnab

setBeneficiario() public method

public setBeneficiario ( Eduardokum\LaravelBoleto\Contracts\Pessoa $beneficiario ) : AbstractRemessa
$beneficiario	Eduardokum\LaravelBoleto\Contracts\Pessoa
return	AbstractRemessa

setCarteira() public method

Define o código da carteira (Com ou sem registro)

public setCarteira ( string $carteira ) : AbstractBoleto
$carteira	string
return	AbstractBoleto

setCarteira() public method

Define o código da carteira (Com ou sem registro)

public setCarteira ( string $carteira ) : AbstractRemessa
$carteira	string
return	AbstractRemessa

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 ( integer $conta ) : AbstractRemessa
$conta	integer
return	AbstractRemessa

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 ( integer $contaDv ) : AbstractRemessa
$contaDv	integer
return	AbstractRemessa

setIdremessa() public method

public setIdremessa ( mixed $idremessa ) : Eduardokum\LaravelBoleto\Cnab\Remessa\AbstractCnab
$idremessa	mixed
return	Eduardokum\LaravelBoleto\Cnab\Remessa\AbstractCnab

setIdremessa() public method

public setIdremessa ( mixed $idremessa ) : AbstractRemessa
$idremessa	mixed
return	AbstractRemessa

trailer() abstract protected method

Função que gera o trailer (footer) do arquivo.

abstract protected trailer ( ) : mixed
return	mixed

Property Details

$agencia protected property

Agência

protected int $agencia
return	integer

$agenciaDv protected property

Dígito da agência

protected string\|int $agenciaDv
return	string \| integer

$beneficiario protected property

Entidade beneficiario (quem esta gerando a remessa)

protected Pessoa,Eduardokum\LaravelBoleto\Contracts $beneficiario
return	Eduardokum\LaravelBoleto\Contracts\Pessoa

$carteira protected property

Carteira de cobrança.

protected $carteira

$carteiras protected property

Define as carteiras disponíveis para cada banco

protected array $carteiras
return	array

$codigoBanco protected property

Código do banco

protected string $codigoBanco
return	string

$conta protected property

Conta

protected int $conta
return	integer

$contaDv protected property

Dígito da conta

protected int $contaDv
return	integer

$fimArquivo protected property

Caracter de fim de arquivo

protected null $fimArquivo
return	null

$fimLinha protected property

Caracter de fim de linha

protected string $fimLinha
return	string

$iRegistros protected property

Contagem dos registros Detalhes

protected int $iRegistros
return	integer

$idremessa protected property

ID do arquivo remessa, sequencial.

protected $idremessa