__call()

Checks if the method of the given name is available, calls it but throws a deprecation.

Parameters

$methodName : string

$arguments : array<string|int, mixed>

__construct()

PageRepository constructor to set the base context, this will effectively remove the necessity for setting properties from the outside.

Parameters

$context : Context|null = null

__get()

Gets the value of the property of the given name if tagged.

Parameters

$propertyName : string

__isset()

Checks if the property of the given name is set.

Parameters

$propertyName : string

__set()

Sets the property of the given name if tagged.

Parameters

$propertyName : string

$propertyValue : mixed

__unset()

Unsets the property of the given name if tagged.

Parameters

$propertyName : string

checkIfPageIsHidden()

Checks if the page is hidden in the active workspace (and the current language), then the "preview" mode for frontend pages is active.

Parameters

$pageId : int

$languageAspect : LanguageAspect

checkRecord()

Checks if a record exists and is accessible.

Parameters

$table : string

The table name to search

$uid : int

The uid to look up in $table

$checkPage : bool|int = 0

If checkPage is set, it's also required that the page on which the record resides is accessible

enableFields()

Returns a part of a WHERE clause which will filter out records with start/end times or hidden/fe_groups fields set to values that should de-select them according to the current time, preview settings or user login. Definitely a frontend function.

Parameters

$table : string

Table name found in the $GLOBALS['TCA'] array

$show_hidden : int = -1

If $show_hidden is set (0/1), any hidden-fields in records are ignored. NOTICE: If you call this function, consider what to do with the show_hidden parameter. Maybe it should be set? See ContentObjectRenderer->enableFields where it's implemented correctly.

$ignore_array : array<string|int, mixed> = []

Array you can pass where keys can be "disabled", "starttime", "endtime", "fe_group" (keys from "enablefields" in TCA) and if set they will make sure that part of the clause is not added. Thus disables the specific part of the clause. For previewing etc.

Tags

throws

InvalidArgumentException

filterAccessiblePageIds()

Removes Page UID numbers from the input array which are not available due to QueryRestrictions This is also very helpful to add a custom RestrictionContainer to add custom Restrictions such as "bad doktypes" e.g. RECYCLER doktypes

Parameters

$pageIds : array<string|int, int>

Array of Page UID numbers to check

$restrictionContainer : QueryRestrictionContainerInterface|null = null

getDescendantPageIdsRecursive()

Generates a list of Page IDs from $startPageId. List does not include $startPageId itself.

Parameters

$startPageId : int

The id of the start page from which point in the page tree to descend.

$depth : int

Maximum recursion depth. Use 100 or so to descend "infinitely". Stops when 0 is reached.

$begin : int = 0

An optional integer the level in the tree to start collecting. Zero means 'start right away', 1 = 'next level and out'

$excludePageIds : array<string|int, mixed> = []

Avoid collecting these pages and their possible subpages

$bypassEnableFieldsCheck : bool = false

If true, then enableFields and other checks are not evaluated

getLanguageOverlay()

Master helper method to overlay a record to a language.

Parameters

$table : string

the name of the table, should be a TCA table with localization enabled

$originalRow : array<string|int, mixed>

the current (full-fletched) record.

$languageAspect : LanguageAspect|null = null

an alternative language aspect if needed (optional)

getMenu()

Returns an array with page rows for subpages of a certain page ID. This is used for menus in the frontend.

Parameters

$pageId : int|array<string|int, int>

The page id (or array of page ids) for which to fetch subpages (PID)

$fields : string = '*'

Fields to select, * is the default - If a custom list is set, make sure the list contains the uid field. It's mandatory for further processing of the result row.

$sortField : string = 'sorting'

The field to sort by. Default is "sorting

$additionalWhereClause : string = ''

Optional additional where clauses. Like "AND title like '%some text%'" for instance.

$checkShortcuts : bool = true

Check if shortcuts exist, checks by default

$disableGroupAccessCheck : bool = false

Tags

see

getPageShortcut()

see

AbstractMenuContentObject::makeMenu()

getMenuForPages()

Returns an array with page-rows for pages with uid in $pageIds.

Parameters

$pageIds : array<string|int, int>

Array of page ids to fetch

$fields : string = '*'

Fields to select, * is the default - If a custom list is set, make sure the list contains the uid field. It's mandatory for further processing of the result row.

$sortField : string = 'sorting'

The field to sort by. Default is "sorting"

$additionalWhereClause : string = ''

Optional additional where clauses. Like "AND title like '%some text%'" for instance.

$checkShortcuts : bool = true

Check if shortcuts exist, checks by default

$disableGroupAccessCheck : bool = false

getMountPointInfo()

Returns a MountPoint array for the specified page

Parameters

$pageId : int

Page id to do the lookup for.

$pageRec : array<string|int, mixed>|bool = false

Optional page record for the given page.

$prevMountPids : array<string|int, mixed> = []

Internal register to prevent lookup cycles.

$firstPageUid : int = 0

The first page id.

Tags

see

https://decisions.typo3.org/t/supporting-or-prohibiting-recursive-mount-points/165/3

An array will be returned if mount pages are enabled, the correct doktype (7) is set for page and there IS a mount_pid with a valid record.

The optional page record must contain at least uid, pid, doktype, mount_pid,mount_pid_ol. If it is not supplied it will be looked up by the system at additional costs for the lookup.

Returns FALSE if no mount point was found, "-1" if there should have been one, but no connection to it, otherwise an array with information about mount pid and modes.

see

