Craft Activity (2.x)

Application extends Recorder
in package

Table of Contents

$_isRecording  : bool
$logQueue  : array<string|int, mixed>
emptyQueue()  : mixed
Empty the commited log queue, causing all the logs in the queue to be lost
getIsRecording()  : bool
Is this recorder currently recording
getQueue()  : array<string|int, mixed>
Get the log queue
getQueuedLogByUid()  : ActivityLog|null
Get a queued log for an uid and type
init()  : void
onEditionChanged()  : mixed
Record log when the edition is changed
queueHasLogForUid()  : bool
Does a log related to an uid and type exists in the queue
removeQueuedLogsByUid()  : mixed
Remove a queued log by uid and type
saveLogs()  : mixed
Save all queued logs
startRecording()  : mixed
Get this recorder to start recording
stopRecording()  : mixed
Get this recorder to stop recording
commitLog()  : bool
Commit a log to be saved, log will be added in the queue if $saveNow is false
isTypeIgnored()  : bool
is a type ignored by the settings
shouldSaveLog()  : bool
Should a log type be saved

Properties

$_isRecording

protected bool $_isRecording = true

$logQueue

protected array<string|int, mixed> $logQueue = []

Methods

emptyQueue()

Empty the commited log queue, causing all the logs in the queue to be lost

public emptyQueue() : mixed
Return values
mixed

getIsRecording()

Is this recorder currently recording

public getIsRecording() : bool
Return values
bool

getQueue()

Get the log queue

public getQueue() : array<string|int, mixed>
Return values
array<string|int, mixed>

getQueuedLogByUid()

Get a queued log for an uid and type

public getQueuedLogByUid(string $uid, string $type) : ActivityLog|null
Parameters
$uid : string
$type : string
Return values
ActivityLog|null

init()

public init() : void
Tags
inheritDoc
Return values
void

onEditionChanged()

Record log when the edition is changed

public onEditionChanged(string $oldEdition, string $newEdition) : mixed
Parameters
$oldEdition : string
$newEdition : string
Return values
mixed

queueHasLogForUid()

Does a log related to an uid and type exists in the queue

public queueHasLogForUid(string $uid, string $type) : bool
Parameters
$uid : string
$type : string
Return values
bool

removeQueuedLogsByUid()

Remove a queued log by uid and type

public removeQueuedLogsByUid(string $uid, string $type) : mixed
Parameters
$uid : string
$type : string
Return values
mixed

saveLogs()

Save all queued logs

public saveLogs() : mixed
Return values
mixed

startRecording()

Get this recorder to start recording

public startRecording() : mixed
Return values
mixed

stopRecording()

Get this recorder to stop recording

public stopRecording() : mixed
Return values
mixed

commitLog()

Commit a log to be saved, log will be added in the queue if $saveNow is false

protected commitLog(string $type[, array<string|int, mixed> $params = [] ][, bool $saveNow = false ]) : bool
Parameters
$type : string
$params : array<string|int, mixed> = []
$saveNow : bool = false
Return values
bool

isTypeIgnored()

is a type ignored by the settings

protected isTypeIgnored(string $type) : bool
Parameters
$type : string
Return values
bool

shouldSaveLog()

Should a log type be saved

protected shouldSaveLog(string $type) : bool
Parameters
$type : string
Return values
bool

Search results