Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe PlgSystemStats
+ Graphe d'héritage de PlgSystemStats:

Fonctions membres publiques

 onAfterInitialise ()
 
 onAjaxSendAlways ()
 
 onAjaxSendNever ()
 
 onAjaxSendOnce ()
 
 onAjaxSendStats ()
 
 onGetStatsData ($context)
 
 debug ($layoutId, $data=array())
 
 render ($layoutId, $data=array())
 

Champs de données

const MODE_ALLOW_ALWAYS = 1
 
const MODE_ALLOW_ONCE = 2
 
const MODE_ALLOW_NEVER = 3
 

Fonctions membres protégées

 getLayoutData ()
 
 getLayoutPaths ()
 
 getRenderer ($layoutId='default')
 

Attributs protégés

 $app
 
 $db
 
 $serverUrl = 'https://developer.joomla.org/stats/submit'
 
 $uniqueId
 

Fonctions membres privées

 getStatsData ()
 
 getUniqueId ()
 
 isAllowedUser ()
 
 isDebugEnabled ()
 
 isUpdateRequired ()
 
 isAjaxRequest ()
 
 saveParams ()
 
 sendStats ()
 
 clearCacheGroups (array $clearGroups, array $cacheClients=array(0, 1))
 

Description détaillée

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

Depuis
3.5

Documentation des fonctions membres

◆ clearCacheGroups()

clearCacheGroups ( array  $clearGroups,
array  $cacheClients = array(0, 1) 
)
private

Clears cache groups. We use it to clear the plugins cache after we update the last run timestamp.

Paramètres
array$clearGroupsThe cache groups to clean
array$cacheClientsThe cache clients (site, admin) to clean
Renvoie
void
Depuis
3.5

Références $options, JPATH_ADMINISTRATOR, et JPATH_SITE.

◆ debug()

debug (   $layoutId,
  $data = array() 
)

Debug a layout of this plugin

Paramètres
string$layoutIdLayout identifier
array$dataOptional data for the layout
Renvoie
string
Depuis
3.5

Références $data.

◆ getLayoutData()

getLayoutData ( )
protected

Get the data for the layout

Renvoie
array
Depuis
3.5

◆ getLayoutPaths()

getLayoutPaths ( )
protected

Get the layout paths

Renvoie
array
Depuis
3.5

Références $template, et JPATH_ADMINISTRATOR.

◆ getRenderer()

getRenderer (   $layoutId = 'default')
protected

Get the plugin renderer

Paramètres
string$layoutIdLayout identifier
Renvoie
JLayout
Depuis
3.5

Références $renderer.

◆ getStatsData()

getStatsData ( )
private

Get the data that will be sent to the stats server.

Renvoie
array
Depuis
3.5

◆ getUniqueId()

getUniqueId ( )
private

Get the unique id. Generates one if none is set.

Renvoie
integer
Depuis
3.5

Références null.

◆ isAjaxRequest()

isAjaxRequest ( )
private

Check valid AJAX request

Renvoie
boolean
Depuis
3.5

◆ isAllowedUser()

isAllowedUser ( )
private

Check if current user is allowed to send the data

Renvoie
boolean
Depuis
3.5

◆ isDebugEnabled()

isDebugEnabled ( )
private

Check if the debug is enabled

Renvoie
boolean
Depuis
3.5

◆ isUpdateRequired()

isUpdateRequired ( )
private

Check if last_run + interval > now

Renvoie
boolean
Depuis
3.5

Références $mode.

◆ onAfterInitialise()

onAfterInitialise ( )

Listener for the onAfterInitialise event

Renvoie
void
Depuis
3.5

◆ onAjaxSendAlways()

onAjaxSendAlways ( )

User selected to always send data

Renvoie
void
Depuis
3.5
Exceptions
ExceptionIf user is not allowed.
RuntimeExceptionIf there is an error saving the params or sending the data.

Références json_encode.

◆ onAjaxSendNever()

onAjaxSendNever ( )

User selected to never send data.

Renvoie
void
Depuis
3.5
Exceptions
ExceptionIf user is not allowed.
RuntimeExceptionIf there is an error saving the params.

Références json_encode.

◆ onAjaxSendOnce()

onAjaxSendOnce ( )

User selected to send data once.

Renvoie
void
Depuis
3.5
Exceptions
ExceptionIf user is not allowed.
RuntimeExceptionIf there is an error saving the params or sending the data.

Références json_encode.

◆ onAjaxSendStats()

onAjaxSendStats ( )

Send the stats to the server. On first load | on demand mode it will show a message asking users to select mode.

Renvoie
void
Depuis
3.5
Exceptions
ExceptionIf user is not allowed.
RuntimeExceptionIf there is an error saving the params or sending the data.

Références $data, et json_encode.

◆ onGetStatsData()

onGetStatsData (   $context)

Get the data through events

Paramètres
string$contextContext where this will be called from
Renvoie
array
Depuis
3.5

◆ render()

render (   $layoutId,
  $data = array() 
)

Render a layout of this plugin

Paramètres
string$layoutIdLayout identifier
array$dataOptional data for the layout
Renvoie
string
Depuis
3.5

Références $data.

◆ saveParams()

saveParams ( )
private

Save the plugin parameters

Renvoie
boolean
Depuis
3.5

Références $query.

◆ sendStats()

sendStats ( )
private

Send the stats to the stats server

Renvoie
boolean
Depuis
3.5
Exceptions
RuntimeExceptionIf there is an error sending the data.

Références $data, et null.

Documentation des champs

◆ $app

$app
protected

◆ $db

$db
protected

◆ $serverUrl

$serverUrl = 'https://developer.joomla.org/stats/submit'
protected

◆ $uniqueId

$uniqueId
protected

◆ MODE_ALLOW_ALWAYS

const MODE_ALLOW_ALWAYS = 1

integer

Depuis
3.5

◆ MODE_ALLOW_NEVER

const MODE_ALLOW_NEVER = 3

integer

Depuis
3.5

◆ MODE_ALLOW_ONCE

const MODE_ALLOW_ONCE = 2

integer

Depuis
3.5

La documentation de cette classe a été générée à partir du fichier suivant :