Admin_GenericEmailingManager Class Reference

Admin_GenericEmailingManager Module
Manage contact lists, and send emailings. More...

Inheritance diagram for Admin_GenericEmailingManager:

Public Member Functions
	__construct ($path_type)
	install ()
	uninstall ()
	is_installed ()
	update ($version, $more='')
	get_adminEngineSpecificMenus ()
	get_adminEngineSpecificMenuItems ()
	get_rights ()
	init_admin ()
	execute_request ()
	get_emailingStatusList ()
	get_emailingsStatusList ($more=false)
	get_emailingStatusIconList ($more=false)
	get_contactStatusList ()
	get_contactsStatusList ($more=false)
	get_contactStatusIconList ($more=false)
	get_contactGroupList ($all=false, $other=false)
	get_contactIdList ($params=array())
	add_contact ($params=array())
	load_additionalDictionnary ()
	initialise_configDisplay ()
	display_configDisplay ()
	initialise_configEdition ($form)
	display_configEdition ()
	save_configuration ()
	get_legalMentionsData ()
Public Member Functions inherited from Module
	__construct ($name, $path_type)
	Module ($name, $path_type)
	get_help ()
	display_help ()
	set_theme ($theme)
	get_translation ($value, $data=array())
	get_adminEditionLanguage ()
	get_contentList ()
	preInit_admin ()
	display_admin ()
	init_parent_admin ()
	get_adminLink ($params=array(), $module=null)
	get_adminJSLink ($params=array(), $module=null)
	init_site ($content=1, $params=array(), $index=null)
	display_site ()
	set_selectedLayout ($layout='', $location='')
	get_adminLayout ($layout='')
	get_siteLayout ()
	get_adminEngineGenericMenus ()
	get_adminEngineGenericMenuItems ()
	get_adminEngineGenericInit ()
	get_adminEngineGenericDisplay ()
	get_adminInternalNotifications ()
	get_adminControlPanelAction ()
	get_adminStatisticsValueTitles ($list, $object=null)
	get_adminStatisticsSpecificOptions ($object=null)
	check_right ($info)
	get_fileInputButtons ($buttons=array(), $delete=true)
	get_dateInputButtons ($update=true, $reset=true)
	init_generic ()
Public Member Functions inherited from Plugin
	__construct ($name, $plugin_type, $path_type)
	get_version ()
	load_library ($library='')
	load_file ($file='')
	load_varFile ($file='')
	load_engineFile ($file='')
	get_engineFileURL ($file='', $path=false)
	get_fileURL ($file='', $path=null, $default='')
	get_varFileURL ($file='', $path=false, $default='')
	get_filePath ($file='')
	get_varFilePath ($file='')
	add_JSFile ($file)
	add_JSEngineFile ($file)
	add_JSExternFile ($file)
	add_JSScript ($script, $unique=false)
	add_JSPreScript ($script, $unique=false)
	add_JSWindowEventScript ($event, $script, $unique=false)
	add_JSLoadScript ($script, $unique=false)
	add_JSUnloadScript ($script, $unique=false)
	add_styleFile ($file, $media='', $condition='')
	add_styleScript ($css)
	add_styleIncludedFile ($file)
	add_StyleExternFile ($file, $media='', $condition='')
	set_RSSFeed ($title, $url)
	add_headerExtra ($content='')
	add_translation ($more='', $lg=null)
	get_languages ()
	execute_onCaMykSInitialise ()
	execute_onCaMykSPageLoad ()
	execute_onCaMykSBodyOpen ()
	execute_onCaMykSBodyClose ()
	execute_onCaMykSAdminPageLoad ()
	execute_onCaMykSAdminBodyOpen ()
	execute_onCaMykSAdminBodyClose ()
	execute_onCaMykSTerminate ()
	get_requestLink ($params=array())
	get_requestJSLink ($params=array())
	get_varFile ($file)

Public Attributes
	$contactItem
	Contact object. More...
	$emailingItem
	Emailing object. More...
