Module Class Reference

Module plugin object. More...

Inheritance diagram for Module:

Public Member Functions
	__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 ()
	init_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='')
	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
	$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
	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
	$libs = array()
	Module libraries to load. More...
	$text = ''
	Module admin message. More...

Detailed Description

Module plugin object.

Engine / Object Library

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.2.3

Date

Creation: Jun 2007

Modification: Mar 2024

Copyright

2007 - 2024 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. ModuleLibraryItem class.

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Constructor & Destructor Documentation

__construct()

Module::__construct	(		$name,
			$path_type
	)

Class constructor

Parameters

string	$name	the module name
string	$path_type	the module path (camyks or site)

Returns

void

Member Function Documentation

Module()

Module::Module	(		$name,
			$path_type
	)

Old style constructor.

Parameters

string	$name	the module name
string	$path_type	the module path (camyks or site)

Returns

void

get_help()

Module::get_help

(

)

Load help files.

Returns

void

display_help()

Module::display_help

(

)

Display help files.

Returns

void

set_theme()

Module::set_theme

(

$theme

)

Set module applied theme.

Parameters

string

$theme

the theme name

Returns

void

get_translation()

Module::get_translation	(		$value,
			$data = array()
	)

Return locale value.

Parameters

string	$value	the locale value to return
mxed	$data	the optional inserted data

Returns

string

Reimplemented from Plugin.

get_adminEditionLanguage()

Module::get_adminEditionLanguage

(

)

Return language to use for admin content edition.

Returns

string

get_contentList()

Module::get_contentList

(

)

Return existing content list.
If the module is not editable return -1

Returns

mixed

Reimplemented in Content_TwitterStatusesViewer, Content_SystemSiteReport, Content_GoogleSearchResultsViewer, Content_GooglePoIMapViewer, Content_GoogleMapsViewer, Content_GenericSiteMap, Content_GenericRandomText, Content_GenericQuickMessage, Content_GenericPetitionViewer, Content_GenericPageRedirector, Content_GenericPageList, Content_GenericNews, Content_GenericMenu, Content_GenericLegalMentions, Content_GenericHTMLNews, Content_GenericHTMLContent, Content_GenericGuestBookViewer, Content_GenericGlossaryViewer, Content_GenericGallery, Content_GenericFaq, Content_GenericBlogsViewer, and Content_GenericArticle.

preInit_admin()

Module::preInit_admin

(

)

Pre-initialise module object in admin mode

Returns

void

init_admin()

Module::init_admin

(

)

Initialise module object in admin mode.

Returns

void

Reimplemented in Tool_Login, Tool_Installer, Tool_InfoBar, Tool_ControlPanel, Content_TwitterStatusesViewer, Content_SystemSiteReport, Content_GoogleSearchResultsViewer, Content_GooglePoIMapViewer, Content_GoogleMapsViewer, Content_GenericSiteMap, Content_GenericRandomText, Content_GenericQuickMessage, Content_GenericPetitionViewer, Content_GenericPageRedirector, Content_GenericPageList, Content_GenericNews, Content_GenericMenu, Content_GenericLegalMentions, Content_GenericHTMLNews, Content_GenericHTMLContent, Content_GenericGuestBookViewer, Content_GenericGlossaryViewer, Content_GenericGallery, Content_GenericFaq, Content_GenericBlogsViewer, Content_GenericArticle, Admin_User, Admin_ToDoList, Admin_ThemeChecker, Admin_SystemUniqueIDManager, Admin_SystemReport, Admin_SystemNotifications, Admin_SystemLogManager, Admin_Statistics, Admin_SiteReport, Admin_Site, Admin_SecurityTools, Admin_PluginManager, Admin_MyShortcuts, Admin_MyMessages, Admin_MyAccount, Admin_MonitoringUserAgentChecker, Admin_LanguageChecker, Admin_Group, Admin_GoogleTools, Admin_GooglePoIMapManager, Admin_GlobalHelp, Admin_GenericPetitionManager, Admin_GenericMediaLibraryManager, Admin_GenericGuestBookManager, Admin_GenericGlossaryManager, Admin_GenericFAQManager, Admin_GenericEmailingManager, Admin_GenericDownloadManager, Admin_GenericDirectoryManager, Admin_GenericContactFormManager, Admin_GenericBlogsManager, Admin_DocumentManager, and Admin_ContentPage.

