‪TYPO3CMS  11.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Belog\Controller\BackendLogController Class Reference
Inheritance diagram for TYPO3\CMS\Belog\Controller\BackendLogController:
TYPO3\CMS\Extbase\Mvc\Controller\ActionController TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface

Public Member Functions

 __construct (ModuleTemplateFactory $moduleTemplateFactory, LogEntryRepository $logEntryRepository, WorkspaceRepository $workspaceRepository)
 
 initializeListAction ()
 
ResponseInterface listAction (Constraint $constraint=null, int $pageId=null, string $layout='Default', string $operation='')
 
 deleteMessageAction (int $errorUid)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 injectResponseFactory (ResponseFactoryInterface $responseFactory)
 
 injectStreamFactory (StreamFactoryInterface $streamFactory)
 
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
 injectObjectManager (ObjectManagerInterface $objectManager)
 
 injectSignalSlotDispatcher (Dispatcher $signalSlotDispatcher)
 
 injectValidatorResolver (ValidatorResolver $validatorResolver)
 
 injectViewResolver (ViewResolverInterface $viewResolver)
 
 injectReflectionService (ReflectionService $reflectionService)
 
 injectHashService (HashService $hashService)
 
 injectMvcPropertyMappingConfigurationService (MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
 
 injectEventDispatcher (EventDispatcherInterface $eventDispatcher)
 
 injectPropertyMapper (PropertyMapper $propertyMapper)
 
 injectInternalFlashMessageService (FlashMessageService $flashMessageService)
 
 injectInternalExtensionService (ExtensionService $extensionService)
 
 initializeControllerArgumentsBaseValidators ()
 
ResponseInterface processRequest (RequestInterface $request)
 
ControllerContext getControllerContext ()
 
 addFlashMessage ($messageBody, $messageTitle='', $severity=AbstractMessage::OK, $storeInSession=true)
 
never forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
 
never throwStatus ($statusCode, $statusMessage=null, $content=null)
 

Protected Member Functions

Constraint getConstraintFromBeUserData ()
 
 persistConstraintInBeUserData (Constraint $constraint)
 
 resetConstraintsOnMemoryExhaustionError ()
 
array groupLogEntriesDay (QueryResultInterface $logEntries)
 
array createUserAndGroupListForSelectOptions ()
 
array createWorkspaceListForSelectOptions ()
 
 forceWorkspaceSelectionIfInWorkspace (Constraint $constraint)
 
array createPageDepthOptions ()
 
 setStartAndEndTimeFromTimeSelector (Constraint $constraint)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 initializeView (ViewInterface $view)
 
 initializeAction ()
 
 initializeActionMethodArguments ()
 
 initializeActionMethodValidators ()
 
 renderAssetsForRequest ($request)
 
string resolveActionMethodName ()
 
 callActionMethod (RequestInterface $request)
 
ViewInterface resolveView ()
 
 setViewConfiguration (ViewInterface $view)
 
array getViewProperty ($extbaseFrameworkConfiguration, $setting)
 
ResponseInterface errorAction ()
 
 addErrorFlashMessage ()
 
string bool getErrorFlashMessage ()
 
ResponseInterface null forwardToReferringRequest ()
 
string getFlattenedValidationErrorMessage ()
 
 getFlashMessageQueue (string $identifier=null)
 
ControllerContext buildControllerContext ()
 
never redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $_=null, $statusCode=303)
 
never redirectToUri ($uri, $_=null, $statusCode=303)
 
string addBaseUriIfNecessary ($uri)
 
 mapRequestArgumentsToControllerArguments ()
 
ResponseInterface htmlResponse (string $html=null)
 
ResponseInterface jsonResponse (string $json=null)
 

Protected Attributes

ModuleTemplateFactory $moduleTemplateFactory
 
LogEntryRepository $logEntryRepository
 
WorkspaceRepository $workspaceRepository
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
ResponseFactoryInterface $responseFactory
 
StreamFactoryInterface $streamFactory
 
TYPO3 CMS Extbase Reflection ReflectionService $reflectionService
 
HashService $hashService
 
ViewInterface $view
 