Public Attributes inherited from Module
	$type
	Module type, can be admin or content. More...
	$title
	Module title. More...
	$libdesc
	Module library description. More...
	$theme
	Theme applied to the Module. More...
	$languages
	Module available locale files. More...
	$rights = array()
	Module permissions. More...
	$selected_layout = ''
	Module layout to use. More...
	$selected_layout_location = 'module'
	Module layout location, can be module or camyks. More...
	$help = null
	Module help files. More...
	$is_editable = true
	Module has editable content. More...
Public Attributes inherited from Plugin
	$name
	Plugin name. More...
	$version
	Plugin version. More...
	$active = false
	Plugin installation status. More...
	$plugin_package = ''
	Plugin package. More...
	$plugin_type
	Plugin type. More...
	$object_type
	Plugin type. More...
	$plugin_path
	Plugin path. More...
	$plugin_site_path
	Plugin site path (for element overwriting). More...
	$plugin_var_path
	Plugin var path. More...
	$plugin_url
	Plugin URL. More...
	$plugin_site_url
	Plugin site URL (for element overwriting). More...
	$plugin_var_url
	Plugin var URL. More...
	$path_type
	Plugin path type. More...
	$author_name
	Plugin author name. More...
	$author_mail
	Plugin author email. More...
	$author_group
	Plugin author group. More...
	$plugin_dependencies = array()
	Plugin dependencies. More...

Protected Attributes
	$contactList = null
	Contact list. More...
	$emailingList = null
	Emailing list. More...
	$emailItem
	Email object. More...
	$emailList = null
	Email list. More...
	$config
	Configuration object. More...
	$maxFileSize = 8
	Maximum upload file size in Mb/Mo. More...
	$extensions = null
	List of plugin extensions. More...
Protected Attributes inherited from Module
	$libs = array()
	Module libraries to load. More...
	$text = ''
	Module admin message. More...

Private Member Functions
	init_admin_main ()
	init_admin_edit_config ()
	init_admin_save_config ()
	init_admin_view_emailing ()
	init_admin_edit_emailing ()
	init_admin_save_emailing ()
	init_admin_delete_emailing ()
	init_admin_reset_emailing ()
	init_admin_send_emailing ()
	init_admin_edit_contact ()
	init_admin_save_contact ()
	init_admin_delete_contact ()
	init_admin_delete_email ()
	init_admin_mark_email ()
	init_admin_import_contactsPrepare ()
	init_admin_import_contactsCheckAndConfigure ()
	init_admin_import_contactsExecute ()
	execute_request_previewEmailing ($params=null)
	execute_request_unsubscribeContact ($params)
	execute_request_exportEmailingResults ()
	execute_request_exportContactList ()
	execute_request_exportContactListXLSX ()
	execute_request_sendEmailingInitialise ()
	execute_request_sendEmailingExecute ()
	execute_request_sendEmailingFinalise ()
	execute_request_setEmailAsOpened ($params)
	execute_request_openEmailLink ($params)
	execute_request_importContactInitialise ()
	execute_request_importContactExecute ()
	execute_request_importContactFinalise ()
	get_emailingStatisticsSummary ($emailing)
	get_contactList ($params=array())
	get_contactSourceList ()
	count_contacts ($params=array())
	get_contactEmailList ($params=array())
	mark_contactAsInvalid ($contactId, $source)
	load_registeredExtensions ()
	install_htaccessRules ()
	update_toVersion1_0_1 ()

Additional Inherited Members
Protected Member Functions inherited from Module
	init_admin_accessDenied ()
	init_admin_pageAccessDenied ()
	init_admin_actionNotAllowed ()
	init_admin_missingPlugin ($type, $name)
	disable_adminEngineMenus ()
	add_moduleContentToPage ($pageId, $moduleIndex, $contentId)
	get_PHPLibs ()
Protected Member Functions inherited from Plugin
	set_redirect ($time, $url='')
	add_meta ($name, $content, $method='name')
	add_toHtaccess ($content='')
	add_dependency ($plugin, $type, $version='1.0', $mandatory=false)
	set_dependencies ()
	register_asSharedObject ($name)
&	get_sharedObject ($name)
	register_asExtension ($plugin)
	get_registeredExtensions ()
	register_asCaMykSEventHandler ($event)

Detailed Description

Admin_GenericEmailingManager Module
Manage contact lists, and send emailings.

Plugin, Module Engine

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.8.2

