Documentation

PessoaBancoEntity extends Entity
in package

Application

Constants

auditlog = []: Allowed keys: 'exclude_fields': <...> 'object_rel': <...>
const_values = []
database = \config\Config::DB_DEFAULT
db_table = 'pessoa_bancos'
pk_field = 'idEntidadeBanco'
sanitize = ['CpfCnpj' => 'onlyNumber']: Estrutura = ['key' => 'rule']
security = ['update' => 'src\models\PessoaBancoSecurity::securityUpdate', 'delete' => 'src\models\PessoaBancoSecurity::securityDelete']: Allowed keys: 'select': <...> 'update': <...> 'delete': <...> 'insert': <...>
tracking = true
validations = ['CpfCnpj' => ['cpfCnpj' => 'O CPF/CNPJ da conta bancária/PIX não é válido.']]: Estrutura = ['key' => ['keyRule' => 'Rule message']]

Properties

$agencia : mixed
$chavePix : mixed
$contacorrente : mixed
$CpfCnpj : mixed
$digitoAgencia : mixed
$digitoConta : mixed
$idBanco : mixed
$idEntidade : mixed
$idEntidadeBanco : mixed
$nomeconta : mixed
$padrao : mixed
$tipoConta : mixed
$tipoPIX : mixed
$variacao : mixed

Methods

__construct() : mixed
delete() : mixed
delete_where() : mixed
getAgencia() : mixed: Get the value of agencia
getAuditlog() : mixed
getChavePix() : mixed: Get the value of chavePix
getConst() : mixed
getConstObj() : mixed
getContacorrente() : mixed: Get the value of contacorrente
getCpfCnpj() : mixed: Get the value of CpfCnpj
getDatabase() : mixed
getDBDriver() : mixed
getDBTable() : mixed
getDigitoAgencia() : mixed: Get the value of digitoAgencia
getDigitoConta() : mixed: Get the value of digitoConta
getIdBanco() : mixed: Get the value of idBanco
getIdEntidade() : mixed: Get the value of idEntidade
getIdEntidadeBanco() : mixed: Get the value of idEntidadeBanco
getNomeconta() : mixed: Get the value of nomeconta
getPadrao() : mixed: Get the value of padrao
getTable() : mixed
getTipoConta() : mixed: Get the value of tipoConta
getTipoPIX() : mixed: Get the value of tipoPIX
getVariacao() : mixed: Get the value of variacao
hasField() : mixed
insert() : null|Entity
insert_or_select() : null|Entity: Funcao que insere ou seleciona se existe
insert_or_update() : array<string|int, mixed>: Funcao que insere ou atualiza uma entidade no banco de dados
securityDelete() : bool
securityInsert() : bool
securitySelect() : array<string|int, mixed>
securityUpdate() : bool
setAgencia() : self: Set the value of agencia
setChavePix() : self: Set the value of chavePix
setContacorrente() : self: Set the value of contacorrente
setCpfCnpj() : self: Set the value of CpfCnpj
setDigitoAgencia() : self: Set the value of digitoAgencia
setDigitoConta() : self: Set the value of digitoConta
setIdBanco() : self: Set the value of idBanco
setIdEntidade() : self: Set the value of idEntidade
setIdEntidadeBanco() : self: Set the value of idEntidadeBanco
setNomeconta() : self: Set the value of nomeconta
setPadrao() : self: Set the value of padrao
setTipoConta() : self: Set the value of tipoConta
setTipoPIX() : self: Set the value of tipoPIX
setVariacao() : self: Set the value of variacao
update() : mixed: A função update pode atualizar uma Entity já instanciada, desde que a chave primária esteja setada, ou pode atualizar uma Entity vazia informando o valor da chave primária no segundo parâmetro (pk_value)
validateFields() : bool
where() : Collection: Rudimentary ORM functions

auditlog

Allowed keys: 'exclude_fields': <...> 'object_rel': <...>


    public
        mixed
    auditlog
    = []

const_values


    public
        mixed
    const_values
    = []

database


    public
        mixed
    database
    = \config\Config::DB_DEFAULT

db_table


    public
        mixed
    db_table
    = 'pessoa_bancos'

pk_field


    public
        mixed
    pk_field
    = 'idEntidadeBanco'

sanitize

Estrutura = ['key' => 'rule']


    public
        mixed
    sanitize
    = ['CpfCnpj' => 'onlyNumber']

security

Allowed keys: 'select': <...> 'update': <...> 'delete': <...> 'insert': <...>


    public
        mixed
    security
    = ['update' => 'src\models\PessoaBancoSecurity::securityUpdate', 'delete' => 'src\models\PessoaBancoSecurity::securityDelete']

tracking


    public
        mixed
    tracking
    = true

