AdministrationController

class \TYPO3\CMS\IndexedSearch\Controller\AdministrationController

Extends
ActionController
Uses
AllowedMethodsTrait

Administration controller. Main module "Indexing".

Table of Contents

Properties

$actionMethodName  : string
Name of the action method
$administrationRepository  : AdministrationRepository
$arguments  : Arguments
$configurationManager  : ConfigurationManagerInterface
$connectionPool  : ConnectionPool
$defaultViewObjectName  : string
The default view object to use if none of the resolved views can render a response for the current request.
$errorMethodName  : string
Name of the special error action method which is called in case of errors
$eventDispatcher  : EventDispatcherInterface
$extensionConfiguration  : ExtensionConfiguration
$hashService  : HashService
$iconFactory  : IconFactory
$indexer  : Indexer
$indexerConfig  : array
$moduleTemplateFactory  : ModuleTemplateFactory
$mvcPropertyMappingConfigurationService  : MvcPropertyMappingConfigurationService
$pageUid  : int
$reflectionService  : ReflectionService
$request  : RequestInterface
The current request.
$responseFactory  : ResponseFactoryInterface
$settings  : array
Contains the settings of the current extension
$streamFactory  : StreamFactoryInterface
$uriBuilder  : UriBuilder
$validatorResolver  : ValidatorResolver
$view  : ViewInterface
The current view, as resolved by resolveView()

Methods

__construct()  : mixed
addFlashMessage()  : mixed
Creates a Message object and adds it to the FlashMessageQueue.
initializeControllerArgumentsBaseValidators()  : mixed
Collects the base validators which were defined for the data type of each controller argument and adds them to the argument's validator chain.
injectConfigurationManager()  : mixed
injectEventDispatcher()  : void
injectHashService()  : mixed
injectInternalExtensionService()  : void
injectInternalFlashMessageService()  : void
injectMvcPropertyMappingConfigurationService()  : mixed
injectPropertyMapper()  : void
injectReflectionService()  : mixed
injectResponseFactory()  : mixed
injectStreamFactory()  : mixed
injectValidatorResolver()  : mixed
injectViewResolver()  : mixed
processRequest()  : ResponseInterface
Override the action name if found in the uc of the user
throwStatus()  : never
Sends the specified HTTP status immediately and only stops to run back through the middleware stack.
addBaseUriIfNecessary()  : string
Adds the base uri if not already in place.
addErrorFlashMessage()  : mixed
If an error occurred during this request, this adds a flash message describing the error to the flash message container.
assertAllowedHttpMethod()  : void
Assert if request method matches allowed HTTP methods and throw exception on mismatch.
callActionMethod()  : ResponseInterface
Calls the specified action method and passes the arguments.
deleteIndexedItemAction()  : ResponseInterface
Remove item from index
errorAction()  : ResponseInterface
A special action which is called if the originally intended action could not be called, for example if the arguments were not valid.
externalDocumentsAction()  : ResponseInterface
Statistics for external documents
forwardToReferringRequest()  : ResponseInterface|null
If information on the request before the current request was sent, this method forwards back to the originating request. This effectively ends processing of the current request, so do not call this method before you have finished the necessary business logic!
getBackendUserAuthentication()  : BackendUserAuthentication
getErrorFlashMessage()  : string|bool
A template method for displaying custom error flash messages, or to display no flash message at all on errors. Override this to customize the flash message in your action controller.
getFlashMessageQueue()  : FlashMessageQueue
todo: As soon as the incoming request contains the compiled plugin namespace, extbase will offer a trait to create a flash message identifier from the current request. Users then should inject the flash message service themselves if needed.
getFlattenedValidationErrorMessage()  : string
Returns a string with a basic error message about validation failure.
getLanguageService()  : LanguageService
htmlResponse()  : ResponseInterface
Returns a response object with either the given html string or the current rendered view as content.
indexAction()  : ResponseInterface
Index action contains the most important statistics
initializeAction()  : mixed
Function will be called before every other action
initializeActionMethodArguments()  : void
Implementation of the arguments initialization in the action controller: Automatically registers arguments of the current action
initializeActionMethodValidators()  : void
Adds the needed validators to the Arguments:
initializeDeleteIndexedItemAction()  : void
initializeModuleTemplate()  : ModuleTemplate
Generates the action menu
initializeSaveStopwordsKeywordsAction()  : void
jsonResponse()  : ResponseInterface
Returns a response object with either the given json string or the current rendered view as content. Mainly to be used for actions / controllers using the JsonView.
mapRequestArgumentsToControllerArguments()  : mixed
Maps arguments delivered by the request object to the local controller arguments.
pagesAction()  : ResponseInterface
Statistics for pages
redirect()  : ResponseInterface
Redirects the request to another action and / or controller.
redirectToUri()  : ResponseInterface
Redirects the web request to another uri.
renderAssetsForRequest()  : void
Method which initializes assets that should be attached to the response for the given $request, which contains parameters that an override can use to determine which assets to add via PageRenderer.
resolveActionMethodName()  : string
Resolves and checks the current action method name
resolveView()  : ViewInterface
Prepares a view for the current action.
saveStopwordsKeywordsAction()  : ResponseInterface
Save stop words and keywords
setViewConfiguration()  : void
statisticAction()  : ResponseInterface
General statistics
statisticDetailsAction()  : ResponseInterface
Statistics for a given page hash
wordDetailAction()  : ResponseInterface
Statistics for a given word id

