‪TYPO3CMS  11.5
TYPO3\CMS\Core\Domain\Repository\PageRepository Class Reference
Inheritance diagram for TYPO3\CMS\Core\Domain\Repository\PageRepository:

Public Member Functions

 __construct (?Context $context=null)
 
array getPage ($uid, $disableGroupAccessCheck=false)
 
array getPage_noCheck ($uid)
 
array null getLanguageOverlay (string $table, array $row)
 
array getPageOverlay ($pageInput, $languageUid=null)
 
array getPagesOverlay (array $pagesInput, $languageUid=null)
 
bool isPageSuitableForLanguage (array $page, LanguageAspect $languageAspect)
 
mixed getRecordOverlay ($table, $row, $sys_language_content=null, $OLmode='')
 
array getMenu ($pageId, $fields=' *', $sortField='sorting', $additionalWhereClause='', $checkShortcuts=true)
 
array getMenuForPages (array $pageIds, $fields=' *', $sortField='sorting', $additionalWhereClause='', $checkShortcuts=true)
 
mixed getPageShortcut ($shortcutFieldValue, $shortcutMode, $thisUid, $iteration=20, $pageLog=[], $disableGroupCheck=false, bool $resolveRandomPageShortcuts=true)
 
 resolveShortcutPage (array $page, bool $resolveRandomSubpages=false, bool $disableGroupAccessCheck=false)
 
string bool getExtURL ($pagerow)
 
mixed getMountPointInfo ($pageId, $pageRec=false, $prevMountPids=[], $firstPageUid=0)
 
int[] filterAccessiblePageIds (array $pageIds, ?QueryRestrictionContainerInterface $restrictionContainer=null)
 
array int checkRecord ($table, $uid, $checkPage=0)
 
mixed getRawRecord ($table, $uid, $fields=' *')
 
string enableFields ($table, $show_hidden=-1, $ignore_array=[])
 
string getMultipleGroupsWhereClause ($field, $table)
 
 fixVersioningPid ($table, &$rr)
 
 versionOL ($table, &$row, $unsetMovePointers=false, $bypassEnableFieldsCheck=false)
 
mixed getWorkspaceVersionOfRecord ($workspace, $table, $uid, $fields=' *', $bypassEnableFieldsCheck=false)
 

Public Attributes

string $where_hid_del = ' AND pages.deleted=0'
 
string $where_groupAccess = ''
 
bool $includeScheduledRecords = false
 
const DOKTYPE_DEFAULT = 1
 
const DOKTYPE_LINK = 3
 
const DOKTYPE_SHORTCUT = 4
 
const DOKTYPE_BE_USER_SECTION = 6
 
const DOKTYPE_MOUNTPOINT = 7
 
const DOKTYPE_SPACER = 199
 
const DOKTYPE_SYSFOLDER = 254
 
const DOKTYPE_RECYCLER = 255
 
const SHORTCUT_MODE_NONE = 0
 
const SHORTCUT_MODE_FIRST_SUBPAGE = 1
 
const SHORTCUT_MODE_RANDOM_SUBPAGE = 2
 
const SHORTCUT_MODE_PARENT_PAGE = 3
 

Protected Member Functions

 init ($show_hidden)
 
int[] getLanguageFallbackChain (?LanguageAspect $languageAspect)
 
array getPageOverlaysForLanguageUids (array $pageUids, array $languageUids)
 
array getSubpagesForPages (array $pageIds, string $fields=' *', string $sortField='sorting', string $additionalWhereClause='', bool $checkShortcuts=true, bool $parentPages=true)
 
array addMountPointParameterToPage (array $page)
 
array checkValidShortcutOfPage (array $page, $additionalWhereClause)
 
int null getMovedPidOfVersionedRecord (string $table, int $liveUid)
 
array purgeComputedProperties (array $row)
 
VariableFrontend getRuntimeCache ()
 
 hasTableWorkspaceSupport (string $tableName)
 

Protected Attributes

int $sys_language_uid = 0
 
int $versioningWorkspaceId = 0
 
array $computedPropertyNames
 
Context $context
 

Detailed Description

Page functions, a lot of sql/pages-related functions

Mainly used in the frontend but also in some cases in the backend. It's important to set the right $where_hid_del in the object so that the functions operate properly

See also
‪\TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::fetch_the_id()

