‪TYPO3CMS  9.5
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Belog\Domain\Model\Constraint Class Reference

Public Member Functions

 setUserOrGroup ($user)
 
string getUserOrGroup ()
 
 setNumber ($number)
 
int getNumber ()
 
 setWorkspaceUid ($workspace)
 
string getWorkspaceUid ()
 
 setTimeFrame ($timeFrame)
 
int getTimeFrame ()
 
 setAction ($action)
 
int getAction ()
 
 setGroupByPage ($groupByPage)
 
bool getGroupByPage ()
 
 setStartTimestamp ($timestamp)
 
int getStartTimestamp ()
 
 setEndTimestamp ($timestamp)
 
int getEndTimestamp ()
 
 setPageId ($id)
 
int getPageId ()
 
 setDepth ($depth)
 
int getDepth ()
 
 setManualDateStart (\DateTime $manualDateStart=null)
 
DateTime getManualDateStart ()
 
 setManualDateStop (\DateTime $manualDateStop=null)
 
DateTime getManualDateStop ()
 

Protected Attributes

string $userOrGroup = '0'
 
int $number = 20
 
int $workspaceUid = \TYPO3\CMS\Belog\Domain\Model\Workspace::UID_ANY_WORKSPACE
 
int $timeFrame = 0
 
int $action = 0
 
bool $groupByPage = false
 
int $startTimestamp = 0
 
int $endTimestamp = 0
 
DateTime $manualDateStart
 
DateTime $manualDateStop
 
int $pageId = 0
 
int $depth = 0
 

Detailed Description

Constraints for log entries

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

Definition at line 21 of file Constraint.php.

Member Function Documentation

◆ getAction()

int TYPO3\CMS\Belog\Domain\Model\Constraint::getAction ( )

Get action

Returns
‪int

Definition at line 188 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$action.

◆ getDepth()

int TYPO3\CMS\Belog\Domain\Model\Constraint::getDepth ( )

Get page level depth

Returns
‪int

Definition at line 288 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$depth.

◆ getEndTimestamp()

int TYPO3\CMS\Belog\Domain\Model\Constraint::getEndTimestamp ( )

Get calculated end timestamp from query constraints

Returns
‪int

Definition at line 248 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$endTimestamp.

◆ getGroupByPage()

bool TYPO3\CMS\Belog\Domain\Model\Constraint::getGroupByPage ( )

Get group by page

Returns
‪bool

Definition at line 208 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$groupByPage.

◆ getManualDateStart()

DateTime TYPO3\CMS\Belog\Domain\Model\Constraint::getManualDateStart ( )

Get manual date start

Returns
‪\DateTime

Definition at line 308 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$manualDateStart.

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

◆ getManualDateStop()

DateTime TYPO3\CMS\Belog\Domain\Model\Constraint::getManualDateStop ( )

Get manual date stop

Returns
‪\DateTime

Definition at line 328 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$manualDateStop.

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

◆ getNumber()

int TYPO3\CMS\Belog\Domain\Model\Constraint::getNumber ( )

Get number of log entries to show

Returns
‪int

Definition at line 128 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$number.

◆ getPageId()

int TYPO3\CMS\Belog\Domain\Model\Constraint::getPageId ( )

Get page id

Returns
‪int

Definition at line 268 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$pageId.

◆ getStartTimestamp()

int TYPO3\CMS\Belog\Domain\Model\Constraint::getStartTimestamp ( )

Get calculated start timestamp from query constraints

Returns
‪int

Definition at line 228 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$startTimestamp.

◆ getTimeFrame()

int TYPO3\CMS\Belog\Domain\Model\Constraint::getTimeFrame ( )

Get time frame

Returns
‪int

Definition at line 168 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$timeFrame.

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

◆ getUserOrGroup()

string TYPO3\CMS\Belog\Domain\Model\Constraint::getUserOrGroup ( )

Get user

Returns
‪string

Definition at line 108 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$userOrGroup.

◆ getWorkspaceUid()

string TYPO3\CMS\Belog\Domain\Model\Constraint::getWorkspaceUid ( )

Get workspace

Returns
‪string

Definition at line 148 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$workspaceUid.

◆ setAction()

TYPO3\CMS\Belog\Domain\Model\Constraint::setAction (   $action)

Set action

Parameters
int$action

Definition at line 178 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$action.

◆ setDepth()

TYPO3\CMS\Belog\Domain\Model\Constraint::setDepth (   $depth)

Set page level depth

Parameters
int$depth

Definition at line 278 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$depth.

◆ setEndTimestamp()

TYPO3\CMS\Belog\Domain\Model\Constraint::setEndTimestamp (   $timestamp)

Set calculated end timestamp from query constraints

Parameters
int$timestamp

Definition at line 238 of file Constraint.php.

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

◆ setGroupByPage()

TYPO3\CMS\Belog\Domain\Model\Constraint::setGroupByPage (   $groupByPage)

Set group by page

Parameters
bool$groupByPage

Definition at line 198 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$groupByPage.

◆ setManualDateStart()

