Référence de la classe Joomla

Graphe d'héritage de Joomla:

Fonctions membres publiques
	__construct (DispatcherInterface $dispatcher, array $config)
	onContentAfterSave ($context, $article, $isNew)
	onContentAfterDelete ($context, $article)
	onContentChangeState ($context, $pks, $value)
	onApplicationAfterSave ($config)
	onExtensionAfterInstall ($installer, $eid)
	onExtensionAfterUninstall ($installer, $eid, $result)
	onExtensionAfterUpdate ($installer, $eid)
	onExtensionAfterSave ($context, $table, $isNew)
	onExtensionAfterDelete ($context, $table)
	onUserAfterSave ($user, $isnew, $success, $msg)
	onUserAfterDelete ($user, $success, $msg)
	onUserAfterSaveGroup ($context, $table, $isNew)
	onUserAfterDeleteGroup ($group, $success, $msg)
	onUserAfterLogin ($options)
	onUserLoginFailure ($response)
	onUserLogout ($user, $options=array())
	onUserAfterRemind ($user)
	onAfterCheckin ($table)
	onAfterLogPurge ($group='')
	onAfterLogExport ($group='')
	onAfterPurge ($group='all')
	onAfterDispatch ()
	onJoomlaAfterUpdate ($oldVersion=null)
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 ()

Fonctions membres protégées
	checkLoggable ($extension)
Fonctions membres protégées hérités de CMSPlugin
	registerLegacyListener (string $methodName)
	registerListener (string $methodName)
	getApplication ()

Attributs protégés
	$loggableExtensions = []
	$contextAliases = ['com_content.form' => 'com_content.article']
	$loggableApi = false
	$loggableVerbs = []
Attributs protégés hérités de ActionLogPlugin
	$app
	$db
	$autoloadLanguage = true
Attributs protégés hérités de CMSPlugin
	$_name = null
	$_type = null
	$autoloadLanguage = false
	$allowLegacyListeners = true

Fonctions membres privées
	getActionLogParams ($context)

Membres hérités additionnels
Champs de données hérités de CMSPlugin
	$params = null

Description détaillée

Joomla! Users Actions Logging Plugin.

Depuis

3.9.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	DispatcherInterface	$dispatcher,
		array	$config
	)

Constructor.

Paramètres

DispatcherInterface	$dispatcher	The dispatcher
array	$config	An optional associative array of configuration settings

Depuis

3.9.0

Références $config, $params, Symfony\Contracts\Service\__construct(), et ComponentHelper\getComponent().

Documentation des fonctions membres

checkLoggable()

checkLoggable (   $extension )

protected

Function to check if a component is loggable or not

Paramètres

string

$extension

The extension that triggered the event

Renvoie

boolean

Depuis

3.9.0

Références $extension.

Référencé par Joomla\onAfterCheckin(), Joomla\onAfterDispatch(), Joomla\onAfterPurge(), Joomla\onApplicationAfterSave(), Joomla\onContentAfterDelete(), Joomla\onContentAfterSave(), Joomla\onContentChangeState(), Joomla\onExtensionAfterDelete(), Joomla\onExtensionAfterInstall(), Joomla\onExtensionAfterSave(), Joomla\onExtensionAfterUninstall(), Joomla\onExtensionAfterUpdate(), Joomla\onUserAfterDelete(), Joomla\onUserAfterDeleteGroup(), Joomla\onUserAfterLogin(), Joomla\onUserAfterRemind(), Joomla\onUserAfterSave(), Joomla\onUserAfterSaveGroup(), Joomla\onUserLoginFailure(), et Joomla\onUserLogout().

getActionLogParams()

getActionLogParams (   $context )

private

Returns the action log params for the given context.

Paramètres

string

$context

The context of the action log

Renvoie

stdClass The params

Depuis

4.2.0

Références $component, $context, CMSPlugin\getApplication(), et null.

Référencé par Joomla\onContentAfterDelete(), Joomla\onContentAfterSave(), Joomla\onContentChangeState(), Joomla\onExtensionAfterDelete(), et Joomla\onExtensionAfterSave().

onAfterCheckin()

onAfterCheckin

(

$table

)

On after Check-in request

Method is called after user request to check-in items.

Paramètres

array

$table

Holds the table name.

Renvoie

void

Depuis

3.9.3

Références $context, $message, $user, Joomla\checkLoggable(), Joomla\Database\getDatabase(), et Factory\getUser().

onAfterDispatch()

onAfterDispatch

(

)

On after Api dispatched

Method is called after user perform an API request better on onAfterDispatch.

Renvoie

void

Depuis

4.0.0

Références $context, $message, $user, Joomla\checkLoggable(), ENT_QUOTES, et CMSPlugin\getApplication().

