PHP 클래스 Eduardokum\LaravelBoleto\Cnab\Remessa\AbstractRemessa

파일 보기 프로젝트 열기: eduardokum/laravel-boleto 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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.

공개 메소드들

메소드 설명
__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

보호된 메소드들

메소드 설명
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.

비공개 메소드들

메소드 설명
valida ( array $a ) : string Valida se a linha esta correta.

메소드 상세

__construct() 공개 메소드

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

add() 보호된 메소드

Função para add valor a linha nas posições informadas.
protected add ( $i, $f, $value ) : array
$i
$f
$value
리턴 array

add() 보호된 메소드

Função para add valor a linha nas posições informadas.
protected add ( integer $i, integer $f, $value ) : array
$i integer
$f integer
$value
리턴 array

addBoleto() 추상적인 공개 메소드

Função para adicionar detalhe ao arquivo.
abstract public addBoleto ( Eduardokum\LaravelBoleto\Contracts\Boleto\Boleto $detalhe ) : mixed
$detalhe Eduardokum\LaravelBoleto\Contracts\Boleto\Boleto
리턴 mixed

addBoletos() 공개 메소드

Função para adicionar multiplos boletos.
public addBoletos ( array $boletos )
$boletos array

gerar() 공개 메소드

Gera o arquivo, retorna a string.
public gerar ( ) : string
리턴 string

getAgencia() 공개 메소드

Retorna a agência
public getAgencia ( ) : integer
리턴 integer

getAgenciaDv() 공개 메소드

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

getBeneficiario() 공개 메소드

public getBeneficiario ( ) : Eduardokum\LaravelBoleto\Contracts\Pessoa
리턴 Eduardokum\LaravelBoleto\Contracts\Pessoa

getCarteira() 공개 메소드

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

getCarteiraNumero() 공개 메소드

Retorna o código da carteira (Com ou sem registro)
public getCarteiraNumero ( ) : string
리턴 string

getCarteiras() 공개 메소드

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

getCodigoBanco() 공개 메소드

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

getConta() 공개 메소드

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

getContaDv() 공개 메소드

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

getCount() 보호된 메소드

Função que mostra a quantidade de linhas do arquivo.
protected getCount ( ) : integer
리턴 integer

getDetalhes() 보호된 메소드

Retorna os detalhes do arquivo
protected getDetalhes ( ) : Collection
리턴 Illuminate\Support\Collection

getHeader() 보호된 메소드

Retorna o header do arquivo.
protected getHeader ( ) : mixed
리턴 mixed

getIdremessa() 공개 메소드

public getIdremessa ( ) : mixed
리턴 mixed

getTrailer() 보호된 메소드

Retorna o trailer do arquivo.
protected getTrailer ( ) : mixed
리턴 mixed

header() 추상적인 보호된 메소드

Função para gerar o cabeçalho do arquivo.
abstract protected header ( ) : mixed
리턴 mixed

iniciaDetalhe() 보호된 메소드

Inicia uma nova linha de detalhe e marca com a atual de edição
protected iniciaDetalhe ( )

iniciaHeader() 보호된 메소드

Inicia a edição do header
protected iniciaHeader ( )

iniciaTrailer() 보호된 메소드

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

isValid() 공개 메소드

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

save() 공개 메소드

Salva o arquivo no path informado
public save ( $path ) : mixed
$path
리턴 mixed

setAgencia() 공개 메소드

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

setAgencia() 공개 메소드

Define a agência
public setAgencia ( integer $agencia ) : AbstractRemessa
$agencia integer
리턴 AbstractRemessa

setAgenciaDv() 공개 메소드

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

setAgenciaDv() 공개 메소드

Define o dígito da agência
public setAgenciaDv ( string | integer $agenciaDv ) : AbstractRemessa
$agenciaDv string | integer
리턴 AbstractRemessa

setBeneficiario() 공개 메소드

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

setBeneficiario() 공개 메소드

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

setCarteira() 공개 메소드

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

setCarteira() 공개 메소드

Define o código da carteira (Com ou sem registro)
public setCarteira ( string $carteira ) : AbstractRemessa
$carteira string
리턴 AbstractRemessa

setConta() 공개 메소드

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

setConta() 공개 메소드

Define o número da conta
public setConta ( integer $conta ) : AbstractRemessa
$conta integer
리턴 AbstractRemessa

setContaDv() 공개 메소드

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

setContaDv() 공개 메소드

Define o dígito verificador da conta
public setContaDv ( integer $contaDv ) : AbstractRemessa
$contaDv integer
리턴 AbstractRemessa

setIdremessa() 공개 메소드

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

setIdremessa() 공개 메소드

public setIdremessa ( mixed $idremessa ) : AbstractRemessa
$idremessa mixed
리턴 AbstractRemessa

trailer() 추상적인 보호된 메소드

Função que gera o trailer (footer) do arquivo.
abstract protected trailer ( ) : mixed
리턴 mixed

프로퍼티 상세

$agencia 보호되어 있는 프로퍼티

Agência
protected int $agencia
리턴 integer

$agenciaDv 보호되어 있는 프로퍼티

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

$beneficiario 보호되어 있는 프로퍼티

Entidade beneficiario (quem esta gerando a remessa)
protected Pessoa,Eduardokum\LaravelBoleto\Contracts $beneficiario
리턴 Eduardokum\LaravelBoleto\Contracts\Pessoa

$carteira 보호되어 있는 프로퍼티

Carteira de cobrança.
protected $carteira

$carteiras 보호되어 있는 프로퍼티

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

$codigoBanco 보호되어 있는 프로퍼티

Código do banco
protected string $codigoBanco
리턴 string

$conta 보호되어 있는 프로퍼티

Conta
protected int $conta
리턴 integer

$contaDv 보호되어 있는 프로퍼티

Dígito da conta
protected int $contaDv
리턴 integer

$fimArquivo 보호되어 있는 프로퍼티

Caracter de fim de arquivo
protected null $fimArquivo
리턴 null

$fimLinha 보호되어 있는 프로퍼티

Caracter de fim de linha
protected string $fimLinha
리턴 string

$iRegistros 보호되어 있는 프로퍼티

Contagem dos registros Detalhes
protected int $iRegistros
리턴 integer

$idremessa 보호되어 있는 프로퍼티

ID do arquivo remessa, sequencial.
protected $idremessa