‪TYPO3CMS  10.4
Public Member Functions | Protected Member Functions | Protected Attributes | Private 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

 injectLogEntryRepository (LogEntryRepository $logEntryRepository)
 
 initializeListAction ()
 
 listAction (Constraint $constraint=null, int $pageId=null, string $layout='Default')
 
 deleteMessageAction (int $errorUid)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
 injectObjectManager (ObjectManagerInterface $objectManager)
 
 injectSignalSlotDispatcher (Dispatcher $signalSlotDispatcher)
 
 injectValidatorResolver (ValidatorResolver $validatorResolver)
 
 injectViewResolver (ViewResolverInterface $viewResolver)
 
 injectReflectionService (ReflectionService $reflectionService)
 
 injectCacheService (CacheService $cacheService)
 
 injectHashService (HashService $hashService)
 
 injectMvcPropertyMappingConfigurationService (MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
 
 injectEventDispatcher (EventDispatcherInterface $eventDispatcher)
 
 initializeControllerArgumentsBaseValidators ()
 
 processRequest (RequestInterface $request, ResponseInterface $response)
 
ControllerContext getControllerContext ()
 
 addFlashMessage ($messageBody, $messageTitle='', $severity=AbstractMessage::OK, $storeInSession=true)
 
bool canProcessRequest (RequestInterface $request)
 
 forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
 
 throwStatus ($statusCode, $statusMessage=null, $content=null)
 

Protected Member Functions

Constraint getConstraintFromBeUserData ()
 
 persistConstraintInBeUserData (Constraint $constraint)
 
 resetConstraintsOnMemoryExhaustionError ()
 
array groupLogEntriesByPageAndDay (QueryResultInterface $logEntries, $groupByPage=false)
 
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 ()
 
 emitBeforeCallActionMethodSignal (array $preparedArguments)
 
ViewInterface resolveView ()
 
 setViewConfiguration (ViewInterface $view)
 
array getViewProperty ($extbaseFrameworkConfiguration, $setting)
 
string errorAction ()
 
 clearCacheOnError ()
 
 addErrorFlashMessage ()
 
string getErrorFlashMessage ()
 
 forwardToReferringRequest ()
 
string getFlattenedValidationErrorMessage ()
 
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

TYPO3 CMS Belog Domain Repository LogEntryRepository $logEntryRepository
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
TYPO3 CMS Extbase Reflection ReflectionService $reflectionService
 
TYPO3 CMS Extbase Service CacheService $cacheService
 
HashService $hashService
 
ViewInterface $view
 
string $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
 
string $actionMethodName = 'indexAction'
 
string $errorMethodName = 'errorAction'
 
TYPO3 CMS Extbase Mvc Controller MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService
 
EventDispatcherInterface $eventDispatcher
 
TYPO3 CMS Extbase Mvc Request $request
 
TYPO3 CMS Extbase Mvc Response $response
 
TYPO3 CMS Extbase SignalSlot Dispatcher $signalSlotDispatcher
 
TYPO3 CMS Extbase Object 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
 
array $supportedRequestTypes = array( Request::class )
 
TYPO3 CMS Extbase Mvc Controller ControllerContext $controllerContext
 
ConfigurationManagerInterface $configurationManager
 

Private Attributes

const TIMEFRAME_THISWEEK = 0
 
const TIMEFRAME_LASTWEEK = 1
 
const TIMEFRAME_LASTSEVENDAYS = 2
 
const TIMEFRAME_THISMONTH = 10
 
const TIMEFRAME_LASTMONTH = 11
 
const TIMEFRAME_LAST31DAYS = 12
 
const TIMEFRAME_CUSTOM = 30
 

Detailed Description

Abstract class to 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 35 of file BackendLogController.php.

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 310 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 244 of file BackendLogController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getGroupNames(), TYPO3\CMS\Backend\Utility\BackendUtility\getUserNames(), and 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 268 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 140 of file BackendLogController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\addFlashMessage(), TYPO3\CMS\Extbase\Mvc\Controller\ActionController\redirect(), 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 292 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 158 of file BackendLogController.php.

References $GLOBALS.

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

◆ groupLogEntriesByPageAndDay()

array TYPO3\CMS\Belog\Controller\BackendLogController::groupLogEntriesByPageAndDay ( QueryResultInterface  $logEntries,
  $groupByPage = false 
)
protected

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

If group by page is FALSE, pid is always -1 (will render a flat list), otherwise the output is split by pages. '12345' is a sub array to split entries by day, number is first second of day

[pid][dayTimestamp][items]

Parameters
QueryResultInterface$logEntries
bool$groupByPage‪Whether or not log entries should be grouped by page
Returns
‪array

Definition at line 210 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 87 of file BackendLogController.php.

References $GLOBALS.

◆ injectLogEntryRepository()

TYPO3\CMS\Belog\Controller\BackendLogController::injectLogEntryRepository ( LogEntryRepository  $logEntryRepository)
Parameters
\TYPO3\CMS\Belog\Domain\Repository\LogEntryRepository$logEntryRepository

Definition at line 79 of file BackendLogController.php.

References TYPO3\CMS\Belog\Controller\BackendLogController\$logEntryRepository.

◆ listAction()

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

Show general information and the installed modules

Parameters
Constraint$constraint
int$pageId
string$layout

Definition at line 108 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\groupLogEntriesByPageAndDay(), TYPO3\CMS\Belog\Controller\BackendLogController\persistConstraintInBeUserData(), TYPO3\CMS\Belog\Controller\BackendLogController\resetConstraintsOnMemoryExhaustionError(), and TYPO3\CMS\Belog\Controller\BackendLogController\setStartAndEndTimeFromTimeSelector().

◆ 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 173 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 183 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 from the different time selector options

Parameters
Constraint$constraint

Definition at line 328 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\getTimeFrame(), TYPO3\CMS\Belog\Domain\Model\Constraint\setEndTimestamp(), TYPO3\CMS\Belog\Domain\Model\Constraint\setStartTimestamp(), TYPO3\CMS\Belog\Controller\BackendLogController\TIMEFRAME_CUSTOM, TYPO3\CMS\Belog\Controller\BackendLogController\TIMEFRAME_LAST31DAYS, TYPO3\CMS\Belog\Controller\BackendLogController\TIMEFRAME_LASTMONTH, TYPO3\CMS\Belog\Controller\BackendLogController\TIMEFRAME_LASTSEVENDAYS, TYPO3\CMS\Belog\Controller\BackendLogController\TIMEFRAME_LASTWEEK, TYPO3\CMS\Belog\Controller\BackendLogController\TIMEFRAME_THISMONTH, and TYPO3\CMS\Belog\Controller\BackendLogController\TIMEFRAME_THISWEEK.

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

Member Data Documentation

◆ $logEntryRepository

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

Definition at line 74 of file BackendLogController.php.

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

◆ TIMEFRAME_CUSTOM

const TYPO3\CMS\Belog\Controller\BackendLogController::TIMEFRAME_CUSTOM = 30
private

Definition at line 70 of file BackendLogController.php.

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

◆ TIMEFRAME_LAST31DAYS

const TYPO3\CMS\Belog\Controller\BackendLogController::TIMEFRAME_LAST31DAYS = 12
private

Definition at line 65 of file BackendLogController.php.

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

◆ TIMEFRAME_LASTMONTH

const TYPO3\CMS\Belog\Controller\BackendLogController::TIMEFRAME_LASTMONTH = 11
private

Definition at line 60 of file BackendLogController.php.

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

◆ TIMEFRAME_LASTSEVENDAYS

const TYPO3\CMS\Belog\Controller\BackendLogController::TIMEFRAME_LASTSEVENDAYS = 2
private

Definition at line 50 of file BackendLogController.php.

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

◆ TIMEFRAME_LASTWEEK

const TYPO3\CMS\Belog\Controller\BackendLogController::TIMEFRAME_LASTWEEK = 1
private

Definition at line 45 of file BackendLogController.php.

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

◆ TIMEFRAME_THISMONTH

const TYPO3\CMS\Belog\Controller\BackendLogController::TIMEFRAME_THISMONTH = 10
private

Definition at line 55 of file BackendLogController.php.

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

◆ TIMEFRAME_THISWEEK

const TYPO3\CMS\Belog\Controller\BackendLogController::TIMEFRAME_THISWEEK = 0
private

Definition at line 40 of file BackendLogController.php.

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