onAfterLogExport()

onAfterLogExport

(

$group = ''

)

On after log export

Method is called after user request to export action log items.

Paramètres

array

$group

Holds the group name.

Renvoie

void

Depuis

3.9.4

Références $context, $message, $user, CMSPlugin\getApplication(), et Factory\getUser().

onAfterLogPurge()

onAfterLogPurge

(

$group = ''

)

On after log action purge

Method is called after user request to clean action log items.

Paramètres

array

$group

Holds the group name.

Renvoie

void

Depuis

3.9.4

Références $context, $message, $user, CMSPlugin\getApplication(), et Factory\getUser().

onAfterPurge()

onAfterPurge

(

$group = 'all'

)

On after Cache purge

Method is called after user request to clean cached items.

Paramètres

string

$group

Holds the group name.

Renvoie

void

Depuis

3.9.4

Références $context, $message, $user, Joomla\checkLoggable(), CMSPlugin\getApplication(), et Factory\getUser().

onApplicationAfterSave()

onApplicationAfterSave

(

$config

)

On Saving application configuration logging method Method is called when the application config is being saved

Paramètres

\Joomla\Registry\Registry

$config

Registry object with the new config

Renvoie

void

Depuis

3.9.0

Références $message, $option, Joomla\checkLoggable(), et CMSPlugin\getApplication().

onContentAfterDelete()

onContentAfterDelete	(		$context,
			$article
	)

After delete content logging method This method adds a record to #__action_logs contains (message, date, context, user) Method is called right after the content is deleted

Paramètres

string	$context	The context of the content passed to the plugin
object	$article	A JTableContent object

Renvoie

void

Depuis

3.9.0

Références $article, $context, $id, $message, $option, $params, Joomla\checkLoggable(), Joomla\getActionLogParams(), CMSPlugin\getApplication(), et null.

onContentAfterSave()

onContentAfterSave	(		$context,
			$article,
			$isNew
	)

After save content logging method This method adds a record to #__action_logs contains (message, date, context, user) Method is called right after the content is saved

Paramètres

string	$context	The context of the content passed to the plugin
object	$article	A JTableContent object
boolean	$isNew	If the content is just about to be created

Renvoie

void

Depuis

3.9.0

Références $article, $context, $id, $message, $option, $params, Joomla\checkLoggable(), Joomla\getActionLogParams(), CMSPlugin\getApplication(), ActionlogsHelper\getContentTypeLink(), et null.

onContentChangeState()

onContentChangeState	(		$context,
			$pks,
			$value
	)

On content change status logging method This method adds a record to #__action_logs contains (message, date, context, user) Method is called when the status of the article is changed

Paramètres

string	$context	The context of the content passed to the plugin
array	$pks	An array of primary key ids of the content that has changed state.
integer	$value	The value of the state that the content has been changed to.

Renvoie

void

Depuis

3.9.0

Références $context, $db, $items, $message, $messages, $option, $params, $query, $value, Joomla\checkLoggable(), Joomla\getActionLogParams(), CMSPlugin\getApplication(), ActionlogsHelper\getContentTypeLink(), Joomla\Database\getDatabase(), null, et ArrayHelper\toInteger().

onExtensionAfterDelete()

onExtensionAfterDelete	(		$context,
			$table
	)

On Deleting extensions logging method Method is called when an extension is being deleted

Paramètres

string	$context	The extension
Table	$table	DataBase Table object

Renvoie

void

Depuis

3.9.0

Références $context, $message, $params, Joomla\checkLoggable(), Joomla\getActionLogParams(), CMSPlugin\getApplication(), et null.

onExtensionAfterInstall()

onExtensionAfterInstall	(		$installer,
			$eid
	)

On installing extensions logging method This method adds a record to #__action_logs contains (message, date, context, user) Method is called when an extension is installed

Paramètres

Installer	$installer	Installer object
integer	$eid	Extension Identifier

Renvoie

void

Depuis

3.9.0

Références $context, $manifest, $message, Joomla\checkLoggable(), CMSPlugin\getApplication(), et null.

onExtensionAfterSave()

onExtensionAfterSave	(		$context,
			$table,
			$isNew
	)

On Saving extensions logging method Method is called when an extension is being saved

Paramètres

string	$context	The extension
Table	$table	DataBase Table object
boolean	$isNew	If the extension is new or not

Renvoie

void

Depuis

3.9.0

Références $context, $message, $option, $params, Joomla\checkLoggable(), Joomla\getActionLogParams(), CMSPlugin\getApplication(), ActionlogsHelper\getContentTypeLink(), et null.

onExtensionAfterUninstall()

onExtensionAfterUninstall	(		$installer,
			$eid,
			$result
	)

