Référence de l'interface ResultAwareInterface

Graphe d'héritage de ResultAwareInterface:

Fonctions membres publiques
	addResult ($data)
	typeCheckResult ($data)

Description détaillée

Defines an Event which has an append-only array argument named 'result'.

This is used for Events whose handlers are expected to return something when called, similar to how many plugin events worked in earlier versions of Joomla.

This interface is partially implemented by the ResultAware trait. The typeCheckResult method is implemented by the various ResultType*Aware traits. Your event needs to use both the ResultAware trait and one of the ResultType*Aware traits. For example, if your event returns boolean results you need to use the ResultAware and ResultTypeBooleanAware traits in your event.

Depuis

4.2.0

Documentation des fonctions membres

addResult()

addResult

(

$data

)

Appends data to the result array of the event.

Paramètres

mixed

$data

What to add to the result array.

Renvoie

void

Depuis

4.2.0

Référencé par Webauthn\onUserMultifactorGetMethod(), Totp\onUserMultifactorGetMethod(), Yubikey\onUserMultifactorGetMethod(), Fixed\onUserMultifactorGetMethod(), et Email\onUserMultifactorGetMethod().

typeCheckResult()

typeCheckResult

(

$data

)

Checks the type of the data being appended to the result argument.

Paramètres

mixed

$data

The data to type check

Renvoie

void

Exceptions

InvalidArgumentException

Implémenté dans AjaxChallenge.

---

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

• ResultAwareInterface.php