IManager
in
Interface IManager
Tags
Table of Contents
Methods
- cleanup() : int
- Cleanup expired tokens
- create() : string
- Create a file and generate a token based on the file path and editor details
- edit() : Response
- Open the editing page for a provided token
- getEditors() : array<string|int, IEditor>
- getToken() : IToken
- Get the token details for a given token
- isEnabled() : bool
- Check if direct editing is enabled
- open() : string
- Create a token based on an existing file path and editor details
- registerDirectEditor() : void
- Register a new editor
Methods
cleanup()
Cleanup expired tokens
public
cleanup() : int
Tags
Return values
int —number of deleted tokens
create()
Create a file and generate a token based on the file path and editor details
public
create(string $path, string $editorId, string $creatorId[, mixed $templateId = null ]) : string
Parameters
- $path : string
- $editorId : string
- $creatorId : string
- $templateId : mixed = null
Tags
Return values
stringedit()
Open the editing page for a provided token
public
edit(string $token) : Response
Parameters
- $token : string
Tags
Return values
ResponsegetEditors()
public
getEditors() : array<string|int, IEditor>
Tags
Return values
array<string|int, IEditor>getToken()
Get the token details for a given token
public
getToken(string $token) : IToken
Parameters
- $token : string
Tags
Return values
ITokenisEnabled()
Check if direct editing is enabled
public
isEnabled() : bool
Tags
Return values
boolopen()
Create a token based on an existing file path and editor details
public
open(string $filePath[, string|null $editorId = null ][, int|null $fileId = null ]) : string
Parameters
- $filePath : string
- $editorId : string|null = null
- $fileId : int|null = null
Tags
Return values
stringregisterDirectEditor()
Register a new editor
public
registerDirectEditor(IEditor $directEditor) : void
Parameters
- $directEditor : IEditor