CaMykS  1.0-20231201
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
Admin_Statistics Class Reference

Admin_Statistics Module
Records and displays website statistics. More...

Inheritance diagram for Admin_Statistics:
Module Plugin

Public Member Functions

 __construct ($path_type)
 
 install ()
 
 uninstall ()
 
 is_installed ()
 
 get_rights ()
 
 get_adminStatisticsValueTitles ($data, $type=null)
 
 init_admin ()
 
 update_statistic ($name='', $plugin='', $type='', $main='', $data1='', $data2='', $params=array())
 
 get_statistics ($plugin, $statName, $params=array())
 
 update_siteStatistics ()
 
 get_displayItems ($period)
 
- 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_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='')
 
 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

 $statobject
 Statistic object. More...
 
 $statdata
 Statistic data object. 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 Member Functions

 display_statistic ()
 
 display_colorPicker ($name)
 
 get_optimisedValue ($value)
 
- 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)
 

Protected Attributes

 $registered_stats = null
 Already registered statistics. More...
 
 $statslist
 Statistic object list. More...
 
 $displayedItems = array('day'=>16, 'month'=>16, 'year'=>8)
 Stores how many day/month/year to display. More...
 
- Protected Attributes inherited from Module
 $libs = array()
 Module libraries to load. More...
 
 $text = ''
 Module admin message. More...
 

Private Member Functions

 init_admin_editSettings ()
 
 init_admin_saveSettings ()
 
 init_admin_singleObject ()
 
 init_admin_mixedObject ()
 
 init_admin_detailObject ()
 
 init_admin_datedObject ()
 
 init_admin_totalObject ()
 
 get_registeredStats ()
 
 load_tabs ()
 
 init_admin_singleStatisticsTabs ()
 
 init_admin_mixedStatisticsTabs ()
 
 init_admin_optionsForm ()
 
 init_admin_colorPickerInput ()
 
 init_admin_getSingleOptions ()
 
 init_admin_getSingleStatisticValues ()
 
 init_admin_getMixedOptions ()
 
 init_admin_getDatedOptions ()
 
 init_admin_getDetailOptions ()
 
 init_admin_getDatedStatisticValues ()
 
 init_admin_getDetailStatisticValues ()
 
 get_settingsStatusList ()
 
 check_filteredIP ($ip)
 
 get_botTitle ($bot, $type)
 

Private Attributes

 $stattypes = array('single', 'mixed', 'dated', 'detail', 'total')
 Statistic type list. More...
 

Detailed Description

Admin_Statistics Module
Records and displays website statistics.

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.2
Date
Creation: May 2007
Modification: Sep 2020
Note
This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
Available types :
  • single : each update create an entry - display each entry
  • mixed : each item is saved by day and values - display by date and detail values
  • dated : each item is save by day and values - display by date only
  • detail : each item is save by day and values - display detail values only
  • total : only one entry per object (date is first entry value) Admin_Statistics class.

Constructor & Destructor Documentation

◆ __construct()

Admin_Statistics::__construct (   $path_type)

Class constructor.

Parameters
string$path_type
Returns
void

Member Function Documentation

◆ install()

Admin_Statistics::install ( )

Install module.

Returns
boolean success

Reimplemented from Plugin.

◆ uninstall()

Admin_Statistics::uninstall ( )

Uninstall module.

Returns
boolean success

Reimplemented from Plugin.

◆ is_installed()

Admin_Statistics::is_installed ( )

Check module installation.

Returns
boolean result

Reimplemented from Plugin.

◆ get_rights()

Admin_Statistics::get_rights ( )

Define module permissions.

Returns
void

Reimplemented from Module.

◆ get_adminStatisticsValueTitles()

Admin_Statistics::get_adminStatisticsValueTitles (   $data,
  $type = null 
)

Return statistic titles

Parameters
array$data
string$type
Returns
array

Reimplemented from Module.

◆ init_admin()

Admin_Statistics::init_admin ( )

Initialise module object in admin mode

Returns
void

Reimplemented from Module.

◆ init_admin_editSettings()

Admin_Statistics::init_admin_editSettings ( )
private

Initialise module object in admin/edit settings mode

Returns
void

◆ init_admin_saveSettings()

Admin_Statistics::init_admin_saveSettings ( )
private

Initialise module object in admin/save settings mode.

Returns
void

◆ init_admin_singleObject()

Admin_Statistics::init_admin_singleObject ( )
private

Initialise module object in admin/single object mode.

Returns
void

◆ init_admin_mixedObject()

Admin_Statistics::init_admin_mixedObject ( )
private

Initialise module object in admin/mixed object mode.

Returns
void

◆ init_admin_detailObject()

Admin_Statistics::init_admin_detailObject ( )
private

Initialise module object in admin/detail object mode.

Returns
void

