Admin_User Module
Manage administration users. More...

Inheritance diagram for Admin_User:

Public Member Functions
	__construct ($path_type)

	install ()

	is_installed ()

	update ($version, $more='')

	init_admin ()

	get_userNameAndEmail ($login)

	get_activeUserList ($objMode=false)

	get_userList ($where='', $objMode=false)

	get_userStatusList ()

	get_registeredExtensionTitleList ()

	get_configValue ($name='')

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

	get_adminStatisticsValueTitles ($list, $object=null)

	get_adminStatisticsSpecificOptions ($object=null)

	get_rights ()

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

	uninstall ()

	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
	$user
	Current user object. More...

	$user_list
	User list. More...

	$layout_itemsByLine = 3
	Define layout items by line. More...

	$layout_cellwidth = '180px'
	Define layout cell width. 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
	Input configuration. More...

	$isConfigLoaded = false
	Stores if the configuration is loaded. More...

Protected Attributes inherited from Module
	$libs = array()
	Module libraries to load. More...

	$text = ''
	Module admin message. More...

Private Member Functions
	init_admin_list ()

	init_admin_edit ()

	init_admin_view ()

	init_admin_delete ()

	init_admin_save ()

	init_admin_reset_2fa ()

	load_configuration ()

	update_toVersion1_1 ()

	update_toVersion1_2 ()

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_User Module
Manage administration users.

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

Date: Creation: Jun 2005; Modification: Jul 2021

Copyright: 2005 - 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_User class.

Constructor & Destructor Documentation

◆ __construct()

Admin_User::__construct ( $path_type )

Class constructor.

Parameters

string $path_type

Returns: void

Member Function Documentation

◆ install()

Admin_User::install ( )

Install module.

Returns: boolean success

Reimplemented from Plugin.

◆ is_installed()

Admin_User::is_installed ( )

Check module installation.

Returns: boolean result

Reimplemented from Plugin.

◆ update()

Admin_User::update	(	$version,
		$more = `''`
	)

Update plugin.

Returns: boolean

Reimplemented from Plugin.

◆ init_admin()

Admin_User::init_admin ( )

Initialise module object in admin mode.

Returns: void

Reimplemented from Module.

◆ init_admin_list()

Admin_User::init_admin_list ( )

private

Initialise module object in admin/list mode

Returns: void

◆ init_admin_edit()

Admin_User::init_admin_edit ( )

private

Initialise module object in admin/edit mode.

Returns: void

◆ init_admin_view()

Admin_User::init_admin_view ( )

private

Initialise module object in admin/view mode.

Returns: void

◆ init_admin_delete()

Admin_User::init_admin_delete ( )

private

Initialise module object in admin/delete mode

Returns: void

◆ init_admin_save()

Admin_User::init_admin_save ( )

private

Initialise module object in admin/save mode

Returns: void

◆ init_admin_reset_2fa()

Admin_User::init_admin_reset_2fa ( )

private

Initialise module object in admin/reset_2fa mode

Returns: void

◆ get_userNameAndEmail()

Admin_User::get_userNameAndEmail ( $login )

Return structured array with name and email.

Parameters

string $login

Returns: array

◆ get_activeUserList()

Admin_User::get_activeUserList ( $objMode = false )

Return structured array of all active users.

Parameters

integer $objMode

Returns: array

◆ get_userList()

Admin_User::get_userList	(	$where = `''`,
		$objMode = `false`
	)

Return all users list.

Parameters

string	$where
integer	$objMode

Returns: array

◆ get_userStatusList()

Admin_User::get_userStatusList ( )

Return status values.

Returns: array

◆ get_registeredExtensionTitleList()

Admin_User::get_registeredExtensionTitleList ( )

Return plugin extension title list.

Returns: array

◆ load_configuration()

Admin_User::load_configuration ( )

private

Load configuration.

Returns: void

◆ get_configValue()

Admin_User::get_configValue ( $name = '' )

Return configuration value.

Parameters

string $name

Returns: mixed

◆ update_toVersion1_1()

Admin_User::update_toVersion1_1 ( )

private

Apply version 1.1 update.

Returns: boolean success

◆ update_toVersion1_2()

Admin_User::update_toVersion1_2 ( )

private

Apply version 1.2 update.

Returns: boolean success

◆ initialise_configDisplay()

Admin_User::initialise_configDisplay ( )

Initialise object in Admin_Site / view configuration mode.

Returns: void

◆ display_configDisplay()

Admin_User::display_configDisplay ( )

Display object in Admin_Site / view configuration mode.

Returns: void

◆ initialise_configEdition()

Admin_User::initialise_configEdition ( $form )

Initialise object in Admin_Site / edit configuration mode.

Parameters

Object $form

Returns: void

◆ display_configEdition()

Admin_User::display_configEdition ( )

Display object in Admin_Site / edit configuration mode.

Returns: void

◆ save_configuration()

Admin_User::save_configuration ( )

Execute object in Admin_Site / save configuration mode.

Returns: void

Member Data Documentation

◆ $user

Admin_User::$user

Current user object.

var Object $user

◆ $user_list

Admin_User::$user_list

User list.

var array $user_list

◆ $layout_itemsByLine

Admin_User::$layout_itemsByLine = 3

Define layout items by line.

var integer $layout_itemsByLine

◆ $layout_cellwidth

Admin_User::$layout_cellwidth = '180px'

Define layout cell width.

var integer $layout_cellwidth

◆ $config

Admin_User::$config

protected

Input configuration.

var Object $config

◆ $isConfigLoaded

Admin_User::$isConfigLoaded = false

protected

Stores if the configuration is loaded.

var boolean isConfigLoaded

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

CaMykS/plugin/module/Admin_User/Admin_User.php.inc

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ install()

◆ is_installed()

◆ update()

◆ init_admin()

◆ init_admin_list()

◆ init_admin_edit()

◆ init_admin_view()

◆ init_admin_delete()

◆ init_admin_save()

◆ init_admin_reset_2fa()

◆ get_userNameAndEmail()

◆ get_activeUserList()

◆ get_userList()

◆ get_userStatusList()

◆ get_registeredExtensionTitleList()

◆ load_configuration()

◆ get_configValue()

◆ update_toVersion1_1()

◆ update_toVersion1_2()

◆ initialise_configDisplay()

◆ display_configDisplay()

◆ initialise_configEdition()

◆ display_configEdition()

◆ save_configuration()

Member Data Documentation

◆ $user

◆ $user_list

◆ $layout_itemsByLine

◆ $layout_cellwidth

◆ $config

◆ $isConfigLoaded