On uninstalling extensions logging method This method adds a record to #__action_logs contains (message, date, context, user) Method is called when an extension is uninstalled

Paramètres

Installer	$installer	Installer instance
integer	$eid	Extension id
integer	$result	Installation result

Renvoie

void

Depuis

3.9.0

Références $context, $manifest, $message, $result, Joomla\checkLoggable(), CMSPlugin\getApplication(), et null.

onExtensionAfterUpdate()

onExtensionAfterUpdate	(		$installer,
			$eid
	)

On updating extensions logging method This method adds a record to #__action_logs contains (message, date, context, user) Method is called when an extension is updated

Paramètres

Installer	$installer	Installer instance
integer	$eid	Extension id

Renvoie

void

Depuis

3.9.0

Références $context, $manifest, $message, Joomla\checkLoggable(), CMSPlugin\getApplication(), et null.

onJoomlaAfterUpdate()

onJoomlaAfterUpdate

(

$oldVersion = null

)

On after CMS Update

Method is called after user update the CMS.

Paramètres

string

$oldVersion

The Joomla version before the update

Renvoie

void

Depuis

3.9.21

Références $context, $message, $user, CMSPlugin\getApplication(), et Factory\getUser().

onUserAfterDelete()

onUserAfterDelete	(		$user,
			$success,
			$msg
	)

On deleting user data logging method

Method is called after user data is deleted from the database

Paramètres

array	$user	Holds the user data
boolean	$success	True if user was successfully stored in the database
string	$msg	Message

Renvoie

void

Depuis

3.9.0

Références $context, $message, $user, Joomla\checkLoggable(), et CMSPlugin\getApplication().

onUserAfterDeleteGroup()

onUserAfterDeleteGroup	(		$group,
			$success,
			$msg
	)

On deleting user group data logging method

Method is called after user group is deleted from the database

Paramètres

array	$group	Holds the group data
boolean	$success	True if user was successfully stored in the database
string	$msg	Message

Renvoie

void

Depuis

3.9.0

Références $context, $message, Joomla\checkLoggable(), et CMSPlugin\getApplication().

onUserAfterLogin()

onUserAfterLogin

(

$options

)

Method to log user login success action

Paramètres

array

$options

Array holding options (user, responseType)

Renvoie

void

Depuis

3.9.0

Références $context, $loggedInUser, $message, $options, $this, et Joomla\checkLoggable().

onUserAfterRemind()

onUserAfterRemind

(

$user

)

On after Remind username request

Method is called after user request to remind their username.

Paramètres

array

$user

Holds the user data.

Renvoie

void

Depuis

3.9.0

Références $context, $message, $user, Joomla\checkLoggable(), et CMSPlugin\getApplication().

onUserAfterSave()

onUserAfterSave	(		$user,
			$isnew,
			$success,
			$msg
	)

On saving user data logging method

Method is called after user data is stored in the database. This method logs who created/edited any user's data

Paramètres

array	$user	Holds the new user data.
boolean	$isnew	True if a new user is stored.
boolean	$success	True if user was successfully stored in the database.
string	$msg	Message.

Renvoie

void

Depuis

3.9.0

Références $context, $message, $task, $user, $userId, Joomla\checkLoggable(), elseif, CMSPlugin\getApplication(), et Factory\getUser().

onUserAfterSaveGroup()

onUserAfterSaveGroup	(		$context,
			$table,
			$isNew
	)

On after save user group data logging method

Method is called after user group is stored into the database

Paramètres

string	$context	The context
Table	$table	DataBase Table object
boolean	$isNew	Is new or not

Renvoie

void

Depuis

3.9.0

Références $context, $message, Joomla\checkLoggable(), et CMSPlugin\getApplication().

onUserLoginFailure()

onUserLoginFailure

(

$response

)

Method to log user login failed action

Paramètres

array

$response

Array of response data.

Renvoie

void

Depuis

3.9.0

Références $context, $db, $loggedInUser, $message, $query, $this, Joomla\checkLoggable(), et Joomla\Database\getDatabase().

onUserLogout()

onUserLogout	(		$user,
			$options = array()
	)

Method to log user's logout action

Paramètres

array	$user	Holds the user data
array	$options	Array holding options (remember, autoregister, group)

Renvoie

void

Depuis

3.9.0

Références $context, $message, $this, $user, Joomla\checkLoggable(), et User\getInstance().

Documentation des champs

$contextAliases

$contextAliases = ['com_content.form' => 'com_content.article']

protected

$loggableApi

$loggableApi = false

protected

$loggableExtensions

$loggableExtensions = []

protected

$loggableVerbs

$loggableVerbs = []

protected

---

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

• Joomla.php