AbstractMenuContentObject

getMultipleGroupsWhereClause()

Creating where-clause for checking group access to elements in enableFields function

Parameters

$field : string

Field with group list

$table : string

Table name

Tags

see

enableFields()

getPage()

Loads the full page record for the given page ID.

Parameters

$uid : int

The page id to look up

$disableGroupAccessCheck : bool = false

set to true to disable group access check

Tags

see

PageRepository::where_groupAccess

see

PageRepository::where_hid_del

By default the usergroup access check is enabled. Use the second method argument to disable the usergroup access check.

The given UID can be preprocessed by registering a hook class that is implementing the PageRepositoryGetPageHookInterface into the configuration array $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_page.php']['getPage'].

see

PageRepository::getPage_noCheck()

throws

UnexpectedValueException

getPage_noCheck()

Return the $row for the page with uid = $uid WITHOUT checking for ->where_hid_del (start- and endtime or hidden). Only "deleted" is checked!

Parameters

$uid : int

The page id to look up

Tags

see

getPage()

getPageIdsRecursive()

Perfect use case: get storage folders recursively, including the given Page IDs.

Parameters

$pageIds : array<string|int, mixed>

$depth : int

getPageOverlay()

Returns the relevant page overlay record fields

Parameters

$pageInput : mixed

If $pageInput is an integer, it's the pid of the pageOverlay record and thus the page overlay record is returned. If $pageInput is an array, it's a page-record and based on this page record the language record is found and OVERLAID before the page record is returned.

$language : int|LanguageAspect|null = null

language UID if you want to set an alternative value to $this->sys_language_uid which is default. Should be >=0

Tags

throws

UnexpectedValueException

getPageShortcut()

Get page shortcut; Finds the records pointed to by input value $SC (the shortcut value)

Parameters

$shortcutFieldValue : string

The value of the "shortcut" field from the pages record

$shortcutMode : int

The shortcut mode: 1 will select first subpage, 2 a random subpage, 3 the parent page; default is the page pointed to by $SC

$thisUid : int

The current page UID of the page which is a shortcut

$iteration : int = 20

Safety feature which makes sure that the function is calling itself recursively max 20 times (since this function can find shortcuts to other shortcuts to other shortcuts...)

$pageLog : array<string|int, mixed> = []

An array filled with previous page uids tested by the function - new page uids are evaluated against this to avoid going in circles.

$disableGroupCheck : bool = false

If true, the group check is disabled when fetching the target page (needed e.g. for menu generation)

$resolveRandomPageShortcuts : bool = true

If true (default) this will also resolve shortcut to random subpages. In case of linking from a page to a shortcut page, we do not want to cache the "random" logic.

Tags

throws

RuntimeException

throws

ShortcutTargetPageNotFoundException

see

getPageAndRootline()

getPagesOverlay()

Returns the relevant page overlay record fields

Parameters

$pagesInput : array<string|int, mixed>

Array of integers or array of arrays. If each value is an integer, it's the pids of the pageOverlay records and thus the page overlay records are returned. If each value is an array, it's page-records and based on this page records the language records are found and OVERLAID before the page records are returned.

$language : int|LanguageAspect|null = null

Language UID if you want to set an alternative value to $this->sys_language_uid which is default. Should be >=0

Tags

throws

UnexpectedValueException

getRawRecord()

Returns record no matter what - except if record is deleted

Parameters

$table : string

The table name to search

$uid : int

The uid to look up in $table

$fields : string = '*'

Fields to select, * is the default - If a custom list is set, make sure the list contains the uid field. It's mandatory for further processing of the result row.

Tags

see

getPage_noCheck()

getWorkspaceVersionOfRecord()

Select the version of a record for a workspace

Parameters

$workspace : int

Workspace ID

$table : string

Table name to select from

$uid : int

Record uid for which to find workspace version.

$fields : string = '*'

Fields to select, * is the default - If a custom list is set, make sure the list contains the uid field. It's mandatory for further processing of the result row.

$bypassEnableFieldsCheck : bool = false

If TRUE, enablefields are not checked for.

Tags

see

BackendUtility::getWorkspaceVersionOfRecord()

isPageSuitableForLanguage()

Checks whether the passed (translated or default language) page is accessible with the given language settings.

Parameters

$page : array<string|int, mixed>

the page translation record or the page in the default language

$languageAspect : LanguageAspect

resolveShortcutPage()

Check if page is a shortcut, then resolve the target page directly.

Parameters

$page : array<string|int, mixed>

$resolveRandomSubpages : bool = false

$disableGroupAccessCheck : bool = false

Tags

see

TypoScriptFrontendController::getPageAndRootline()

versionOL()

Versioning Preview Overlay

Parameters

$table : string

Table name

$row : array<string|int, mixed>

Record array passed by reference. As minimum, the "uid", "pid" and "t3ver_state" fields must exist! The record MAY be set to FALSE in which case the calling function should act as if the record is forbidden to access!

$unsetMovePointers : bool = false

If set, the $row is cleared in case it is a move-pointer. This is only for preview of moved records (to remove the record from the original location so it appears only in the new location)

$bypassEnableFieldsCheck : bool = false

Unless this option is TRUE, the $row is unset if enablefields for BOTH the version AND the online record deselects it. This is because when versionOL() is called it is assumed that the online record is already selected with no regards to it's enablefields. However, after looking for a new version the online record enablefields must ALSO be evaluated of course. This is done all by this function!

Tags

see

BackendUtility::workspaceOL()