TYPO3\CMS\Belog\Domain\Model\Constraint::setManualDateStart ( \DateTime  $manualDateStart = null)

Set manual date start

Parameters
\DateTime$manualDateStart

Definition at line 298 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$manualDateStart.

◆ setManualDateStop()

TYPO3\CMS\Belog\Domain\Model\Constraint::setManualDateStop ( \DateTime  $manualDateStop = null)

Set manual date stop

Parameters
\DateTime$manualDateStop

Definition at line 318 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$manualDateStop.

◆ setNumber()

TYPO3\CMS\Belog\Domain\Model\Constraint::setNumber (   $number)

Set number of log rows to show

Parameters
int$number

Definition at line 118 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$number.

◆ setPageId()

TYPO3\CMS\Belog\Domain\Model\Constraint::setPageId (   $id)

Set page id

Parameters
int$id

Definition at line 258 of file Constraint.php.

◆ setStartTimestamp()

TYPO3\CMS\Belog\Domain\Model\Constraint::setStartTimestamp (   $timestamp)

Set calculated start timestamp from query constraints

Parameters
int$timestamp

Definition at line 218 of file Constraint.php.

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

◆ setTimeFrame()

TYPO3\CMS\Belog\Domain\Model\Constraint::setTimeFrame (   $timeFrame)

Set time frame

Parameters
int$timeFrame

Definition at line 158 of file Constraint.php.

References TYPO3\CMS\Belog\Domain\Model\Constraint\$timeFrame.

◆ setUserOrGroup()

TYPO3\CMS\Belog\Domain\Model\Constraint::setUserOrGroup (   $user)

Set user

Parameters
string$user

Definition at line 98 of file Constraint.php.

◆ setWorkspaceUid()

TYPO3\CMS\Belog\Domain\Model\Constraint::setWorkspaceUid (   $workspace)

Set workspace

Parameters
string$workspace

Definition at line 138 of file Constraint.php.

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

Member Data Documentation

◆ $action

int TYPO3\CMS\Belog\Domain\Model\Constraint::$action = 0
protected

Selected action

Definition at line 51 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getAction(), and TYPO3\CMS\Belog\Domain\Model\Constraint\setAction().

◆ $depth

int TYPO3\CMS\Belog\Domain\Model\Constraint::$depth = 0
protected

Page level depth

Definition at line 91 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getDepth(), and TYPO3\CMS\Belog\Domain\Model\Constraint\setDepth().

◆ $endTimestamp

int TYPO3\CMS\Belog\Domain\Model\Constraint::$endTimestamp = 0
protected

Calculated end timestamp

Definition at line 69 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getEndTimestamp().

◆ $groupByPage

bool TYPO3\CMS\Belog\Domain\Model\Constraint::$groupByPage = false
protected

Whether rows should be grouped by page

Definition at line 57 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getGroupByPage(), and TYPO3\CMS\Belog\Domain\Model\Constraint\setGroupByPage().

◆ $manualDateStart

DateTime TYPO3\CMS\Belog\Domain\Model\Constraint::$manualDateStart
protected

Manual date start

Definition at line 74 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getManualDateStart(), and TYPO3\CMS\Belog\Domain\Model\Constraint\setManualDateStart().

◆ $manualDateStop

DateTime TYPO3\CMS\Belog\Domain\Model\Constraint::$manualDateStop
protected

Manual date stop

Definition at line 79 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getManualDateStop(), and TYPO3\CMS\Belog\Domain\Model\Constraint\setManualDateStop().

◆ $number

int TYPO3\CMS\Belog\Domain\Model\Constraint::$number = 20
protected

Number of log rows to show

Definition at line 33 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getNumber(), and TYPO3\CMS\Belog\Domain\Model\Constraint\setNumber().

◆ $pageId

int TYPO3\CMS\Belog\Domain\Model\Constraint::$pageId = 0
protected

Selected page ID in page context

Definition at line 85 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getPageId().

◆ $startTimestamp

int TYPO3\CMS\Belog\Domain\Model\Constraint::$startTimestamp = 0
protected

Calculated start timestamp

Definition at line 63 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getStartTimestamp().

◆ $timeFrame

int TYPO3\CMS\Belog\Domain\Model\Constraint::$timeFrame = 0
protected

Selected time frame

Definition at line 45 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getTimeFrame(), and TYPO3\CMS\Belog\Domain\Model\Constraint\setTimeFrame().

◆ $userOrGroup

string TYPO3\CMS\Belog\Domain\Model\Constraint::$userOrGroup = '0'
protected

Selected user/group; possible values are "gr-<uid>" for a group, "us-<uid>" for a user or -1 for "all users"

Definition at line 27 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getUserOrGroup().

◆ $workspaceUid

int TYPO3\CMS\Belog\Domain\Model\Constraint::$workspaceUid = \TYPO3\CMS\Belog\Domain\Model\Workspace::UID_ANY_WORKSPACE
protected

UID of selected workspace

Definition at line 39 of file Constraint.php.

Referenced by TYPO3\CMS\Belog\Domain\Model\Constraint\getWorkspaceUid().