Joomla! Documentation™

In een standaard Joomla installatie hebben we een aantal vooraf gedefineerde gebruiker gebeurtenissen die, wanneer geactiveerd, functies oproepen in de bijbehorende plugins.

onUserAuthorisation

Beschrijving

Deze gebeurtenis wordt geactiveerd nadat de gebruiker is geverifieerd in het Joomla! gebruikersbestand.

Parameters

• $user - een associatieve array van het JAuthenticateResponse type (zie link voor array keys)
• $options - een associatieve array die de volgende sleutels bevat: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

Return waarde

Boolean

Gebruikt in bestanden

• libraries/joomla/user/authentication.php

Voorbeeld

• Plugin User - Face Control

onUserAuthorisationFailure

Description

The system triggers this event when the user has been authenticated but he has not been authorised to login. You should only use this event in User plugins.

Parameters

• $user - an object JAuthenticationResponse

Return Value

void (it does not return any value or object)

Used in files

• libraries/cms/application/cms.php

onUserLogin

Description

This event is triggered after the user is authenticated against the Joomla! user-base.

Als het nodig is om de login-procedure (verificatie) af te breken, dan zult u de onUserAuthenticate in plaats daarvan moeten gebruiken.

Parameters

• $user - an associative array of JAuthenticationResponse type (see link for array keys)
• $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

Return Value

Boolean

Used in files

• libraries/joomla/application/application.php
• plugins/user/joomla.php

Example

• plugins/user/example.php

onUserLogout

Beschrijving

Dit evenement wordt gestart vóór de gebruiker is afgemeld van het systeem.

Als een plugin false retourneert zal het algemene uitloggen mislukken en de onUserLogoutFailure event wordt geactiveerd; als dit lukt zal het onUserAfterLogout event worden geactiveerd.

NOTE: as of 3.3.6, returning false does not work correctly, because stock components perform their logout operation during the onUserLogout event. So even if your plugin returns false, the stock ones have already run anyway. Thus, the user will be "mostly" logged out even if you return false. There is no actual way to cleanly abort logout.

Parameters

• $credentials - een associatieve array die de volgende sleutels bevat: ["username"] => string, ["id"] => int
• $options - een associatieve array die de volgende sleutels bevat: ["clientid"] => int

Return waarde

Boolean

Gebruikt in bestanden

• libraries/cms/application/cms.php
• plugins/user/joomla/joomla.php
• plugins/system/logout.php
• plugins/system/remember/remember.php

Voorbeeld

• plugins/user/example.php

onUserLoginFailure

Beschrijving

Deze gebeurtenis wordt geactiveerd wanneer een gebruiker authenticatie-aanvraag is mislukt door een plugin.

Parameters

Two parameters. The credentials array for the user (see onAuthenticate), and the JAuthenticationResponse that caused the failure.

Return Value

Unknown. The return value appears to be ignored in any case.

Gebruikt in bestand

• libraries/joomla/application/user/authentication.php

onUserAfterLogin

Beschrijving

Deze gebeurtenis wordt geactiveerd wanneer een gebruiker succesvol is ingelogd.

Parameters

Opties is een array met:

• remember
• return
• entry_url
• action
• user - JUser Object
• responseType

Retourwaarde

Boolean

Gebruikt in bestanden

• libraries/legacy/application/application.php
• libraries/cms/application/cms.php
• plugins/authentication/cookie/cookie.php

onUserBeforeSave

Description

This event is triggered before an update of a user record.

De oude en de nieuwe gebruiker parameters worden aangeboden; veel gebruikte leden zijn: gebruikersnaam, naam, e-mailadres, wachtwoord, wachtwoord_wissen.

The password array entry is the hashed password value. If the user has just changed the password, you may retrieve the cleartext password from $newUser['password_clear']. (It will be set to "" if the password has not been changed.)

Parameters

• $oldUser - An associative array of the columns in the user table (current values).
• $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
• $newUser - An associative array of the columns in the user table (new values).

Return Value

Boolean. Whether the user-save should proceed or not. Any plugin that returns false aborts the save.

Gebruikt in bestand

• libraries/joomla/user/user.php

Voorbeeld

• plugins/user/example.php

onUserAfterSave

Description

This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

Parameters

• $user - An associative array of the columns in the user table.
• $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
• $success - Boolean to identify if the store was successful
• $msg - Error message if store failed

Note: The old values that were just updated are not available here or afterwards. In case you need the old values, use onBeforeStoreUser().

Retourwaarde

Geen

Gebruikt in bestand

• libraries/joomla/user/user.php

Voorbeeld

• plugins/user/example.php

onUserBeforeDelete

Beschrijving

De gebeurtenis wordt geactiveerd wanneer een gebruiker wordt verwijderd uit het systeem.

Parameters

• $user - Een associatieve array van de kolommen in de user tabel.

Retourwaarde

Geen.

Gebruikt in bestanden

• libraries/joomla/user/user.php
• plugins/user/joomla.php

Voorbeeld

• plugins/user/example.php

onUserAfterDelete

Beschrijving

De gebeurtenis wordt geactiveerd wanneer een gebruiker verwijderd is uit het systeem.

Parameters

• $user - An associative array of the columns in the user table.
• $succes - Boolean to identify if the deletion was successful
• $msg - Error message if delete failed (JError object detailing the error, if any)

Retourwaarde

Geen.

Gebruikt in bestanden

• libraries/joomla/user/user.php
• plugins/user/joomla.php

Voorbeeld

• plugins/user/example.php

Volgorde van uitvoering

To modify Joomla! login process upon your needs (e.g. creating AJAX output for login), it may be useful to know the order of the events to be fired.

Foutieve referenties	CORRECT CREDENTIALS and the user is not blocked (is activated)	CORRECT CREDENTIALS and the user is blocked (is not activated)
onUserAuthenticate returns TRUE or FALSE | | \ / onUserLoginFailure	onUserAuthenticate returns TRUE or FALSE | | \ / onUserLogin returns FALSE -> END returns TRUE | | \ / onUserAfterLogin	onUserAuthenticate returns TRUE or FALSE | | \ / onUserLogin returns TRUE or FALSE | | \ / END

Example idea Let's assume you want to preform Ajax login. You have already overriden a mod_login form so it's posted to Joomla! via an AJAX call. You added a field named ajax to the form. So when the form is posted and authentication is failed, your custom plugin must return some JSON data.

public function onUserLoginFailure($response)
{
	$input  = JFactory::getApplication()->input;

	// If a non-ajax form was posted, we do not modify the behavior
	if (!$input->post->get('ajax', false))
	{
		return;
	}

	$app = JFactory::getApplication();
	$task_failed = false; 

	// Fill this array with the data you want to return, e.g. $response['status'] may be useful
	// Check libraries/joomla/user/authentication.php for available status codes 
	$data = array('status' => $response['status']);
        
        // At least here in the plugin it's a must to send proper headers
        JFactory::getApplication()->setHeader('Content-Type', 'application/json', true)->sendHeaders();
	echo new JResponseJson($data, $response['error_message'], $task_failed);

	// Closing app is a must here to return JSON immediately
	$app->close();
}