PHP Класс Eduardokum\LaravelBoleto\Cnab\Remessa\AbstractRemessa

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

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

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