class CEmailTypes


Located at : UKNOWVA_ROOT/components/com_community/libraries/emailtypes.php

Properties

$_emailtypes
$_adminonlygroups

Methods

CEmailTypes()

No description

isAdminOnlyGroup($group)

No description

getEmailTypes()

No description

loadDefault()

No description

addEmailType($groupKey, $EmailTypeID, $description = '', $value, $tips = '', $adminOnly = FALSE)

Function to add new email type.

addGroup($key, $description = '', $adminOnly = FALSE)

Function to add new email group.

removeGroup($key)

Function used to remove email group and its associated email types.

removeEmailType($groupKey, $EmailTypeID)

Function used to remove an email type param - groupKey : string - the key of the group - EmailTypeID : string - the unique key of the email type

convertToParamsString()

Function used to convert email types to params string

Details

at line 17
CEmailTypes()

at line 24
isAdminOnlyGroup($group)

Parameters

$group

at line 28
getEmailTypes()

at line 32
loadDefault()

at line 127
addEmailType($groupKey, $EmailTypeID, $description = '', $value, $tips = '', $adminOnly = FALSE)

Function to add new email type.

param - groupKey : string - the key of the group - EmailTypeID : string - the unique key of the email type - description : string - the label of the email type - value : int - the configured value (enable/disable) of the email type - tips : string - the tips of the email type

Parameters

$groupKey
$EmailTypeID
$description
$value
$tips
$adminOnly

at line 146
addGroup($key, $description = '', $adminOnly = FALSE)

Function to add new email group.

param - key : string - the key of the group - description : string - the label of the group name

Parameters

$key
$description
$adminOnly

at line 165
removeGroup($key)

Function used to remove email group and its associated email types.

param - key : string - the key of the group

Parameters

$key

at line 178
removeEmailType($groupKey, $EmailTypeID)

Function used to remove an email type param - groupKey : string - the key of the group - EmailTypeID : string - the unique key of the email type

Parameters

$groupKey
$EmailTypeID

at line 196
convertToParamsString()

Function used to convert email types to params string