HistoryService implements SingletonInterface
Service for history
Table of Contents
Interfaces
- SingletonInterface
- "empty" interface for singletons (marker interface pattern)
Properties
- $backendUserNames : array<string|int, mixed>
- $differencesObject : DiffUtility|null
- $historyEntries : array<string|int, mixed>
Methods
- __construct() : mixed
- Creates this object.
- getHistory() : array<string|int, mixed>
- Gets the editing history of a record.
- getStageChanges() : array<string|int, mixed>
- getDifferences() : array<string|int, mixed>
- Gets the differences between two record versions out of one record history entry.
- getDifferencesObject() : DiffUtility
- Gets an instance of the record differences utility.
- getHistoryEntries() : array<string|int, mixed>
- Gets an instance of the record history of a record.
- getHistoryEntry() : array<string|int, mixed>
- Gets the human readable representation of one record history entry.
- getLanguageService() : LanguageService
- getUserName() : string
- Gets the username of a backend user.
Properties
$backendUserNames
protected
array<string|int, mixed>
$backendUserNames
$differencesObject
protected
DiffUtility|null
$differencesObject
$historyEntries
protected
array<string|int, mixed>
$historyEntries
= []
Methods
__construct()
Creates this object.
public
__construct() : mixed
getHistory()
Gets the editing history of a record.
public
getHistory(string $table, int $id) : array<string|int, mixed>
Parameters
- $table : string
-
Name of the table
- $id : int
-
Uid of the record
Return values
array<string|int, mixed> —Record history entries
getStageChanges()
public
getStageChanges(string $table, int $id) : array<string|int, mixed>
Parameters
- $table : string
- $id : int
Return values
array<string|int, mixed>getDifferences()
Gets the differences between two record versions out of one record history entry.
protected
getDifferences(array<string|int, mixed> $entry) : array<string|int, mixed>
Parameters
- $entry : array<string|int, mixed>
-
Record history entry
Return values
array<string|int, mixed>getDifferencesObject()
Gets an instance of the record differences utility.
protected
getDifferencesObject() : DiffUtility
Return values
DiffUtilitygetHistoryEntries()
Gets an instance of the record history of a record.
protected
getHistoryEntries(string $table, int $id) : array<string|int, mixed>
Parameters
- $table : string
-
Name of the table
- $id : int
-
Uid of the record
Return values
array<string|int, mixed>getHistoryEntry()
Gets the human readable representation of one record history entry.
protected
getHistoryEntry(array<string|int, mixed> $entry) : array<string|int, mixed>
Parameters
- $entry : array<string|int, mixed>
-
Record history entry
Tags
Return values
array<string|int, mixed>getLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetUserName()
Gets the username of a backend user.
protected
getUserName(string $user) : string
Parameters
- $user : string