CaMykS  1.0-20181201
 All Classes Files Functions Variables Pages
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Module Class Reference
Inheritance diagram for Module:
Inheritance graph
[legend]
Collaboration diagram for Module:
Collaboration graph
[legend]

Public Member Functions

 __construct ($name, $path_type)
 
 Module ($name, $path_type)
 
 get_help ()
 
 display_help ()
 
 set_theme ($theme)
 
 get_translation ($value, $data=null)
 
 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_translation ($value, $data=null)
 
 get_languages ()
 
 execute_onCaMykSInitialise ()
 
 execute_onCaMykSPageLoad ()
 
 execute_onCaMykSBodyOpen ()
 
 execute_onCaMykSBodyClose ()
 
 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

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

Module::__construct (   $name,
  $path_type 
)

Class constructor

Parameters
string$namethe module name
string$path_typethe module path (camyks or site)

Member Function Documentation

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
Module::check_right (   $info)

Return right value for this module/mode.

Parameters
$info
Returns
boolean
Module::disable_adminEngineMenus ( )
protected

Tell admin Tool_InfoBar to disable menus

Returns
void
Module::display_admin ( )

Display module object in admin mode.

Returns
void
Module::display_help ( )

Display help files.

Returns
void
Module::display_site ( )

Display module in site mode.

Returns
void
Module::get_adminControlPanelAction ( )

Return action to execute in control panel

Returns
boolean
Module::get_adminEditionLanguage ( )

Return language to use for admin content edition.

Returns
string
Module::get_adminEngineGenericDisplay ( )

Display module specific content to admin page

Returns
string
Module::get_adminEngineGenericInit ( )

Allow module to add specific data to admin page

Returns
boolean
Module::get_adminEngineGenericMenuItems ( )

Return admin menu items to register : always displayed.

Returns
array
Module::get_adminEngineGenericMenus ( )

Return admin menus to register : always displayed.

Returns
array
Module::get_adminEngineSpecificMenuItems ( )

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

Returns
array
Module::get_adminEngineSpecificMenus ( )

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

Returns
array
Module::get_adminInternalNotifications ( )

Return notified items for module

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

Return admin Javascript link.

Parameters
array$params
string$module
Returns
string
Module::get_adminLayout (   $layout = '')

Load selected admin layout.

Parameters
string$layoutthe selected layout
Returns
void
Module::get_adminLink (   $params = array(),
  $module = null 
)

Return admin link.

Parameters
array$params
string$module
Returns
string
Module::get_adminStatisticsSpecificOptions (   $object = null)

Return object specific options in statistics engine

Parameters
string$object
Returns
string
Module::get_adminStatisticsValueTitles (   $list,
  $object = null 
)

Return object titles in statistics engine

Parameters
array$listthe id list to get
string$objectthe object
Returns
array
Module::get_contentList ( )

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

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

Return default buttons definition for html from date input.

Parameters
boolean$updateadd update button to button list
boolean$resetadd reset button to button list
Returns
array
Module::get_fileInputButtons (   $buttons = array(),
  $delete = true 
)

Return default buttons definition for html form file input.

Parameters
array$buttons
boolean$deleteadd view button to buttons list
Returns
array
Module::get_help ( )

Load help files.

Returns
void
Module::get_PHPLibs ( )
protected

Load PHP libraries.

Returns
void
Deprecated:
Use Plugin::load_library instead.
Module::get_rights ( )

Load right list.

Returns
void
Module::get_siteLayout ( )

Load selected site layout

Returns
void
Module::get_translation (   $value,
  $data = null 
)

Return locale value.

Parameters
string$valuethe locale value to return
mxed$datathe optional inserted data
Returns
string
Module::init_admin ( )

Initialise module object in admin mode.

Returns
void
Module::init_admin_accessDenied ( )
protected

init module object in admin/access denied mode

Returns
void
Module::init_admin_actionNotAllowed ( )
protected

Initialise module object in admin/action not allowed mode

Returns
void
Module::init_admin_missingPlugin (   $type,
  $name 
)
protected

Initialise module object in admin/missing plugin mode

Returns
void
Module::init_admin_pageAccessDenied ( )
protected

Initialise module object in admin/page access denied mode

Returns
void
Module::init_generic ( )

Generic module initialisation.

Returns
boolean
Deprecated:
Never been used.
Module::init_parent_admin ( )
Module::init_site (   $content = 1,
  $params = array(),
  $index = null 
)

Initialise module object in site mode.

Parameters
integer$content
array$params
integer$index
Returns
void
Module::Module (   $name,
  $path_type 
)

Old style constructor.

Parameters
string$namethe module name
string$path_typethe module path (camyks or site)
Module::preInit_admin ( )

Pre-initialise module object in admin mode

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

Update selected layout.

Parameters
string$layout
string$location
Returns
void
Module::set_theme (   $theme)

Set module applied theme.

Parameters
string$themethe theme name
Returns
void

Member Data Documentation

array Module::$help = null

Module help files.

boolean Module::$is_editable = true

Module has editable content.

array Module::$languages

Module available locale files.

string Module::$libdesc

Module library description.

array Module::$libs = array()
protected

Module libraries to load.

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.

string Module::$text = ''
protected

Module admin message.

Theme Module::$theme

Theme applied to the Module.

string Module::$title

Module title.

string Module::$type

Module type, can be admin or content.


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