Properties

$actionMethodName

Name of the action method

protected string $actionMethodName = 'indexAction'

$defaultViewObjectName

The default view object to use if none of the resolved views can render a response for the current request.

protected string $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class

$errorMethodName

Name of the special error action method which is called in case of errors

protected string $errorMethodName = 'errorAction'

$eventDispatcher

protected EventDispatcherInterface $eventDispatcher

$hashService

protected HashService $hashService

$indexerConfig

protected array $indexerConfig = []

$reflectionService

protected ReflectionService $reflectionService

$responseFactory

protected ResponseFactoryInterface $responseFactory

$settings

Contains the settings of the current extension

protected array $settings

$streamFactory

protected StreamFactoryInterface $streamFactory

$validatorResolver

protected ValidatorResolver $validatorResolver

$view

The current view, as resolved by resolveView()

protected ViewInterface $view

Methods

__construct()

public __construct(ModuleTemplateFactory $moduleTemplateFactory, AdministrationRepository $administrationRepository, Indexer $indexer, IconFactory $iconFactory, ExtensionConfiguration $extensionConfiguration, ConnectionPool $connectionPool) : mixed

Parameters

$moduleTemplateFactory : ModuleTemplateFactory
$administrationRepository : AdministrationRepository
$indexer : Indexer
$iconFactory : IconFactory
$extensionConfiguration : ExtensionConfiguration
$connectionPool : ConnectionPool

addFlashMessage()

Creates a Message object and adds it to the FlashMessageQueue.

public addFlashMessage(string $messageBody[, string $messageTitle = '' ][, int|ContextualFeedbackSeverity $severity = ContextualFeedbackSeverity::OK ][, bool $storeInSession = true ]) : mixed

Parameters

$messageBody : string
$messageTitle : string = ''

Optional message title

$severity : int|ContextualFeedbackSeverity = ContextualFeedbackSeverity::OK

Optional severity, must be one of \TYPO3\CMS\Core\Type\ContextualFeedbackSeverity cases. Accepts int values as well, which is deprecated.

$storeInSession : bool = true

Optional, defines whether the message should be stored in the session (default) or not

Tags

throws
InvalidArgumentException

if the message body is no string

see
FlashMessage
todo:

Change $severity to allow ContextualFeedbackSeverity only in v13

initializeControllerArgumentsBaseValidators()

Collects the base validators which were defined for the data type of each controller argument and adds them to the argument's validator chain.

public initializeControllerArgumentsBaseValidators() : mixed

injectEventDispatcher()

public injectEventDispatcher(EventDispatcherInterface $eventDispatcher) : void

Parameters

$eventDispatcher : EventDispatcherInterface

injectHashService()

public injectHashService(HashService $hashService) : mixed

Parameters

$hashService : HashService

injectInternalExtensionService()

public final injectInternalExtensionService(ExtensionService $extensionService) : void

Parameters

$extensionService : ExtensionService

injectInternalFlashMessageService()

public final injectInternalFlashMessageService(FlashMessageService $flashMessageService) : void

Parameters

$flashMessageService : FlashMessageService

injectPropertyMapper()

public injectPropertyMapper(PropertyMapper $propertyMapper) : void

Parameters

$propertyMapper : PropertyMapper

injectReflectionService()

public injectReflectionService(ReflectionService $reflectionService) : mixed

Parameters

$reflectionService : ReflectionService

injectResponseFactory()

public final injectResponseFactory(ResponseFactoryInterface $responseFactory) : mixed

Parameters

$responseFactory : ResponseFactoryInterface

injectStreamFactory()

public final injectStreamFactory(StreamFactoryInterface $streamFactory) : mixed

Parameters

$streamFactory : StreamFactoryInterface

injectValidatorResolver()