validations

Estrutura = ['key' => ['keyRule' => 'Rule message']]


    public
        mixed
    validations
    = ['CpfCnpj' => ['cpfCnpj' => 'O CPF/CNPJ da conta bancária/PIX não é válido.']]

$agencia


        private
            mixed
    $agencia

$chavePix


        private
            mixed
    $chavePix

$contacorrente


        private
            mixed
    $contacorrente

$CpfCnpj


        private
            mixed
    $CpfCnpj

$digitoAgencia


        private
            mixed
    $digitoAgencia

$digitoConta


        private
            mixed
    $digitoConta

$idBanco


        private
            mixed
    $idBanco

$idEntidade


        private
            mixed
    $idEntidade

$idEntidadeBanco


        private
            mixed
    $idEntidadeBanco

$nomeconta


        private
            mixed
    $nomeconta

$padrao


        private
            mixed
    $padrao

$tipoConta


        private
            mixed
    $tipoConta

$tipoPIX


        private
            mixed
    $tipoPIX

$variacao


        private
            mixed
    $variacao

__construct()


    public
                    __construct([array<string|int, mixed> $values = [] ]) : mixed

Parameters

$values : array<string|int, mixed> = []

delete()


    public
                    delete(mixed $motivo) : mixed

Parameters

$motivo : mixed

delete_where()


    public
            static        delete_where(mixed $motivo[, mixed $where = [] ]) : mixed

Parameters

$motivo : mixed
$where : mixed = []

getAgencia()

Get the value of agencia


    public
                    getAgencia() : mixed

getAuditlog()


    public
                    getAuditlog([string|null $key = null ]) : mixed

Parameters

$key : string|null = null

getChavePix()

Get the value of chavePix


    public
                    getChavePix() : mixed

getConst()


    public
            static        getConst(string $field[, mixed $const_value = null ]) : mixed

Parameters

$field : string
$const_value : mixed = null

getConstObj()


    public
            static        getConstObj(string $field[, mixed $const_value = null ]) : mixed

Parameters

$field : string
$const_value : mixed = null

getContacorrente()

Get the value of contacorrente


    public
                    getContacorrente() : mixed

getCpfCnpj()

Get the value of CpfCnpj


    public
                    getCpfCnpj() : mixed

getDatabase()


    public
                    getDatabase() : mixed

getDBDriver()


    public
            static        getDBDriver() : mixed

getDBTable()


    public
            static        getDBTable() : mixed

getDigitoAgencia()

Get the value of digitoAgencia


    public
                    getDigitoAgencia() : mixed

getDigitoConta()

Get the value of digitoConta


    public
                    getDigitoConta() : mixed

getIdBanco()

Get the value of idBanco


    public
                    getIdBanco() : mixed

getIdEntidade()

Get the value of idEntidade


    public
                    getIdEntidade() : mixed

getIdEntidadeBanco()

Get the value of idEntidadeBanco


    public
                    getIdEntidadeBanco() : mixed

getNomeconta()

Get the value of nomeconta


    public
                    getNomeconta() : mixed

getPadrao()

Get the value of padrao


    public
                    getPadrao() : mixed

getTable()


    public
                    getTable() : mixed

getTipoConta()

Get the value of tipoConta


    public
                    getTipoConta() : mixed

getTipoPIX()

Get the value of tipoPIX


    public
                    getTipoPIX() : mixed

getVariacao()

Get the value of variacao


    public
                    getVariacao() : mixed

hasField()


    public
            static        hasField(mixed $field) : mixed

Parameters

$field : mixed

insert()


    public
                    insert() : null|Entity

Return values

null|Entity

insert_or_select()

Funcao que insere ou seleciona se existe


    public
                    insert_or_select([mixed $where = [] ]) : null|Entity

Parameters

$where : mixed = []

Return values

null|Entity

insert_or_update()

Funcao que insere ou atualiza uma entidade no banco de dados


    public
                    insert_or_update([mixed $where = [] ][, mixed $update_fields = ['*'] ]) : array<string|int, mixed>

Parameters

$where : mixed = []
$update_fields : mixed = ['*']

Return values

array<string|int, mixed>

securityDelete()


    public
                    securityDelete(mixed $table, mixed $where) : bool

Parameters

$table : mixed
$where : mixed

Return values

bool

securityInsert()


    public
                    securityInsert(mixed $fields) : bool

Parameters

$fields : mixed

Return values

bool —

return 'true' if the security function didn't find any security issue and 'false' otherwise

securitySelect()


    public
                    securitySelect(mixed $table, mixed $fields, mixed $where) : array<string|int, mixed>

Parameters

$table : mixed
$fields : mixed
$where : mixed

Return values

array<string|int, mixed> —

