Admin_GenericEmailingManagerContact Class Reference

Admin_GenericEmailingManager Module, contact library. More...

Inheritance diagram for Admin_GenericEmailingManagerContact:

Public Member Functions
	__construct ($id, &$module)
	build_SQLCondition ($params)
	check_data ()
	get_statusList ()
	get_multiStatusList ($more=false)
	get_statusIconList ()
	get_groupList ($all=false, $other=false)
	get_groupTitle ($group)
	get_itemsAsMailParams ()
	get_list ($params=array())
	count ($params=array())
	get_idList ($params=array())
	get_emailList ($params=array())
	get_fullNameList ($params=array())
	get_fromEmail ($email, $id=false)
	get_fromFullName ($firstname, $lastname)
	update_asUnsubscribed ($email)
	mark_asInvalid ()
	get_fullName ($default='')
	add_object ($params=array())
Public Member Functions inherited from ModuleLibrary
	__construct ($id, &$module, $wf_version=false)
	ModuleLibrary ($id, &$module, $wf_version=false)
	init_library ()
	initialise ()
	get ($language=true)
	get_fromHeader ($prefix='')
	save ()
	delete ()
	reset ()
	install ()
	uninstall ()
	is_installed ()
	is_marked ()
&	get_newObject ($id=0)
	get_databaseItems ()
	save_databaseItems ()
	delete_databaseItems ()
	reset_databaseItems ()
	install_databaseItems ()
	uninstall_databaseItems ()
	check_databaseInstallation ()
	get_objectList_databaseItemsSQLQuery ($where='', $limit=-1, $count=-1, $order='id', $sens='')
	update_databaseSpecificItems ($updatedItems)
	get_databaseLocalisedItems ()
	save_databaseLocalisedItems ()
	delete_databaseLocalisedItems ()
	reset_databaseLocalisedItems ()
	install_databaseLocalisedItems ()
	get_objectList_databaseLocalisedItemsSQLQuery ($ids)
	get_allDatabaseItems ($language)
	get_objectList_allDatabaseItemsSQLQuery ($language, $where='', $limit=-1, $count=-1, $order='id', $sens='')
	get_textItems ($language=null)
	save_textItems ()
	delete_textItems ()
	reset_textItems ()
	install_textItems ()
	get_fileItems ($language=null)
	save_fileItems ()
	delete_fileItems ()
	reset_fileItems ()
	install_fileItems ()
	get_tempItems ()
	get_fromArray ($data, $match=null, $onlyAvailable=false)
	get_fromItems ()
	load_fromSession ($name='ObjectData', $onlyAvailable=false)
	save_toSession ($name='ObjectData')
	delete_fromSession ($name='ObjectData')
	get_fileURL ($file, $full=true, $default='')
	load_file ($file)
	get_varFileURL ($file, $full=true, $default='')
	load_varFile ($file)
	get_translation ($str, $args=null)
	get_objectList ($language=false, $where='', $limit=-1, $count=-1, $order='id', $sens='')
	get_objectIdList ($language=false, $where='', $orderBy='', $orderWay='asc')
	get_nameList ($element='name', $where='', $language='', $orderBy='', $orderWay='asc')
	get_objectCount ($where='', $language=false)
	get_uniqueItemList ($element='name', $where='', $structured=false)
	execute_DBQuery ($sql='', $line=-1, $file='', $resName=null)
	execute_DBMultiQueries ($sql='', $line=-1, $file='', $resName=null)
	get_DBQueryGeneratedId ($resName=null)
	get_DBQueryDataLine ($resName=null)
	get_DBQueryNumDataLine ($resName=null)
	get_DBQueryError ($resName=null)
	get_DBQueryAffectedRows ($resName=null)
	escape_string ($string)
	get_DBInsertExtra ()
	create_DBTable ($name, $fields, $charset='utf8')

Private Member Functions
	build_whereStatement ($params=array())
	_check_existingEmail ($email=null)

Additional Inherited Members
Public Attributes inherited from ModuleLibrary
	$object_type = 'ModuleLibrary'
	Object type. More...
	$_libName
	Object name. More...
	$_libParent
	Parent module. More...
	$_libItems = array()
	Object item list. More...
	$_libItemTypes = array('db' => array(), 'dbl' => array(), 'text' => array(), 'file' => array(), 'temp' => array())
	Object item list by type. More...
	$_libSQLTable
	Object table name in database. More...
	$_libSQLLocaleTable
	$_libDesc
	Library description. More...
	$_libError
	Last error. More...
	$_libIsInstalled = null
	$id
	Object instance id. More...
	$vars = array()
	Object item values. More...
