Admin_GenericGuestBookManager Class Reference

Admin_GenericGuestBookManager module. More...

Inheritance diagram for Admin_GenericGuestBookManager:

Public Member Functions
	__construct ($path_type)
	install ()
	uninstall ()
	is_installed ()
	get_rights ()
	get_adminControlPanelAction ()
	get_adminInternalNotifications ()
	init_admin ()
	get_messagesStatusList ($full=false)
	get_messageStatusList ()
	get_messageStatusIconList ()
	get_messageList ($params)
	count_messages ($params=array())
	save_siteMessage ()
	get_messageObject ()
	get_configValue ($item)
	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_adminEngineSpecificMenus ()
	get_adminEngineSpecificMenuItems ()
	get_adminEngineGenericInit ()
	get_adminEngineGenericDisplay ()
	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='')
	update ($version, $more='')
	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())
	execute_request ()
	get_varFile ($file)

Public Attributes
	$msgItem
	Message object. More...
	$msgList
	Message list. 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
	$config
	Plugin configuration. 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_viewMsg ()
	init_admin_editMsg ()
	init_admin_saveMsg ()
	init_admin_deleteMsg ()
	init_admin_editConfig ()
	init_admin_saveConfig ()
	send_notifications ()
	get_notificationContent ()
	update_statistics ()

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_GenericGuestBookManager module.

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.1.1

Date

Creation: Sep 2010

Modification: Jan 2021

Copyright

2010 - 2021 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_GenericGuestBookManager class.

Constructor & Destructor Documentation

__construct()

Admin_GenericGuestBookManager::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

install()

Admin_GenericGuestBookManager::install

(

)

Install module.

Returns

boolean success

Reimplemented from Plugin.

uninstall()

Admin_GenericGuestBookManager::uninstall

(

)

Uninstall module.

Returns

boolean success

Reimplemented from Plugin.

is_installed()

Admin_GenericGuestBookManager::is_installed

(

)

Check module installation.

Returns

boolean result

Reimplemented from Plugin.

get_rights()

Admin_GenericGuestBookManager::get_rights

(

)

Define module permission.

Returns

void

Reimplemented from Module.

get_adminControlPanelAction()

Admin_GenericGuestBookManager::get_adminControlPanelAction

(

)

Update control panel description.

Returns

void

Reimplemented from Module.

get_adminInternalNotifications()

Admin_GenericGuestBookManager::get_adminInternalNotifications

(

)

Return notified items for module.

Returns

Array

Reimplemented from Module.

init_admin()

Admin_GenericGuestBookManager::init_admin

(

)

Initialise module object in admin mode

Returns

void

Reimplemented from Module.

init_admin_main()

Admin_GenericGuestBookManager::init_admin_main ( )

private

Initialise module object in admin/main mode

Returns

void

init_admin_viewMsg()

Admin_GenericGuestBookManager::init_admin_viewMsg ( )

private

Initialise module object in admin/view_msg mode

Returns

void

init_admin_editMsg()

Admin_GenericGuestBookManager::init_admin_editMsg ( )

private

Initialise module object in admin/edit_msg mode

Returns

void

init_admin_saveMsg()

Admin_GenericGuestBookManager::init_admin_saveMsg ( )

private

Initialise module object in admin/save_msg mode

Returns

void

init_admin_deleteMsg()

Admin_GenericGuestBookManager::init_admin_deleteMsg ( )

private

Initialise module object in admin/delete_msg mode

Returns

void

init_admin_editConfig()

Admin_GenericGuestBookManager::init_admin_editConfig ( )

private

Initialise module object in admin/edit_config mode

Returns

void

init_admin_saveConfig()

Admin_GenericGuestBookManager::init_admin_saveConfig ( )

private

Initialise module object in admin/save_config mode

Returns

void

get_messagesStatusList()

Admin_GenericGuestBookManager::get_messagesStatusList

(

$full = false

)

Return messages status list

Parameters

boolean

$full

Returns

array

get_messageStatusList()

Admin_GenericGuestBookManager::get_messageStatusList

(

)

Return message status list

Returns

array

get_messageStatusIconList()

Admin_GenericGuestBookManager::get_messageStatusIconList

(

)

Return message status icon list

Returns

array

get_messageList()

Admin_GenericGuestBookManager::get_messageList

(

$params

)

Return message list

Parameters

array

$params

Returns

array

count_messages()

Admin_GenericGuestBookManager::count_messages

(

$params = array()

)

Return message count

Parameters

array

$params

Returns

integer

save_siteMessage()

Admin_GenericGuestBookManager::save_siteMessage

(

)

save message from site

Returns

boolean success

get_messageObject()

Admin_GenericGuestBookManager::get_messageObject

(

)

Return message object

Returns

object

send_notifications()

Admin_GenericGuestBookManager::send_notifications ( )

private

Send notification emails

Parameters

string

$vEmail

Returns

void

get_notificationContent()

Admin_GenericGuestBookManager::get_notificationContent ( )

private

Return admin email content

Returns

string

update_statistics()

Admin_GenericGuestBookManager::update_statistics ( )

private

Update statistics

Returns

boolean success

get_configValue()

Admin_GenericGuestBookManager::get_configValue

(

$item

)

Return config value.

Parameters

string

$item

Returns

mixed

load_additionalDictionnary()

Admin_GenericGuestBookManager::load_additionalDictionnary

(

)

Load additional dictionnary.

Returns

void

initialise_configDisplay()

Admin_GenericGuestBookManager::initialise_configDisplay

(

)

Initialise object in Admin_Site / view configuration mode

Returns

void

display_configDisplay()

Admin_GenericGuestBookManager::display_configDisplay

(

)

Display object in Admin_Site / view configuration mode

Returns

void

initialise_configEdition()

Admin_GenericGuestBookManager::initialise_configEdition

(

$form

)

Initialise object in Admin_Site / edit configuration mode

Parameters

Object

$form

Returns

void

display_configEdition()

Admin_GenericGuestBookManager::display_configEdition

(

)

Display object in Admin_Site / edit configuration mode

Returns

void

save_configuration()

Admin_GenericGuestBookManager::save_configuration

(

)

Execute object in Admin_Site / save configuration mode

Returns

void

get_legalMentionsData()

Admin_GenericGuestBookManager::get_legalMentionsData

(

)

Return legal mentions data.

Returns

array

Member Data Documentation

$msgItem

Object Admin_GenericGuestBookManager::$msgItem

Message object.

$msgList

array Admin_GenericGuestBookManager::$msgList

Message list.

$config

Admin_GenericGuestBookManager::$config

protected

Plugin configuration.

var Object $config

---

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

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