Date

Creation: Dec 2012

Modification: Nov 2022

Copyright

2012 - 2022 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Requires XLSXReader from https://github.com/gneustaetter/XLSXReader to import xlsx data

Requires PHP_XLSXWriter from https://github.com/Dj1b/PHP_XLSXWriter to export xlsx data Admin_GenericEmailingManager class.

Constructor & Destructor Documentation

__construct()

Admin_GenericEmailingManager::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

install()

Admin_GenericEmailingManager::install

(

)

Install module.

Returns

boolean success

Reimplemented from Plugin.

uninstall()

Admin_GenericEmailingManager::uninstall

(

)

Unintall module.

Returns

boolean success

Reimplemented from Plugin.

is_installed()

Admin_GenericEmailingManager::is_installed

(

)

Check module installation.

Returns

boolean result

Reimplemented from Plugin.

update()

Admin_GenericEmailingManager::update	(		$version,
			$more = ''
	)

Update plugin.

Returns

boolean

Reimplemented from Plugin.

get_adminEngineSpecificMenus()

Admin_GenericEmailingManager::get_adminEngineSpecificMenus

(

)

Register a menu in admin interface.

Returns

array

Reimplemented from Module.

get_adminEngineSpecificMenuItems()

Admin_GenericEmailingManager::get_adminEngineSpecificMenuItems

(

)

Register menu items in admin interface.

Returns

array

Reimplemented from Module.

get_rights()

Admin_GenericEmailingManager::get_rights

(

)

Return module rights.

Returns

void

Reimplemented from Module.

init_admin()

Admin_GenericEmailingManager::init_admin

(

)

Initialise module object in admin mode.

Returns

void

Reimplemented from Module.

execute_request()

Admin_GenericEmailingManager::execute_request

(

)

Execute module object in request mode.

Returns

void

Reimplemented from Plugin.

init_admin_main()

Admin_GenericEmailingManager::init_admin_main ( )

private

Initialise module object in admin/main mode.

Returns

void

init_admin_edit_config()

Admin_GenericEmailingManager::init_admin_edit_config ( )

private

Initialise module object in admin/edit_config mode.

Returns

void

init_admin_save_config()

Admin_GenericEmailingManager::init_admin_save_config ( )

private

Initialise module object in admin/save_config mode.

Returns

void

init_admin_view_emailing()

Admin_GenericEmailingManager::init_admin_view_emailing ( )

private

Initialise module object in admin/view_emailing mode.

Returns

void

init_admin_edit_emailing()

Admin_GenericEmailingManager::init_admin_edit_emailing ( )

private

Initialise module object in admin/edit_emailing mode.

Returns

void

init_admin_save_emailing()

Admin_GenericEmailingManager::init_admin_save_emailing ( )

private

Initialise module object in admin/save_emailing mode.

Returns

void

init_admin_delete_emailing()

Admin_GenericEmailingManager::init_admin_delete_emailing ( )

private

Initialise module object in admin/delete_emailing mode.

Returns

void

init_admin_reset_emailing()

Admin_GenericEmailingManager::init_admin_reset_emailing ( )

private

Initialise module object in admin/reset_emailing mode.

Returns

void

init_admin_send_emailing()

Admin_GenericEmailingManager::init_admin_send_emailing ( )

private

Initialise module object in admin/send_emailing mode.

Returns

void

init_admin_edit_contact()

Admin_GenericEmailingManager::init_admin_edit_contact ( )

private

Initialise module object in admin/edit_contact mode

Returns

void

init_admin_save_contact()

Admin_GenericEmailingManager::init_admin_save_contact ( )

private

Initialise module object in admin/save_contact mode.

Returns

void

init_admin_delete_contact()

Admin_GenericEmailingManager::init_admin_delete_contact ( )

private

Initialise module object in admin/delete_contact mode.

Returns

void

init_admin_delete_email()

Admin_GenericEmailingManager::init_admin_delete_email ( )

private

Initialise module object in admin/delete_email mode.

Returns

void

init_admin_mark_email()

Admin_GenericEmailingManager::init_admin_mark_email ( )

private

Initialise module object in admin/mark_email mode.

Returns

void

init_admin_import_contactsPrepare()

