Class SimpleID\Auth\CredentialEvent

`extends`	`AuditEvent`
`implements`	`GenericEventInterface`
`uses`	`GenericEventTrait`

Event dispatched when a user has added, changed or removed a credential under an authentication scheme.

Some authentication schemes handle multiple credentials (e.g. WebAuthnAuthSchemeModule handles multiple security keys), whereas others can only handle a single credential (e.g. a password). If an authentication scheme handle multiple credentials, each credential is identified using a module-specifc ID.

SimpleID\Util\Events\BaseEvent
- SimpleID\Base\AuditEvent
  - SimpleID\Auth\CredentialEvent implements GenericEventInterface uses GenericEventTrait

Located at core/Auth/CredentialEvent.php

Methods


					
	public

__construct(User $user, string $event_type, string $auth_module_name, ?string $credential_id = null)

Creates a credential event.

Parameters

`$user`	the user whose credentials were affected by this event
`$event_type`	the event type (one of `CREDENTIAL_ADDED_EVENT`, `CREDENTIAL_CHANGED_EVENT` or `CREDENTIAL_DELETED_EVENT`)
`$auth_module_name`	the name of the module which is managing the credential
`$credential_id`	the module-specifc ID of the credential (if any)

Overrides

SimpleID\Base\AuditEvent::__construct()


					
	public

getAuthModuleName(): string

Returns the name of the module that manages this credential.

Returns

the fully qualified class name of the module that manages this credential


					
	public

getCredentialId(): string

Returns the ID of the credential affected by this event.

If the authentication scheme only handles one credential, this function may return null.

Returns

ID of the credential affected by this event

Methods inherited from SimpleID\Base\AuditEvent
`getTime(), getIP(), getUserAgent(), getLocation(), getSubject(), getClient(), getAuditEventName()`

Methods used from SimpleID\Util\Events\GenericEventTrait
`setEventName(), getEventName()`

Constants
`public`	`CREDENTIAL_ADDED_EVENT = 'credential_added'` Event type when a credential is added to the user's profile Event type when a credential is added to the user's profile	#
`public`	`CREDENTIAL_CHANGED_EVENT = 'credential_changed'` Event type when a credential is changed in the user's profile (e.g. changing a password) Event type when a credential is changed in the user's profile (e.g. changing a password)	#
`public`	`CREDENTIAL_DELETED_EVENT = 'credential_deleted'` Event type when a credential is deleted from the user's profile Event type when a credential is deleted from the user's profile	#

Properties
`protected`	`string`	`$authModuleName`	#
`protected`	`?string`	`$credentialId`	#

Properties inherited from SimpleID\Base\AuditEvent
`$time, $ip, $userAgent, $location, $subject, $client`

Properties used from SimpleID\Util\Events\GenericEventTrait
`$eventName`

Namespaces

Classes

Interfaces

Traits

Class SimpleID\Auth\CredentialEvent

Parameters

Overrides

Returns

Returns