NoteRenderer
Renders notes for the current backend user
Table of Contents
Properties
- $backendViewFactory : BackendViewFactory
- $pagePermissionCache : array<string|int, mixed>
- $pageRenderer : PageRenderer
- $sysNoteRepository : SysNoteRepository
Methods
- __construct() : mixed
- renderList() : string
- Render notes by single PID
- enrichWithEditPermissions() : array<string|int, mixed>
- getBackendUser() : BackendUserAuthentication
Properties
$backendViewFactory read-only
protected
BackendViewFactory
$backendViewFactory
$pagePermissionCache
protected
array<string|int, mixed>
$pagePermissionCache
= []
$pageRenderer read-only
protected
PageRenderer
$pageRenderer
$sysNoteRepository read-only
protected
SysNoteRepository
$sysNoteRepository
Methods
__construct()
public
__construct(SysNoteRepository $sysNoteRepository, BackendViewFactory $backendViewFactory, PageRenderer $pageRenderer) : mixed
Parameters
- $sysNoteRepository : SysNoteRepository
- $backendViewFactory : BackendViewFactory
- $pageRenderer : PageRenderer
renderList()
Render notes by single PID
public
renderList(ServerRequestInterface $request, int $pid[, int|null $position = null ][, string $returnUrl = '' ]) : string
Parameters
- $request : ServerRequestInterface
-
Incoming request
- $pid : int
-
The page id notes should be rendered for
- $position : int|null = null
-
null for no restriction, integer for defined position
- $returnUrl : string = ''
-
Url to return to when editing and closing a notes record again
Return values
stringenrichWithEditPermissions()
protected
enrichWithEditPermissions(array<string|int, mixed> $notes) : array<string|int, mixed>
Parameters
- $notes : array<string|int, mixed>
Return values
array<string|int, mixed>getBackendUser()
protected
getBackendUser() : BackendUserAuthentication