string $defaultViewObjectName = TemplateView::class
 
string $actionMethodName = 'indexAction'
 
string $errorMethodName = 'errorAction'
 
TYPO3 CMS Extbase Mvc Controller MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService
 
EventDispatcherInterface $eventDispatcher
 
Request $request
 
TYPO3 CMS Extbase SignalSlot Dispatcher $signalSlotDispatcher
 
ObjectManagerInterface $objectManager
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder $uriBuilder
 
array $settings
 
TYPO3 CMS Extbase Validation ValidatorResolver $validatorResolver
 
TYPO3 CMS Extbase Mvc Controller Arguments $arguments
 
ControllerContext $controllerContext
 
ConfigurationManagerInterface $configurationManager
 

Detailed Description

Show log entries from sys_log

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

Definition at line 40 of file BackendLogController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Belog\Controller\BackendLogController::__construct ( ModuleTemplateFactory  $moduleTemplateFactory,
LogEntryRepository  $logEntryRepository,
WorkspaceRepository  $workspaceRepository 
)

Definition at line 46 of file BackendLogController.php.

References TYPO3\CMS\Belog\Controller\BackendLogController\$logEntryRepository, TYPO3\CMS\Belog\Controller\BackendLogController\$moduleTemplateFactory, and TYPO3\CMS\Belog\Controller\BackendLogController\$workspaceRepository.

Member Function Documentation

◆ createPageDepthOptions()

array TYPO3\CMS\Belog\Controller\BackendLogController::createPageDepthOptions ( )
protected

Create options for the 'depth of page levels' selector. This is shown if the module is displayed in page -> info

Returns
‪array Key is depth identifier (1 = One level), value the localized select option label

Definition at line 292 of file BackendLogController.php.

References TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\listAction().

◆ createUserAndGroupListForSelectOptions()

array TYPO3\CMS\Belog\Controller\BackendLogController::createUserAndGroupListForSelectOptions ( )
protected

Create options for the user / group drop down. This is not moved to a repository by intention to not mix up this 'meta' data with real repository work

Returns
‪array Key is the option name, value its label

Definition at line 226 of file BackendLogController.php.

References TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\listAction().

◆ createWorkspaceListForSelectOptions()

array TYPO3\CMS\Belog\Controller\BackendLogController::createWorkspaceListForSelectOptions ( )
protected

Create options for the workspace selector

Returns
‪array Key is uid of workspace, value its label

Definition at line 250 of file BackendLogController.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\listAction().

◆ deleteMessageAction()

TYPO3\CMS\Belog\Controller\BackendLogController::deleteMessageAction ( int  $errorUid)

Delete all log entries that share the same message with the log entry given in $errorUid

Parameters
int$errorUid

Definition at line 129 of file BackendLogController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\addFlashMessage(), TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate(), and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

◆ forceWorkspaceSelectionIfInWorkspace()

TYPO3\CMS\Belog\Controller\BackendLogController::forceWorkspaceSelectionIfInWorkspace ( Constraint  $constraint)
protected

If the user is in a workspace different than LIVE, we force to show only log entries from the selected workspace, and the workspace selector is not shown.

Parameters
Constraint$constraint

Definition at line 274 of file BackendLogController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), and TYPO3\CMS\Belog\Domain\Model\Constraint\setWorkspaceUid().

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\listAction().

◆ getConstraintFromBeUserData()

Constraint TYPO3\CMS\Belog\Controller\BackendLogController::getConstraintFromBeUserData ( )
protected

Get module states (the constraint object) from user data

Returns
‪Constraint

Definition at line 147 of file BackendLogController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\listAction().

◆ groupLogEntriesDay()

array TYPO3\CMS\Belog\Controller\BackendLogController::groupLogEntriesDay ( QueryResultInterface  $logEntries)
protected

Create a sorted array for day from the query result of the sys log repository.

pid is always -1 to render a flat list. '12345' is a sub array to split entries by day, number is first second of day

[pid][dayTimestamp][items]

Parameters
QueryResultInterface$logEntries
Returns
‪array

Definition at line 196 of file BackendLogController.php.

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\listAction().