public injectValidatorResolver(ValidatorResolver $validatorResolver) : mixed

Parameters

$validatorResolver : ValidatorResolver

processRequest()

Override the action name if found in the uc of the user

public processRequest(RequestInterface $request) : ResponseInterface

Parameters

$request : RequestInterface

The request object

Return values

ResponseInterface

throwStatus()

Sends the specified HTTP status immediately and only stops to run back through the middleware stack.

public throwStatus(int $statusCode[, string $statusMessage = null ][, string $content = null ]) : never

Note: If any other plugin or content or hook is used within a frontend request, this is skipped by design.

Parameters

$statusCode : int

The HTTP status code

$statusMessage : string = null

A custom HTTP status message

$content : string = null

Body content which further explains the status

Tags

throws
PropagateResponseException

Return values

never

addBaseUriIfNecessary()

Adds the base uri if not already in place.

protected addBaseUriIfNecessary(string $uri) : string

Parameters

$uri : string

The URI

Return values

string

addErrorFlashMessage()

If an error occurred during this request, this adds a flash message describing the error to the flash message container.

protected addErrorFlashMessage() : mixed

assertAllowedHttpMethod()

Assert if request method matches allowed HTTP methods and throw exception on mismatch.

protected assertAllowedHttpMethod(ServerRequestInterface $request, non-empty-string ...$allowedHttpMethods) : void

Parameters

$request : ServerRequestInterface
$allowedHttpMethods : non-empty-string

Tags

throws
MethodNotAllowedException

callActionMethod()

Calls the specified action method and passes the arguments.

protected callActionMethod(RequestInterface $request) : ResponseInterface

If the action returns a string, it is appended to the content in the response object. If the action doesn't return anything and a valid view exists, the view is rendered automatically.

Parameters

$request : RequestInterface

Return values

ResponseInterface

deleteIndexedItemAction()

Remove item from index

protected deleteIndexedItemAction(string $itemId[, int $depth = 1 ][, string $mode = 'overview' ]) : ResponseInterface

Parameters

$itemId : string
$depth : int = 1
$mode : string = 'overview'

Return values

ResponseInterface

errorAction()

A special action which is called if the originally intended action could not be called, for example if the arguments were not valid.

protected errorAction() : ResponseInterface

The default implementation sets a flash message, request errors and forwards back to the originating action. This is suitable for most actions dealing with form input.

We clear the page cache by default on an error as well, as we need to make sure the data is re-evaluated when the user changes something.

Return values

ResponseInterface

externalDocumentsAction()

Statistics for external documents

protected externalDocumentsAction() : ResponseInterface

Return values

ResponseInterface

forwardToReferringRequest()

If information on the request before the current request was sent, this method forwards back to the originating request. This effectively ends processing of the current request, so do not call this method before you have finished the necessary business logic!

protected forwardToReferringRequest() : ResponseInterface|null

Return values

ResponseInterface|null

getErrorFlashMessage()

A template method for displaying custom error flash messages, or to display no flash message at all on errors. Override this to customize the flash message in your action controller.

protected getErrorFlashMessage() : string|bool

Return values

string|bool —

The flash message or FALSE if no flash message should be set

getFlashMessageQueue()

todo: As soon as the incoming request contains the compiled plugin namespace, extbase will offer a trait to create a flash message identifier from the current request. Users then should inject the flash message service themselves if needed.

protected getFlashMessageQueue([string|null $identifier = null ]) : FlashMessageQueue

Parameters

$identifier : string|null = null

Return values

FlashMessageQueue

getFlattenedValidationErrorMessage()

Returns a string with a basic error message about validation failure.

protected getFlattenedValidationErrorMessage() : string

