[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/plugins/system/stats/ -> stats.php (summary)

(no description)

Copyright: (C) 2015 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 634 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PlgSystemStats:: (22 methods):
  onAfterInitialise()
  onAfterDispatch()
  onAjaxSendAlways()
  onAjaxSendNever()
  onAjaxSendStats()
  onGetStatsData()
  debug()
  getLayoutData()
  getLayoutPaths()
  getRenderer()
  getStatsData()
  getUniqueId()
  isAllowedUser()
  isDebugEnabled()
  isUpdateRequired()
  isAjaxRequest()
  render()
  saveParams()
  sendStats()
  clearCacheGroups()
  disablePlugin()
  isCaptiveMFA()


Class: PlgSystemStats  - X-Ref

Statistics system plugin. This sends anonymous data back to the Joomla! Project about the
PHP, SQL, Joomla and OS versions

onAfterInitialise()   X-Ref
Listener for the `onAfterInitialise` event

return: void

onAfterDispatch()   X-Ref
Listener for the `onAfterDispatch` event

return: void

onAjaxSendAlways()   X-Ref
User selected to always send data

return: void

onAjaxSendNever()   X-Ref
User selected to never send data.

return: void

onAjaxSendStats()   X-Ref
Send the stats to the server.
On first load | on demand mode it will show a message asking users to select mode.

return: void

onGetStatsData($context)   X-Ref
Get the data through events

param: string  $context  Context where this will be called from
return: array

debug($layoutId, $data = [])   X-Ref
Debug a layout of this plugin

param: string  $layoutId  Layout identifier
param: array   $data      Optional data for the layout
return: string

getLayoutData()   X-Ref
Get the data for the layout

return: array

getLayoutPaths()   X-Ref
Get the layout paths

return: array

getRenderer($layoutId = 'default')   X-Ref
Get the plugin renderer

param: string  $layoutId  Layout identifier
return: \Joomla\CMS\Layout\LayoutInterface

getStatsData()   X-Ref
Get the data that will be sent to the stats server.

return: array

getUniqueId()   X-Ref
Get the unique id. Generates one if none is set.

return: integer

isAllowedUser()   X-Ref
Check if current user is allowed to send the data

return: boolean

isDebugEnabled()   X-Ref
Check if the debug is enabled

return: boolean

isUpdateRequired()   X-Ref
Check if last_run + interval > now

return: boolean

isAjaxRequest()   X-Ref
Check valid AJAX request

return: boolean

render($layoutId, $data = [])   X-Ref
Render a layout of this plugin

param: string  $layoutId  Layout identifier
param: array   $data      Optional data for the layout
return: string

saveParams()   X-Ref
Save the plugin parameters

return: boolean

sendStats()   X-Ref
Send the stats to the stats server

return: boolean

clearCacheGroups(array $clearGroups)   X-Ref
Clears cache groups. We use it to clear the plugins cache after we update the last run timestamp.

param: array  $clearGroups  The cache groups to clean
return: void

disablePlugin()   X-Ref
Disable this plugin, if user selects once or never, to stop Joomla loading the plugin on every page load and
therefore regaining a tiny bit of performance

return: boolean

isCaptiveMFA()   X-Ref
Are we in a Multi-factor Authentication page?

return: bool



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer