CoolCMS API

AuthLog extends BaseEntity
in package
implements IdentifiableInterface uses IdentifiableTrait

AbstractYes
Attributes
#[MappedSuperclass]
#[TableAlias]
$alias: 'authLog'

Table of Contents

Interfaces

IdentifiableInterface
Entity with a simple integer primary key. Most entities have one (often via {@see \App\Core\Traits\Shared\Models\Entities\IdentifiableTrait}); texts and links with a composite key do not, which is why `getId()` is not on {@see \App\Core\Base\BaseEntity}. Code that needs the id of a generic entity asks for this interface (parameter type, template bound, `instanceof`).

Properties

$apiClientId  : int|null
$createdAt  : DateTime|null
$eventType  : string
$id  : int|null
$ip  : string|null
$metadataJson  : string|null
$userAgent  : string|null
$userId  : int|null

Methods

__construct()  : mixed
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getApiClientId()  : int|null
getCreatedAt()  : DateTime|null
getEventType()  : string
getId()  : int|null
getIp()  : string|null
getMetadataJson()  : string|null
getUserAgent()  : string|null
getUserId()  : int|null
isPersisted()  : bool
setApiClientId()  : $this
setCreatedAt()  : $this
setEventType()  : $this
setId()  : $this
setIp()  : $this
setMetadataJson()  : $this
setUserAgent()  : $this
setUserId()  : $this
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$apiClientId

protected int|null $apiClientId = null
Attributes
#[Column]
$name: 'api_client_id'
$type: 'integer'
$nullable: true
$options: ['unsigned' => true]

$createdAt

protected DateTime|null $createdAt = null
Attributes
#[Column]
$name: 'created_at'
$type: 'datetime'

$eventType

protected string $eventType = ''
Attributes
#[Column]
$name: 'event_type'
$type: 'string'
$length: 40

$id

protected int|null $id = null
Attributes
#[Column]
$type: 'integer'
$name: 'auth_log_id'
$options: ['unsigned' => true]
#[GeneratedValue]
#[Id]

$metadataJson

protected string|null $metadataJson = null
Attributes
#[Column]
$name: 'metadata_json'
$type: 'text'
$nullable: true

$userAgent

protected string|null $userAgent = null
Attributes
#[Column]
$name: 'user_agent'
$type: 'string'
$length: 255
$nullable: true

$userId

protected int|null $userId = null
Attributes
#[Column]
$name: 'cms_system_users_user_id'
$type: 'integer'
$nullable: true
$options: ['unsigned' => true]
#[ExternalReadonly]

Methods

__construct()

public __construct([int|null $id = null ][, string $eventType = '' ][, int|null $userId = null ][, int|null $apiClientId = null ][, string|null $ip = null ][, string|null $userAgent = null ][, string|null $metadataJson = null ][, DateTime|null $createdAt = null ]) : mixed
Parameters
$id : int|null = null
$eventType : string = ''
$userId : int|null = null
$apiClientId : int|null = null
$ip : string|null = null
$userAgent : string|null = null
$metadataJson : string|null = null
$createdAt : DateTime|null = null

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.

public callInitMethods() : void

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.

public getAllTraits() : array<string, string>
Return values
array<string, string>

getApiClientId()

public getApiClientId() : int|null
Return values
int|null

getCreatedAt()

public getCreatedAt() : DateTime|null
Return values
DateTime|null

getEventType()

public getEventType() : string
Return values
string

getIp()

public getIp() : string|null
Return values
string|null

getMetadataJson()

public getMetadataJson() : string|null
Return values
string|null

getUserAgent()

public getUserAgent() : string|null
Return values
string|null

getUserId()

public getUserId() : int|null
Return values
int|null

setApiClientId()

public setApiClientId(int|null $apiClientId) : $this
Parameters
$apiClientId : int|null
Return values
$this

setCreatedAt()

public setCreatedAt(DateTime|null $createdAt) : $this
Parameters
$createdAt : DateTime|null
Return values
$this

setEventType()

public setEventType(string $eventType) : $this
Parameters
$eventType : string
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
Return values
$this

setIp()

public setIp(string|null $ip) : $this
Parameters
$ip : string|null
Return values
$this

setMetadataJson()

public setMetadataJson(string|null $metadataJson) : $this
Parameters
$metadataJson : string|null
Return values
$this

setUserAgent()

public setUserAgent(string|null $userAgent) : $this
Parameters
$userAgent : string|null
Return values
$this

setUserId()

public setUserId(int|null $userId) : $this
Parameters
$userId : int|null
Return values
$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.

private static getTraitsRecursive(array<string, string> $traits) : array<string, string>
Parameters
$traits : array<string, string>
Return values
array<string, string>
On this page

Search results