1. class
  2. Core
  3. \
  4. Model

Model

class Model

Parent class for our models. Takes functions from DB wrapper and extract functionality further to make operations easier to use and improve extendability.

Constants

BLACKLIST

Constant for blacklist.
WHITELIST

Constant for whitelist.

Properties

static protected DB $_db

The instance of the DB class.
number $id

The current id.
protected string $_modelName

The name of the model.
static protected bool $_softDelete

$_softDelete value.
static protected string $_table

The name of the table.
protected bool $_validates

Flag to indicate if validation is successful.
protected array $_validationErrors

The array of validation errors.

Methods

__construct()

Default constructor.

void
addErrorMessage(string $field, string $message)

Generates error messages that occur during form validation.

void
afterDelete()

Called before delete.

void
afterSave()

Called before save.

Model
assign(array $params, array $list = [], string $assignmentFilter = self::BLACKLIST)

Update the object with an associative array.

void
beforeDelete()

This runs before delete, needs to return a boolean

void
beforeSave()

Called after save.

static int
count()

Retrieves number of rows affected or returned by the last query. This is a wrapper function for the DB::count function.

stdClass
data()

Grab object and if we just need data for smaller result set.

bool
delete()

Wrapper for database delete function. If not softDelete we set it.

static array
getColumns()

Gets columns from table.

array
getColumnsForSave()

Gets an associative array of field values for insert or updating.

static DB
getDb()

Returns an instance of the DB class.

array
getErrorMessages()

Displays error messages when form validation fails.

static array
_fetchStyleParams(array $params)

Used to set default fetchStyle param.

static array|bool
find(array $params = [])

Wrapper for the find function that is found in the DB class.

static object|bool
findById(int $id)

Get result from database by primary key ID.

static array|bool
findByTable(string $table, array $params = [])

Performs a database query against a specified table using the same query-building logic as the default find method.

static array
findAllByUserId(int $user_id, array $params = [])

Retrieves list of all records within a table related to a user.

static object|bool
findFirst(array $params = [])

Wrapper for the findFirst function that is found in the DB class.

static int
findTotal(array $params = [])

Returns number of records in a table. A wrapper function for findTotal function in DB class.

bool
insert(array $fields)

Wrapper for database insert function.

bool
isNew()

Checks if an object is a new insertion or an existing record.

void
onConstruct()

Runs when the object is constructed.

void
populateObjData(array|object $result)

Populates object with data.

DB
query(string $sql, array $bind = [])

Wrapper for database query function.

void
runValidation(object $validator)

Runs a validator object and sets validates boolean and adds error message if validator fails.

bool
save()

Wrapper for update and insert functions. A failed form validation will cause this function to return false.

static array
_softDeleteParams(array $params)

Adds to the conditions to avoid getting soft deleted rows returned

bool
update(array $fields)

Wrapper for the update function found in the DB class.

static int
updateWhere(array $fields, array $params)

Updates one or more rows in this model's underlying table using your framework's params-style conditions.

bool
validationPassed()

Getter function for the $_validates boolean instance variable.

void
validator()

Function that is called on save. If validation fails the save function will not proceed. This function is just a signature and must be implemented by models that run form validation because since it is called from within this class.

Details

at line 66
__construct()

Default constructor.

at line 80
void addErrorMessage(string $field, string $message)

Generates error messages that occur during form validation.

Parameters

string $field

The form field associated with failed form validation
string $message

A message that describes to the user the cause for failed form validation.

Return Value

void

at line 93
void afterDelete()

Called before delete.

Return Value

void

at line 100
void afterSave()

Called before save.

Return Value

void

at line 112
Model assign(array $params, array $list = [], string $assignmentFilter = self::BLACKLIST)

Update the object with an associative array.

Parameters

array $params

Take values from post array and assign values.
array $list

A list of values to blacklist or whitelist.
string $assignmentFilter

When set to ModelName::BLACKLIST the values in the $list array is blacklisted. When set to ModelName::WHITELIST they are whitelisted.

Return Value

Model

Report for whether or not the operation was successful.

at line 135
void beforeDelete()

This runs before delete, needs to return a boolean

Return Value

void

Boolean value depending on results of operation.

at line 142
void beforeSave()

Called after save.

Return Value

void

at line 150
static int count()

Retrieves number of rows affected or returned by the last query. This is a wrapper function for the DB::count function.

Return Value

int

The number of rows affected or returned by the last query.

at line 159
stdClass data()

Grab object and if we just need data for smaller result set.

Return Value

stdClass

The data associated with an object.

at line 180
bool delete()

Wrapper for database delete function. If not softDelete we set it.

If row is set to softDelete we call the database delete function.

Return Value

bool

$deleted True if delete operation is successful. Otherwise, we return false.

at line 202
static array getColumns()

Gets columns from table.

Return Value

array

An array of objects where each one represents a column from a database table.

at line 212
array getColumnsForSave()

Gets an associative array of field values for insert or updating.

Return Value

array

