Documentation

CstItemEntity extends Entity
in package

Application

Constants

auditlog = []: Allowed keys: 'exclude_fields': <...> 'object_rel': <...>
const_values = []
database = \config\Config::DB_DEFAULT
db_table = 'nfe_cst_item'
pk_field = 'idCstItem'
sanitize = []
security = ['select' => 'core\EntitySecurity::securitySelect', 'delete' => 'core\EntitySecurity::securityDelete', 'update' => 'core\EntitySecurity::securityUpdate', 'insert' => 'core\EntitySecurity::securityInsert']: Allowed keys: 'select': <...> 'update': <...> 'delete': <...> 'insert': <...>
tracking = false
validations = []

Properties

$cClassTrib : mixed
$creditoPresumido : mixed
$descricao : mixed
$estornoCredito : mixed
$idCst : mixed
$idCstItem : mixed
$monofasicaComDiferimento : mixed
$monofasicaNormal : mixed
$monofasicaRetidaAnterior : mixed
$monofasicaSujeitaRetencao : mixed
$percentualCBS : mixed
$percentualIBS : mixed
$tipoAliquota : mixed
$tributacaoRegular : mixed

Methods

__construct() : mixed
delete() : mixed
delete_where() : mixed
getAuditlog() : mixed
getCClassTrib() : mixed: Get the value of cClassTrib
getConst() : mixed
getConstObj() : mixed
getCreditoPresumido() : mixed: Get the value of creditoPresumido
getDatabase() : mixed
getDBDriver() : mixed
getDBTable() : mixed
getDescricao() : mixed: Get the value of descricao
getEstornoCredito() : mixed: Get the value of estornoCredito
getIdCst() : mixed: Get the value of idCst
getIdCstItem() : mixed: Get the value of idCstItem
getMonofasicaComDiferimento() : mixed: Get the value of monofasicaComDiferimento
getMonofasicaNormal() : mixed: Get the value of monofasicaNormal
getMonofasicaRetidaAnterior() : mixed: Get the value of monofasicaRetidaAnterior
getMonofasicaSujeitaRetencao() : mixed: Get the value of monofasicaSujeitaRetencao
getPercentualCBS() : mixed: Get the value of percentualCBS
getPercentualIBS() : mixed: Get the value of percentualIBS
getTable() : mixed
getTipoAliquota() : mixed: Get the value of tipoAliquota
getTributacaoRegular() : mixed: Get the value of tributacaoRegular
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
setCClassTrib() : self: Set the value of cClassTrib
setCreditoPresumido() : self: Set the value of creditoPresumido
setDescricao() : self: Set the value of descricao
setEstornoCredito() : self: Set the value of estornoCredito
setIdCst() : self: Set the value of idCst
setIdCstItem() : self: Set the value of idCstItem
setMonofasicaComDiferimento() : self: Set the value of monofasicaComDiferimento
setMonofasicaNormal() : self: Set the value of monofasicaNormal
setMonofasicaRetidaAnterior() : self: Set the value of monofasicaRetidaAnterior
setMonofasicaSujeitaRetencao() : self: Set the value of monofasicaSujeitaRetencao
setPercentualCBS() : self: Set the value of percentualCBS
setPercentualIBS() : self: Set the value of percentualIBS
setTipoAliquota() : self: Set the value of tipoAliquota
setTributacaoRegular() : self: Set the value of tributacaoRegular
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
    = 'nfe_cst_item'

pk_field


    public
        mixed
    pk_field
    = 'idCstItem'

sanitize


    public
        mixed
    sanitize
    = []

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
    = false

validations


    public
        mixed
    validations
    = []

$cClassTrib


        private
            mixed
    $cClassTrib

$creditoPresumido


        private
            mixed
    $creditoPresumido

$descricao


        private
            mixed
    $descricao

$estornoCredito


        private
            mixed
    $estornoCredito

$idCst


        private
            mixed
    $idCst

$idCstItem


        private
            mixed
    $idCstItem

$monofasicaComDiferimento


        private
            mixed
    $monofasicaComDiferimento

$monofasicaNormal


        private
            mixed
    $monofasicaNormal

$monofasicaRetidaAnterior


        private
            mixed
    $monofasicaRetidaAnterior

$monofasicaSujeitaRetencao


        private
            mixed
    $monofasicaSujeitaRetencao

$percentualCBS


        private
            mixed
    $percentualCBS

$percentualIBS


        private
            mixed
    $percentualIBS

$tipoAliquota


        private
            mixed
    $tipoAliquota

$tributacaoRegular


        private
            mixed
    $tributacaoRegular

__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

getCClassTrib()

Get the value of cClassTrib


    public
                    getCClassTrib() : 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

getCreditoPresumido()

Get the value of creditoPresumido


    public
                    getCreditoPresumido() : mixed

getDatabase()


    public
                    getDatabase() : mixed

getDBDriver()


    public
            static        getDBDriver() : mixed

getDBTable()


    public
            static        getDBTable() : mixed

getDescricao()

Get the value of descricao


    public
                    getDescricao() : mixed

getEstornoCredito()

