MailSetting
Mail settings
class System\Models\MailSetting
extends ModelTraits
| Trait | Description |
|---|---|
Validation
|
Constants
| Constant | Type | Value | Description |
|---|---|---|---|
MODE_LOG
|
string |
"log"
|
string
"log"
|
MODE_MAIL
|
string |
"mail"
|
string
"mail"
|
MODE_SENDMAIL
|
string |
"sendmail"
|
string
"sendmail"
|
MODE_SMTP
|
string |
"smtp"
|
string
"smtp"
|
Properties
public
$implement
:
array
= [{}]
Behaviors implemented by this model.
public
$rules
:
mixed
= {"sender_name":"required","sender_email":"required|email"}
public
$settingsCode
:
string
= "system_mail_settings"
Unique code
public
$settingsFields
:
mixed
= "fields.yaml"
Settings form field defitions
protected
$validationDefaultAttrNames
:
array
= []
Default custom attribute names.
protected $validationErrors : Illuminate\Support\MessageBag
The message bag instance containing validation error messages
Methods
public static applyConfigValues ()
public
filterFields (array $fields, string | null $context = null)
: void
Filter fields callback.
We use this to automatically set the SMTP port to the encryption type's corresponding port, if it was originally using a default port.
| Property | Type | Description |
|---|---|---|
| $fields | array |
array
|
| $context | string | null |
string | null
|
public getSendModeOptions ()
public getSmtpEncryptionOptions () : array
smtp_encryption options values
public initSettingsData () : void
Initialize the seed data for this model. This only executes when the model is first created or reset to default.
public static bootValidation () : void
Boot the validation trait for this model.
public errors () : Illuminate\Support\MessageBag
Get validation error message collection for the Model
public
forceSave ($options = null, $sessionKey = null)
: bool
Force save the model even if validation fails.
| Property | Type | Description |
|---|---|---|
| $options | mixed |
mixed
|
| $sessionKey | mixed |
mixed
|
public
isAttributeRequired (string $attribute, boolean $checkDependencies = true)
: bool
Determines if an attribute is required based on the validation rules.
| Property | Type | Description |
|---|---|---|
| $attribute | string |
string
|
| $checkDependencies | boolean |
boolean
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 |
public setValidationAttributeName (string $attr, string $name) : void
Programatically sets the validation attribute names, will take lower priority
to model defined attribute names found in $attributeNames.
| Property | Type | Description |
|---|---|---|
| $attr | string |
string
|
| $name | string |
string
|
public setValidationAttributeNames (array $attributeNames) : void
Programatically sets multiple validation attribute names.
| Property | Type | Description |
|---|---|---|
| $attributeNames | array |
array
|
public
validate ($rules = null, $customMessages = null, $attributeNames = null)
: bool
Validate the model instance
| Property | Type | Description |
|---|---|---|
| $rules | mixed |
mixed
|
| $customMessages | mixed |
mixed
|
| $attributeNames | mixed |
mixed
|
public static validated (Closure | string $callback) : void
Create a new native event for handling afterValidate().
| Property | Type | Description |
|---|---|---|
| $callback | Closure | string |
Closure | string
|
public static validating (Closure | string $callback) : void
Create a new native event for handling beforeValidate().
| Property | Type | Description |
|---|---|---|
| $callback | Closure | string |
Closure | string
|
protected getRelationValidationValue ($relationName)
Attachments validate differently to their simple values.
| Property | Type | Description |
|---|---|---|
| $relationName | mixed |
mixed
|
protected getValidationAttributes () : array
Returns the model data used for validation.
protected
static
makeValidator ($data, $rules, $customMessages, $attributeNames, $connection = null)
: Illuminate\Contracts\Validation\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.
| Property | Type | Description |
|---|---|---|
| $data | mixed |
mixed
|
| $rules | mixed |
mixed
|
| $customMessages | mixed |
mixed
|
| $attributeNames | mixed |
mixed
|
| $connection | mixed |
mixed
|
protected processRuleFieldNames (array $rules) : array
Processes field names in a rule array.
Converts any field names using array notation (ie. field[child]) into dot notation (ie. field.child)
| Property | Type | Description |
|---|---|---|
| $rules | array |
array
Rules array |
protected processValidationRules ($rules)
Process rules
| Property | Type | Description |
|---|---|---|
| $rules | mixed |
mixed
|
protected processValidationUniqueRule (string $definition, string $fieldName) : string
Rebuilds the unique validation rule to force for the existing ID
| Property | Type | Description |
|---|---|---|
| $definition | string |
string
|
| $fieldName | string |
string
|