‪TYPO3CMS  9.5
TYPO3\CMS\IndexedSearch\Controller\AdministrationController Class Reference
Inheritance diagram for TYPO3\CMS\IndexedSearch\Controller\AdministrationController:
TYPO3\CMS\Extbase\Mvc\Controller\ActionController TYPO3\CMS\Extbase\Mvc\Controller\AbstractController TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface

Public Member Functions

 initializeAction ()
 
 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
 injectAdministrationRepository (AdministrationRepository $administrationRepository)
 
 indexAction ()
 
 pagesAction ()
 
 externalDocumentsAction ()
 
 statisticDetailsAction ($pageHash=0)
 
 saveStopwordsKeywordsAction ($pageHash, $pageId, $stopwords=[], $keywords=[])
 
 wordDetailAction ($id=0, $pageHash=0)
 
 statisticAction ($depth=1, $mode='overview')
 
 deleteIndexedItemAction ($id, $depth=1, $mode='overview')
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 injectCacheService (\TYPO3\CMS\Extbase\Service\CacheService $cacheService)
 
 injectMvcPropertyMappingConfigurationService (\TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
 
 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
 injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
 
 injectValidatorResolver (\TYPO3\CMS\Extbase\Validation\ValidatorResolver $validatorResolver)
 
ControllerContext getControllerContext ()
 
 __construct ()
 
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 addFlashMessage ($messageBody, $messageTitle='', $severity=\TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession=true)
 
bool canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
 
 forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
 
 throwStatus ($statusCode, $statusMessage=null, $content=null)
 
 initializeControllerArgumentsBaseValidators ()
 

Protected Member Functions

 initializeView (ViewInterface $view)
 
 generateMenu ()
 
string getHref ($controller, $action, $parameters=[])
 
BackendUserAuthentication getBackendUserAuthentication ()
 
LanguageService getLanguageService ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 renderAssetsForRequest ($request)
 
 initializeActionMethodArguments ()
 
 initializeActionMethodValidators ()
 
string resolveActionMethodName ()
 
 callActionMethod ()
 
 emitBeforeCallActionMethodSignal (array $preparedArguments)
 
ViewInterface resolveView ()
 
 setViewConfiguration (ViewInterface $view)
 
array getViewProperty ($extbaseFrameworkConfiguration, $setting)
 
mixed resolveViewObjectName ()
 
string errorAction ()
 
 clearCacheOnError ()
 
 addErrorFlashMessage ()
 
string getErrorFlashMessage ()
 
 forwardToReferringRequest ()
 
string getFlattenedValidationErrorMessage ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
TYPO3 CMS Extbase Mvc Controller ControllerContext buildControllerContext ()
 
 redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)
 
 redirectToUri ($uri, $delay=0, $statusCode=303)
 
string addBaseUriIfNecessary ($uri)
 
 mapRequestArgumentsToControllerArguments ()
 

Protected Attributes

AdministrationRepository $administrationRepository
 
int $pageUid = 0
 
array $external_parsers = array( )
 
array $indexerConfig = array( )
 
bool $enableMetaphoneSearch = false
 
TYPO3 CMS IndexedSearch Indexer $indexer
 
BackendTemplateView $defaultViewObjectName = BackendTemplateView::class
 
BackendTemplateView $view
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
TYPO3 CMS Extbase Reflection ReflectionService $reflectionService
 
TYPO3 CMS Extbase Service CacheService $cacheService
 
ViewInterface $view
 
string $namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
 
array $viewFormatToObjectNameMap = array( )
 
string $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
 
string $actionMethodName = 'indexAction'
 
string $errorMethodName = 'errorAction'
 
TYPO3 CMS Extbase Mvc Controller MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService
 
TYPO3 CMS Extbase Mvc Request $request
 
TYPO3 CMS Extbase Mvc Response $response
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
TYPO3 CMS Extbase SignalSlot Dispatcher $signalSlotDispatcher
 
TYPO3 CMS Extbase Object ObjectManagerInterface $objectManager
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder $uriBuilder
 
string $extensionName
 
array $settings
 
TYPO3 CMS Extbase Mvc RequestInterface $request
 
TYPO3 CMS Extbase Mvc ResponseInterface $response
 
TYPO3 CMS Extbase Validation ValidatorResolver $validatorResolver
 
TYPO3 CMS Extbase Mvc Controller Arguments $arguments
 
array $supportedRequestTypes = array( \TYPO3\CMS\Extbase\Mvc\Request::class )
 
TYPO3 CMS Extbase Mvc Controller ControllerContext $controllerContext
 
ConfigurationManagerInterface $configurationManager
 

Additional Inherited Members

- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
static array getActionMethodParameters ($objectManager)
 

Detailed Description

Administration controller

This class is a specific controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 36 of file AdministrationController.php.

Member Function Documentation

◆ deleteIndexedItemAction()

TYPO3\CMS\IndexedSearch\Controller\AdministrationController::deleteIndexedItemAction (   $id,
  $depth = 1,
  $mode = 'overview' 
)

Remove item from index

Parameters
string$id
int$depth
string$mode

Definition at line 517 of file AdministrationController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirect().

◆ externalDocumentsAction()

TYPO3\CMS\IndexedSearch\Controller\AdministrationController::externalDocumentsAction ( )

Statistics for external documents

Definition at line 240 of file AdministrationController.php.

◆ generateMenu()

◆ getBackendUserAuthentication()