Associative array of fields from database and values from model object.

at line 241
static DB getDb()

Returns an instance of the DB class.

Return Value

DB

$_db The instance of the DB class.

at line 254
array getErrorMessages()

Displays error messages when form validation fails.

Return Value

array

An array that contains a list of items that failed form validation.

at line 264
static protected array _fetchStyleParams(array $params)

Used to set default fetchStyle param.

Parameters

array $params

Query params.

Return Value

array

$params Updated params.

at line 278
static array|bool find(array $params = [])

Wrapper for the find function that is found in the DB class.

Parameters

array $params

The values for the query. They are the fields of the table in our database. The default value is an empty array.

Return Value

array|bool

An array of objects returned from an SQL query.

at line 292
static object|bool findById(int $id)

Get result from database by primary key ID.

Parameters

int $id

The ID of the row we want to retrieve from the database.

Return Value

object|bool

The row from a database.

at line 308
static array|bool findByTable(string $table, array $params = [])

Performs a database query against a specified table using the same query-building logic as the default find method.

This method is useful when querying a different table than the one defined by the model's static::$_table property (e.g., joining or selecting from related tables).

Parameters

string $table

The name of the table to query (can include alias, e.g. 'cart_items AS items').
array $params

The query parameters such as columns, joins, conditions, bind, order, limit, etc.

Return Value

array|bool

An array of result objects if found, or false/empty array if no results.

at line 324
static array findAllByUserId(int $user_id, array $params = [])

Retrieves list of all records within a table related to a user.

Parameters

int $user_id

The user ID.
array $params

Used to build conditions for database query. The default value is an empty array.

Return Value

array

The list of records that is returned from the database.

at line 342
static object|bool findFirst(array $params = [])

Wrapper for the findFirst function that is found in the DB class.

Parameters

array $params

The values for the query. They are the fields of the table in our database. The default value is an empty array.

Return Value

object|bool

An array of object returned from an SQL query.

at line 357
static int findTotal(array $params = [])

Returns number of records in a table. A wrapper function for findTotal function in DB class.

Parameters

array $params

The values for the query. They are the fields of the table in our database. The default value is an empty array.

Return Value

int

The number of records in a table.

at line 372
bool insert(array $fields)

Wrapper for database insert function.

Parameters

array $fields

The field names and the respective values we will use to populate a database record. The default value is an empty array.

Return Value

bool

Report for whether or not the operation was successful.

at line 384
bool isNew()

Checks if an object is a new insertion or an existing record.

Return Value

bool

Returns true if the record exists. Otherwise, we return false.

at line 393
void onConstruct()

Runs when the object is constructed.

Return Value

void

at line 401
protected void populateObjData(array|object $result)

Populates object with data.

Parameters

array|object $result

Results from a database query.

Return Value

void

at line 416
DB query(string $sql, array $bind = [])

Wrapper for database query function.

Parameters

string $sql

The database query we will submit to the database.
array $bind

The values we want to bind in our database query. The default value is an empty array.

Return Value

DB

The results of the database query.

at line 427
void runValidation(object $validator)

Runs a validator object and sets validates boolean and adds error message if validator fails.

Parameters

object $validator

The validator object.

Return Value

void

at line 442
bool save()

Wrapper for update and insert functions. A failed form validation will cause this function to return false.

Return Value

bool

True if the update operation is successful. Otherwise, we return false.

at line 483
static protected array _softDeleteParams(array $params)

Adds to the conditions to avoid getting soft deleted rows returned

Parameters

array $params

Defined parameters to search by.

Return Value

array

$params parameters with appended conditions for soft delete.

at line 512
bool update(array $fields)

Wrapper for the update function found in the DB class.

Parameters

array $fields

The value of the fields we want to set for the database record. The default value is an empty array.

Return Value

bool

True if the update operation is successful. Otherwise, we return false.

at line 542
static int updateWhere(array $fields, array $params)

Updates one or more rows in this model's underlying table using your framework's params-style conditions.

This method delegates to the DB::updateWhere() method and allows you to pass both the fields to update and a parameterized WHERE clause (using conditions and bind arrays just like find/findFirst).

Example:

Queue::updateWhere(
    ['reserved_at' => date('Y-m-d H:i:s')],
    ['conditions' => 'id = ?', 'bind' => [$jobId]]
);

Parameters

array $fields

Associative array of columns to update with their new values. Example: ['status' => 'processed', 'attempts' => 3]
array $params

Query parameters for the WHERE clause. Supports:

  • conditions (string|array): SQL conditions with placeholders.
  • bind (array): Values to bind to placeholders.

Return Value

int

The number of rows affected by the update.

at line 552
bool validationPassed()

Getter function for the $_validates boolean instance variable.

Return Value

bool

$_validates is true if validation is successful and false if there is a failure.

at line 563
void validator()

Function that is called on save. If validation fails the save function will not proceed. This function is just a signature and must be implemented by models that run form validation because since it is called from within this class.

Return Value

void