◆ initializeListAction()

TYPO3\CMS\Belog\Controller\BackendLogController::initializeListAction ( )

Initialize list action

Definition at line 59 of file BackendLogController.php.

References $GLOBALS.

◆ listAction()

ResponseInterface TYPO3\CMS\Belog\Controller\BackendLogController::listAction ( Constraint  $constraint = null,
int  $pageId = null,
string  $layout = 'Default',
string  $operation = '' 
)

Show general information and the installed modules

Parameters
Constraint | null$constraint
int | null$pageId
string$layout
string$operation
Returns
‪ResponseInterface

Definition at line 86 of file BackendLogController.php.

References TYPO3\CMS\Belog\Controller\BackendLogController\createPageDepthOptions(), TYPO3\CMS\Belog\Controller\BackendLogController\createUserAndGroupListForSelectOptions(), TYPO3\CMS\Belog\Controller\BackendLogController\createWorkspaceListForSelectOptions(), TYPO3\CMS\Belog\Controller\BackendLogController\forceWorkspaceSelectionIfInWorkspace(), TYPO3\CMS\Belog\Controller\BackendLogController\getConstraintFromBeUserData(), TYPO3\CMS\Belog\Controller\BackendLogController\groupLogEntriesDay(), TYPO3\CMS\Extbase\Mvc\Controller\ActionController\htmlResponse(), TYPO3\CMS\Belog\Controller\BackendLogController\persistConstraintInBeUserData(), TYPO3\CMS\Belog\Controller\BackendLogController\resetConstraintsOnMemoryExhaustionError(), TYPO3\CMS\Belog\Controller\BackendLogController\setStartAndEndTimeFromTimeSelector(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

◆ persistConstraintInBeUserData()

TYPO3\CMS\Belog\Controller\BackendLogController::persistConstraintInBeUserData ( Constraint  $constraint)
protected

Save current constraint object in be user settings (uC)

Parameters
Constraint$constraint

Definition at line 162 of file BackendLogController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\listAction(), and TYPO3\CMS\Belog\Controller\BackendLogController\resetConstraintsOnMemoryExhaustionError().

◆ resetConstraintsOnMemoryExhaustionError()

TYPO3\CMS\Belog\Controller\BackendLogController::resetConstraintsOnMemoryExhaustionError ( )
protected

In case the script execution fails, because the user requested too many results (memory exhaustion in php), reset the constraints in be user settings, so the belog can be accessed again in the next call.

Definition at line 172 of file BackendLogController.php.

References TYPO3\CMS\Belog\Controller\BackendLogController\persistConstraintInBeUserData().

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\listAction().

◆ setStartAndEndTimeFromTimeSelector()

TYPO3\CMS\Belog\Controller\BackendLogController::setStartAndEndTimeFromTimeSelector ( Constraint  $constraint)
protected

Calculate the start- and end timestamp

Parameters
Constraint$constraint

Definition at line 310 of file BackendLogController.php.

References $GLOBALS, TYPO3\CMS\Belog\Domain\Model\Constraint\getManualDateStart(), TYPO3\CMS\Belog\Domain\Model\Constraint\getManualDateStop(), TYPO3\CMS\Belog\Domain\Model\Constraint\setEndTimestamp(), and TYPO3\CMS\Belog\Domain\Model\Constraint\setStartTimestamp().

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\listAction().

Member Data Documentation

◆ $logEntryRepository

LogEntryRepository TYPO3\CMS\Belog\Controller\BackendLogController::$logEntryRepository
protected

Definition at line 43 of file BackendLogController.php.

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\__construct().

◆ $moduleTemplateFactory

ModuleTemplateFactory TYPO3\CMS\Belog\Controller\BackendLogController::$moduleTemplateFactory
protected

Definition at line 42 of file BackendLogController.php.

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\__construct().

◆ $workspaceRepository

WorkspaceRepository TYPO3\CMS\Belog\Controller\BackendLogController::$workspaceRepository
protected

Definition at line 44 of file BackendLogController.php.

Referenced by TYPO3\CMS\Belog\Controller\BackendLogController\__construct().