OpenDocumentRepository
Read onlyYes
FinalYes
Repository for managing recent documents for backend users.
Table of Contents
Methods
- add() : void
- Add or update a document in the recent list.
- findForUser() : array<string, OpenDocument>
- Find all recent documents for a user.
- remove() : void
- Remove a document from the recent list.
Methods
add()
Add or update a document in the recent list.
public
add(string $table, int $uid, BackendUserAuthentication $backendUser) : void
Parameters
- $table : string
-
Table name
- $uid : int
-
Record UID
- $backendUser : BackendUserAuthentication
findForUser()
Find all recent documents for a user.
public
findForUser(BackendUserAuthentication $backendUser) : array<string, OpenDocument>
Parameters
- $backendUser : BackendUserAuthentication
Return values
array<string, OpenDocument> —Indexed by document identifier (table:uid), limited to MAX_RECENT_DOCUMENTS
remove()
Remove a document from the recent list.
public
remove(string $identifier, BackendUserAuthentication $backendUser) : void
Used when a record is deleted.
Parameters
- $identifier : string
-
Document identifier (table:uid)
- $backendUser : BackendUserAuthentication