Admin_GenericEmailingManager::init_admin_import_contactsPrepare ( )

private

Initialise module object in admin/import_contactsPrepare mode.

Returns

void

init_admin_import_contactsCheckAndConfigure()

Admin_GenericEmailingManager::init_admin_import_contactsCheckAndConfigure ( )

private

Initialise module object in admin/import_contactsCheckAndConfigure mode.

Returns

void

init_admin_import_contactsExecute()

Admin_GenericEmailingManager::init_admin_import_contactsExecute ( )

private

Initialise module object in admin/import_contactsExecute mode.

Returns

void

execute_request_previewEmailing()

Admin_GenericEmailingManager::execute_request_previewEmailing (   $params = null )

private

Execute module object in request / preview mode.

Parameters

array

$params

Returns

void

execute_request_unsubscribeContact()

Admin_GenericEmailingManager::execute_request_unsubscribeContact (   $params )

private

Execute module object in request / unsubscribe mode.

Returns

void

execute_request_exportEmailingResults()

Admin_GenericEmailingManager::execute_request_exportEmailingResults ( )

private

Execute module object in request / export emailing results mode.

Returns

void

execute_request_exportContactList()

Admin_GenericEmailingManager::execute_request_exportContactList ( )

private

Execute module object in request / export contact list as XLS mode.

Returns

void

execute_request_exportContactListXLSX()

Admin_GenericEmailingManager::execute_request_exportContactListXLSX ( )

private

Execute module object in request / export contact list as XLSX mode.

Returns

void

execute_request_sendEmailingInitialise()

Admin_GenericEmailingManager::execute_request_sendEmailingInitialise ( )

private

Execute module object in request / send_emailingInitialise mode.

Returns

void

execute_request_sendEmailingExecute()

Admin_GenericEmailingManager::execute_request_sendEmailingExecute ( )

private

Execute module object in request / send_emailingExecute mode.

Returns

void

execute_request_sendEmailingFinalise()

Admin_GenericEmailingManager::execute_request_sendEmailingFinalise ( )

private

Execute module object in request / send_emailingFinalise mode.

Returns

void

execute_request_setEmailAsOpened()

Admin_GenericEmailingManager::execute_request_setEmailAsOpened (   $params )

private

Execute module object in request / setEmailAsOpened mode.

Parameters

array

$params

Returns

void

execute_request_openEmailLink()

Admin_GenericEmailingManager::execute_request_openEmailLink (   $params )

private

Execute module object in request / openEmailLink mode.

Parameters

array

$params

Returns

void

execute_request_importContactInitialise()

Admin_GenericEmailingManager::execute_request_importContactInitialise ( )

private

Execute module object in request / import_contactInitialise mode.

Returns

void

execute_request_importContactExecute()

Admin_GenericEmailingManager::execute_request_importContactExecute ( )

private

Execute module object in request / import_contactExecute mode.

Returns

void

execute_request_importContactFinalise()

Admin_GenericEmailingManager::execute_request_importContactFinalise ( )

private

Execute module object in request / import_contactFinalise mode.

Returns

void

get_emailingStatusList()

Admin_GenericEmailingManager::get_emailingStatusList

(

)

Return emailing status list.

Returns

array

get_emailingsStatusList()

Admin_GenericEmailingManager::get_emailingsStatusList

(

$more = false

)

Return emailings status list.

Parameters

boolean

$more

Returns

array

get_emailingStatusIconList()

Admin_GenericEmailingManager::get_emailingStatusIconList

(

$more = false

)

Return emailing status icon list.

Parameters

boolean

$more

Returns

array

get_emailingStatisticsSummary()

Admin_GenericEmailingManager::get_emailingStatisticsSummary (   $emailing )

private

Return emailing statistics summary.

Parameters

integer

$emailing

Returns

array

get_contactStatusList()

Admin_GenericEmailingManager::get_contactStatusList

(

)

Return contact status list.

Returns

array

get_contactsStatusList()

Admin_GenericEmailingManager::get_contactsStatusList

(

$more = false

)

Return contacts status list.

Parameters

boolean

$more

Returns

array

get_contactStatusIconList()

Admin_GenericEmailingManager::get_contactStatusIconList