Protected Member Functions inherited from ModuleLibrary
	add_newItem ($name, $itemtype, $info0, $info1, $info2, $default=null, $localised=false)
	insert_multiObjectsDatabaseItems ($keys, $values)
	check_SQLCondition ($where, $localeOnly=false)
	build_SQLOrderByStatement ($order, $way='')
Protected Attributes inherited from ModuleLibrary
	$_libParentFile
	Object library file. More...
	$_libDBConnector
	Database connection. More...

Detailed Description

Admin_GenericEmailingManager Module, contact library.

Plugin, Module Library

Author

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

Version

1.0.3

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. Admin_GenericEmailingManagerContact class.

Constructor & Destructor Documentation

__construct()

Admin_GenericEmailingManagerContact::__construct	(		$id,
		&	$module
	)

Class constructor.

Parameters

integer	$id
Module	$module

Returns

void

Member Function Documentation

build_SQLCondition()

Admin_GenericEmailingManagerContact::build_SQLCondition

(

$params

)

Build sql condition for lists.

Parameters

array

$params

Returns

string

Reimplemented from ModuleLibrary.

check_data()

Admin_GenericEmailingManagerContact::check_data

(

)

Check object data.

Returns

boolean success

Reimplemented from ModuleLibrary.

get_statusList()

Admin_GenericEmailingManagerContact::get_statusList

(

)

Return object status list.

Returns

array

get_multiStatusList()

Admin_GenericEmailingManagerContact::get_multiStatusList

(

$more = false

)

Return objects status list.

Parameters

boolean

$more

Returns

array

get_statusIconList()

Admin_GenericEmailingManagerContact::get_statusIconList

(

)

Return object status list.

Returns

array

get_groupList()

Admin_GenericEmailingManagerContact::get_groupList	(		$all = false,
			$other = false
	)

Return object group list.

Parameters

boolean	$all
boolean	$other

Returns

array

get_groupTitle()

Admin_GenericEmailingManagerContact::get_groupTitle

(

$group

)

Return object category title.

Parameters

integer

$group

Returns

string

get_itemsAsMailParams()

Admin_GenericEmailingManagerContact::get_itemsAsMailParams

(

)

Return object items as mail params.

Returns

array

get_list()

Admin_GenericEmailingManagerContact::get_list

(

$params = array()

)

Return object list.

Parameters

array

$params

Returns

array

count()

Admin_GenericEmailingManagerContact::count

(

$params = array()

)

Return message count with given parameters.

Parameters

array

$params

Returns

array

get_idList()

Admin_GenericEmailingManagerContact::get_idList

(

$params = array()

)

Return object id list.

Parameters

array

$params

Returns

array

get_emailList()

Admin_GenericEmailingManagerContact::get_emailList

(

$params = array()

)

Return object email list.

Parameters

array

$params

Returns

array

get_fullNameList()

Admin_GenericEmailingManagerContact::get_fullNameList

(

$params = array()

)

Return contact full name list.

Parameters

array

$params

Returns

array

build_whereStatement()

Admin_GenericEmailingManagerContact::build_whereStatement (   $params = array() )

private

Build where statement from params.

Parameters

array

$params

Returns

string

get_fromEmail()

Admin_GenericEmailingManagerContact::get_fromEmail	(		$email,
			$id = false
	)

Load object from email.

Parameters

string	$email
integer	$id

Returns

boolean success

get_fromFullName()

Admin_GenericEmailingManagerContact::get_fromFullName	(		$firstname,
			$lastname
	)

Load object from fullname.

Parameters

string	$firstname
string	$lastname

Returns

boolean success

update_asUnsubscribed()

Admin_GenericEmailingManagerContact::update_asUnsubscribed

(

$email

)

Set status as unsubsribed.

Parameters

string

$email

Returns

boolean success

mark_asInvalid()

Admin_GenericEmailingManagerContact::mark_asInvalid

(

)

Update status to invalid.

Returns

boolean result

get_fullName()

Admin_GenericEmailingManagerContact::get_fullName

(

$default = ''

)

Return full contact name.

Returns

string

add_object()

Admin_GenericEmailingManagerContact::add_object

(

$params = array()

)

Add new object or update existing one.

Parameters

array

$params

Returns

boolean result

_check_existingEmail()

Admin_GenericEmailingManagerContact::_check_existingEmail (   $email = null )

private

Check is email already exists

Returns

boolean result

---

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

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