BaseModel.php

Callbacks for afterDelete

Creates DataConverter instance.

Are casts used?

Initializes the instance with any additional steps. Optionally implemented by child classes.

Fetches the row of database. This method works only with dbCalls.

Fetches the column of database. This method works only with dbCalls.

Fetches all results, while optionally limiting them. This method works only with dbCalls.

Returns the first row of the result set. This method works only with dbCalls.

Inserts data into the current database. This method works only with dbCalls.

Compiles batch insert and runs the queries, validating each row prior. This method works only with dbCalls.

Updates a single record in the database. This method works only with dbCalls.

Compiles an update and runs the query. This method works only with dbCalls.

Deletes a single record from the database where $id matches. This method works only with dbCalls.

Permanently deletes all rows that have been marked as deleted. through soft deletes (deleted = 1). This method works only with dbCalls.

Works with the find* methods to return only the rows that have been deleted. This method works only with dbCalls.

Compiles a replace and runs the query. This method works only with dbCalls.

Grabs the last error(s) that occurred from the Database connection. This method works only with dbCalls.

Public getter to return the id value using the idValue() method. For example with SQL this will return $data->$this->primaryKey.

Override countAllResults to account for soft deleted accounts. This method works only with dbCalls.

Loops over records in batches, allowing you to operate on them. This method works only with dbCalls.

Fetches the row of database.

Fetches the column of database.

Fetches all results, while optionally limiting them.

Returns the first row of the result set.

A convenience method that will attempt to determine whether the data should be inserted or updated. Will work with either an array or object. When using with custom class objects, you must ensure that the class will provide access to the class variables, even if through a magic method.

This method is called on save to determine if entry have to be updated. If this method returns false insert operation will be executed

Returns last insert ID or 0.

Inserts data into the database. If an object is provided, it will attempt to convert it to an array.

Set datetime to created field.

Set datetime to updated field.

Compiles batch insert runs the queries, validating each row prior.

Updates a single record in the database. If an object is provided, it will attempt to convert it into an array.

Compiles an update and runs the query.

Deletes a single record from the database where $id matches.

Permanently deletes all rows that have been marked as deleted through soft deletes (deleted = 1).

Sets $useSoftDeletes value so that we can temporarily override the soft deletes settings. Can be used for all find* methods.

Works with the find* methods to return only the rows that have been deleted.

Compiles a replace and runs the query.

Grabs the last error(s) that occurred. If data was validated, it will first check for errors there, otherwise will try to grab the last error from the Database connection. The return array should be in the following format: ['source' => 'message']

Works with Pager to get the size and offset parameters. Expects a GET variable (?page=2) that specifies the page of results to display.

It could be used when you have to change default or override current allowed fields.

Sets whether or not we should whitelist data set during updates or inserts against $this->availableFields.

Ensures that only the fields that are allowed to be updated are in the data array.

Ensures that only the fields that are allowed to be inserted are in the data array.

Sets the date or current date if null value is passed.

A utility function to allow child models to use the type of date/time format that they prefer. This is primarily used for setting created_at, updated_at and deleted_at values, but can be used by inheriting classes. The available time formats are: - 'int' - Stores the date as an integer timestamp - 'datetime' - Stores the data in the SQL datetime format - 'date' - Stores the date (only) in the SQL date format.

Converts Time value to string using $this->dateFormat. The available time formats are: - 'int' - Stores the date as an integer timestamp - 'datetime' - Stores the data in the SQL datetime format - 'date' - Stores the date (only) in the SQL date format.

Set the value of the skipValidation flag.

Allows to set (and reset) validation messages. It could be used when you have to change default or override current validate messages.

Allows to set field wise validation message. It could be used when you have to change default or override current validate messages.

Allows to set (and reset) validation rules. It could be used when you have to change default or override current validate rules.

Allows to set field wise validation rules. It could be used when you have to change default or override current validate rules.

Should validation rules be removed before saving? Most handy when doing updates.

Validate the row data against the validation rules (or the validation group) specified in the class property, $validationRules.

Returns the model's defined validation rules so that they can be used elsewhere, if needed.

Returns the model's validation messages, so they can be used elsewhere, if needed.

Removes any rules that apply to fields that have not been set currently so that rules don't block updating when only updating a partial row.

Sets $tempAllowCallbacks value so that we can temporarily override the setting. Resets after the next method that uses triggers.

A simple event trigger for Model Events that allows additional data manipulation within the model. Specifically intended for usage by child models this can be used to format data, save/load related classes, etc. It is the responsibility of the callback methods to return the data itself. Each $eventData array MUST have a 'data' key with the relevant data for callback methods (like an array of key/value pairs to insert or update, an array of results, etc.) If callbacks are not allowed then returns $eventData immediately.

Sets the return type of the results to be as an associative array.

Sets the return type to be of the specified type of object. Defaults to a simple object, but can be any class that has class vars with the same name as the collection columns, or at least allows them to be created.

Takes a class and returns an array of its public and protected properties as an array suitable for use in creates and updates. This method uses objectToRawArray() internally and does conversion to string on all Time instances

Convert any Time instances to appropriate $dateFormat.

Takes a class and returns an array of its public and protected properties as an array with raw values.

Transform data to array.

Provides the db connection and model's properties.

Checks for the existence of properties across this model, and db connection.

Provides direct access to method in the database connection.

Sets $allowEmptyInserts.

Converts database data array to return type value.