OpenDocumentController

Controller for documents processing.

Contains AJAX endpoints for the open docs toolbar item.

Internal

This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.

Attributes
#[AsController]

Table of Contents

Properties

$breadcrumb  : Breadcrumb
$breadcrumbFactory  : BreadcrumbFactory
$iconFactory  : IconFactory
$openDocumentRepository  : OpenDocumentRepository
$resourceFactory  : ResourceFactory
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
list()  : ResponseInterface
Returns all recent documents as JSON.
getBackendUser()  : BackendUserAuthentication
getBreadcrumb()  : array<int, array<string, mixed>>
Get breadcrumb nodes for a record using TYPO3's breadcrumb infrastructure.
getFileBreadcrumb()  : array<int, array<string, mixed>>
Get breadcrumb nodes for file/resource records.
serializeDocument()  : array<string, mixed>|null
Serialize a single document to JSON-friendly format.
serializeDocuments()  : array<int, array<string, mixed>>
Serialize documents to JSON-friendly format.

Properties

Methods

list()

Returns all recent documents as JSON.

public list(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Return values
ResponseInterface

getBreadcrumb()

Get breadcrumb nodes for a record using TYPO3's breadcrumb infrastructure.

protected getBreadcrumb(string $table, array<string|int, mixed> $record) : array<int, array<string, mixed>>
Parameters
$table : string
$record : array<string|int, mixed>
Return values
array<int, array<string, mixed>> —

Array of serialized BreadcrumbNode objects

getFileBreadcrumb()

Get breadcrumb nodes for file/resource records.

protected getFileBreadcrumb(string $table, array<string|int, mixed> $record) : array<int, array<string, mixed>>
Parameters
$table : string
$record : array<string|int, mixed>
Return values
array<int, array<string, mixed>> —

Array of serialized BreadcrumbNode objects

serializeDocument()

Serialize a single document to JSON-friendly format.

protected serializeDocument(OpenDocument $document) : array<string, mixed>|null
Parameters
$document : OpenDocument
Return values
array<string, mixed>|null —

Returns null if document is invalid or deleted

serializeDocuments()

Serialize documents to JSON-friendly format.

protected serializeDocuments(array<string, OpenDocument> $documents) : array<int, array<string, mixed>>
Parameters
$documents : array<string, OpenDocument>
Return values
array<int, array<string, mixed>> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results