display_admin()

Module::display_admin

(

)

Display module object in admin mode.

Returns

void

init_parent_admin()

Module::init_parent_admin

(

)

init_admin_accessDenied()

Module::init_admin_accessDenied ( )

protected

init module object in admin/access denied mode

Returns

void

init_admin_pageAccessDenied()

Module::init_admin_pageAccessDenied ( )

protected

Initialise module object in admin/page access denied mode

Returns

void

init_admin_actionNotAllowed()

Module::init_admin_actionNotAllowed ( )

protected

Initialise module object in admin/action not allowed mode

Returns

void

init_admin_missingPlugin()

Module::init_admin_missingPlugin (   $type,   $name  )

protected

Initialise module object in admin/missing plugin mode

Returns

void

get_adminLink()

Module::get_adminLink	(		$params = array(),
			$module = null
	)

Return admin link.

Parameters

array	$params
string	$module

Returns

string

get_adminJSLink()

Module::get_adminJSLink	(		$params = array(),
			$module = null
	)

Return admin Javascript link.

Parameters

array	$params
string	$module

Returns

string

init_site()

Module::init_site	(		$content = 1,
			$params = array(),
			$index = null
	)

Initialise module object in site mode.

Parameters

integer	$content
array	$params
integer	$index

Returns

void

Reimplemented in Content_TwitterStatusesViewer, Content_SystemSiteReport, Content_GoogleSearchResultsViewer, Content_GooglePoIMapViewer, Content_GoogleMapsViewer, Content_GenericSiteMap, Content_GenericRandomText, Content_GenericQuickMessage, Content_GenericPetitionViewer, Content_GenericPageList, Content_GenericNews, Content_GenericMenu, Content_GenericHTMLNews, Content_GenericHTMLContent, Content_GenericGuestBookViewer, Content_GenericGlossaryViewer, Content_GenericGallery, Content_GenericFaq, Content_GenericBlogsViewer, Content_GenericArticle, Content_GenericPageRedirector, and Content_GenericLegalMentions.

display_site()

Module::display_site

(

)

Display module in site mode.

Returns

void

set_selectedLayout()

Module::set_selectedLayout	(		$layout = '',
			$location = ''
	)

Update selected layout.

Parameters

string	$layout
string	$location

Returns

void

get_adminLayout()

Module::get_adminLayout

(

$layout = ''

)

Load selected admin layout.

Parameters

string

$layout

the selected layout

Returns

void

get_siteLayout()

Module::get_siteLayout

(

)

Load selected site layout

Returns

void

get_adminEngineGenericMenus()

Module::get_adminEngineGenericMenus

(

)

Return admin menus to register : always displayed.

Returns

array

Reimplemented in Admin_MyShortcuts.

get_adminEngineGenericMenuItems()

Module::get_adminEngineGenericMenuItems

(

)

Return admin menu items to register : always displayed.

Returns

array

Reimplemented in Tool_Login, Tool_ControlPanel, and Admin_MyShortcuts.

get_adminEngineSpecificMenus()

Module::get_adminEngineSpecificMenus

(

)

Return admin menus to register : display only when module is selected.

Returns

array

Reimplemented in Admin_SystemReport, Admin_PluginManager, Admin_MonitoringUserAgentChecker, Admin_GenericPetitionManager, Admin_GenericEmailingManager, and Admin_ContentPage.

get_adminEngineSpecificMenuItems()

Module::get_adminEngineSpecificMenuItems

(

)

Return admin menu items to register : display only when module is selected.

Returns

array

Reimplemented in Admin_SystemReport, Admin_PluginManager, Admin_MonitoringUserAgentChecker, Admin_GenericPetitionManager, Admin_GenericEmailingManager, and Admin_ContentPage.

get_adminEngineGenericInit()

Module::get_adminEngineGenericInit

(

)

Allow module to add specific data to admin page

Returns

boolean

Reimplemented in Admin_MyShortcuts.

get_adminEngineGenericDisplay()

Module::get_adminEngineGenericDisplay

(

)

Display module specific content to admin page

Returns

string

Reimplemented in Admin_MyShortcuts.

get_adminInternalNotifications()

Module::get_adminInternalNotifications

(

)

Return notified items for module

Returns

array

