MailLayout
Mail layout
class System\Models\MailLayout
extends Model
Extends
Class | Description |
---|---|
Model
|
Traits
Trait | Description |
---|---|
Validation
|
Properties
public static $codeCache : mixed
public
$rules
:
array
= {"code":"required|unique:system_mail_layouts","name":"required","content_html":"required"}
Validation rules
protected
$fillable
:
array
= []
Fillable fields
protected
$guarded
:
array
= []
Guarded fields
protected
$jsonable
:
array
= ["options"]
Options array
protected
$table
:
string
= "system_mail_layouts"
The database table used by the model.
inherited
protected
$validationDefaultAttrNames
:
array
= []
Default custom attribute names.
inherited protected $validationErrors : Illuminate\Support\MessageBag
The message bag instance containing validation error messages
Methods
public beforeDelete () : void
Fired before the model is deleted.
public static createLayouts () : void
Loops over each mail layout and ensures the system has a layout, if the layout does not exist, it will create one.
public
fillFromCode (string | null $code = null
)
: void
Fill model using a view file retrieved by code.
Property | Type | Description |
---|---|---|
$code | string | null |
string | null
|
public fillFromView (string $path) : void
Fill model using a view file retrieved by path.
Property | Type | Description |
---|---|---|
$path | string |
string
|
public static findOrMakeLayout (string $code) : MailLayout
Find a MailLayout instance by its code or create a new instance from the view file.
Property | Type | Description |
---|---|---|
$code | string |
string
|
public static getIdFromCode (string $code) : string
Return the ID of a MailLayout instance from a defined code.
Property | Type | Description |
---|---|---|
$code | string |
string
|
public static listCodes () : array
List MailLayouts codes keyed by ID.
protected static getTemplateSections (string $code) : array | null
Get section array from a view file retrieved by code.
Property | Type | Description |
---|---|---|
$code | string |
string
|
inherited public static bootValidation () : void
Boot the validation trait for this model.
inherited public errors () : Illuminate\Support\MessageBag
Get validation error message collection for the Model
inherited
public
forceSave ($options = null
, $sessionKey = null
)
: bool
Force save the model even if validation fails.
Property | Type | Description |
---|---|---|
$options | mixed |
mixed
|
$sessionKey | mixed |
mixed
|
inherited
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 |
inherited 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
|
inherited public setValidationAttributeNames (array $attributeNames) : void
Programatically sets multiple validation attribute names.
Property | Type | Description |
---|---|---|
$attributeNames | array |
array
|
inherited
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
|
inherited public static validated (Closure | string $callback) : void
Create a new native event for handling afterValidate().
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
inherited public static validating (Closure | string $callback) : void
Create a new native event for handling beforeValidate().
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
inherited protected getRelationValidationValue ($relationName)
Attachments validate differently to their simple values.
Property | Type | Description |
---|---|---|
$relationName | mixed |
mixed
|
inherited protected getValidationAttributes () : array
Returns the model data used for validation.
inherited
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
|
inherited 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 |
inherited protected processValidationRules ($rules)
Process rules
Property | Type | Description |
---|---|---|
$rules | mixed |
mixed
|
inherited 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
|