Admin_SecurityTools Class Reference

Inheritance diagram for Admin_SecurityTools:

Public Member Functions
	__construct ($path_type)
	install ()
	uninstall ()
	update ($version, $more='')
	is_installed ()
	get_rights ()
	execute_onCaMykSInitialise ()
	init_admin ()
	execute_request ()
	get_ipFilterRuleStatusList ()
	get_ipFilterRulesStatusList ($params=array())
	get_ipFilterRulePermissionList ()
	get_ipFilterRulesPermissionList ($params=array())
	get_ipFilterRulePermissionIconList ()
	get_ipFilterRulePSideModeList ()
	get_urlFilterRuleStatusList ()
	get_urlFilterRulesStatusList ($params=array())
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='')
	add_translation ($more='', $lg=null)
	get_languages ()
	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
	Configuration object. More...
	$ipfilterrule
	IP filter rule object. More...
	$urlFilterRule
	URL filter rule object. More...
	$backupfile
	Backup file object. More...
	$tools
	Security tools list. 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_updateConfig ()
	init_admin_editIPFilter ()
	init_admin_editIPFilterForm ()
	init_admin_saveIPFilter ()
	init_admin_deleteIPFilter ()
	init_admin_editURLFilterRule ()
	init_admin_editURLFilterRuleForm ()
	init_admin_saveURLFilterRule ()
	init_admin_deleteURLFilterRule ()
	init_admin_editUAFilterConfig ()
	init_admin_saveUAFilterConfig ()
	init_admin_editBackUpConfig ()
	init_admin_saveBackUpConfig ()
	init_admin_deleteBackUpFile ()
	init_admin_editNewBackUpFile ()
	init_admin_saveNewBackUpFile ()
	init_admin_checkCaMykSIntegrity ()
	execute_request_checkIPAddress ()
	check_security ()
	get_IPFilterRules ()
	get_backUpFiles ()
	get_backUpValues ()
	get_backupMethodsList ()
	get_backupCompressionsList ()
	get_backupTypesList ()
	update_toVersion1_1 ()

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_SecurityTools Module class.

Constructor & Destructor Documentation

__construct()

Admin_SecurityTools::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

install()

Admin_SecurityTools::install

(

)

Install module object.

Returns

boolean success

Reimplemented from Plugin.

uninstall()

Admin_SecurityTools::uninstall

(

)

Uninstall module object.

Returns

boolean success

Reimplemented from Plugin.

update()

Admin_SecurityTools::update	(		$version,
			$more = ''
	)

Update plugin.

Returns

boolean

Reimplemented from Plugin.

is_installed()

Admin_SecurityTools::is_installed

(

)

Check module installation.

Returns

boolean result

Reimplemented from Plugin.

get_rights()

Admin_SecurityTools::get_rights

(

)

Returns available permissions.

Returns

void

Reimplemented from Module.

execute_onCaMykSInitialise()

Admin_SecurityTools::execute_onCaMykSInitialise

(

)

Execute handler on CaMykS initialise.

Returns

void

Reimplemented from Plugin.

init_admin()

Admin_SecurityTools::init_admin

(

)

Initialise module object in admin mode.

Returns

void

Reimplemented from Module.

execute_request()

Admin_SecurityTools::execute_request

(

)

Execute module object in request mode.

Returns

void

Reimplemented from Plugin.

init_admin_main()

Admin_SecurityTools::init_admin_main ( )

private

init_admin_updateConfig()

Admin_SecurityTools::init_admin_updateConfig ( )

private

init_admin_editIPFilter()

Admin_SecurityTools::init_admin_editIPFilter ( )

private

Initialise module object in admin/edit_ipfilter mode.

Returns

void

init_admin_editIPFilterForm()

Admin_SecurityTools::init_admin_editIPFilterForm ( )

private

init_admin_saveIPFilter()

Admin_SecurityTools::init_admin_saveIPFilter ( )

private

init_admin_deleteIPFilter()

Admin_SecurityTools::init_admin_deleteIPFilter ( )

private

init_admin_editURLFilterRule()

Admin_SecurityTools::init_admin_editURLFilterRule ( )

private

Initialise module object in admin/edit_urlfilter mode.

Returns

void

init_admin_editURLFilterRuleForm()

Admin_SecurityTools::init_admin_editURLFilterRuleForm ( )

private

init_admin_saveURLFilterRule()

Admin_SecurityTools::init_admin_saveURLFilterRule ( )

private

init_admin_deleteURLFilterRule()

Admin_SecurityTools::init_admin_deleteURLFilterRule ( )

private

init_admin_editUAFilterConfig()

Admin_SecurityTools::init_admin_editUAFilterConfig ( )

private