return an array with information to be appended in the SQL select

securityUpdate()


    public
                    securityUpdate(mixed $fields, mixed $where) : bool

Parameters

$fields : mixed
$where : mixed

Return values

bool —

return 'true' if the security function didn't find any security issue and 'false' otherwise

setAgencia()

Set the value of agencia


    public
                    setAgencia(mixed $agencia) : self

Parameters

$agencia : mixed

Return values

self

setChavePix()

Set the value of chavePix


    public
                    setChavePix(mixed $chavePix) : self

Parameters

$chavePix : mixed

Return values

self

setContacorrente()

Set the value of contacorrente


    public
                    setContacorrente(mixed $contacorrente) : self

Parameters

$contacorrente : mixed

Return values

self

setCpfCnpj()

Set the value of CpfCnpj


    public
                    setCpfCnpj(mixed $CpfCnpj) : self

Parameters

$CpfCnpj : mixed

Return values

self

setDigitoAgencia()

Set the value of digitoAgencia


    public
                    setDigitoAgencia(mixed $digitoAgencia) : self

Parameters

$digitoAgencia : mixed

Return values

self

setDigitoConta()

Set the value of digitoConta


    public
                    setDigitoConta(mixed $digitoConta) : self

Parameters

$digitoConta : mixed

Return values

self

setIdBanco()

Set the value of idBanco


    public
                    setIdBanco(mixed $idBanco) : self

Parameters

$idBanco : mixed

Return values

self

setIdEntidade()

Set the value of idEntidade


    public
                    setIdEntidade(mixed $idEntidade) : self

Parameters

$idEntidade : mixed

Return values

self

setIdEntidadeBanco()

Set the value of idEntidadeBanco


    public
                    setIdEntidadeBanco(mixed $idEntidadeBanco) : self

Parameters

$idEntidadeBanco : mixed

Return values

self

setNomeconta()

Set the value of nomeconta


    public
                    setNomeconta(mixed $nomeconta) : self

Parameters

$nomeconta : mixed

Return values

self

setPadrao()

Set the value of padrao


    public
                    setPadrao(mixed $padrao) : self

Parameters

$padrao : mixed

Return values

self

setTipoConta()

Set the value of tipoConta


    public
                    setTipoConta(mixed $tipoConta) : self

Parameters

$tipoConta : mixed

Return values

self

setTipoPIX()

Set the value of tipoPIX


    public
                    setTipoPIX(mixed $tipoPIX) : self

Parameters

$tipoPIX : mixed

Return values

self

setVariacao()

Set the value of variacao


    public
                    setVariacao(mixed $variacao) : self

Parameters

$variacao : mixed

Return values

self

update()

A função update pode atualizar uma Entity já instanciada, desde que a chave primária esteja setada, ou pode atualizar uma Entity vazia informando o valor da chave primária no segundo parâmetro (pk_value)


    public
                    update(array<string|int, mixed> $values[, mixed $pk_value = null ]) : mixed

Parameters

$values : array<string|int, mixed>
$pk_value : mixed = null

validateFields()


    public
                    validateFields([array<string|int, mixed> $fields = [] ]) : bool

Parameters

$fields : array<string|int, mixed> = []

Return values

bool

where()

Rudimentary ORM functions


    public
            static        where([mixed $where = [] ][, mixed $select = '*' ]) : Collection

Parameters

$where : mixed = []
$select : mixed = '*'

Return values

Collection

PessoaBancoEntity extends Entity in package Application

Table of Contents

Constants

Properties

Methods

Constants

auditlog

const_values

database

db_table

pk_field

sanitize

security

tracking

validations

Properties

$agencia

$chavePix

$contacorrente

$CpfCnpj

$digitoAgencia

$digitoConta

$idBanco

$idEntidade

$idEntidadeBanco

$nomeconta

$padrao

$tipoConta

$tipoPIX

$variacao

Methods

__construct()

Parameters

delete()

Parameters

delete_where()

Parameters

getAgencia()

getAuditlog()

Parameters

getChavePix()

getConst()

Parameters

getConstObj()

Parameters

getContacorrente()

getCpfCnpj()

getDatabase()

getDBDriver()

getDBTable()

getDigitoAgencia()

getDigitoConta()

getIdBanco()

getIdEntidade()

getIdEntidadeBanco()

getNomeconta()

getPadrao()

getTable()

getTipoConta()

getTipoPIX()

getVariacao()

hasField()

Parameters

insert()

Return values

insert_or_select()

Parameters

Return values

insert_or_update()

Parameters

Return values

securityDelete()

Parameters

Return values

securityInsert()

Parameters

Return values

securitySelect()

Parameters

Return values

PessoaBancoEntity extends Entity
in package

Application