Class SimpleID\Base\AuditEvent

`extends`	`BaseEvent`

Base class to represent an audit event.

An audit event represents an action that are typically logged for audit purposes. An audit event is usually an action performed by a remote user agent affecting a subject (typically a user) or a client.

This base class automatically collects the following additional information:

the time the event occurred
the IP address of the remote machine
the name of the user agent provided by the remote machine
if the log_location configuration variable is set to true, uses a GeoIP resolver service to resolve the location of the IP address

SimpleID\Util\Events\BaseEvent
- SimpleID\Base\AuditEvent
  - SimpleID\Auth\CredentialEvent implements GenericEventInterface uses GenericEventTrait
  - SimpleID\Auth\LoginEvent implements FormEventInterface
  - SimpleID\Auth\LogoutEvent
  - SimpleID\Base\ConsentEvent implements GenericEventInterface uses GenericEventTrait
  - SimpleID\Protocols\ProtocolResultEvent implements ProtocolResult

Located at core/Base/AuditEvent.php

Methods


					
	public

__construct(Storable $subject = null, Storable $client = null)

Creates an audit event

Parameters

`$subject`	the subject affected by the event
`$client`	the client affected by the event

Overridden by


					
	public

getTime(): DateTimeImmutable

Returns the time the event occurred.


					
	public

getIP(): string|null

Returns the IP address of the user agent that triggered this event.

Returns

the IP address or null if the IP address is not available


					
	public

getUserAgent(): string|null

Returns the user agent that triggered this event.

Returns

the name of the user agent or null if it is not available


					
	public

getLocation(): array<string, string>|null

Returns the location information based on the IP address.

The location information is an array returned by Fat-Free Framework's \Web\Geo::location() function.

Returns

an array containing location information, or null if the information is not available


					
	public

getSubject(): Storable|null

Returns the subject (usually the user) affected by this event.

Returns

the subject affected by this event


					
	public

getClient(): Storable|null

Returns the client affected by this event.

Returns

the client affected by this event


					
	public

getAuditEventName(): string

Returns a shortened event name for audit purposes.

If the event implements GenericEventInterface, this is equivalent to getEventName(). Otherwise, it returns the name of the event class, without the namespace.

Classes that do not use GenericEventInterface may wish to override this method to return a shorter event name.

Properties
`protected`	`DateTimeImmutable`	`$time`	#
`protected`	`string\|null`	`$ip = null`	#
`protected`	`string\|null`	`$userAgent = null`	#
`protected`	`array<string, string>\|null`	`$location = null`	#
`protected`	`Storable\|null`	`$subject`	#
`protected`	`Storable\|null`	`$client`	#

Namespaces

Classes

Class SimpleID\Base\AuditEvent

Parameters

Overridden by

Returns

Returns

Returns

Returns

Returns