We may add all validation error messages to a log file in the future, but for security reasons (@see #54074) we do not return these here.

Return values

string

htmlResponse()

Returns a response object with either the given html string or the current rendered view as content.

protected htmlResponse([string|null $html = null ]) : ResponseInterface

Parameters

$html : string|null = null

Return values

ResponseInterface

indexAction()

Index action contains the most important statistics

protected indexAction() : ResponseInterface

Return values

ResponseInterface

initializeAction()

Function will be called before every other action

protected initializeAction() : mixed

initializeActionMethodArguments()

Implementation of the arguments initialization in the action controller: Automatically registers arguments of the current action

protected initializeActionMethodArguments() : void

Don't override this method - use initializeAction() instead.

Tags

throws
InvalidArgumentTypeException
see
initializeArguments()

initializeActionMethodValidators()

Adds the needed validators to the Arguments:

protected initializeActionMethodValidators() : void
  • Validators checking the data type from the @param annotation
  • Custom validators specified with validate annotations.
  • Model-based validators (validate annotations in the model)
  • Custom model validator classes

initializeDeleteIndexedItemAction()

protected initializeDeleteIndexedItemAction() : void

initializeModuleTemplate()

Generates the action menu

protected initializeModuleTemplate(ServerRequestInterface $request) : ModuleTemplate

Parameters

$request : ServerRequestInterface

Return values

ModuleTemplate

initializeSaveStopwordsKeywordsAction()

protected initializeSaveStopwordsKeywordsAction() : void

jsonResponse()

Returns a response object with either the given json string or the current rendered view as content. Mainly to be used for actions / controllers using the JsonView.

protected jsonResponse([string|null $json = null ]) : ResponseInterface

Parameters

$json : string|null = null

Return values

ResponseInterface

mapRequestArgumentsToControllerArguments()

Maps arguments delivered by the request object to the local controller arguments.

protected mapRequestArgumentsToControllerArguments() : mixed

Tags

throws
RequiredArgumentMissingException

pagesAction()

Statistics for pages

protected pagesAction() : ResponseInterface

Return values

ResponseInterface

redirect()

Redirects the request to another action and / or controller.

protected redirect(string|null $actionName[, string|null $controllerName = null ][, string|null $extensionName = null ][, array|null $arguments = null ][, int|null $pageUid = null ][, null $_ = null ][, int $statusCode = 303 ]) : ResponseInterface

Redirect will be sent to the client which then performs another request to the new URI.

Parameters

$actionName : string|null

Name of the action to forward to

$controllerName : string|null = null

Unqualified object name of the controller to forward to. If not specified, the current controller is used.

$extensionName : string|null = null

Name of the extension containing the controller to forward to. If not specified, the current extension is assumed.

$arguments : array|null = null

Arguments to pass to the target action

$pageUid : int|null = null

Target page uid. If NULL, the current page uid is used

$_ : null = null

(optional) Unused

$statusCode : int = 303

(optional) The HTTP status code for the redirect. Default is "303 See Other

Return values

ResponseInterface

redirectToUri()

Redirects the web request to another uri.

protected redirectToUri(mixed $uri[, null $_ = null ][, int $statusCode = 303 ]) : ResponseInterface

Parameters

$uri : mixed

A string representation of a URI

$_ : null = null

(optional) Unused

$statusCode : int = 303

(optional) The HTTP status code for the redirect. Default is "303 See Other"

Return values

ResponseInterface

renderAssetsForRequest()

Method which initializes assets that should be attached to the response for the given $request, which contains parameters that an override can use to determine which assets to add via PageRenderer.

protected renderAssetsForRequest(RequestInterface $request) : void

This default implementation will attempt to render the sections "HeaderAssets" and "FooterAssets" from the template that is being rendered, inserting the rendered content into either page header or footer, as appropriate. Both sections are optional and can be used one or both in combination.

You can add assets with this method without worrying about duplicates, if for example you do this in a plugin that gets used multiple time on a page.

Parameters

$request : RequestInterface

resolveActionMethodName()

Resolves and checks the current action method name

protected resolveActionMethodName() : string

Tags

throws
NoSuchActionException

if the action specified in the request object does not exist (and if there's no default action either).

Return values

string —

Method name of the current action

resolveView()

Prepares a view for the current action.

protected resolveView() : ViewInterface

By default, this method tries to locate a view with a name matching the current action.

Return values

ViewInterface

saveStopwordsKeywordsAction()

Save stop words and keywords

protected saveStopwordsKeywordsAction(string $pageHash, int $pageId[, array $stopwords = [] ][, array $keywords = [] ]) : ResponseInterface

Parameters

$pageHash : string
$pageId : int
$stopwords : array = []
$keywords : array = []

Return values

ResponseInterface

setViewConfiguration()

protected setViewConfiguration(ViewInterface $view) : void

Parameters

$view : ViewInterface

statisticAction()

General statistics

protected statisticAction([int $depth = 1 ][, string $mode = 'overview' ]) : ResponseInterface

Parameters

$depth : int = 1
$mode : string = 'overview'

Return values

ResponseInterface

statisticDetailsAction()

Statistics for a given page hash

protected statisticDetailsAction([int $pageHash = 0 ]) : ResponseInterface

Parameters

$pageHash : int = 0

Return values

ResponseInterface

wordDetailAction()

Statistics for a given word id

protected wordDetailAction([int $wordHash = 0 ][, int $pageHash = 0 ]) : ResponseInterface

Parameters

$wordHash : int = 0
$pageHash : int = 0

Return values

ResponseInterface
On this page