Reimplemented in Admin_SystemReport, Admin_SiteReport, Admin_MonitoringUserAgentChecker, and Admin_GenericGuestBookManager.

disable_adminEngineMenus()

Module::disable_adminEngineMenus ( )

protected

Tell admin Tool_InfoBar to disable menus

Returns

void

get_adminControlPanelAction()

Module::get_adminControlPanelAction

(

)

Return action to execute in control panel

Returns

boolean

Reimplemented in Admin_ToDoList, Admin_SystemReport, Admin_SystemNotifications, Admin_SiteReport, Admin_MyMessages, Admin_MonitoringUserAgentChecker, Admin_GenericGuestBookManager, Admin_GenericContactFormManager, and Admin_GenericBlogsManager.

get_adminStatisticsValueTitles()

Module::get_adminStatisticsValueTitles	(		$list,
			$object = null
	)

Return object titles in statistics engine

Parameters

array	$list	the id list to get
string	$object	the object

Returns

array

Reimplemented in Admin_ContentPage, Admin_GenericDownloadManager, and Admin_Statistics.

get_adminStatisticsSpecificOptions()

Module::get_adminStatisticsSpecificOptions

(

$object = null

)

Return object specific options in statistics engine

Parameters

string

$object

Returns

string

get_rights()

Module::get_rights

(

)

Load right list.

Returns

void

Reimplemented in Admin_ToDoList, Admin_ThemeChecker, Admin_SystemUniqueIDManager, Admin_SystemReport, Admin_SystemNotifications, Admin_SystemLogManager, Admin_Statistics, Admin_SiteReport, Admin_Site, Admin_SecurityTools, Admin_MyShortcuts, Admin_MyMessages, Admin_MyAccount, Admin_MonitoringUserAgentChecker, Admin_LanguageChecker, Admin_GoogleTools, Admin_GooglePoIMapManager, Admin_GlobalHelp, Admin_GenericPetitionManager, Admin_GenericMediaLibraryManager, Admin_GenericGuestBookManager, Admin_GenericGlossaryManager, Admin_GenericFAQManager, Admin_GenericEmailingManager, Admin_GenericDownloadManager, Admin_GenericDirectoryManager, Admin_GenericContactFormManager, Admin_GenericBlogsManager, Admin_DocumentManager, and Admin_ContentPage.

check_right()

Module::check_right

(

$info

)

Return right value for this module/mode.

Parameters

$info

Returns

boolean

get_fileInputButtons()

Module::get_fileInputButtons	(		$buttons = array(),
			$delete = true
	)

Return default buttons definition for html form file input.

Parameters

array	$buttons
boolean	$delete	add view button to buttons list

Returns

array

get_dateInputButtons()

Module::get_dateInputButtons	(		$update = true,
			$reset = true
	)

Return default buttons definition for html from date input.

Parameters

boolean	$update	add update button to button list
boolean	$reset	add reset button to button list

Returns

array

add_moduleContentToPage()

Module::add_moduleContentToPage (   $pageId,   $moduleIndex,   $contentId  )

protected

Apply module object, with current settings, in given page module location

Parameters

integer	$pageId
integer	$moduleIndex
integer	$contentId

Returns

boolean result

get_PHPLibs()

Module::get_PHPLibs ( )

protected

Load PHP libraries.

Returns

void

Deprecated:

Use Plugin::load_library instead.

init_generic()

Module::init_generic

(

)

Generic module initialisation.

Returns

boolean

Deprecated:

Never been used.

Member Data Documentation

$type

string Module::$type

Module type, can be admin or content.

$title

string Module::$title

Module title.

$libdesc

string Module::$libdesc

Module library description.

$libs

array Module::$libs = array()

protected

Module libraries to load.

$theme

Theme Module::$theme

Theme applied to the Module.

$languages

array Module::$languages

Module available locale files.

$rights

array Module::$rights = array()

Module permissions.

$selected_layout

string Module::$selected_layout = ''

Module layout to use.

$selected_layout_location

string Module::$selected_layout_location = 'module'

Module layout location, can be module or camyks.

$help

array Module::$help = null

Module help files.

$is_editable

boolean Module::$is_editable = true

Module has editable content.

$text

string Module::$text = ''

protected

Module admin message.

---

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

• CaMykS/engine/lib/object/Module.php.inc