Mail
extends Base
in package
Table of Contents
Properties
- $element : mixed
- $extension : mixed
- $fd : mixed
- $key : mixed
Methods
- __construct() : mixed
- generateIndex() : mixed
- Generates the index for the current model
- getBaseEmailTemplatesFolder() : mixed
- Retrieve the folder path of the base email templates
- getExcludedFiles() : mixed
- Retrieves a list of excluded email template files
- getFileObject() : mixed
- Retrieves a file object
- getFiles() : mixed
- Retrieves a list of email template files
- getFolder() : mixed
- Generates the path to an email template
- getForm() : mixed
- To satisfy the requirements from \JModelAdmin
- getOverrideFolder() : mixed
- Generates the path to the overriden folder
- getUserStateFromRequest() : mixed
- Get state from the current request
- reset() : mixed
- Reset the emails template file to it's original condition
- write() : mixed
- Saves contents
- populateState() : mixed
- Stock method to auto-populate the model state.
Properties
$element
protected
mixed
$element
= null
$extension
protected
mixed
$extension
= null
$fd
protected
mixed
$fd
= null
$key
protected
mixed
$key
= null
Methods
__construct()
public
__construct([mixed $config = [] ]) : mixed
Parameters
- $config : mixed = []
generateIndex()
Generates the index for the current model
public
final generateIndex([mixed $namespace = '' ]) : mixed
Parameters
- $namespace : mixed = ''
Tags
getBaseEmailTemplatesFolder()
Retrieve the folder path of the base email templates
public
static getBaseEmailTemplatesFolder([mixed $override = false ]) : mixed
Parameters
- $override : mixed = false
Tags
getExcludedFiles()
Retrieves a list of excluded email template files
public
getExcludedFiles() : mixed
By default is empty, need to use child class to override this method if there is for the extension
Tags
getFileObject()
Retrieves a file object
public
getFileObject(mixed $absolutePath[, mixed $contents = false ][, mixed $isBase = false ]) : mixed
Parameters
- $absolutePath : mixed
- $contents : mixed = false
- $isBase : mixed = false
Tags
getFiles()
Retrieves a list of email template files
public
getFiles([mixed $options = [] ]) : mixed
Parameters
- $options : mixed = []
Tags
getFolder()
Generates the path to an email template
public
getFolder([mixed $base = false ]) : mixed
Parameters
- $base : mixed = false
Tags
getForm()
To satisfy the requirements from \JModelAdmin
public
getForm([mixed $data = [] ][, mixed $loadData = true ]) : mixed
Parameters
- $data : mixed = []
- $loadData : mixed = true
Tags
getOverrideFolder()
Generates the path to the overriden folder
public
getOverrideFolder(mixed $file[, mixed $isBase = false ]) : mixed
Parameters
- $file : mixed
- $isBase : mixed = false
Tags
getUserStateFromRequest()
Get state from the current request
public
getUserStateFromRequest(mixed $key[, mixed $default = '' ][, mixed $type = 'none' ]) : mixed
Parameters
- $key : mixed
- $default : mixed = ''
- $type : mixed = 'none'
Tags
reset()
Reset the emails template file to it's original condition
public
reset(mixed $file) : mixed
Parameters
- $file : mixed
Tags
write()
Saves contents
public
write(mixed $path, mixed $contents) : mixed
Parameters
- $path : mixed
- $contents : mixed
Tags
populateState()
Stock method to auto-populate the model state.
protected
populateState() : mixed