Admin_SystemNotifications Class Reference

Admin_SystemNotifications Module
Gather and display notifications from websites you manage. More...

Inheritance diagram for Admin_SystemNotifications:

Public Member Functions
	__construct ($path_type)
	install ()
	uninstall ()
	is_installed ()
	get_rights ()
	get_adminControlPanelAction ()
	init_admin ()
	execute_request ()
	get_websiteStatusList ()
	get_websitesStatusList ($more=false)
	count_websites ($params=array())
	get_websiteList ($params=array())
	get_configValue ($item)
	initialise_configDisplay ()
	display_configDisplay ()
	initialise_configEdition ($form)
	display_configEdition ()
	save_configuration ()
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_adminInternalNotifications ()
	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())
	get_varFile ($file)

Protected Attributes
	$websiteItem
	Website object. More...
	$websiteList = null
	Website list. More...
	$isConfig = false
	Is module is configuration mode. 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_edit_website ()
	init_admin_save_website ()
	init_admin_delete_website ()
	init_admin_check_website ()
	init_admin_check_websites ()
	execute_request_loadNotifications ()
	get_configurationModuleModeList ()
	get_configurationAccessStatusList ()
	get_configurationAccessAuthenticationList ()
	get_adminUserList ($params=array())

Additional Inherited Members
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 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_SystemNotifications Module
Gather and display notifications from websites you manage.

Plugin / Input 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.2.3

Date

Creation: Jun 2018

Modification: Jun 2021

Copyright

2018 - 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_SystemNotifications Module class.

Constructor & Destructor Documentation

__construct()

Admin_SystemNotifications::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

install()

Admin_SystemNotifications::install

(

)

Install module.

Returns

boolean success

Reimplemented from Plugin.

uninstall()

Admin_SystemNotifications::uninstall

(

)

Unintall module.

Returns

boolean success

Reimplemented from Plugin.

is_installed()

Admin_SystemNotifications::is_installed

(

)

Check module installation.

Returns

boolean result

Reimplemented from Plugin.

get_rights()

Admin_SystemNotifications::get_rights

(

)

Build module rights.

Returns

void

Reimplemented from Module.

get_adminControlPanelAction()

Admin_SystemNotifications::get_adminControlPanelAction

(

)

Update description in control panel

Returns

void

Reimplemented from Module.

init_admin()

Admin_SystemNotifications::init_admin

(

)

Initialise module object in admin mode

Returns

void

Reimplemented from Module.

execute_request()

Admin_SystemNotifications::execute_request

(

)

Execute module object in request mode.

Returns

void

Reimplemented from Plugin.

init_admin_main()

Admin_SystemNotifications::init_admin_main ( )

private

Initialise module object in admin/main mode.

Returns

void

init_admin_edit_config()

Admin_SystemNotifications::init_admin_edit_config ( )

private

Initialise module object in admin/edit_config mode.

Returns

void

init_admin_save_config()

Admin_SystemNotifications::init_admin_save_config ( )

private

Initialise module object in admin/save_config mode.

Returns

void

init_admin_edit_website()

Admin_SystemNotifications::init_admin_edit_website ( )

private

Initialise module object in admin/edit_website mode.

Returns

void

init_admin_save_website()

Admin_SystemNotifications::init_admin_save_website ( )

private

Initialise module object in admin/save_website mode.

Returns

void

init_admin_delete_website()

Admin_SystemNotifications::init_admin_delete_website ( )

private

Initialise module object in admin/delete_website mode.

Returns

void

init_admin_check_website()

Admin_SystemNotifications::init_admin_check_website ( )

private

Initialise module object in admin/check_website mode.

Returns

void

init_admin_check_websites()

Admin_SystemNotifications::init_admin_check_websites ( )

private

Initialise module object in admin/check_websites mode.

Returns

void

execute_request_loadNotifications()

Admin_SystemNotifications::execute_request_loadNotifications ( )

private

Execute module object in request/load notifications mode

Returns

void

get_configurationModuleModeList()

Admin_SystemNotifications::get_configurationModuleModeList ( )

private

Return configuration module mode list

Returns

array

get_configurationAccessStatusList()

Admin_SystemNotifications::get_configurationAccessStatusList ( )

private

Return configuration access status list.

Returns

array

get_configurationAccessAuthenticationList()

Admin_SystemNotifications::get_configurationAccessAuthenticationList ( )

private

Return configuration access authentication list.

Returns

array

get_websiteStatusList()

Admin_SystemNotifications::get_websiteStatusList

(

)

Return single website list.

Returns

array

get_websitesStatusList()

Admin_SystemNotifications::get_websitesStatusList

(

$more = false

)

Return websites status list.

Parameters

boolean

$more

Returns

array

count_websites()

Admin_SystemNotifications::count_websites

(

$params = array()

)

Return website count.

Parameters

array

$params

Returns

integer

get_websiteList()

Admin_SystemNotifications::get_websiteList

(

$params = array()

)

Return website list.

Parameters

array

$params

Returns

array

get_configValue()

Admin_SystemNotifications::get_configValue

(

$item

)

Return given config item value.

Parameters

string

$item

Returns

mixed

get_adminUserList()

Admin_SystemNotifications::get_adminUserList (   $params = array() )

private

Return admin user list.

Parameters

params

$params

Returns

array

initialise_configDisplay()

Admin_SystemNotifications::initialise_configDisplay

(

)

Initialise object in Admin_Site / view configuration mode

Returns

void

display_configDisplay()

Admin_SystemNotifications::display_configDisplay

(

)

Display object in Admin_Site / view configuration mode

Returns

void

initialise_configEdition()

Admin_SystemNotifications::initialise_configEdition

(

$form

)

Initialise object in Admin_Site / edit configuration mode

Parameters

Object

$form

Returns

void

display_configEdition()

Admin_SystemNotifications::display_configEdition

(

)

Display object in Admin_Site / edit configuration mode

Returns

void

save_configuration()

Admin_SystemNotifications::save_configuration

(

)

Member Data Documentation

$websiteItem

Admin_SystemNotifications::$websiteItem

protected

Website object.

var object $websiteItem

$websiteList

Admin_SystemNotifications::$websiteList = null

protected

Website list.

var array $websiteList

$isConfig

Admin_SystemNotifications::$isConfig = false

protected

Is module is configuration mode.

var boolean $isConfig

---

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

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