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.
Traits
Supports ability to validate console input.
Constants
| BLACKLIST |
Constant for blacklist. |
| WHITELIST |
Constant for whitelist. |
Properties
| protected array | $errors | An array of errors. |
from HasValidators |
| protected string | $fieldName | The name of the field to be validated. |
from HasValidators |
| protected array | $reservedKeywords | An array of reserved keywords. |
from HasValidators |
| protected array | $validators | Array of validator callbacks. |
from HasValidators |
| static protected DB | $_db | The instance of the DB class. |
|
| int | $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. |
Methods
Adds a new error message to the $errors array.
Enforce rule where input must contain only alphabetic characters.
Enforce rule where input must be alphanumeric characters.
Ensures input is between within a certain range in length.
Checks if class exists within the specified namespace.
Tests form validation with multiple fields. Used by the unique validator to test several fields for uniqueness.
Enforce rule where response and $match parameter needs to be different.
Sets name of field to be validated.
Supports includeDeleted feature for database operations.
Checks if a port on a particular host is in use. Assists in verifying if a port is available for a serve command. If the port is already in use an error message is presented to the user.
Ensure user inputs valid comma separated list of values. The user must provide the following in the $attributes parameter: 1) Class containing full namespaced path 2) Name of function that returns an array of strings or a comma separated array of strings.
Enforces rule when input must contain at least one lower case character.
Enforce rule where response and $match parameter needs to match.
Ensures input meets requirements for maximum allowable length.
Ensures input meets requirements for minimum allowable length.
Enforces rule when input must contain no special characters.
Enforce rule when reserved keywords should be avoided.
Enforces rule when input must contain at least one numeric character.
Enforce rule where input must contain only numeric characters.
Parse array containing additional validators or attributes for FrameworkQuestion as strings along with any additional parameters that maybe expected.
Resets fieldname and validators instance variables so duplicate messages are not displayed in forms.
Adds validator to array of validators to be used.
Enforces rule when input must contain at least one special character.
Split on commas (tolerate spaces), normalize to lowercase, drop empties.
Checks if value already exists in a database.
Enforces rule when input must contain at least one lower case character.
Calls validator callbacks. This function also ensures validators don't bleed into next question if instance is reused.
Default constructor.
Called before delete.
Called before save.
Update the object with an associative array.
This runs before delete, needs to return a boolean
Called after save.
Retrieves number of rows affected or returned by the last query. This is a wrapper function for the DB::count function.
Wrapper for database delete function. If not softDelete we set it.
Gets columns from table.
Gets an associative array of field values for insert or updating.
Displays error messages when form validation fails.
Used to set default fetchStyle param.
Wrapper for the find function that is found in the DB class.
Get result from database by primary key ID.
Performs a database query against a specified table using the same query-building logic as the default find method.
Retrieves list of all records within a table related to a user.
Wrapper for the findFirst function that is found in the DB class.
Returns number of records in a table. A wrapper function for findTotal function in DB class.
Wrapper for database insert function.
Checks if an object is a new insertion or an existing record.
Runs when the object is constructed.
Populates object with data.
Checks if results of validation is true or false. If false, the $this->_validates boolean instance variable is set to false. There are two ways to provide parameters for validation. You can pass the results from chaining functions and use just one parameter. Or you can provide the value of the field's name attribute, an array of validators, and a value for how you want the name of the field represented in error messages. If this value is not provided then the name attribute is used in messaging.
Wrapper for update and insert functions. A failed form validation will cause this function to return false.
Adds to the conditions to avoid getting soft deleted rows returned
Wrapper for the update function found in the DB class.
Updates one or more rows in this model's underlying table using your framework's params-style conditions.
Getter function for the $_validates boolean instance variable.
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
in
HasValidators at line 82
void
addErrorMessage(string $message)
Adds a new error message to the $errors array.
in
HasValidators at line 92
HasValidators
alpha()
Enforce rule where input must contain only alphabetic characters.
in
HasValidators at line 106
HasValidators
alphaNumeric()
Enforce rule where input must be alphanumeric characters.
in
HasValidators at line 124
HasValidators
between(array $range)
Ensures input is between within a certain range in length.
in
HasValidators at line 149
HasValidators
classExists(string|array $namespace)
Checks if class exists within the specified namespace.
in
HasValidators at line 164
HasValidators
colonNotation()
Ensures response is in colon notation format.
in
HasValidators at line 186
void
compositeFieldValidation(array|string $additionalFieldData, array $conditions, array $bind)
Tests form validation with multiple fields. Used by the unique validator to test several fields for uniqueness.
in
HasValidators at line 209
HasValidators
different(mixed $data)
Enforce rule where response and $match parameter needs to be different.
in
HasValidators at line 224
void
displayErrorMessages()
Displays a list of all error messages.
in
HasValidators at line 240
HasValidators
dotNotation()
Ensures response is in dot notation format.
in
HasValidators at line 257
HasValidators
email()
Ensures input is a valid E-mail address.
in
HasValidators at line 272
HasValidators
fieldName(string|array $fieldName)
Sets name of field to be validated.
in
HasValidators at line 288
void
includeDeleted(bool|string $includeDeleted, array $queryParams)
Supports includeDeleted feature for database operations.
in
HasValidators at line 299
HasValidators
integer()
Enforce rule where input must be an integer.
in
HasValidators at line 313
HasValidators
ip()
Enforce rule where input must be a valid IP address.
in
HasValidators at line 331
HasValidators
isPortUsed(array $attributes)
Checks if a port on a particular host is in use. Assists in verifying if a port is available for a serve command. If the port is already in use an error message is presented to the user.
in
HasValidators at line 360
HasValidators
list(array $attributes)
Ensure user inputs valid comma separated list of values. The user must provide the following in the $attributes parameter: 1) Class containing full namespaced path 2) Name of function that returns an array of strings or a comma separated array of strings.
3) A string value in this array as an alias (optional).
in
HasValidators at line 398
HasValidators
lower()
Enforces rule when input must contain at least one lower case character.
in
HasValidators at line 413
HasValidators
match(mixed $match)
Enforce rule where response and $match parameter needs to match.
in
HasValidators at line 428
HasValidators
max(int|array $maxRule)
Ensures input meets requirements for maximum allowable length.
in
HasValidators at line 444
HasValidators
min(int|array $minRule)
Ensures input meets requirements for minimum allowable length.
in
HasValidators at line 459
HasValidators
negative()
Enforces rule when input must be a negative number.
in
HasValidators at line 473
HasValidators
noSpecialChars()
Enforces rule when input must contain no special characters.
in
HasValidators at line 487
HasValidators
notReservedKeyword()
Enforce rule when reserved keywords should be avoided.
in
HasValidators at line 501
HasValidators
number()
Enforces rule when input must contain at least one numeric character.
in
HasValidators at line 515
HasValidators
numeric()
Enforce rule where input must contain only numeric characters.
in
HasValidators at line 537
static protected void
parseAttributes(object $object, array $validators)
Parse array containing additional validators or attributes for FrameworkQuestion as strings along with any additional parameters that maybe expected.
in
HasValidators at line 558
HasValidators
required()
Ensures required input is entered.
in
HasValidators at line 572
protected void
resetAfterValidation()
Resets fieldname and validators instance variables so duplicate messages are not displayed in forms.
in
HasValidators at line 582
HasValidators
positive()
Enforces rule when input must a positive number.
in
HasValidators at line 596
HasValidators
queue()
Validates if queue exists in database or redis.
in
HasValidators at line 621
HasValidators
setValidator(callable $validator)
Adds validator to array of validators to be used.
in
HasValidators at line 631
HasValidators
special()
Enforces rule when input must contain at least one special character.
in
HasValidators at line 645
HasValidators
tel()
Enforces rule where input must be a valid phone number.
in
HasValidators at line 669
HasValidators
testFilterNotation()
Ensures response is in colon notation format.
in
HasValidators at line 690
static protected array
tokens(string $data)
Split on commas (tolerate spaces), normalize to lowercase, drop empties.
Useful for cases where you have a comma separated string.
in
HasValidators at line 703
HasValidators
unique(array $attributes)
Checks if value already exists in a database.
in
HasValidators at line 747
HasValidators
upper()
Enforces rule when input must contain at least one lower case character.
in
HasValidators at line 761
HasValidators
url()
Enforce rule where input must be a valid URL.
in
HasValidators at line 777
protected bool
validate(mixed $response)
Calls validator callbacks. This function also ensures validators don't bleed into next question if instance is reused.
at line 65
__construct()
Default constructor.
at line 75
void
afterDelete()
Called before delete.
at line 82
void
afterSave()
Called before save.
at line 94
Model
assign(array $params, array $list = [], string $assignmentFilter = self::BLACKLIST)
Update the object with an associative array.
at line 117
void
beforeDelete()
This runs before delete, needs to return a boolean
at line 124
void
beforeSave()
Called after save.
at line 132
static int
count()
Retrieves number of rows affected or returned by the last query. This is a wrapper function for the DB::count function.
at line 141
stdClass
data()
Grab object and if we just need data for smaller result set.
at line 162
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.
at line 184
static array
getColumns()
Gets columns from table.
at line 194
array
getColumnsForSave()
Gets an associative array of field values for insert or updating.
at line 223
static DB
getDb()
Returns an instance of the DB class.
at line 236
array
getErrorMessages()
Displays error messages when form validation fails.
at line 246
static protected array
_fetchStyleParams(array $params)
Used to set default fetchStyle param.
at line 260
static array|bool
find(array $params = [])
Wrapper for the find function that is found in the DB class.
at line 274
static object|bool
findById(int $id)
Get result from database by primary key ID.
at line 290
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).
at line 306
static array
findAllByUserId(int $user_id, array $params = [])
Retrieves list of all records within a table related to a user.
at line 324
static object|bool
findFirst(array $params = [])
Wrapper for the findFirst function that is found in the DB class.
at line 339
static int
findTotal(array $params = [])
Returns number of records in a table. A wrapper function for findTotal function in DB class.
at line 354
bool
insert(array $fields)
Wrapper for database insert function.
at line 366
bool
isNew()
Checks if an object is a new insertion or an existing record.
at line 375
void
onConstruct()
Runs when the object is constructed.
at line 383
protected void
populateObjData(array|object $result)
Populates object with data.
at line 398
DB
query(string $sql, array $bind = [])
Wrapper for database query function.
at line 420
void
runValidation(bool|string $param, array $validators = [], string|null $fieldName = null)
Checks if results of validation is true or false. If false, the $this->_validates boolean instance variable is set to false. There are two ways to provide parameters for validation. You can pass the results from chaining functions and use just one parameter. Or you can provide the value of the field's name attribute, an array of validators, and a value for how you want the name of the field represented in error messages. If this value is not provided then the name attribute is used in messaging.
at line 443
bool
save()
Wrapper for update and insert functions. A failed form validation will cause this function to return false.
at line 484
static protected array
_softDeleteParams(array $params)
Adds to the conditions to avoid getting soft deleted rows returned
at line 513
bool
update(array $fields)
Wrapper for the update function found in the DB class.
at line 543
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]]
);
at line 553
bool
validationPassed()
Getter function for the $_validates boolean instance variable.
at line 564
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.