(

$more = false

)

Return contact status icon list.

Parameters

boolean

$more

Returns

array

get_contactList()

Admin_GenericEmailingManager::get_contactList (   $params = array() )

private

Return contact list.

Parameters

array

$params

Returns

array

get_contactGroupList()

Admin_GenericEmailingManager::get_contactGroupList	(		$all = false,
			$other = false
	)

Return contact group list.

Parameters

boolean	$all
boolean	$other

Returns

array

get_contactSourceList()

Admin_GenericEmailingManager::get_contactSourceList ( )

private

Return contact source list.

Returns

array $params

count_contacts()

Admin_GenericEmailingManager::count_contacts (   $params = array() )

private

Return contact count

Parameters

array

$params

Returns

array

get_contactIdList()

Admin_GenericEmailingManager::get_contactIdList

(

$params = array()

)

Return contact id list.

Parameters

array

$params

Returns

array

get_contactEmailList()

Admin_GenericEmailingManager::get_contactEmailList (   $params = array() )

private

Return contact email list.

Parameters

array

$params

Returns

array

mark_contactAsInvalid()

Admin_GenericEmailingManager::mark_contactAsInvalid (   $contactId,   $source  )

private

Mark contact as invalid

Parameters

integer	$contactId
string	$source

Returns

boolean success

add_contact()

Admin_GenericEmailingManager::add_contact

(

$params = array()

)

Add contact information.

Parameters

array

$params

Returns

boolean success

load_registeredExtensions()

Admin_GenericEmailingManager::load_registeredExtensions ( )

private

Load extensions list.

Returns

void

load_additionalDictionnary()

Admin_GenericEmailingManager::load_additionalDictionnary

(

)

Load additional dictionnary.

Returns

void

install_htaccessRules()

Admin_GenericEmailingManager::install_htaccessRules ( )

private

Install .htaccess rules.

Returns

boolean success

initialise_configDisplay()

Admin_GenericEmailingManager::initialise_configDisplay

(

)

Initialise object in Admin_Site, view configuration mode.

Returns

void

display_configDisplay()

Admin_GenericEmailingManager::display_configDisplay

(

)

Display object in Admin_Site, view configuration mode.

Returns

void

initialise_configEdition()

Admin_GenericEmailingManager::initialise_configEdition

(

$form

)

Initialise object in Admin_Site, edit configuration mode.

Parameters

Object

$form

Returns

void

display_configEdition()

Admin_GenericEmailingManager::display_configEdition

(

)

Display object in Admin_Site, edit configuration mode

Returns

void

save_configuration()

Admin_GenericEmailingManager::save_configuration

(

)

Execute object in Admin_Site, save configuration mode

Returns

void

get_legalMentionsData()

Admin_GenericEmailingManager::get_legalMentionsData

(

)

Return legal mentions data.

Returns

array

update_toVersion1_0_1()

Admin_GenericEmailingManager::update_toVersion1_0_1 ( )

private

Apply version 1.0.1 update.

Returns

boolean success

Member Data Documentation

$contactItem

Admin_GenericEmailingManager::$contactItem

Contact object.

var Object $contactItem

$contactList

Admin_GenericEmailingManager::$contactList = null

protected

Contact list.

var array $contactList

$emailingItem

Admin_GenericEmailingManager::$emailingItem

Emailing object.

var Object $emailingItem

$emailingList

Admin_GenericEmailingManager::$emailingList = null

protected

Emailing list.

var array $emailingList

$emailItem

Admin_GenericEmailingManager::$emailItem

protected

Email object.

var Object $emailItem

$emailList

Admin_GenericEmailingManager::$emailList = null

protected

Email list.

var array $emailList

$config

Admin_GenericEmailingManager::$config

protected

Configuration object.

var Object $config

$maxFileSize

Admin_GenericEmailingManager::$maxFileSize = 8

protected

Maximum upload file size in Mb/Mo.

var integer $maxFileSize

$extensions

Admin_GenericEmailingManager::$extensions = null

protected

List of plugin extensions.

var array $extensions

---

The documentation for this class was generated from the following file:

• CaMykS/plugin/module/Admin_GenericEmailingManager/Admin_GenericEmailingManager.php.inc