Aplus Framework Docs

Model

in package

• mvc

implements ModelInterface

Class Model.

Interfaces, Classes, Traits and Enums

ModelInterface

Interface ModelInterface.

Table of Contents

$allowedFields  : array<string|int, mixed>

Allowed columns for INSERT and UPDATE.

$autoTimestamps  : bool

Auto set timestamp fields.

$cacheActive  : bool

$cacheDataNotFound  : int|string

$cacheInstance  : string

$cacheTtl  : int

$columnCase  : string

$connectionRead  : string

Database connection instance name for read operations.

$connectionWrite  : string

Database connection instance name for write operations.

$fieldCreated  : string

The timestamp field for 'created at' time when $autoTimestamps is true.

$fieldUpdated  : string

The timestamp field for 'updated at' time when $autoTimestamps is true.

$languageInstance  : string

$models  : array<string|int, mixed>

$pager  : Pager

The Pager instance.

$pagerAllowedQueries  : array<string|int, mixed>|null

$pagerQuery  : string

$pagerUrl  : string

Pager URL.

$pagerView  : string

Default pager view.

$primaryKey  : string

Table Primary Key.

$protectPrimaryKey  : bool

Prevents Primary Key changes on INSERT and UPDATE.

$returnType  : string

Fetched item return type.

$table  : string

Table name.

$timestampFormat  : string

The timestamp format used on database write operations.

$validation  : Validation

The Model Validation instance.

$validationLabels  : array<string|int, mixed>

Validation field labels.

$validationMessages  : array<string|int, mixed>

Validation error messages.

$validationRules  : array<string|int, mixed>

Validation rules.

$validationValidators  : array<string|int, mixed>

Validation Validators.

__call()  : mixed

count()  : int

A basic function to count rows in the table.

create()  : false|int|string

Insert a new row.

createBy()  : false|int|string

Insert a new row and return the inserted column value.

createById()  :

delete()  : false|int|string

Delete based on Primary Key.

deleteBy()  : false|int|string

Delete based on column value.

deleteById()  :

find()  : Entity|array<string|int, mixed>|array<string|int, float>|array<string|int, int>|array<string|int, null>|stdClass|array<string|int, string>|null

Alias of {@see Model::read()}.

findAll()  : array<int, \Framework\MVC\Entity|array|\stdClass>

Alias of {@see Model::list()}.

findBy()  : Entity|array<string, float|int|string|null>|stdClass|null

Alias of {@see Model::readBy()}.

findById()  :

get()  : T

Get same Model instance.

getErrors()  : array<string, string>

Get Validation errors.

getPager()  : Pager

Get the Pager.

getValidationMessages()  : array<string, array<string, string>>

getValidationValidators()  : array<int, string>

list()  : array<int, \Framework\MVC\Entity|array|\stdClass>

List rows, optionally with limit and offset.

paginate()  : array<int, \Framework\MVC\Entity|array|\stdClass>

A basic function to paginate all rows of the table.

read()  : Entity|array<string, float|int|string|null>|stdClass|null

Read a row based on Primary Key.

readBy()  : Entity|array<string, float|int|string|null>|stdClass|null

Read a row by column name and value.

readById()  :

replace()  : false|int|string

Replace based on Primary Key and return the number of affected rows.

replaceBy()  : false|int|string

Replace based on column value and return the number of affected rows.

replaceById()  :

save()  : false|int|string

Save a row. Update if the Primary Key is present, otherwise insert a new row.

update()  : false|int|string

Update based on Primary Key and return the number of affected rows.

updateBy()  : false|int|string

Update based on column value and return the number of affected rows.

updateById()  :

checkMysqliException()  : void

checkPrimaryKey()  : void

convertCase()  : string

Convert a value to specific case.

filterAllowedFields()  : array<string, T>

getAllowedFields()  : array<int, string>

getCache()  : Cache

getCacheDataNotFound()  : int|string

getCacheInstance()  : string

getCacheKey()  : string

getCacheTtl()  : int

getConnectionRead()  : string

getConnectionWrite()  : string

getDatabaseToRead()  : Database

getDatabaseToWrite()  : Database

getFieldCreated()  : string

getFieldUpdated()  : string

getLanguage()  : Language

getLanguageInstance()  : string

getPagerAllowedQueries()  : array<string|int, string>|null

Get allowed queries to be used in the Pager.

getPagerQuery()  : string|null

Get the custom query to be used in the Pager.

getPagerUrl()  : string|null

Get the custom URL to be used in the Pager.

getPagerView()  : string|null

Get the custom view to be used in the Pager.

getPrimaryKey()  : string

getReturnType()  : string

getTable()  : string

getTimestamp()  : string

Used to auto set the timestamp fields.

getTimestampFormat()  : string

getValidation()  : Validation

getValidationLabels()  : array<string, string>

getValidationRules()  : array<string, string[]|string>

isAutoTimestamps()  : bool

isCacheActive()  : bool

isProtectPrimaryKey()  : bool

makeArray()  : array<string, mixed>

makeEntity()  : Entity|array<string, float|int|string|null>|stdClass

makePageLimitAndOffset()  : array<int, int|null>

makeTableName()  : string

readRow()  : array<string, float|int|string|null>|null

readWithCache()  : Entity|array<string, float|int|string|null>|stdClass|null

sanitizePageNumber()  : int

setDuplicateEntryError()  : void

Set "Duplicate entry" as 'unique' error in the Validation.

setPager()  : static

Set the Pager.

timezone()  : DateTimeZone

Get the timezone from database write connection config. As fallback, uses the UTC timezone.

updateCachedRow()  : void