Documentation

NfeObservacoesEntity extends Entity
in package

Table of Contents

Constants

auditlog  = []
Allowed keys: 'exclude_fields': <...> 'object_rel': <...>
const_values  = []
database  = \config\Config::DB_NFE
db_table  = 'observacoes_nfe'
pk_field  = 'idObservacao'
sanitize  = ['cpfCnpj' => 'onlyNumber']
Estrutura = ['key' => 'rule']
security  = ['select' => 'core\EntitySecurity::securitySelect', 'delete' => 'core\EntitySecurity::securityDelete', 'update' => 'core\EntitySecurity::securityUpdate', 'insert' => 'core\EntitySecurity::securityInsert']
Allowed keys: 'select': <...> 'update': <...> 'delete': <...> 'insert': <...>
tracking  = true
validations  = ['campoDestino' => ['required' => 'O campo Campo Destino é obrigatório.'], 'textoObservacao' => ['required' => 'O campo Observação é obrigatório.'], 'emitenteid' => ['required' => 'O campo Emitente é obrigatório.'], 'estado' => ['required' => 'O campo Estado é obrigatório.'], 'ativo' => ['required' => 'O campo Status é obrigatório.']]
Estrutura = ['key' => ['keyRule' => 'Rule message']]

Properties

$ativo  : mixed
$campoDestino  : mixed
$cpfCnpj  : mixed
$DataHora  : mixed
$emitenteid  : mixed
$estado  : mixed
$idObservacao  : mixed
$idUsuario  : mixed
$textoObservacao  : mixed

Methods

__construct()  : mixed
delete()  : mixed
delete_where()  : mixed
getAtivo()  : mixed
Get the value of ativo
getAuditlog()  : mixed
getCampoDestino()  : mixed
Get the value of campoDestino
getConst()  : mixed
getConstObj()  : mixed
getCpfCnpj()  : mixed
Get the value of cpfCnpj
getDatabase()  : mixed
getDataHora()  : mixed
Get the value of DataHora
getDBDriver()  : mixed
getDBTable()  : mixed
getEmitenteid()  : mixed
Get the value of emitenteid
getEstado()  : mixed
Get the value of estado
getIdObservacao()  : mixed
Get the value of idObservacao
getIdUsuario()  : mixed
Get the value of idUsuario
getTable()  : mixed
getTextoObservacao()  : mixed
Get the value of textoObservacao
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
setAtivo()  : self
Set the value of ativo
setCampoDestino()  : self
Set the value of campoDestino
setCpfCnpj()  : self
Set the value of cpfCnpj
setDataHora()  : self
Set the value of DataHora
setEmitenteid()  : self
Set the value of emitenteid
setEstado()  : self
Set the value of estado
setIdObservacao()  : self
Set the value of idObservacao
setIdUsuario()  : self
Set the value of idUsuario
setTextoObservacao()  : self
Set the value of textoObservacao
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

Constants

auditlog

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

public mixed auditlog = []

const_values

public mixed const_values = []

sanitize

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

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

security

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

public mixed security = ['select' => 'core\EntitySecurity::securitySelect', 'delete' => 'core\EntitySecurity::securityDelete', 'update' => 'core\EntitySecurity::securityUpdate', 'insert' => 'core\EntitySecurity::securityInsert']

tracking

public mixed tracking = true

validations

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

public mixed validations = ['campoDestino' => ['required' => 'O campo Campo Destino é obrigatório.'], 'textoObservacao' => ['required' => 'O campo Observação é obrigatório.'], 'emitenteid' => ['required' => 'O campo Emitente é obrigatório.'], 'estado' => ['required' => 'O campo Estado é obrigatório.'], 'ativo' => ['required' => 'O campo Status é obrigatório.']]

Properties

Methods

__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 = []

getAuditlog()

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

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

getDatabase()

public getDatabase() : mixed

getDBDriver()

public static getDBDriver() : mixed

getDBTable()

public static getDBTable() : mixed

getTable()

public getTable() : mixed

getTextoObservacao()

Get the value of textoObservacao

public getTextoObservacao() : mixed

hasField()

public static hasField(mixed $field) : mixed
Parameters
$field : mixed

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

setAtivo()

Set the value of ativo

public setAtivo(mixed $ativo) : self
Parameters
$ativo : mixed
Return values
self

setCampoDestino()

Set the value of campoDestino

public setCampoDestino(mixed $campoDestino) : self
Parameters
$campoDestino : mixed
Return values
self

setCpfCnpj()

Set the value of cpfCnpj

public setCpfCnpj(mixed $cpfCnpj) : self
Parameters
$cpfCnpj : mixed
Return values
self

setDataHora()

Set the value of DataHora

public setDataHora(mixed $DataHora) : self
Parameters
$DataHora : mixed
Return values
self

setEmitenteid()

Set the value of emitenteid

public setEmitenteid(mixed $emitenteid) : self
Parameters
$emitenteid : mixed
Return values
self

setEstado()

Set the value of estado

public setEstado(mixed $estado) : self
Parameters
$estado : mixed
Return values
self

setIdObservacao()

Set the value of idObservacao

public setIdObservacao(mixed $idObservacao) : self
Parameters
$idObservacao : mixed
Return values
self

setIdUsuario()

Set the value of idUsuario

public setIdUsuario(mixed $idUsuario) : self
Parameters
$idUsuario : mixed
Return values
self

setTextoObservacao()

Set the value of textoObservacao

public setTextoObservacao(mixed $textoObservacao) : self
Parameters
$textoObservacao : 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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results