RuleCondition
extends Model
in package
Uses
Validation
RainLab\Notify\Models\RuleCondition
Tags
Table of Contents
- $belongsTo : mixed
- $class_name : string|null
- $condition_control_type : string|null
- $config_data : string|null
- $created_at : Carbon|null
- $hasMany : array<string|int, mixed>
- $id : int
- $rule_host_id : int|null
- $rule_host_type : string|null
- $rule_parent_id : int|null
- $rules : array<string|int, mixed>
- $table : string
- $updated_at : Carbon|null
- $fillable : array<string|int, mixed>
- $guarded : array<string|int, mixed>
- $jsonable : array<string|int, mixed>
- $validationDefaultAttrNames : array<string|int, mixed>
- $validationErrors : MessageBag
- afterFetch() : mixed
- afterSave() : mixed
- all() :
- applyConditionClass() : bool
- Extends this model with the condition class
- applyCustomData() : mixed
- beforeSave() : mixed
- bootValidation() : void
- Boot the validation trait for this model.
- errors() : MessageBag
- Get validation error message collection for the Model
- filterFields() : mixed
- forceSave() : bool
- Force save the model even if validation fails.
- get() :
- getConditionClass() : mixed
- getConditionObject() : mixed
- getRootConditionClass() : mixed
- getText() : mixed
- isAttributeRequired() : bool
- Determines if an attribute is required based on the validation rules.
- isCompound() : mixed
- newModelQuery() :
- newQuery() :
- query() :
- setValidationAttributeName() : void
- Programatically sets the validation attribute names, will take lower priority to model defined attribute names found in `$attributeNames`.
- setValidationAttributeNames() : void
- Programatically sets multiple validation attribute names.
- validate() : bool
- Validate the model instance
- validated() : void
- Create a new native event for handling afterValidate().
- validating() : void
- Create a new native event for handling beforeValidate().
- whereClassName() :
- whereConditionControlType() :
- whereConfigData() :
- whereCreatedAt() :
- whereId() :
- whereRuleHostId() :
- whereRuleHostType() :
- whereRuleParentId() :
- whereUpdatedAt() :
- getRelationValidationValue() : mixed
- Attachments validate differently to their simple values.
- getValidationAttributes() : array<string|int, mixed>
- Returns the model data used for validation.
- loadCustomData() : mixed
- makeValidator() : Validator
- Instantiates the validator used by the validation process, depending if the class is being used inside or outside of Laravel. Optional connection string to make the validator use a different database connection than the default connection.
- processRuleFieldNames() : array<string|int, mixed>
- Processes field names in a rule array.
- processValidationRules() : mixed
- Process rules
- processValidationUniqueRule() : string
- Rebuilds the unique validation rule to force for the existing ID
- setCustomData() : mixed
Properties
$belongsTo
public
mixed
$belongsTo
= ['parent' => [self::class, 'key' => 'rule_parent_id'], 'notification_rule' => [RainLabNotifyModelsNotificationRule::class, 'key' => 'rule_host_id']]
$class_name
public
string|null
$class_name
$condition_control_type
public
string|null
$condition_control_type
$config_data
public
string|null
$config_data
$created_at
public
Carbon|null
$created_at
$hasMany
public
array<string|int, mixed>
$hasMany
= ['children' => [self::class, 'key' => 'rule_parent_id', 'delete' => true]]
Relations
$id
public
int
$id
$rule_host_id
public
int|null
$rule_host_id
$rule_host_type
public
string|null
$rule_host_type
$rule_parent_id
public
int|null
$rule_parent_id
$rules
public
array<string|int, mixed>
$rules
= []
The rules to be applied to the data.
$table
public
string
$table
= 'rainlab_notify_rule_conditions'
The database table used by the model.
$updated_at
public
Carbon|null
$updated_at
$fillable
protected
array<string|int, mixed>
$fillable
= []
Fillable fields
$guarded
protected
array<string|int, mixed>
$guarded
= []
Guarded fields
$jsonable
protected
array<string|int, mixed>
$jsonable
= ['config_data']
List of attribute names which are json encoded and decoded from the database.
$validationDefaultAttrNames
protected
array<string|int, mixed>
$validationDefaultAttrNames
= []
Default custom attribute names.
$validationErrors
protected
MessageBag
$validationErrors
The message bag instance containing validation error messages
Methods
afterFetch()
public
afterFetch() : mixed
Return values
mixed —afterSave()
public
afterSave() : mixed
Return values
mixed —all()
public
static all(mixed $columns) :
Parameters
- $columns : mixed
Return values
—applyConditionClass()
Extends this model with the condition class
public
applyConditionClass([string $class = null ]) : bool
Parameters
- $class : string = null
-
Class name
Return values
bool —applyCustomData()
public
applyCustomData() : mixed
Return values
mixed —beforeSave()
public
beforeSave() : mixed
Return values
mixed —bootValidation()
Boot the validation trait for this model.
public
static bootValidation() : void
Return values
void —errors()
Get validation error message collection for the Model
public
errors() : MessageBag
Return values
MessageBag —filterFields()
public
filterFields(mixed $fields, mixed $context) : mixed
Parameters
- $fields : mixed
- $context : mixed
Return values
mixed —forceSave()
Force save the model even if validation fails.
public
forceSave([mixed $options = null ][, mixed $sessionKey = null ]) : bool
Parameters
- $options : mixed = null
- $sessionKey : mixed = null
Return values
bool —get()
public
static get(mixed $columns) :
Parameters
- $columns : mixed
Return values
—getConditionClass()
public
getConditionClass() : mixed
Return values
mixed —getConditionObject()
public
getConditionObject() : mixed
Return values
mixed —getRootConditionClass()
public
getRootConditionClass() : mixed
Return values
mixed —getText()
public
getText() : mixed
Return values
mixed —isAttributeRequired()
Determines if an attribute is required based on the validation rules.
public
isAttributeRequired(string $attribute[, bool $checkDependencies = true ]) : bool
Parameters
- $attribute : string
- $checkDependencies : bool = true
-
Checks the attribute dependencies (for required_if & required_with rules). Note that it will only be checked up to the next level, if another dependent rule is found then it will just assume the field is required
Return values
bool —isCompound()
public
isCompound() : mixed
Return values
mixed —newModelQuery()
public
static newModelQuery() :
Return values
—newQuery()
public
static newQuery() :
Return values
—query()
public
static query() :
Return values
—setValidationAttributeName()
Programatically sets the validation attribute names, will take lower priority to model defined attribute names found in `$attributeNames`.
public
setValidationAttributeName(string $attr, string $name) : void
Parameters
- $attr : string
- $name : string
Return values
void —setValidationAttributeNames()
Programatically sets multiple validation attribute names.
public
setValidationAttributeNames(array<string|int, mixed> $attributeNames) : void
Parameters
- $attributeNames : array<string|int, mixed>
Return values
void —validate()
Validate the model instance
public
validate([mixed $rules = null ][, mixed $customMessages = null ][, mixed $attributeNames = null ]) : bool
Parameters
- $rules : mixed = null
- $customMessages : mixed = null
- $attributeNames : mixed = null
Return values
bool —validated()
Create a new native event for handling afterValidate().
public
static validated(Closure|string $callback) : void
Parameters
- $callback : Closure|string
Return values
void —validating()
Create a new native event for handling beforeValidate().
public
static validating(Closure|string $callback) : void
Parameters
- $callback : Closure|string
Return values
void —whereClassName()
public
static whereClassName(mixed $value) :
Parameters
- $value : mixed
Return values
—whereConditionControlType()
public
static whereConditionControlType(mixed $value) :
Parameters
- $value : mixed
Return values
—whereConfigData()
public
static whereConfigData(mixed $value) :
Parameters
- $value : mixed
Return values
—whereCreatedAt()
public
static whereCreatedAt(mixed $value) :
Parameters
- $value : mixed
Return values
—whereId()
public
static whereId(mixed $value) :
Parameters
- $value : mixed
Return values
—whereRuleHostId()
public
static whereRuleHostId(mixed $value) :
Parameters
- $value : mixed
Return values
—whereRuleHostType()
public
static whereRuleHostType(mixed $value) :
Parameters
- $value : mixed
Return values
—whereRuleParentId()
public
static whereRuleParentId(mixed $value) :
Parameters
- $value : mixed
Return values
—whereUpdatedAt()
public
static whereUpdatedAt(mixed $value) :
Parameters
- $value : mixed
Return values
—getRelationValidationValue()
Attachments validate differently to their simple values.
protected
getRelationValidationValue(mixed $relationName) : mixed
Parameters
- $relationName : mixed
Return values
mixed —getValidationAttributes()
Returns the model data used for validation.
protected
getValidationAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —loadCustomData()
protected
loadCustomData() : mixed
Return values
mixed —makeValidator()
Instantiates the validator used by the validation process, depending if the class is being used inside or outside of Laravel. Optional connection string to make the validator use a different database connection than the default connection.
protected
static makeValidator(mixed $data, mixed $rules, mixed $customMessages, mixed $attributeNames[, mixed $connection = null ]) : Validator
Parameters
- $data : mixed
- $rules : mixed
- $customMessages : mixed
- $attributeNames : mixed
- $connection : mixed = null
Return values
Validator —processRuleFieldNames()
Processes field names in a rule array.
protected
processRuleFieldNames(array<string|int, mixed> $rules) : array<string|int, mixed>
Converts any field names using array notation (ie. field[child]) into dot notation (ie. field.child)
Parameters
- $rules : array<string|int, mixed>
-
Rules array
Return values
array<string|int, mixed> —processValidationRules()
Process rules
protected
processValidationRules(mixed $rules) : mixed
Parameters
- $rules : mixed
Return values
mixed —processValidationUniqueRule()
Rebuilds the unique validation rule to force for the existing ID
protected
processValidationUniqueRule(string $definition, string $fieldName) : string
Parameters
- $definition : string
- $fieldName : string
Return values
string —setCustomData()
protected
setCustomData() : mixed