Admin_SystemLogManager Module
Store and display logs. More...

Inheritance diagram for Admin_SystemLogManager:

Public Member Functions
	__construct ($path_type)

	get_rights ()

	init_admin ()

	execute_request ()

	write_log ($log, $action, $message='')

	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)

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

	install ()

	uninstall ()

	is_installed ()

	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
	$config
	Module configuration object. More...

	$isConfig = false
	Is in configuration mode. More...

	$logList = array()
	Log list. More...

	$logFileList = array()
	Log file list. More...

	$selection = array()
	Selection values. More...

	$currentFileContent
	Selected file content. 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_update_selection ()

	init_admin_edit_config ()

	init_admin_save_config ()

	execute_request_downloadLogFile ()

	get_configurationLoggingPeriodList ()

	get_logList ()

	get_logFileList ($log)

	get_logFilePath ($log)

	get_logFileTitle ($name)

	prune_oldFiles ($log)

	get_configValue ($item)

	clean_value ($value='')

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_SystemLogManager Module
Store and display logs.

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

Date: Creation: Jun 2018; Modification: Dec 2022

Copyright: 2018 - 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_SystemLogManager Module class.

Constructor & Destructor Documentation

◆ __construct()

Admin_SystemLogManager::__construct ( $path_type )

Class constructor.

Parameters

string $path_type

Returns: void

Member Function Documentation

◆ get_rights()

Admin_SystemLogManager::get_rights ( )

Return module permissions.

Returns: void

Reimplemented from Module.

◆ init_admin()

Admin_SystemLogManager::init_admin ( )

Initialise module object in admin mode.

Returns: void

Reimplemented from Module.

◆ execute_request()

Admin_SystemLogManager::execute_request ( )

Execute module in request mode.

Returns: void

Reimplemented from Plugin.

◆ init_admin_main()

Admin_SystemLogManager::init_admin_main ( )

private

Initialise module object in admin/main mode

Returns: void

◆ init_admin_update_selection()

Admin_SystemLogManager::init_admin_update_selection ( )

private

Initialise module object in admin/update_selection mode

Returns: void

◆ init_admin_edit_config()

Admin_SystemLogManager::init_admin_edit_config ( )

private

Initialise module object in admin/edit_config mode

Returns: void

◆ init_admin_save_config()

Admin_SystemLogManager::init_admin_save_config ( )

private

Initialise module object in admin/save_config mode

Returns: void

◆ execute_request_downloadLogFile()

Admin_SystemLogManager::execute_request_downloadLogFile ( )

private

Execute module object in request/downloadLogFile mode.

Returns: void

◆ get_configurationLoggingPeriodList()

Admin_SystemLogManager::get_configurationLoggingPeriodList ( )

private

Return configuration logging period list

Returns: array

◆ get_logList()

Admin_SystemLogManager::get_logList ( )

private

Return available log list

Returns: array

◆ get_logFileList()

Admin_SystemLogManager::get_logFileList ( $log )

private

Return available log file list for give log.

Parameters

string $log

Returns: array

◆ get_logFilePath()

Admin_SystemLogManager::get_logFilePath ( $log )

private

Return current log file path.

Parameters

string $log

Returns: string

◆ get_logFileTitle()

Admin_SystemLogManager::get_logFileTitle ( $name )

private

Return log file title from its name.

Parameters

string $name

Returns: string

◆ write_log()

Admin_SystemLogManager::write_log	(	$log,
		$action,
		$message = `''`
	)

Write log information to log file

Parameters

string	$log
string	$action
string	$message

Returns: boolean result

◆ prune_oldFiles()

Admin_SystemLogManager::prune_oldFiles ( $log )

private

Prune all old files for given log

Parameters

string $log

Returns: boolean result

◆ get_configValue()

Admin_SystemLogManager::get_configValue ( $item )

private

Return given config item value

Parameters

string $item

Returns: mixed

◆ clean_value()

Admin_SystemLogManager::clean_value ( $value = '' )

private

Returned clean value (to avoid PHP/JS injection in logs)

Parameters

string $value

Returns: value

◆ initialise_configDisplay()

Admin_SystemLogManager::initialise_configDisplay ( )

Initialise object in Admin_Site / view configuration mode

Returns: void

◆ display_configDisplay()

Admin_SystemLogManager::display_configDisplay ( )

Display object in Admin_Site / view configuration mode

Returns: void

◆ initialise_configEdition()

Admin_SystemLogManager::initialise_configEdition ( $form )

Initialise object in Admin_Site / edit configuration mode

Parameters

Object $form

Returns: void

◆ display_configEdition()

Admin_SystemLogManager::display_configEdition ( )

Display object in Admin_Site / edit configuration mode

Returns: void

◆ save_configuration()

Admin_SystemLogManager::save_configuration ( )

Member Data Documentation

◆ $config

Admin_SystemLogManager::$config

protected

Module configuration object.

var Object $config

◆ $isConfig

Admin_SystemLogManager::$isConfig = false

protected

Is in configuration mode.

var boolean $isConfig

◆ $logList

Admin_SystemLogManager::$logList = array()

protected

Log list.

var array $logList

◆ $logFileList

Admin_SystemLogManager::$logFileList = array()

protected

Log file list.

var array $logFileList

◆ $selection

Admin_SystemLogManager::$selection = array()

protected

Selection values.

var array $selection

◆ $currentFileContent

Admin_SystemLogManager::$currentFileContent

protected

Selected file content.

var string $currentFileContent

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

CaMykS/plugin/module/Admin_SystemLogManager/Admin_SystemLogManager.php.inc

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ get_rights()

◆ init_admin()

◆ execute_request()

◆ init_admin_main()

◆ init_admin_update_selection()

◆ init_admin_edit_config()

◆ init_admin_save_config()

◆ execute_request_downloadLogFile()

◆ get_configurationLoggingPeriodList()

◆ get_logList()

◆ get_logFileList()

◆ get_logFilePath()

◆ get_logFileTitle()

◆ write_log()

◆ prune_oldFiles()

◆ get_configValue()

◆ clean_value()

◆ initialise_configDisplay()

◆ display_configDisplay()

◆ initialise_configEdition()

◆ display_configEdition()

◆ save_configuration()

Member Data Documentation

◆ $config

◆ $isConfig

◆ $logList

◆ $logFileList

◆ $selection

◆ $currentFileContent