Admin_SystemUniqueIDManager Module
Provides unique ids on requests. More...

Inheritance diagram for Admin_SystemUniqueIDManager:

Public Member Functions
	__construct ($path_type)

	install ()

	uninstall ()

	is_installed ()

	get_rights ()

	init_admin ()

	count_keys ($params=array())

	get_keyList ($params=array())

	get_newUniqueID ($plugin, $object)

	get_configValue ($item)

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_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='')

	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
	$keyItem
	Unique id object. More...

	$keyList = null
	Unique id 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 Member Functions
	get_keyStatusList ()

	get_keysStatusList ($more=false)

	get_keyGeneratingMethodList ()

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)

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_edit_config ()

	init_admin_save_config ()

	init_admin_create_key ()

	init_admin_delete_key ()

Detailed Description

Admin_SystemUniqueIDManager Module
Provides unique ids on requests.

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: Jan 2015; Modification: Jan 2021

Copyright: 2015 - 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_SystemUniqueIDManager class.

Constructor & Destructor Documentation

◆ __construct()

Admin_SystemUniqueIDManager::__construct ( $path_type )

Class constructor.

Parameters

string $path_type

Returns: void

Member Function Documentation

◆ install()

Admin_SystemUniqueIDManager::install ( )

Install module.

Returns: boolean success

Reimplemented from Plugin.

◆ uninstall()

Admin_SystemUniqueIDManager::uninstall ( )

Unintall module.

Returns: boolean success

Reimplemented from Plugin.

◆ is_installed()

Admin_SystemUniqueIDManager::is_installed ( )

Check module installation.

Returns: boolean result

Reimplemented from Plugin.

◆ get_rights()

Admin_SystemUniqueIDManager::get_rights ( )

Define module permissions.

Returns: void

Reimplemented from Module.

◆ init_admin()

Admin_SystemUniqueIDManager::init_admin ( )

Initialise module object in admin mode

Returns: void

Reimplemented from Module.

◆ init_admin_main()

Admin_SystemUniqueIDManager::init_admin_main ( )

private

Initialise module object in admin/main mode

Returns: void

◆ init_admin_edit_config()

Admin_SystemUniqueIDManager::init_admin_edit_config ( )

private

Initialise module object in admin/edit_config mode

Returns: void

◆ init_admin_save_config()

Admin_SystemUniqueIDManager::init_admin_save_config ( )

private

Initialise module object in admin/save_config mode.

Returns: void

◆ init_admin_create_key()

Admin_SystemUniqueIDManager::init_admin_create_key ( )

private

Initialise module object in admin/create_key mode.

Returns: void

◆ init_admin_delete_key()

Admin_SystemUniqueIDManager::init_admin_delete_key ( )

private

Initialise module object in admin/delete_key mode.

Returns: void

◆ get_keyStatusList()

Admin_SystemUniqueIDManager::get_keyStatusList ( )

protected

Return single key status list.

Returns: array

◆ get_keysStatusList()

Admin_SystemUniqueIDManager::get_keysStatusList ( $more = false )

protected

Return keys status list.

Parameters

boolean $more

◆ get_keyGeneratingMethodList()

Admin_SystemUniqueIDManager::get_keyGeneratingMethodList ( )

protected

Return keys generating method list.

Returns: array

◆ count_keys()

Admin_SystemUniqueIDManager::count_keys ( $params = array() )

Return keys count.

Parameters

array $params

Returns: integer

◆ get_keyList()

Admin_SystemUniqueIDManager::get_keyList ( $params = array() )

Return key list.

Parameters

array $params

Returns: array

◆ get_newUniqueID()

Admin_SystemUniqueIDManager::get_newUniqueID	(	$plugin,
		$object
	)

Return new unique ID.

Parameters

string	$plugin
string	$object

Returns: mixed // unique ID on success, false on failure

◆ get_configValue()

Admin_SystemUniqueIDManager::get_configValue ( $item )

Return given config item value.

Parameters

string $item

Returns: mixed

Member Data Documentation

◆ $keyItem

Admin_SystemUniqueIDManager::$keyItem

Unique id object.

var Object $keyItem

◆ $keyList

Admin_SystemUniqueIDManager::$keyList = null

Unique id list.

var array $uniqueIDList

◆ $config

Admin_SystemUniqueIDManager::$config

protected

Plugin configuration.

var Object $config

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

CaMykS/plugin/module/Admin_SystemUniqueIDManager/Admin_SystemUniqueIDManager.php.inc

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ install()

◆ uninstall()

◆ is_installed()

◆ get_rights()

◆ init_admin()

◆ init_admin_main()

◆ init_admin_edit_config()

◆ init_admin_save_config()

◆ init_admin_create_key()

◆ init_admin_delete_key()

◆ get_keyStatusList()

◆ get_keysStatusList()

◆ get_keyGeneratingMethodList()

◆ count_keys()

◆ get_keyList()

◆ get_newUniqueID()

◆ get_configValue()

Member Data Documentation

◆ $keyItem

◆ $keyList

◆ $config