Admin_GlobalHelp Class Reference

Admin_GlobalHelp Module
Displays help for all plugins. More...

Inheritance diagram for Admin_GlobalHelp:

Public Member Functions
	__construct ($path_type)
	get_rights ()
	init_admin ()
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())
	execute_request ()
	get_varFile ($file)

Public Attributes
	$help
	Link to help files. 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
	$list
	List of available help files. More...
	$htitle
	Help files title. More...
	$hfile
	Help files name to display. More...
	$location
	Help files location to display. More...
Protected Attributes inherited from Module
	$libs = array()
	Module libraries to load. More...
	$text = ''
	Module admin message. More...

Private Member Functions
	get_engineHelpList ()
	get_modulesHelpList ()
	get_siteHelpList ()
	check_engineHelpFile ($name)
	check_modulesHelpFile ($name)
	check_siteHelpFile ($name)

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_GlobalHelp Module
Displays help for all plugins.

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: Fev 2007

Modification: Jan 2021

Copyright

2007 - 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_GlobalHelp class.

Constructor & Destructor Documentation

__construct()

Admin_GlobalHelp::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

get_rights()

Admin_GlobalHelp::get_rights

(

)

Define plugin permissions.

Returns

void

Reimplemented from Module.

init_admin()

Admin_GlobalHelp::init_admin

(

)

Initialise object when in admin mode

Returns

void

Reimplemented from Module.

get_engineHelpList()

Admin_GlobalHelp::get_engineHelpList ( )

private

Load engine help files.

Returns

void

get_modulesHelpList()

Admin_GlobalHelp::get_modulesHelpList ( )

private

Load modules help files.

Returns

void

get_siteHelpList()

Admin_GlobalHelp::get_siteHelpList ( )

private

Load site help files.

Returns

void

check_engineHelpFile()

Admin_GlobalHelp::check_engineHelpFile (   $name )

private

Check engine help files.

Returns

void

check_modulesHelpFile()

Admin_GlobalHelp::check_modulesHelpFile (   $name )

private

Check modules help files.

Returns

void

check_siteHelpFile()

Admin_GlobalHelp::check_siteHelpFile (   $name )

private

Check site help.

Returns

void

Member Data Documentation

$list

Admin_GlobalHelp::$list

protected

List of available help files.

var array $list

$help

Admin_GlobalHelp::$help

Link to help files.

var mixed $help

$htitle

Admin_GlobalHelp::$htitle

protected

Help files title.

var string $htitle

$hfile

Admin_GlobalHelp::$hfile

protected

Help files name to display.

var string $hfile

$location

Admin_GlobalHelp::$location

protected

Help files location to display.

var string $location

---

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

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