◆ init_admin_datedObject()

Admin_Statistics::init_admin_datedObject ( )
private

Initialise module object in admin/dated object mode.

Returns
void

◆ init_admin_totalObject()

Admin_Statistics::init_admin_totalObject ( )
private

Initialise module object in admin/total object mode.

Returns
void

◆ update_statistic()

Admin_Statistics::update_statistic (   $name = '',
  $plugin = '',
  $type = '',
  $main = '',
  $data1 = '',
  $data2 = '',
  $params = array() 
)

Update statistic.

Parameters
string$name
string$plugin
string$type
string$main
string$data1
string$data2
array$params
Returns
void

◆ get_statistics()

Admin_Statistics::get_statistics (   $plugin,
  $statName,
  $params = array() 
)

Return statistic values.

Parameters
string$plugin
string$statName
array$params
Returns
array

◆ update_siteStatistics()

Admin_Statistics::update_siteStatistics ( )

Update site statistics.

Returns
void

◆ get_displayItems()

Admin_Statistics::get_displayItems (   $period)

Return displayed item for the given period.

Parameters
string$period
Returns
integer

◆ display_statistic()

Admin_Statistics::display_statistic ( )
protected

Display statistic.

Returns
void

◆ get_registeredStats()

Admin_Statistics::get_registeredStats ( )
private

Load registered statistic list.

Returns
boolean success

◆ load_tabs()

Admin_Statistics::load_tabs ( )
private

Build tabs.

Returns
void

◆ init_admin_singleStatisticsTabs()

Admin_Statistics::init_admin_singleStatisticsTabs ( )
private

Build tabs in single type stats.

Returns
void

◆ init_admin_mixedStatisticsTabs()

Admin_Statistics::init_admin_mixedStatisticsTabs ( )
private

Build tabs in mixed type stats.

Returns
void

◆ init_admin_optionsForm()

Admin_Statistics::init_admin_optionsForm ( )
private

Build option form.

Returns
void

◆ init_admin_colorPickerInput()

Admin_Statistics::init_admin_colorPickerInput ( )
private

Load color picker.

Returns
void

◆ init_admin_getSingleOptions()

Admin_Statistics::init_admin_getSingleOptions ( )
private

Build option in single type stats.

Returns
void

◆ init_admin_getSingleStatisticValues()

Admin_Statistics::init_admin_getSingleStatisticValues ( )
private

Load values in single type stats.

Returns
void

◆ init_admin_getMixedOptions()

Admin_Statistics::init_admin_getMixedOptions ( )
private

Build option in mixed type stats.

Returns
void

◆ init_admin_getDatedOptions()

Admin_Statistics::init_admin_getDatedOptions ( )
private

Build option in dated type stats.

Returns
void

◆ init_admin_getDetailOptions()

Admin_Statistics::init_admin_getDetailOptions ( )
private

Build option in detail type stats.

Returns
void

◆ init_admin_getDatedStatisticValues()

Admin_Statistics::init_admin_getDatedStatisticValues ( )
private

Load value in dated type stats.

Returns
void

◆ init_admin_getDetailStatisticValues()

Admin_Statistics::init_admin_getDetailStatisticValues ( )
private

Load value in detail type stats.

Returns
void

◆ display_colorPicker()

Admin_Statistics::display_colorPicker (   $name)
protected

Display color picker.

Parameters
string$name
Returns
void

◆ get_settingsStatusList()

Admin_Statistics::get_settingsStatusList ( )
private

Return settings status list.

Returns
array

◆ check_filteredIP()

Admin_Statistics::check_filteredIP (   $ip)
private

Check given ip in filtered ip list.

Parameters
string$ip
Returns
boolean result

◆ get_optimisedValue()

Admin_Statistics::get_optimisedValue (   $value)
protected

Return optimised value.

Parameters
integer$value
Returns
string

◆ get_botTitle()

Admin_Statistics::get_botTitle (   $bot,
  $type 
)
private

Return bot title

Parameters
string$bot
string$type
Returns
string

Member Data Documentation

◆ $statobject

Admin_Statistics::$statobject

Statistic object.

var Object $statobject

◆ $statdata

Admin_Statistics::$statdata

Statistic data object.

var Object $statdata

◆ $registered_stats

Admin_Statistics::$registered_stats = null
protected

Already registered statistics.

var Object $registered_stats

◆ $stattypes

Admin_Statistics::$stattypes = array('single', 'mixed', 'dated', 'detail', 'total')
private

Statistic type list.

var Object $stattypes

◆ $statslist

Admin_Statistics::$statslist
protected

Statistic object list.

var array $statslist

◆ $displayedItems

Admin_Statistics::$displayedItems = array('day'=>16, 'month'=>16, 'year'=>8)
protected

Stores how many day/month/year to display.

var array $displayedItems


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