OpenDocumentService

Access to open and recent documents

Internal

helper class

Table of Contents

Methods

closeAllDocuments()  : void
Closes all open documents
closeDocument()  : void
Close a document and add it to the list of recent documents
getOpenDocuments()  : array<string|int, mixed>
Get the list of open documents for the current user
getRecentDocuments()  : array<string|int, mixed>
Get the list of recent documents for the current user
addToRecentDocuments()  : void
Add a document to the list of recent documents
getBackendUser()  : BackendUserAuthentication
storeOpenDocuments()  : void
Store a list of open documents

Methods

closeAllDocuments()

Closes all open documents

public closeAllDocuments() : void

closeDocument()

Close a document and add it to the list of recent documents

public closeDocument(string $identifier) : void
Parameters
$identifier : string

a document identifier (MD5 hash)

getOpenDocuments()

Get the list of open documents for the current user

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

getRecentDocuments()

Get the list of recent documents for the current user

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

addToRecentDocuments()

Add a document to the list of recent documents

protected addToRecentDocuments(string $identifier, array<string|int, mixed> $document) : void
Parameters
$identifier : string

identifier of the document

$document : array<string|int, mixed>

document data

storeOpenDocuments()

Store a list of open documents

protected storeOpenDocuments(array<string|int, mixed> $openDocuments) : void
Parameters
$openDocuments : array<string|int, mixed>

        
On this page

Search results