Documentation

EasyBlogModelSpools extends Mail
in package

Table of Contents

Properties

$_data  : mixed
$_pagination  : mixed
$_total  : mixed
$element  : mixed
$extension  : mixed
$fd  : mixed
$key  : mixed

Methods

__construct()  : mixed
_buildQuery()  : string
Method to build the query for the tags
_buildQueryOrderBy()  : mixed
_buildQueryWhere()  : mixed
generateIndex()  : mixed
Generates the index for the current model
getBaseEmailTemplatesFolder()  : mixed
Retrieve the folder path of the base email templates
getData()  : array<string|int, mixed>
Method to get categories item data
getExcludedFiles()  : mixed
Retrieves a list of excluded email template files for EasyBlog
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
getPagination()  : int
Method to get a pagination object for the categories
getTotal()  : int
Method to get the total nr of the categories
getUserStateFromRequest()  : mixed
Get state from the current request
purge()  : mixed
Purges all emails from the system
removeUserEmailActivities()  : mixed
Delete particular user email activities
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

$_data

protected mixed $_data = \null

$_pagination

protected mixed $_pagination = \null

$_total

protected mixed $_total = \null

$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

_buildQuery()

Method to build the query for the tags

public _buildQuery([mixed $publishedOnly = false ][, mixed $isCount = false ]) : string
Parameters
$publishedOnly : mixed = false
$isCount : mixed = false
Tags
access

private

Return values
string

_buildQueryOrderBy()

public _buildQueryOrderBy() : mixed

_buildQueryWhere()

public _buildQueryWhere() : mixed

generateIndex()

Generates the index for the current model

public final generateIndex([mixed $namespace = '' ]) : mixed
Parameters
$namespace : mixed = ''
Tags
since
1.1.0
access

private

getBaseEmailTemplatesFolder()

Retrieve the folder path of the base email templates

public static getBaseEmailTemplatesFolder([mixed $override = false ]) : mixed
Parameters
$override : mixed = false
Tags
since
1.0.0
access

public

getData()

Method to get categories item data

public getData([mixed $usePagination = true ]) : array<string|int, mixed>
Parameters
$usePagination : mixed = true
Tags
access

public

Return values
array<string|int, mixed>

getExcludedFiles()

Retrieves a list of excluded email template files for EasyBlog

public getExcludedFiles() : mixed
Tags
since
6.0.0
access

public

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
since
1.1.2
access

public

getFiles()

Retrieves a list of email template files

public getFiles([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Tags
since
1.1.2
access

public

getFolder()

Generates the path to an email template

public getFolder([mixed $base = false ]) : mixed
Parameters
$base : mixed = false
Tags
since
5.1
access

public

getForm()

To satisfy the requirements from \JModelAdmin

public getForm([mixed $data = [] ][, mixed $loadData = true ]) : mixed
Parameters
$data : mixed = []
$loadData : mixed = true
Tags
since
1.1.0
access

public

getOverrideFolder()

Generates the path to the overriden folder

public getOverrideFolder(mixed $file[, mixed $isBase = false ]) : mixed
Parameters
$file : mixed
$isBase : mixed = false
Tags
since
1.1.2
access

public

getPagination()

Method to get a pagination object for the categories

public getPagination() : int
Tags
access

public

Return values
int

getTotal()

Method to get the total nr of the categories

public getTotal() : int
Tags
access

public

Return values
int

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
since
1.1.0
access

public

purge()

Purges all emails from the system

public purge([mixed $type = '' ]) : mixed
Parameters
$type : mixed = ''
Tags
since
4.0
access

public

@return

removeUserEmailActivities()

Delete particular user email activities

public removeUserEmailActivities([mixed $recipientEmail = '' ]) : mixed
Parameters
$recipientEmail : mixed = ''
Tags
since
5.2
access

public

reset()

Reset the emails template file to it's original condition

public reset(mixed $file) : mixed
Parameters
$file : mixed
Tags
since
1.1.5
access

public

write()

Saves contents

public write(mixed $path, mixed $contents) : mixed
Parameters
$path : mixed
$contents : mixed
Tags
since
1.1.2
access

public

populateState()

Stock method to auto-populate the model state.

protected populateState() : mixed
Tags
since
1.1.2
access

protected


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results