Notifications

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.

Ensures response is in colon notation format.

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.

Displays a list of all error messages.

Ensures response is in dot notation format.

Ensures input is a valid E-mail address.

Sets name of field to be validated.

Supports includeDeleted feature for database operations.

Enforce rule where input must be an integer.

Enforce rule where input must be a valid IP address.

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.

3) A string value in this array as an alias (optional).

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 be a negative number.

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.

Ensures required input is entered.

Resets fieldname and validators instance variables so duplicate messages are not displayed in forms.

Enforces rule when input must a positive number.

Validates if queue exists in database or redis.

Adds validator to array of validators to be used.

Enforces rule when input must contain at least one special character.

Enforces rule where input must be a valid phone number.

Ensures response is in colon notation format.

Split on commas (tolerate spaces), normalize to lowercase, drop empties.

Useful for cases where you have a comma separated string.

Checks if value already exists in a database.

Enforces rule when input must contain at least one lower case character.

Enforce rule where input must be a valid URL.

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

Implementation of beforeSave from base class.

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

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

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

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

Gets columns from table.

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

Returns an instance of the DB class.

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.

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).

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.

Wrapper for database query function.

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.

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]]
);

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.

Sets values for timestamp fields.

Mark notification record as read.

Mark notification record as read by id.

Permanently delete old notifications from this model's table.

Computes a UTC cutoff timestamp for the given number of days and issues a single parameterized DELETE against {\Core\Models\static::$_table}. When $onlyRead is true, only notifications that have been marked as read (read_at IS NOT NULL) are pruned; otherwise all notifications older than the cutoff are removed.

Performance note: add an index on created_at (and optionally (read_at, created_at)) to keep this operation fast on large tables.