Definition at line 52 of file PageRepository.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Domain\Repository\PageRepository::__construct ( ?Context  $context = null)

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

Parameters
Context | null$context

Definition at line 137 of file PageRepository.php.

References TYPO3\CMS\Core\Domain\Repository\PageRepository\$context, $GLOBALS, TYPO3\CMS\Core\Domain\Repository\PageRepository\getMultipleGroupsWhereClause(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\init().

Member Function Documentation

◆ addMountPointParameterToPage()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::addMountPointParameterToPage ( array  $page)
protected

Replaces the given page record with mounted page if required

If the given page record is a mount point in overlay mode, the page record is replaced by the record of the overlaying page. The overlay record is enriched by setting the mount point mapping into the field _MP_PARAM as string for example '23-14'.

In all other cases the given page record is returned as is.

Todo:
‪Find a better name. The current doesn't hit the point.
Parameters
array$page‪The page record to handle.
Returns
‪array The given page record or it's replacement.

Definition at line 913 of file PageRepository.php.

References TYPO3\CMS\Core\Domain\Repository\PageRepository\getMountPointInfo(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\getPage().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\getSubpagesForPages().

◆ checkRecord()

array int TYPO3\CMS\Core\Domain\Repository\PageRepository::checkRecord (   $table,
  $uid,
  $checkPage = 0 
)

Checks if a record exists and is accessible. The row is returned if everything's OK.

Parameters
string$table‪The table name to search
int$uid‪The uid to look up in $table
bool | int$checkPage‪If checkPage is set, it's also required that the page on which the record resides is accessible
Returns
‪array|int Returns array (the record) if OK, otherwise blank/0 (zero)

Definition at line 1331 of file PageRepository.php.

References $GLOBALS, TYPO3\CMS\Core\Database\Connection\PARAM_INT, and TYPO3\CMS\Core\Domain\Repository\PageRepository\versionOL().

◆ checkValidShortcutOfPage()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::checkValidShortcutOfPage ( array  $page,
  $additionalWhereClause 
)
protected

If shortcut, look up if the target exists and is currently visible

Parameters
array$page‪The page to check
string$additionalWhereClause‪Optional additional where clauses. Like "AND title like '%some text%'" for instance.
Returns
‪array

Definition at line 945 of file PageRepository.php.

References TYPO3\CMS\Core\Database\Connection\PARAM_INT, and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\getSubpagesForPages().

◆ enableFields()

string TYPO3\CMS\Core\Domain\Repository\PageRepository::enableFields (   $table,
  $show_hidden = -1,
  $ignore_array = [] 
)

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.

Is using the $GLOBALS['TCA'] arrays "ctrl" part where the key "enablefields" determines for each table which of these features applies to that table.

Parameters
string$table‪Table name found in the $GLOBALS['TCA'] array
int$show_hidden‪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.
array$ignore_array‪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.
Exceptions

Definition at line 1427 of file PageRepository.php.

References $GLOBALS, TYPO3\CMS\Core\Versioning\VersionState\DEFAULT_STATE, TYPO3\CMS\Core\Domain\Repository\PageRepository\getMultipleGroupsWhereClause(), TYPO3\CMS\Core\Domain\Repository\PageRepository\hasTableWorkspaceSupport(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

Referenced by TYPO3\CMS\Frontend\ContentObject\RecordsContentObject\collectRecordsFromSource(), and TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbQueryParser\getFrontendConstraintStatement().

◆ filterAccessiblePageIds()

int [] TYPO3\CMS\Core\Domain\Repository\PageRepository::filterAccessiblePageIds ( array  $pageIds,
?QueryRestrictionContainerInterface  $restrictionContainer = null 
)

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
int[]$pageIds‪Array of Page UID numbers to check
QueryRestrictionContainerInterface | null$restrictionContainer
Returns
‪int[] Returns the array of remaining page UID numbers

Definition at line 1290 of file PageRepository.php.

◆ fixVersioningPid()

TYPO3\CMS\Core\Domain\Repository\PageRepository::fixVersioningPid (   $table,
$rr 
)

Finding online PID for offline version record

ONLY active when backend user is previewing records. MUST NEVER affect a site served which is not previewed by backend users!!!

What happens in this method: If a record was moved in a workspace, the records' PID might be different. This is only reason nowadays why this method exists.

This is checked:

  1. ‪If the record has a "online pendant" (t3ver_oid > 0), it overrides the "pid" with the one from the online version.
  2. ‪If a record is a live version, check if there is a moved version in this workspace, and override the LIVE version with the new moved "pid" value.

Used whenever you are tracking something back, like making the root line.

Principle; Record offline! => Find online?

Parameters
string$table‪Table name
array$rr‪Record array passed by reference. As minimum, "pid" and "uid" fields must exist! Having "t3ver_state" and "t3ver_wsid" is nice and will save you a DB query.
See also
‪BackendUtility::fixVersioningPid()
versionOL()
Deprecated:
‪will be removed in TYPO3 v12, use versionOL() directly to achieve the same result.

Definition at line 1601 of file PageRepository.php.

References TYPO3\CMS\Core\Domain\Repository\PageRepository\$versioningWorkspaceId, TYPO3\CMS\Core\Domain\Repository\PageRepository\getMovedPidOfVersionedRecord(), TYPO3\CMS\Core\Domain\Repository\PageRepository\hasTableWorkspaceSupport(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, and TYPO3\CMS\Core\Database\Connection\PARAM_INT.

◆ getExtURL()

string bool TYPO3\CMS\Core\Domain\Repository\PageRepository::getExtURL (   $pagerow)

Returns the redirect URL for the input page row IF the doktype is set to 3.

Parameters
array$pagerow‪The page row to return URL type for
Returns
‪string|bool The URL from based on the data from "pages:url". False if not found.

Definition at line 1143 of file PageRepository.php.

References $GLOBALS.

◆ getLanguageFallbackChain()

int [] TYPO3\CMS\Core\Domain\Repository\PageRepository::getLanguageFallbackChain ( ?LanguageAspect  $languageAspect)
protected

Returns the cleaned fallback chain from the current language aspect, if there is one.

Parameters
LanguageAspect | null$languageAspect
Returns
‪int[]

Definition at line 509 of file PageRepository.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\function, and TYPO3\CMS\Core\Context\LanguageAspect\getFallbackChain().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\getPagesOverlay(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\isPageSuitableForLanguage().

◆ getLanguageOverlay()

array null TYPO3\CMS\Core\Domain\Repository\PageRepository::getLanguageOverlay ( string  $table,
array  $row 
)

Master helper method to overlay a record to a language.

Be aware that for pages the languageId is taken, and for all other records the contentId. This might change through a feature switch in the future.

Parameters
string$table‪the name of the table, should be a TCA table with localization enabled
array$row‪the current (full-fletched) record.
Returns
‪array|null

Definition at line 363 of file PageRepository.php.

References $GLOBALS, TYPO3\CMS\Core\Domain\Repository\PageRepository\getPageOverlay(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\getRecordOverlay().

◆ getMenu()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::getMenu (   $pageId,
  $fields = '*',
  $sortField = 'sorting',
  $additionalWhereClause = '',
  $checkShortcuts = true 
)

Returns an array with page rows for subpages of a certain page ID. This is used for menus in the frontend. If there are mount points in overlay mode the _MP_PARAM field is set to the correct MPvar.

If the $pageId being input does in itself require MPvars to define a correct rootline these must be handled externally to this function.

Parameters
int | int[]$pageId‪The page id (or array of page ids) for which to fetch subpages (PID)
string$fields‪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.
string$sortField‪The field to sort by. Default is "sorting @param string $additionalWhereClause Optional additional where clauses. Like "AND title like 'some text'" for instance.
bool$checkShortcuts‪Check if shortcuts exist, checks by default
Returns
‪array Array with key/value pairs; keys are page-uid numbers. values are the corresponding page records (with overlaid localized fields, if any)
See also
getPageShortcut()
‪\TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject::makeMenu()

Definition at line 766 of file PageRepository.php.

References $fields, and TYPO3\CMS\Core\Domain\Repository\PageRepository\getSubpagesForPages().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\getPageShortcut().

◆ getMenuForPages()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::getMenuForPages ( array  $pageIds,
  $fields = '*',
  $sortField = 'sorting',
  $additionalWhereClause = '',
  $checkShortcuts = true 
)

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

This is used for menus. If there are mount points in overlay mode the _MP_PARAM field is set to the correct MPvar.

Parameters
int[]$pageIds‪Array of page ids to fetch
string$fields‪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.
string$sortField‪The field to sort by. Default is "sorting"
string$additionalWhereClause‪Optional additional where clauses. Like "AND title like '%some text%'" for instance.
bool$checkShortcuts‪Check if shortcuts exist, checks by default
Returns
‪array Array with key/value pairs; keys are page-uid numbers. values are the corresponding page records (with overlaid localized fields, if any)

Definition at line 790 of file PageRepository.php.

References $fields, and TYPO3\CMS\Core\Domain\Repository\PageRepository\getSubpagesForPages().

◆ getMountPointInfo()

mixed TYPO3\CMS\Core\Domain\Repository\PageRepository::getMountPointInfo (   $pageId,
  $pageRec = false,
  $prevMountPids = [],
  $firstPageUid = 0 
)

Returns a MountPoint array for the specified page

Does a recursive search if the mounted page should be a mount page itself.

Note:

Recursive mount points are not supported by all parts of the core. The usage is discouraged. They may be removed from this method.

See also
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.

Parameters
int$pageIdPage id to do the lookup for.
array | bool$pageRec‪Optional page record for the given page.
array$prevMountPids‪Internal register to prevent lookup cycles.
int$firstPageUid‪The first page id.
Returns
‪mixed Mount point array or failure flags (-1, false).
See also
‪\TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject

Definition at line 1194 of file PageRepository.php.

References $GLOBALS, TYPO3\CMS\Core\Domain\Repository\PageRepository\getRuntimeCache(), TYPO3\CMS\Core\Database\Connection\PARAM_INT, and TYPO3\CMS\Core\Domain\Repository\PageRepository\versionOL().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\addMountPointParameterToPage(), and TYPO3\CMS\Core\Routing\PageRouter\resolveMountPointParameterIntoPageSlug().

◆ getMovedPidOfVersionedRecord()

int null TYPO3\CMS\Core\Domain\Repository\PageRepository::getMovedPidOfVersionedRecord ( string  $table,
int  $liveUid 
)
protected

Returns the PID of the new (moved) location within a version, when a $liveUid is given.

Please note: This is only performed within a workspace. This was previously stored in the move placeholder's PID, but move pointer's PID and move placeholder's PID are the same since TYPO3 v10, so the MOVE_POINTER is queried.

Parameters
string$table‪Table name
int$liveUid‪Record UID of online version
Returns
‪int|null If found, the Page ID of the moved record, otherwise null.

Definition at line 1751 of file PageRepository.php.

References TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Domain\Repository\PageRepository\hasTableWorkspaceSupport(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, and TYPO3\CMS\Core\Database\Connection\PARAM_INT.

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\fixVersioningPid().

◆ getMultipleGroupsWhereClause()

string TYPO3\CMS\Core\Domain\Repository\PageRepository::getMultipleGroupsWhereClause (   $field,
  $table 
)

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

Parameters
string$field‪Field with group list
string$table‪Table name
Returns
‪string AND sql-clause
See also
enableFields()

Definition at line 1537 of file PageRepository.php.

References TYPO3\CMS\Core\Domain\Repository\PageRepository\getRuntimeCache().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\__construct(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\enableFields().

◆ getPage()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::getPage (   $uid,
  $disableGroupAccessCheck = false 
)

Loads the full page record for the given page ID.

The page record is either served from a first-level cache or loaded from the database. If no page can be found, an empty array is returned.

Language overlay and versioning overlay are applied. Mount Point handling is not done, an overlaid Mount Point is not replaced.

The result is conditioned by the public properties where_groupAccess and where_hid_del that are preset by the init() method.

See also
‪PageRepository::where_groupAccess
‪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'].

Parameters
int$uid‪The page id to look up
bool$disableGroupAccessCheck‪set to true to disable group access check
Returns
‪array The resulting page record with overlays or empty array
Exceptions

Definition at line 255 of file PageRepository.php.

References $GLOBALS, TYPO3\CMS\Core\Domain\Repository\PageRepository\$where_groupAccess, TYPO3\CMS\Core\Domain\Repository\PageRepository\getPageOverlay(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getRuntimeCache(), TYPO3\CMS\Core\Database\Connection\PARAM_INT, TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\versionOL().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\addMountPointParameterToPage(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getPageShortcut(), and TYPO3\CMS\Core\Routing\PageRouter\resolveMountPointParameterIntoPageSlug().

◆ getPage_noCheck()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::getPage_noCheck (   $uid)

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
int$uid‪The page id to look up
Returns
‪array The page row with overlaid localized fields. Empty array if no page.
See also
getPage()

Definition at line 323 of file PageRepository.php.

References TYPO3\CMS\Core\Domain\Repository\PageRepository\$versioningWorkspaceId, TYPO3\CMS\Core\Domain\Repository\PageRepository\getPageOverlay(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getRuntimeCache(), TYPO3\CMS\Core\Database\Connection\PARAM_INT, and TYPO3\CMS\Core\Domain\Repository\PageRepository\versionOL().

◆ getPageOverlay()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::getPageOverlay (   $pageInput,
  $languageUid = null 
)

Returns the relevant page overlay record fields

Parameters
mixed$pageInput‪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.
int$languageUid‪Language UID if you want to set an alternative value to $this->sys_language_uid which is default. Should be >=0
Exceptions

Definition at line 396 of file PageRepository.php.

References TYPO3\CMS\Core\Domain\Repository\PageRepository\getPagesOverlay().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\getLanguageOverlay(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getPage(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getPage_noCheck(), and TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbBackend\overlayLanguageAndWorkspaceForSingleRecord().

◆ getPageOverlaysForLanguageUids()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::getPageOverlaysForLanguageUids ( array  $pageUids,
array  $languageUids 
)
protected

Returns the first match of overlays for pages in the passed languages.

NOTE regarding the query restrictions: Currently the visibility aspect within the FrontendRestrictionContainer will allow page translation records to be selected as they are child-records of a page. However you may argue that the visibility flag should determine this. But that's not how it's done right now.

Parameters
array$pageUids
array$languageUids‪uid of sys_language, please note that the order is important here.
Returns
‪array

Definition at line 530 of file PageRepository.php.

References $GLOBALS, TYPO3\CMS\Core\Database\Connection\PARAM_INT, and TYPO3\CMS\Core\Domain\Repository\PageRepository\versionOL().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\getPagesOverlay().

◆ getPageShortcut()

mixed TYPO3\CMS\Core\Domain\Repository\PageRepository::getPageShortcut (   $shortcutFieldValue,
  $shortcutMode,
  $thisUid,
  $iteration = 20,
  $pageLog = [],
  $disableGroupCheck = false,
bool  $resolveRandomPageShortcuts = true 
)

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

Parameters
string$shortcutFieldValue‪The value of the "shortcut" field from the pages record
int$shortcutMode‪The shortcut mode: 1 will select first subpage, 2 a random subpage, 3 the parent page; default is the page pointed to by $SC
int$thisUid‪The current page UID of the page which is a shortcut
int$iteration‪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...)
array$pageLog‪An array filled with previous page uids tested by the function - new page uids are evaluated against this to avoid going in circles.
bool$disableGroupCheck‪If true, the group check is disabled when fetching the target page (needed e.g. for menu generation)
bool$resolveRandomPageShortcuts‪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.
Exceptions

Definition at line 1017 of file PageRepository.php.

References TYPO3\CMS\Core\Domain\Repository\PageRepository\$where_groupAccess, TYPO3\CMS\Core\Domain\Repository\PageRepository\DOKTYPE_BE_USER_SECTION, TYPO3\CMS\Core\Domain\Repository\PageRepository\DOKTYPE_RECYCLER, TYPO3\CMS\Core\Domain\Repository\PageRepository\DOKTYPE_SPACER, TYPO3\CMS\Core\Domain\Repository\PageRepository\DOKTYPE_SYSFOLDER, TYPO3\CMS\Core\Domain\Repository\PageRepository\getMenu(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getPage(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Core\Domain\Repository\PageRepository\SHORTCUT_MODE_FIRST_SUBPAGE, TYPO3\CMS\Core\Domain\Repository\PageRepository\SHORTCUT_MODE_PARENT_PAGE, and TYPO3\CMS\Core\Domain\Repository\PageRepository\SHORTCUT_MODE_RANDOM_SUBPAGE.

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\resolveShortcutPage().

◆ getPagesOverlay()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::getPagesOverlay ( array  $pagesInput,
  $languageUid = null 
)

Returns the relevant page overlay record fields

Parameters
array$pagesInput‪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.
int$languageUid‪Language UID if you want to set an alternative value to $this->sys_language_uid which is default. Should be >=0
Exceptions

Definition at line 414 of file PageRepository.php.

References $GLOBALS, TYPO3\CMS\Core\Domain\Repository\PageRepository\$sys_language_uid, TYPO3\CMS\Core\Domain\Repository\PageRepository\getLanguageFallbackChain(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\getPageOverlaysForLanguageUids().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\getPageOverlay(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\getSubpagesForPages().

◆ getRawRecord()

mixed TYPO3\CMS\Core\Domain\Repository\PageRepository::getRawRecord (   $table,
  $uid,
  $fields = '*' 
)

Returns record no matter what - except if record is deleted

Parameters
string$table‪The table name to search
int$uid‪The uid to look up in $table
string$fields‪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.
Returns
‪mixed Returns array (the record) if found, otherwise blank/0 (zero)
See also
getPage_noCheck()

Definition at line 1382 of file PageRepository.php.

References $fields, $GLOBALS, TYPO3\CMS\Core\Database\Connection\PARAM_INT, TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\versionOL().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbBackend\overlayLanguageAndWorkspaceForJoinedSelect(), and TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbBackend\overlayLanguageAndWorkspaceForSingleRecord().

◆ getRecordOverlay()

mixed TYPO3\CMS\Core\Domain\Repository\PageRepository::getRecordOverlay (   $table,
  $row,
  $sys_language_content = null,
  $OLmode = '' 
)

Creates language-overlay for records in general (where translation is found in records from the same table)

Parameters
string$table‪Table name
array$row‪Record to overlay. Must contain uid, pid and $table]['ctrl']['languageField']
LanguageAspect | int | null$sys_language_content‪Pointer to the sys_language uid for content on the site.
string$OLmode‪Overlay mode. If "hideNonTranslated" then records without translation will not be returned un-translated but unset (and return value is NULL)
Exceptions

Definition at line 610 of file PageRepository.php.

References $GLOBALS, TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Domain\Repository\PageRepository\hasTableWorkspaceSupport(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, TYPO3\CMS\Core\Database\Connection\PARAM_INT, and TYPO3\CMS\Core\Domain\Repository\PageRepository\versionOL().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\getLanguageOverlay(), and TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbBackend\overlayLanguageAndWorkspaceForSingleRecord().

◆ getRuntimeCache()

◆ getSubpagesForPages()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::getSubpagesForPages ( array  $pageIds,
string  $fields = '*',
string  $sortField = 'sorting',
string  $additionalWhereClause = '',
bool  $checkShortcuts = true,
bool  $parentPages = true 
)
protected

Loads page records either by PIDs or by UIDs.

By default the subpages of the given page IDs are loaded (as the method name suggests). If $parentPages is set to FALSE, the page records for the given page IDs are loaded directly.

Concerning the rationale, please see these two other methods:

See also
PageRepository::getMenu()
PageRepository::getMenuForPages()

Version and language overlay are applied to the loaded records.

If a record is a mount point in overlay mode, the the overlaying page record is returned in place of the record. The record is enriched by the field _MP_PARAM containing the mount point mapping for the mount point.

The query can be customized by setting fields, sorting and additional WHERE clauses. If additional WHERE clauses are given, the clause must start with an operator, i.e: "AND title like '%some text%'".

The keys of the returned page records are the page UIDs.

CAUTION: In case of an overlaid mount point, it is the original UID.

Parameters
int[]$pageIds‪PIDs or UIDs to load records for
string$fields‪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.
string$sortField‪the field to sort by
string$additionalWhereClause‪optional additional WHERE clause
bool$checkShortcuts‪whether to check if shortcuts exist
bool$parentPages‪Switch to load pages (false) or child pages (true).
Returns
‪array page records
See also
‪self::getPageShortcut()
‪\TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject::makeMenu()

Definition at line 831 of file PageRepository.php.

References $fields, $GLOBALS, TYPO3\CMS\Core\Domain\Repository\PageRepository\addMountPointParameterToPage(), TYPO3\CMS\Core\Domain\Repository\PageRepository\checkValidShortcutOfPage(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getPagesOverlay(), TYPO3\CMS\Core\Database\Connection\PARAM_INT, TYPO3\CMS\Core\Database\Query\QueryHelper\parseOrderBy(), TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\versionOL().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\getMenu(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\getMenuForPages().

◆ getWorkspaceVersionOfRecord()

mixed TYPO3\CMS\Core\Domain\Repository\PageRepository::getWorkspaceVersionOfRecord (   $workspace,
  $table,
  $uid,
  $fields = '*',
  $bypassEnableFieldsCheck = false 
)

Select the version of a record for a workspace

Parameters
int$workspace‪Workspace ID
string$table‪Table name to select from
int$uid‪Record uid for which to find workspace version.
string$fields‪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.
bool$bypassEnableFieldsCheck‪If TRUE, enablefields are not checked for.
Returns
‪mixed If found, return record, otherwise other value: Returns 1 if version was sought for but not found, returns -1/-2 if record (offline/online) existed but had enableFields that would disable it. Returns FALSE if not in workspace or no versioning for record. Notice, that the enablefields of the online record is also tested.
See also
‪BackendUtility::getWorkspaceVersionOfRecord()

Definition at line 1806 of file PageRepository.php.

References $fields, TYPO3\CMS\Core\Domain\Repository\PageRepository\hasTableWorkspaceSupport(), TYPO3\CMS\Core\Versioning\VersionState\NEW_PLACEHOLDER, TYPO3\CMS\Core\Database\Connection\PARAM_INT, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\versionOL().

◆ hasTableWorkspaceSupport()

◆ init()

TYPO3\CMS\Core\Domain\Repository\PageRepository::init (   $show_hidden)
protected

init() MUST be run directly after creating a new template-object This sets the internal variable $this->where_hid_del to the correct where clause for page records taking deleted/hidden/starttime/endtime/t3ver_state into account

Parameters
bool$show_hidden‪If $show_hidden is TRUE, the hidden-field is ignored!! Normally this should be FALSE. Is used for previewing.

Definition at line 159 of file PageRepository.php.

References $GLOBALS, TYPO3\CMS\Core\Domain\Repository\PageRepository\getRuntimeCache(), and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\__construct().

◆ isPageSuitableForLanguage()

bool TYPO3\CMS\Core\Domain\Repository\PageRepository::isPageSuitableForLanguage ( array  $page,
LanguageAspect  $languageAspect 
)

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

Parameters
array$page‪the page translation record or the page in the default language
LanguageAspect$languageAspect
Returns
‪bool true if the given page translation record is suited for the given language ID

Definition at line 481 of file PageRepository.php.

References TYPO3\CMS\Core\Context\LanguageAspect\getId(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\getLanguageFallbackChain().

◆ purgeComputedProperties()

array TYPO3\CMS\Core\Domain\Repository\PageRepository::purgeComputedProperties ( array  $row)
protected

Purges computed properties from database rows, such as _ORIG_uid or _ORIG_pid for instance.

Parameters
array$row
Returns
‪array

Definition at line 1911 of file PageRepository.php.

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\versionOL().

◆ resolveShortcutPage()

TYPO3\CMS\Core\Domain\Repository\PageRepository::resolveShortcutPage ( array  $page,
bool  $resolveRandomSubpages = false,
bool  $disableGroupAccessCheck = false 
)

Check if page is a shortcut, then resolve the target page directly. This is a better method than "getPageShortcut()" and should be used instead, as this automatically checks for $page records and returns the shortcut pages directly.

This method also provides a runtime cache around resolving the shortcut resolving, in order to speed up link generation to the same shortcut page.

See also
‪\TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::getPageAndRootline()

Definition at line 1101 of file PageRepository.php.

References TYPO3\CMS\Core\Cache\Frontend\VariableFrontend\get(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getPageShortcut(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getRuntimeCache(), and TYPO3\CMS\Core\Cache\Frontend\VariableFrontend\set().

Referenced by TYPO3\CMS\Frontend\Typolink\PageLinkBuilder\resolveShortcutPage().

◆ versionOL()

TYPO3\CMS\Core\Domain\Repository\PageRepository::versionOL (   $table,
$row,
  $unsetMovePointers = false,
  $bypassEnableFieldsCheck = false 
)

Versioning Preview Overlay

ONLY active when backend user is previewing records. MUST NEVER affect a site served which is not previewed by backend users!!!

Generally ALWAYS used when records are selected based on uid or pid. If records are selected on other fields than uid or pid (eg. "email = ....") then usage might produce undesired results and that should be evaluated on individual basis.

Principle; Record online! => Find offline?

Parameters
string$table‪Table name
array$row‪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!
bool$unsetMovePointers‪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)
bool$bypassEnableFieldsCheck‪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!
See also
fixVersioningPid()
‪BackendUtility::workspaceOL()

Definition at line 1673 of file PageRepository.php.

References TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, TYPO3\CMS\Core\Domain\Repository\PageRepository\getWorkspaceVersionOfRecord(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, TYPO3\CMS\Core\Versioning\VersionState\NEW_PLACEHOLDER, TYPO3\CMS\Core\Database\Connection\PARAM_INT, TYPO3\CMS\Core\Domain\Repository\PageRepository\purgeComputedProperties(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\checkRecord(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getMountPointInfo(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getPage(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getPage_noCheck(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getPageOverlaysForLanguageUids(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getRawRecord(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getRecordOverlay(), TYPO3\CMS\Core\Domain\Repository\PageRepository\getSubpagesForPages(), and TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbBackend\overlayLanguageAndWorkspaceForSingleRecord().

Member Data Documentation

◆ $computedPropertyNames

array TYPO3\CMS\Core\Domain\Repository\PageRepository::$computedPropertyNames
protected
Initial value:
= array(
'_LOCALIZED_UID',
'_MP_PARAM',
'_ORIG_uid',
'_ORIG_pid',
'_SHORTCUT_ORIGINAL_PAGE_UID',
'_PAGES_OVERLAY',
'_PAGES_OVERLAY_UID',
'_PAGES_OVERLAY_LANGUAGE',
'_PAGES_OVERLAY_REQUESTEDLANGUAGE',
)

Computed properties that are added to database rows.

Definition at line 95 of file PageRepository.php.

◆ $context

Context TYPO3\CMS\Core\Domain\Repository\PageRepository::$context
protected

◆ $includeScheduledRecords

bool TYPO3\CMS\Core\Domain\Repository\PageRepository::$includeScheduledRecords = false

Definition at line 73 of file PageRepository.php.

◆ $sys_language_uid

int TYPO3\CMS\Core\Domain\Repository\PageRepository::$sys_language_uid = 0
protected

Can be migrated away later to use context API directly.

Definition at line 79 of file PageRepository.php.

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\getPagesOverlay().

◆ $versioningWorkspaceId

int TYPO3\CMS\Core\Domain\Repository\PageRepository::$versioningWorkspaceId = 0
protected

Can be migrated away later to use context API directly. Workspace ID for preview If > 0, versioning preview of other record versions is allowed. THIS MUST ONLY BE SET IF the page is not cached and truly previewed by a backend user!

Definition at line 89 of file PageRepository.php.

Referenced by TYPO3\CMS\Core\Domain\Repository\PageRepository\fixVersioningPid(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\getPage_noCheck().

◆ $where_groupAccess

string TYPO3\CMS\Core\Domain\Repository\PageRepository::$where_groupAccess = ''

◆ $where_hid_del

string TYPO3\CMS\Core\Domain\Repository\PageRepository::$where_hid_del = ' AND pages.deleted=0'

This is not the final clauses. There will normally be conditions for the hidden, starttime and endtime fields as well. You MUST initialize the object by the init() function

Definition at line 62 of file PageRepository.php.

◆ DOKTYPE_BE_USER_SECTION

◆ DOKTYPE_DEFAULT

◆ DOKTYPE_LINK

◆ DOKTYPE_MOUNTPOINT

◆ DOKTYPE_RECYCLER

◆ DOKTYPE_SHORTCUT

◆ DOKTYPE_SPACER

◆ DOKTYPE_SYSFOLDER

◆ SHORTCUT_MODE_FIRST_SUBPAGE

const TYPO3\CMS\Core\Domain\Repository\PageRepository::SHORTCUT_MODE_FIRST_SUBPAGE = 1

◆ SHORTCUT_MODE_NONE

const TYPO3\CMS\Core\Domain\Repository\PageRepository::SHORTCUT_MODE_NONE = 0

Named constants for "magic numbers" of the field shortcut_mode

Definition at line 122 of file PageRepository.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\generateMessagesForCurrentPage().

◆ SHORTCUT_MODE_PARENT_PAGE

const TYPO3\CMS\Core\Domain\Repository\PageRepository::SHORTCUT_MODE_PARENT_PAGE = 3

◆ SHORTCUT_MODE_RANDOM_SUBPAGE

const TYPO3\CMS\Core\Domain\Repository\PageRepository::SHORTCUT_MODE_RANDOM_SUBPAGE = 2