Get the value of estornoCredito


    public
                    getEstornoCredito() : mixed

getIdCst()

Get the value of idCst


    public
                    getIdCst() : mixed

getIdCstItem()

Get the value of idCstItem


    public
                    getIdCstItem() : mixed

getMonofasicaComDiferimento()

Get the value of monofasicaComDiferimento


    public
                    getMonofasicaComDiferimento() : mixed

getMonofasicaNormal()

Get the value of monofasicaNormal


    public
                    getMonofasicaNormal() : mixed

getMonofasicaRetidaAnterior()

Get the value of monofasicaRetidaAnterior


    public
                    getMonofasicaRetidaAnterior() : mixed

getMonofasicaSujeitaRetencao()

Get the value of monofasicaSujeitaRetencao


    public
                    getMonofasicaSujeitaRetencao() : mixed

getPercentualCBS()

Get the value of percentualCBS


    public
                    getPercentualCBS() : mixed

getPercentualIBS()

Get the value of percentualIBS


    public
                    getPercentualIBS() : mixed

getTable()


    public
                    getTable() : mixed

getTipoAliquota()

Get the value of tipoAliquota


    public
                    getTipoAliquota() : mixed

getTributacaoRegular()

Get the value of tributacaoRegular


    public
                    getTributacaoRegular() : 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

setCClassTrib()

Set the value of cClassTrib


    public
                    setCClassTrib(mixed $cClassTrib) : self

Parameters

$cClassTrib : mixed

Return values

self

setCreditoPresumido()

Set the value of creditoPresumido


    public
                    setCreditoPresumido(mixed $creditoPresumido) : self

Parameters

$creditoPresumido : mixed

Return values

self

setDescricao()

Set the value of descricao


    public
                    setDescricao(mixed $descricao) : self

Parameters

$descricao : mixed

Return values

self

setEstornoCredito()

Set the value of estornoCredito


    public
                    setEstornoCredito(mixed $estornoCredito) : self

Parameters

$estornoCredito : mixed

Return values

self

setIdCst()

Set the value of idCst


    public
                    setIdCst(mixed $idCst) : self

Parameters

$idCst : mixed

Return values

self

setIdCstItem()

Set the value of idCstItem


    public
                    setIdCstItem(mixed $idCstItem) : self

Parameters

$idCstItem : mixed

Return values

self

setMonofasicaComDiferimento()

Set the value of monofasicaComDiferimento


    public
                    setMonofasicaComDiferimento(mixed $monofasicaComDiferimento) : self

Parameters

$monofasicaComDiferimento : mixed

Return values

self

setMonofasicaNormal()

Set the value of monofasicaNormal


    public
                    setMonofasicaNormal(mixed $monofasicaNormal) : self

Parameters

$monofasicaNormal : mixed

Return values

self

setMonofasicaRetidaAnterior()

Set the value of monofasicaRetidaAnterior


    public
                    setMonofasicaRetidaAnterior(mixed $monofasicaRetidaAnterior) : self

Parameters

$monofasicaRetidaAnterior : mixed

Return values

self

setMonofasicaSujeitaRetencao()

Set the value of monofasicaSujeitaRetencao


    public
                    setMonofasicaSujeitaRetencao(mixed $monofasicaSujeitaRetencao) : self

Parameters

$monofasicaSujeitaRetencao : mixed

Return values

self

setPercentualCBS()

Set the value of percentualCBS


    public
                    setPercentualCBS(mixed $percentualCBS) : self

Parameters

$percentualCBS : mixed

Return values

self

setPercentualIBS()

Set the value of percentualIBS


    public
                    setPercentualIBS(mixed $percentualIBS) : self

Parameters

$percentualIBS : mixed

Return values

self

setTipoAliquota()

Set the value of tipoAliquota


    public
                    setTipoAliquota(mixed $tipoAliquota) : self

Parameters

$tipoAliquota : mixed

Return values

self

setTributacaoRegular()

Set the value of tributacaoRegular


    public
                    setTributacaoRegular(mixed $tributacaoRegular) : self

Parameters

$tributacaoRegular : 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

CstItemEntity 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

$cClassTrib

$creditoPresumido

$descricao

$estornoCredito

$idCst

$idCstItem

$monofasicaComDiferimento

$monofasicaNormal

$monofasicaRetidaAnterior

$monofasicaSujeitaRetencao

$percentualCBS

$percentualIBS

$tipoAliquota

$tributacaoRegular

Methods

__construct()

Parameters

delete()

Parameters

delete_where()

Parameters

getAuditlog()

Parameters

getCClassTrib()

getConst()

Parameters

getConstObj()

Parameters

getCreditoPresumido()

getDatabase()

getDBDriver()

getDBTable()

getDescricao()

getEstornoCredito()

getIdCst()

getIdCstItem()

getMonofasicaComDiferimento()

getMonofasicaNormal()

getMonofasicaRetidaAnterior()

getMonofasicaSujeitaRetencao()

getPercentualCBS()

getPercentualIBS()

getTable()

getTipoAliquota()

getTributacaoRegular()

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

CstItemEntity extends Entity
in package

Application