CaMykS
1.0-20231201
|
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... | |
Module plugin object.
Engine / Object Library
Module::__construct | ( | $name, | |
$path_type | |||
) |
Class constructor
string | $name | the module name |
string | $path_type | the module path (camyks or site) |
Module::Module | ( | $name, | |
$path_type | |||
) |
Old style constructor.
string | $name | the module name |
string | $path_type | the module path (camyks or site) |
Module::get_help | ( | ) |
Load help files.
Module::display_help | ( | ) |
Display help files.
Module::set_theme | ( | $theme | ) |
Set module applied theme.
string | $theme | the theme name |
Module::get_translation | ( | $value, | |
$data = array() |
|||
) |
Return locale value.
string | $value | the locale value to return |
mxed | $data | the optional inserted data |
Reimplemented from Plugin.
Module::get_adminEditionLanguage | ( | ) |
Return language to use for admin content edition.
Module::get_contentList | ( | ) |
Return existing content list.
If the module is not editable return -1
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.
Module::preInit_admin | ( | ) |
Pre-initialise module object in admin mode
Module::init_admin | ( | ) |
Initialise module object in admin mode.
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.
Module::display_admin | ( | ) |
Display module object in admin mode.
Module::init_parent_admin | ( | ) |
|
protected |
init module object in admin/access denied mode
|
protected |
Initialise module object in admin/page access denied mode
|
protected |
Initialise module object in admin/action not allowed mode
|
protected |
Initialise module object in admin/missing plugin mode
Module::get_adminLink | ( | $params = array() , |
|
$module = null |
|||
) |
Return admin link.
array | $params | |
string | $module |
Module::get_adminJSLink | ( | $params = array() , |
|
$module = null |
|||
) |
Return admin Javascript link.
array | $params | |
string | $module |
Module::init_site | ( | $content = 1 , |
|
$params = array() , |
|||
$index = null |
|||
) |
Initialise module object in site mode.
integer | $content | |
array | $params | |
integer | $index |
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.
Module::display_site | ( | ) |
Display module in site mode.
Module::set_selectedLayout | ( | $layout = '' , |
|
$location = '' |
|||
) |
Update selected layout.
string | $layout | |
string | $location |
Module::get_adminLayout | ( | $layout = '' | ) |
Load selected admin layout.
string | $layout | the selected layout |
Module::get_siteLayout | ( | ) |
Load selected site layout
Module::get_adminEngineGenericMenus | ( | ) |
Module::get_adminEngineGenericMenuItems | ( | ) |
Return admin menu items to register : always displayed.
Reimplemented in Tool_Login, Tool_ControlPanel, and Admin_MyShortcuts.
Module::get_adminEngineSpecificMenus | ( | ) |
Return admin menus to register : display only when module is selected.
Reimplemented in Admin_SystemReport, Admin_PluginManager, Admin_MonitoringUserAgentChecker, Admin_GenericPetitionManager, Admin_GenericEmailingManager, and Admin_ContentPage.
Module::get_adminEngineSpecificMenuItems | ( | ) |
Return admin menu items to register : display only when module is selected.
Reimplemented in Admin_SystemReport, Admin_PluginManager, Admin_MonitoringUserAgentChecker, Admin_GenericPetitionManager, Admin_GenericEmailingManager, and Admin_ContentPage.
Module::get_adminEngineGenericInit | ( | ) |
Module::get_adminEngineGenericDisplay | ( | ) |
Module::get_adminInternalNotifications | ( | ) |
Return notified items for module
Reimplemented in Admin_SystemReport, Admin_SiteReport, Admin_MonitoringUserAgentChecker, and Admin_GenericGuestBookManager.
|
protected |
Tell admin Tool_InfoBar to disable menus
Module::get_adminControlPanelAction | ( | ) |
Return action to execute in control panel
Reimplemented in Admin_ToDoList, Admin_SystemReport, Admin_SystemNotifications, Admin_SiteReport, Admin_MyMessages, Admin_MonitoringUserAgentChecker, Admin_GenericGuestBookManager, Admin_GenericContactFormManager, and Admin_GenericBlogsManager.
Module::get_adminStatisticsValueTitles | ( | $list, | |
$object = null |
|||
) |
Return object titles in statistics engine
array | $list | the id list to get |
string | $object | the object |
Reimplemented in Admin_ContentPage, Admin_GenericDownloadManager, and Admin_Statistics.
Module::get_adminStatisticsSpecificOptions | ( | $object = null | ) |
Return object specific options in statistics engine
string | $object |
Module::get_rights | ( | ) |
Load right list.
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.
Module::check_right | ( | $info | ) |
Return right value for this module/mode.
$info |
Module::get_fileInputButtons | ( | $buttons = array() , |
|
$delete = true |
|||
) |
Return default buttons definition for html form file input.
array | $buttons | |
boolean | $delete | add view button to buttons list |
Module::get_dateInputButtons | ( | $update = true , |
|
$reset = true |
|||
) |
Return default buttons definition for html from date input.
boolean | $update | add update button to button list |
boolean | $reset | add reset button to button list |
|
protected |
Apply module object, with current settings, in given page module location
integer | $pageId | |
integer | $moduleIndex | |
integer | $contentId |
|
protected |
Module::init_generic | ( | ) |
string Module::$type |
Module type, can be admin or content.
string Module::$title |
Module title.
string Module::$libdesc |
Module library description.
|
protected |
Module libraries to load.
array Module::$languages |
Module available locale files.
array Module::$rights = array() |
Module permissions.
string Module::$selected_layout = '' |
Module layout to use.
string Module::$selected_layout_location = 'module' |
Module layout location, can be module or camyks.
array Module::$help = null |
Module help files.
boolean Module::$is_editable = true |
Module has editable content.
|
protected |
Module admin message.