init_admin_saveUAFilterConfig()

Admin_SecurityTools::init_admin_saveUAFilterConfig ( )

private

Initialise module object in admin/save_uafilterconfig mode.

Returns

void

init_admin_editBackUpConfig()

Admin_SecurityTools::init_admin_editBackUpConfig ( )

private

init_admin_saveBackUpConfig()

Admin_SecurityTools::init_admin_saveBackUpConfig ( )

private

Initialise module object in admin/save_backupconfig mode.

Returns

void

init_admin_deleteBackUpFile()

Admin_SecurityTools::init_admin_deleteBackUpFile ( )

private

Initialise module object in admin/save_backupconfig mode.

Returns

void

init_admin_editNewBackUpFile()

Admin_SecurityTools::init_admin_editNewBackUpFile ( )

private

Initialise module object in admin/edit_newbackupfile mode

Returns

void

init_admin_saveNewBackUpFile()

Admin_SecurityTools::init_admin_saveNewBackUpFile ( )

private

Initialise module object in admin/save_newbackupfile mode.

Returns

void

init_admin_checkCaMykSIntegrity()

Admin_SecurityTools::init_admin_checkCaMykSIntegrity ( )

private

Initialise object module in admin/checkCaMykSIntegrity mode.

Returns

void

execute_request_checkIPAddress()

Admin_SecurityTools::execute_request_checkIPAddress ( )

private

Execute module object in request mode / add article.

Returns

void

check_security()

Admin_SecurityTools::check_security ( )

private

Check all security tools.

Returns

void

get_ipFilterRuleStatusList()

Admin_SecurityTools::get_ipFilterRuleStatusList

(

)

Return IP Filter rule status list

Returns

array

get_ipFilterRulesStatusList()

Admin_SecurityTools::get_ipFilterRulesStatusList

(

$params = array()

)

Return IP Filter rules status list

Parameters

array

$params

Returns

array

get_ipFilterRulePermissionList()

Admin_SecurityTools::get_ipFilterRulePermissionList

(

)

Return IP Filter rule permission list

Returns

array

get_ipFilterRulesPermissionList()

Admin_SecurityTools::get_ipFilterRulesPermissionList

(

$params = array()

)

Return IP Filter rules permission list

Parameters

array

$params

Returns

array

get_ipFilterRulePermissionIconList()

Admin_SecurityTools::get_ipFilterRulePermissionIconList

(

)

Return IP Filter rule permission icon list

Returns

array

get_ipFilterRulePSideModeList()

Admin_SecurityTools::get_ipFilterRulePSideModeList

(

)

Return IP Filter rule site mode list

Returns

array

get_IPFilterRules()

Admin_SecurityTools::get_IPFilterRules ( )

private

Load IP Filter rules

Returns

void

get_urlFilterRuleStatusList()

Admin_SecurityTools::get_urlFilterRuleStatusList

(

)

Return URL Filter rule status list

Returns

array

get_urlFilterRulesStatusList()

Admin_SecurityTools::get_urlFilterRulesStatusList

(

$params = array()

)

Return URL Filter rules status list

Parameters

array

$params

Returns

array

get_backUpFiles()

Admin_SecurityTools::get_backUpFiles ( )

private

Load back up files.

Returns

void

get_backUpValues()

Admin_SecurityTools::get_backUpValues ( )

private

Load all needed backup values.

Returns

void

get_backupMethodsList()

Admin_SecurityTools::get_backupMethodsList ( )

private

Return backup methods list.

Returns

array

get_backupCompressionsList()

Admin_SecurityTools::get_backupCompressionsList ( )

private

Return backup compressions list

Returns

array

get_backupTypesList()

Admin_SecurityTools::get_backupTypesList ( )

private

Return backup types list.

Returns

array

update_toVersion1_1()

Admin_SecurityTools::update_toVersion1_1 ( )

private

Apply version 1.1 update.

Returns

boolean success

Member Data Documentation

$config

Admin_SecurityTools::$config

protected

Configuration object.

var Object $config

$ipfilterrule

Admin_SecurityTools::$ipfilterrule

protected

IP filter rule object.

var Object $ipfilterrule

$urlFilterRule

Admin_SecurityTools::$urlFilterRule

protected

URL filter rule object.

var Object urlFilterRule

$backupfile

Admin_SecurityTools::$backupfile

protected

Backup file object.

var Object backupfile

$tools

Admin_SecurityTools::$tools

protected

Initial value:

= array(
        'ipfilter'  => array('configure' => false),
        'urlfilter' => array('configure' => false),
        'uafilter'  => array('configure' => true),
        'backup'    => array('configure' => true),
    )

Security tools list.

var array tools

---

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

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