PHP Class Eduardokum\LaravelBoleto\Boleto\Pessoa

Inheritance: implements Eduardokum\LaravelBoleto\Contracts\Pessoa
Show file Open project: eduardokum/laravel-boleto

Protected Properties

Property Type Description
$bairro string
$cep string
$cidade string
$documento string
$endereco string
$nome string
$uf string

Public Methods

Method Description
__construct ( array $params = [] ) Construtor
create ( $nome, $documento, null $endereco = null, $bairro = null, null $cep = null, null $cidade = null, null $uf = null ) : Pessoa Cria a pessoa passando os parametros.
getBairro ( ) : string Retorna o bairro
getCep ( ) : string Retorna o CEP
getCepCidadeUf ( ) : string Retorna o endereço formatado para a linha 2 de endereço
getCidade ( ) : string Retorna a cidade
getDocumento ( ) : string Retorna o documento (CPF ou CNPJ)
getEndereco ( ) : string Retorna o endereço
getNome ( ) : string Retorna o nome
getNomeDocumento ( ) : string Retorna o nome e o documento formatados
getTipoDocumento ( ) : string Retorna se o tipo do documento é CPF ou CNPJ ou Documento
getUf ( ) : string Retorna a UF
setBairro ( string $bairro ) Define o bairro
setCep ( string $cep ) Define o CEP
setCidade ( string $cidade ) Define a cidade
setDocumento ( string $documento ) Define o documento (CPF ou CNPJ)
setEndereco ( string $endereco ) Define o endereço
setNome ( string $nome ) Define o nome
setUf ( string $uf ) Define a UF

Method Details

__construct() public method

Construtor
public __construct ( array $params = [] )
$params array

create() public static method

Cria a pessoa passando os parametros.
public static create ( $nome, $documento, null $endereco = null, $bairro = null, null $cep = null, null $cidade = null, null $uf = null ) : Pessoa
$nome
$documento
$endereco null
$cep null
$cidade null
$uf null
return Pessoa

getBairro() public method

Retorna o bairro
public getBairro ( ) : string
return string

getCep() public method

Retorna o CEP
public getCep ( ) : string
return string

getCepCidadeUf() public method

Ex: 71000-000 - Brasília - DF
public getCepCidadeUf ( ) : string
return string

getCidade() public method

Retorna a cidade
public getCidade ( ) : string
return string

getDocumento() public method

Retorna o documento (CPF ou CNPJ)
public getDocumento ( ) : string
return string

getEndereco() public method

Retorna o endereço
public getEndereco ( ) : string
return string

getNome() public method

Retorna o nome
public getNome ( ) : string
return string

getNomeDocumento() public method

Retorna o nome e o documento formatados
public getNomeDocumento ( ) : string
return string

getTipoDocumento() public method

Retorna se o tipo do documento é CPF ou CNPJ ou Documento
public getTipoDocumento ( ) : string
return string

getUf() public method

Retorna a UF
public getUf ( ) : string
return string

setBairro() public method

Define o bairro
public setBairro ( string $bairro )
$bairro string

setCep() public method

Define o CEP
public setCep ( string $cep )
$cep string

setCidade() public method

Define a cidade
public setCidade ( string $cidade )
$cidade string

setDocumento() public method

Define o documento (CPF ou CNPJ)
public setDocumento ( string $documento )
$documento string

setEndereco() public method

Define o endereço
public setEndereco ( string $endereco )
$endereco string

setNome() public method

Define o nome
public setNome ( string $nome )
$nome string

setUf() public method

Define a UF
public setUf ( string $uf )
$uf string

Property Details

$bairro protected property

protected string $bairro
return string

$cep protected property

protected string $cep
return string

$cidade protected property

protected string $cidade
return string

$documento protected property

protected string $documento
return string

$endereco protected property

protected string $endereco
return string

$nome protected property

protected string $nome
return string

$uf protected property

protected string $uf
return string