Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe PlgSystemStats
+ Graphe d'héritage de PlgSystemStats:

Fonctions membres publiques

 onAfterInitialise ()
 
 onAfterDispatch ()
 
 onAjaxSendAlways ()
 
 onAjaxSendNever ()
 
 onAjaxSendStats ()
 
 onGetStatsData ($context)
 
 debug ($layoutId, $data=[])
 
 render ($layoutId, $data=[])
 
- Fonctions membres publiques hérités de CMSPlugin
 __construct (&$subject, $config=array())
 
 loadLanguage ($extension='', $basePath=JPATH_ADMINISTRATOR)
 
 setApplication (CMSApplicationInterface $application)
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 
- Fonctions membres publiques hérités de PluginInterface
 registerListeners ()
 

Champs de données

const MODE_ALLOW_ALWAYS = 1
 
const MODE_ALLOW_NEVER = 3
 
- Champs de données hérités de CMSPlugin
 $params = null
 

Fonctions membres protégées

 getLayoutData ()
 
 getLayoutPaths ()
 
 getRenderer ($layoutId='default')
 
- Fonctions membres protégées hérités de CMSPlugin
 registerLegacyListener (string $methodName)
 
 registerListener (string $methodName)
 
 getApplication ()
 

Attributs protégés

 $app
 
 $db
 
 $serverUrl = 'https://developer.joomla.org/stats/submit'
 
 $uniqueId
 
- Attributs protégés hérités de CMSPlugin
 $_name = null
 
 $_type = null
 
 $autoloadLanguage = false
 
 $allowLegacyListeners = true
 

Fonctions membres privées

 getStatsData ()
 
 getUniqueId ()
 
 isAllowedUser ()
 
 isDebugEnabled ()
 
 isUpdateRequired ()
 
 isAjaxRequest ()
 
 saveParams ()
 
 sendStats ()
 
 clearCacheGroups (array $clearGroups)
 
 disablePlugin ()
 
 isCaptiveMFA ()
 

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)
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
Renvoie
void
Depuis
3.5

Références $options, et JPATH_CACHE.

◆ debug()

debug (   $layoutId,
  $data = [] 
)

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.

◆ disablePlugin()

disablePlugin ( )
private

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

Depuis
4.0.0
Renvoie
boolean

Références $db, $query, et $result.

◆ getLayoutData()

getLayoutData ( )
protected

Get the data for the layout

Renvoie
array
Depuis
3.5

Références $params, et $this.

◆ getLayoutPaths()

getLayoutPaths ( )
protected

Get the layout paths

Renvoie
array
Depuis
3.5

Références $template, __DIR__, Factory\getApplication(), et JPATH_ADMINISTRATOR.

◆ getRenderer()

getRenderer (   $layoutId = 'default')
protected

Get the plugin renderer

Paramètres
string$layoutIdLayout identifier
Renvoie
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

Références $data.

◆ 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

Références Factory\getUser().

◆ isCaptiveMFA()

isCaptiveMFA ( )
private

Are we in a Multi-factor Authentication page?

Renvoie
bool
Depuis
4.2.1

◆ 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 $last, et $mode.

◆ onAfterDispatch()

onAfterDispatch ( )

Listener for the onAfterDispatch event

Renvoie
void
Depuis
4.0.0

◆ 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 Text\_().

◆ 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 Text\_().

◆ 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, disabling the plugin or sending the data.

Références $data, et Text\_().

◆ 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 = [] 
)

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 $db, $query, et $result.

◆ sendStats()

sendStats ( )
private

Send the stats to the stats server

Renvoie
boolean
Depuis
3.5
Exceptions
RuntimeExceptionIf there is an error sending the data and debug mode enabled.

Références $data, et elseif.

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

◆ MODE_ALLOW_NEVER

const MODE_ALLOW_NEVER = 3

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