MailTemplate
        
        Mail template
    
    
 class System\Models\MailTemplate
extends ModelExtends
| Class | Description | 
|---|---|
| Model | 
Traits
| Trait | Description | 
|---|---|
| Validation | 
Properties
            
            
            
                public
            
            
            $belongsTo
            
                :
                                                            mixed
                                                                        
                        = {"layout":{}}
                    
                            
        
        
        
            
            
            
                public
            
            
            $rules
            
                :
                                                            array
                                                                        
                        = {"code":"required|unique:system_mail_templates","subject":"required","description":"required","content_html":"required"}
                    
                            
        
        
        Validation rules
            
            
            
                protected
            
            
            $fillable
            
                :
                                                            array
                                                                        
                        = []
                    
                            
        
        
        Fillable fields
            
            
            
                protected
            
            
            $guarded
            
                :
                                                            array
                                                                        
                        = []
                    
                            
        
        
        Guarded fields
            
            
            
                protected
            
            
            $table
            
                :
                                                            string
                                                                        
                        = "system_mail_templates"
                    
                            
        
        
        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 afterFetch () : void
Fired after the model has been fetched.
public static allTemplates () : array
Returns a list of all mail templates.
Returns an array of the MailTemplate objects.
public fillFromContent (string $content) : void
Fill model using provided content.
| Property | Type | Description | 
|---|---|---|
| $content | string | string | 
public fillFromView (string $path) : void
Fill model using a view file path.
| Property | Type | Description | 
|---|---|---|
| $path | string | string | 
public static findOrMakeTemplate (string $code) : MailTemplate
Find a MailTemplate record by code or create one from a view file.
| Property | Type | Description | 
|---|---|---|
| $code | string | string | 
model
public static listAllTemplates () : array
Returns an array of template codes and descriptions.
public static registerCallback (callable $callback)
| Property | Type | Description | 
|---|---|---|
| $callback | callable | callable | 
public static syncAll () : void
Syncronise all file templates to the database.
protected fillFromSections (array $sections) : void
Fill model using provided section array.
| Property | Type | Description | 
|---|---|---|
| $sections | array | array | 
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 |