BackendUserAuthentication TYPO3\CMS\IndexedSearch\Controller\AdministrationController::getBackendUserAuthentication ( )
protected

◆ getHref()

string TYPO3\CMS\IndexedSearch\Controller\AdministrationController::getHref (   $controller,
  $action,
  $parameters = [] 
)
protected

Creates te URI for a backend action

Parameters
string$controller
string$action
array$parameters
Returns
‪string

Definition at line 532 of file AdministrationController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$uriBuilder.

Referenced by TYPO3\CMS\IndexedSearch\Controller\AdministrationController\generateMenu(), and TYPO3\CMS\IndexedSearch\Controller\AdministrationController\statisticDetailsAction().

◆ getLanguageService()

◆ indexAction()

TYPO3\CMS\IndexedSearch\Controller\AdministrationController::indexAction ( )

Index action contains the most important statistics

Definition at line 205 of file AdministrationController.php.

References $GLOBALS.

◆ initializeAction()

TYPO3\CMS\IndexedSearch\Controller\AdministrationController::initializeAction ( )

Function will be called before every other action

Reimplemented from TYPO3\CMS\Extbase\Mvc\Controller\ActionController.

Definition at line 145 of file AdministrationController.php.

◆ initializeView()

◆ injectAdministrationRepository()

TYPO3\CMS\IndexedSearch\Controller\AdministrationController::injectAdministrationRepository ( AdministrationRepository  $administrationRepository)
Parameters
\TYPO3\CMS\IndexedSearch\Domain\Repository\AdministrationRepository$administrationRepository

Definition at line 197 of file AdministrationController.php.

References TYPO3\CMS\IndexedSearch\Controller\AdministrationController\$administrationRepository.

◆ pagesAction()

TYPO3\CMS\IndexedSearch\Controller\AdministrationController::pagesAction ( )

Statistics for pages

Definition at line 232 of file AdministrationController.php.

◆ processRequest()

TYPO3\CMS\IndexedSearch\Controller\AdministrationController::processRequest ( \TYPO3\CMS\Extbase\Mvc\RequestInterface  $request,
\TYPO3\CMS\Extbase\Mvc\ResponseInterface  $response 
)

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

Parameters
\TYPO3\CMS\Extbase\Mvc\RequestInterface$request
\TYPO3\CMS\Extbase\Mvc\ResponseInterface$response
Exceptions

Definition at line 162 of file AdministrationController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$request, TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$response, TYPO3\CMS\Extbase\Mvc\Cli\Request\getArguments(), TYPO3\CMS\IndexedSearch\Controller\AdministrationController\getBackendUserAuthentication(), and TYPO3\CMS\Extbase\Mvc\Cli\Request\setArguments().

◆ saveStopwordsKeywordsAction()

TYPO3\CMS\IndexedSearch\Controller\AdministrationController::saveStopwordsKeywordsAction (   $pageHash,
  $pageId,
  $stopwords = [],
  $keywords = [] 
)

Save stop words and keywords

Parameters
string$pageHash
int$pageId
array$stopwords
array$keywords

Definition at line 430 of file AdministrationController.php.

References TYPO3\CMS\IndexedSearch\Controller\AdministrationController\getBackendUserAuthentication(), and TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirect().

◆ statisticAction()

TYPO3\CMS\IndexedSearch\Controller\AdministrationController::statisticAction (   $depth = 1,
  $mode = 'overview' 
)

◆ statisticDetailsAction()

◆ wordDetailAction()

TYPO3\CMS\IndexedSearch\Controller\AdministrationController::wordDetailAction (   $id = 0,
  $pageHash = 0 
)

Statistics for a given word id

Parameters
int$id
int$pageHash

Definition at line 450 of file AdministrationController.php.

Member Data Documentation

◆ $administrationRepository

AdministrationRepository TYPO3\CMS\IndexedSearch\Controller\AdministrationController::$administrationRepository
protected

◆ $defaultViewObjectName

BackendTemplateView TYPO3\CMS\IndexedSearch\Controller\AdministrationController::$defaultViewObjectName = BackendTemplateView::class
protected

Backend Template Container

Definition at line 68 of file AdministrationController.php.

◆ $enableMetaphoneSearch

bool TYPO3\CMS\IndexedSearch\Controller\AdministrationController::$enableMetaphoneSearch = false
protected

is metaphone enabled

Definition at line 56 of file AdministrationController.php.

◆ $external_parsers

array TYPO3\CMS\IndexedSearch\Controller\AdministrationController::$external_parsers = array( )
protected

◆ $indexer

TYPO3 CMS IndexedSearch Indexer TYPO3\CMS\IndexedSearch\Controller\AdministrationController::$indexer
protected

Indexer object

Definition at line 62 of file AdministrationController.php.

◆ $indexerConfig

array TYPO3\CMS\IndexedSearch\Controller\AdministrationController::$indexerConfig = array( )
protected

Configuration defined in the Extension Manager

Definition at line 52 of file AdministrationController.php.

◆ $pageUid

int TYPO3\CMS\IndexedSearch\Controller\AdministrationController::$pageUid = 0
protected

Current page id

Definition at line 44 of file AdministrationController.php.

◆ $view

BackendTemplateView TYPO3\CMS\IndexedSearch\Controller\AdministrationController::$view
protected

BackendTemplateContainer

Definition at line 74 of file AdministrationController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\AdministrationController\initializeView().