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 null	getManualDateStart ()
	setManualDateStop (\DateTime $manualDateStop=null)
DateTime null	getManualDateStop ()

Protected Attributes
string	$userOrGroup = '0'
int	$number = 20
int	$workspaceUid = Workspace::UID_ANY_WORKSPACE
int	$timeFrame = 0
int	$action = 0
bool	$groupByPage = false
int	$startTimestamp = 0
int	$endTimestamp = 0
DateTime null	$manualDateStart
DateTime null	$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 22 of file Constraint.php.

Member Function Documentation

getAction()

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

(

)

Get action

Returns

‪int

Definition at line 189 of file Constraint.php.

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

Referenced by TYPO3\CMS\Belog\Domain\Repository\LogEntryRepository\createQueryConstraints().

getDepth()

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

(

)

Get page level depth

Returns

‪int

Definition at line 289 of file Constraint.php.

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

Referenced by TYPO3\CMS\Belog\Domain\Repository\LogEntryRepository\addPageTreeConstraintsToQuery().

getEndTimestamp()

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

(

)

Get calculated end timestamp from query constraints

Returns

‪int

Definition at line 249 of file Constraint.php.

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

Referenced by TYPO3\CMS\Belog\Domain\Repository\LogEntryRepository\createQueryConstraints().

getGroupByPage()

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

(

)

Get group by page

Returns

‪bool

Definition at line 209 of file Constraint.php.

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

getManualDateStart()

DateTime null TYPO3\CMS\Belog\Domain\Model\Constraint::getManualDateStart

(

)

Get manual date start

Returns

‪\DateTime|null

Definition at line 309 of file Constraint.php.

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

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

getManualDateStop()

DateTime null TYPO3\CMS\Belog\Domain\Model\Constraint::getManualDateStop

(

)

Get manual date stop

Returns

‪\DateTime|null

Definition at line 329 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 129 of file Constraint.php.

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

Referenced by TYPO3\CMS\Belog\Domain\Repository\LogEntryRepository\findByConstraint().

getPageId()

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

(

)

Get page id

Returns

‪int

Definition at line 269 of file Constraint.php.

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

Referenced by TYPO3\CMS\Belog\Domain\Repository\LogEntryRepository\addPageTreeConstraintsToQuery().

getStartTimestamp()

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

(

)

Get calculated start timestamp from query constraints

Returns

‪int

Definition at line 229 of file Constraint.php.

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

Referenced by TYPO3\CMS\Belog\Domain\Repository\LogEntryRepository\createQueryConstraints().

getTimeFrame()

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

(

)

Get time frame

Returns

‪int

Definition at line 169 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 109 of file Constraint.php.

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

Referenced by TYPO3\CMS\Belog\Domain\Repository\LogEntryRepository\addUsersAndGroupsToQueryConstraints().

getWorkspaceUid()

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

(

)

Get workspace

Returns

‪string

Definition at line 149 of file Constraint.php.

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

Referenced by TYPO3\CMS\Belog\Domain\Repository\LogEntryRepository\createQueryConstraints().

setAction()

TYPO3\CMS\Belog\Domain\Model\Constraint::setAction

(

$action

)

Set action

Parameters

int

$action

Definition at line 179 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 279 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 239 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 199 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 299 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 319 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 119 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 259 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 219 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 159 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 99 of file Constraint.php.

setWorkspaceUid()

TYPO3\CMS\Belog\Domain\Model\Constraint::setWorkspaceUid

(

$workspace

)

Set workspace

Parameters

string

$workspace

Definition at line 139 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 52 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 92 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 70 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 58 of file Constraint.php.

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

$manualDateStart

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

protected

Manual date start

Definition at line 75 of file Constraint.php.

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

$manualDateStop

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

protected

Manual date stop

Definition at line 80 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 34 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 86 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 64 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 46 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 28 of file Constraint.php.

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

$workspaceUid

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

protected

UID of selected workspace

Definition at line 40 of file Constraint.php.

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