TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
PageRepository Class Reference
Inheritance diagram for PageRepository:
PageRepositoryFixture

Public Member Functions

 init ($show_hidden)
 
 getPage ($uid, $disableGroupAccessCheck=false)
 
 getPage_noCheck ($uid)
 
 getFirstWebPage ($uid)
 
 getPageIdFromAlias ($alias)
 
 getPageOverlay ($pageInput, $lUid=-1)
 
 getPagesOverlay (array $pagesInput, $lUid=-1)
 
 getRecordOverlay ($table, $row, $sys_language_content, $OLmode= '')
 
 getMenu ($pageId, $fields= '*', $sortField= 'sorting', $additionalWhereClause= '', $checkShortcuts=true)
 
 getMenuForPages (array $pageIds, $fields= '*', $sortField= 'sorting', $additionalWhereClause= '', $checkShortcuts=true)
 
 getDomainStartPage ($domain, $path= '', $request_uri= '')
 
 getRootLine ($uid, $MP= '', $ignoreMPerrors=false)
 
 getPathFromRootline ($rl, $len=20)
 
 getExtURL ($pagerow)
 
 getMountPointInfo ($pageId, $pageRec=false, $prevMountPids=[], $firstPageUid=0)
 
 checkRecord ($table, $uid, $checkPage=0)
 
 getRawRecord ($table, $uid, $fields= '*', $noWSOL=false)
 
 getRecordsByField ($theTable, $theField, $theValue, $whereClause= '', $groupBy= '', $orderBy= '', $limit= '')
 
 deleteClause ($table)
 
 enableFields ($table, $show_hidden=-1, $ignore_array=[], $noVersionPreview=false)
 
 getMultipleGroupsWhereClause ($field, $table)
 
 fixVersioningPid ($table, &$rr)
 
 movePlhOL ($table, &$row)
 
 getMovePlaceholder ($table, $uid, $fields= '*')
 
 getWorkspaceVersionOfRecord ($workspace, $table, $uid, $fields= '*', $bypassEnableFieldsCheck=false)
 
 checkWorkspaceAccess ($wsid)
 

Static Public Member Functions

static storeHash ($hash, $data, $ident, $lifetime=0)
 

Public Attributes

 $urltypes = ['', 'http://', 'ftp://', 'mailto:', 'https://']
 
 $where_hid_del = ' AND pages.deleted=0'
 
 $where_groupAccess = ''
 
 $sys_language_uid = 0
 
 $versioningPreview = false
 
 $versioningPreview_where_hid_del = ''
 
 $versioningWorkspaceId = 0
 
 $workspaceCache = []
 
 $error_getRootLine = ''
 
 $error_getRootLine_failPid = 0
 
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

 getSubpagesForPages (array $pageIds, $fields= '*', $sortField= 'sorting', $additionalWhereClause= '', $checkShortcuts=true, $parentPages=true)
 
 addMountPointParameterToPage (array $page)
 
 checkValidShortcutOfPage (array $page, $additionalWhereClause)
 
 purgeComputedProperties (array $row)
 
 shouldFieldBeOverlaid ($table, $field, $value)
 
 getTypoScriptFrontendController ()
 
 getBackendUser ()
 

Protected Attributes

 $cache_getRootLine = []
 
 $cache_getPage = []
 
 $cache_getPage_noCheck = []
 
 $cache_getPageIdFromAlias = []
 
 $cache_getMountPointInfo = []
 
 $tableNamesAllowedOnRootLevel
 
 $computedPropertyNames
 

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
::fetch_the_id()

Definition at line 40 of file PageRepository.php.

Member Function Documentation

addMountPointParameterToPage ( array  $page)
protected

Add the mount point parameter to the page if needed

Parameters
array$pageThe page to check
Returns
array

Definition at line 762 of file PageRepository.php.

References PageRepository\getMountPointInfo(), and PageRepository\getPage().

Referenced by PageRepository\getSubpagesForPages().

checkRecord (   $table,
  $uid,
  $checkPage = 0 
)

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

Parameters
string$tableThe table name to search
int$uidThe uid to look up in $table
bool | int$checkPageIf 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 1125 of file PageRepository.php.

References $GLOBALS, and GeneralUtility\makeInstance().

checkValidShortcutOfPage ( array  $page,
  $additionalWhereClause 
)
protected

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

Parameters
array$pageThe page to check
string$additionalWhereClauseOptional additional where clauses. Like "AND title like '%blabla%'" for instance.
Returns
array

Definition at line 795 of file PageRepository.php.

References GeneralUtility\makeInstance(), and QueryHelper\stripLogicalOperatorPrefix().

Referenced by PageRepository\getSubpagesForPages().

checkWorkspaceAccess (   $wsid)

Checks if user has access to workspace.

Parameters
int$wsidWorkspace ID
Returns
bool TRUE if has access

Definition at line 1812 of file PageRepository.php.

References PageRepository\getBackendUser(), ExtensionManagementUtility\isLoaded(), and GeneralUtility\makeInstance().

Referenced by PageRepository\fixVersioningPid().

deleteClause (   $table)

Returns the "AND NOT deleted" clause for the tablename given IF $GLOBALS['TCA'] configuration points to such a field.

Parameters
string$tableTablename
Returns
string
See also
enableFields()

Definition at line 1318 of file PageRepository.php.

References $GLOBALS.

enableFields (   $table,
  $show_hidden = -1,
  $ignore_array = [],
  $noVersionPreview = false 
)

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$tableTable name found in the $GLOBALS['TCA'] array
int$show_hiddenIf $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_arrayArray 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.
bool$noVersionPreviewIf set, enableFields will be applied regardless of any versioning preview settings which might otherwise disable enableFields
Exceptions
InvalidArgumentException
Returns
string The clause starting like " AND ...=... AND ...=...
See also
::enableFields(), deleteClause()

Definition at line 1340 of file PageRepository.php.

References $GLOBALS, GeneralUtility\callUserFunction(), VersionState\DEFAULT_STATE, PageRepository\getMultipleGroupsWhereClause(), PageRepository\getTypoScriptFrontendController(), GeneralUtility\makeInstance(), and QueryHelper\stripLogicalOperatorPrefix().

Referenced by PageRepository\init().

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!!!

Will look if the "pid" value of the input record is -1 (it is an offline version) and if the table supports versioning; if so, it will translate the -1 PID into the PID of the original record.

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

Principle; Record offline! => Find online?

Parameters
string$tableTable name
array$rrRecord array passed by reference. As minimum, "pid" and "uid" fields must exist! "t3ver_oid" and "t3ver_wsid" is nice and will save you a DB query.
Returns
void (Passed by ref).
See also
BackendUtility::fixVersioningPid(), versionOL(), getRootLine()

Definition at line 1491 of file PageRepository.php.

References $GLOBALS, PageRepository\checkWorkspaceAccess(), PageRepository\getMovePlaceholder(), and PageRepository\getRawRecord().

getBackendUser ( )
protected

Returns the current BE user.

Returns

Definition at line 1967 of file PageRepository.php.

References $GLOBALS.

Referenced by PageRepository\checkWorkspaceAccess().

getDomainStartPage (   $domain,
  $path = '',
  $request_uri = '' 
)

Will find the page carrying the domain record matching the input domain. Might exit after sending a redirect-header IF a found domain record instructs to do so.

Parameters
string$domainDomain name to search for. Eg. "www.typo3.com". Typical the HTTP_HOST value.
string$pathPath for the current script in domain. Eg. "/somedir/subdir". Typ. supplied by ::getIndpEnv('SCRIPT_NAME')
string$request_uriRequest URI: Used to get parameters from if they should be appended. Typ. supplied by ::getIndpEnv('REQUEST_URI')
Returns
mixed If found, returns integer with page UID where found. Otherwise blank. Might exit if location-header is sent, see description.
See also
::findDomainRecord()

Definition at line 860 of file PageRepository.php.

References HttpUtility\HTTP_STATUS_301, GeneralUtility\makeInstance(), HttpUtility\redirect(), and QueryHelper\stripLogicalOperatorPrefix().

getExtURL (   $pagerow)

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

Parameters
array$pagerowThe page row to return URL type for
Returns
string|bool The URL from based on the data from "urltype" and "url". False if not found.
See also
::initializeRedirectUrlHandlers()

Definition at line 998 of file PageRepository.php.

References GeneralUtility\getIndpEnv().

getFirstWebPage (   $uid)

Returns the $row of the first web-page in the tree (for the default menu...)

Parameters
int$uidThe page id for which to fetch first subpages (PID)
Returns
mixed If found: The page record (with overlayed localized fields, if any). If NOT found: blank value (not array!)
See also
::fetch_the_id()

Definition at line 331 of file PageRepository.php.

References PageRepository\getPageOverlay(), GeneralUtility\makeInstance(), and QueryHelper\stripLogicalOperatorPrefix().

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$fieldsList of fields to select. Default is "*" = all
string$sortFieldThe field to sort by. Default is "sorting @param string $additionalWhereClause Optional additional where clauses. Like "AND title like 'blabla'" for instance.
bool$checkShortcutsCheck 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 overlayed localized fields, if any)
See also
::getPageShortcut(), ::makeMenu()
,

Definition at line 661 of file PageRepository.php.

References $fields, and PageRepository\getSubpagesForPages().

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$fieldsList of fields to select. Default is "*" = all
string$sortFieldThe field to sort by. Default is "sorting"
string$additionalWhereClauseOptional additional where clauses. Like "AND title like '%blabla%'" for instance.
bool$checkShortcutsCheck 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 overlayed localized fields, if any)

Definition at line 679 of file PageRepository.php.

References $fields, and PageRepository\getSubpagesForPages().

getMountPointInfo (   $pageId,
  $pageRec = false,
  $prevMountPids = [],
  $firstPageUid = 0 
)

Returns MountPoint id for page

Does a recursive search if the mounted page should be a mount page itself. It has a run-away break so it can't go into infinite loops.

Parameters
int$pageIdPage id for which to look for a mount pid. Will be returned only if mount pages are enabled, the correct doktype (7) is set for page and there IS a mount_pid (which has a valid record that is not deleted...)
array | bool$pageRecOptional page record for the page id. If not supplied it will be looked up by the system. Must contain at least uid,pid,doktype,mount_pid,mount_pid_ol
array$prevMountPidsArray accumulating formerly tested page ids for mount points. Used for recursivity brake.
int$firstPageUidThe first page id.
Returns
mixed 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 also

Definition at line 1026 of file PageRepository.php.

References $GLOBALS, and GeneralUtility\makeInstance().

Referenced by PageRepository\addMountPointParameterToPage().

getMovePlaceholder (   $table,
  $uid,
  $fields = '*' 
)

Returns move placeholder of online (live) version

Parameters
string$tableTable name
int$uidRecord UID of online version
string$fieldsField list, default is *
Returns
array If found, the record, otherwise nothing.
See also
BackendUtility::getMovePlaceholder()

Definition at line 1675 of file PageRepository.php.

References $fields, $GLOBALS, GeneralUtility\makeInstance(), VersionState\MOVE_PLACEHOLDER, and GeneralUtility\trimExplode().

Referenced by PageRepository\fixVersioningPid().

getMultipleGroupsWhereClause (   $field,
  $table 
)

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

Parameters
string$fieldField with group list
string$tableTable name
Returns
string AND sql-clause
See also
enableFields()

Definition at line 1446 of file PageRepository.php.

References PageRepository\getTypoScriptFrontendController(), GeneralUtility\intExplode(), and GeneralUtility\makeInstance().

Referenced by PageRepository\enableFields().

getPage (   $uid,
  $disableGroupAccessCheck = false 
)

Returns the $row for the page with uid = $uid (observing ->where_hid_del) Any pages_language_overlay will be applied before the result is returned. If no page is found an empty array is returned.

Parameters
int$uidThe page id to look up.
bool$disableGroupAccessCheckIf set, the check for group access is disabled. VERY rarely used
Exceptions
UnexpectedValueException
Returns
array The page row with overlayed localized fields. Empty it no page.
See also
getPage_noCheck()

Definition at line 239 of file PageRepository.php.

References $GLOBALS, PageRepository\getPageOverlay(), GeneralUtility\getUserObj(), GeneralUtility\makeInstance(), and QueryHelper\stripLogicalOperatorPrefix().

Referenced by PageRepository\addMountPointParameterToPage().

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

Definition at line 297 of file PageRepository.php.

References PageRepository\getPageOverlay(), and GeneralUtility\makeInstance().

getPageIdFromAlias (   $alias)

Returns a pagerow for the page with alias $alias

Parameters
string$aliasThe alias to look up the page uid for.
Returns
int Returns page uid (int) if found, otherwise 0 (zero)
See also
::checkAndSetAlias(), ContentObjectRenderer::typoLink()

Definition at line 364 of file PageRepository.php.

References GeneralUtility\makeInstance().

getPageOverlay (   $pageInput,
  $lUid = -1 
)

Returns the relevant page overlay record fields

Parameters
mixed$pageInputIf $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 OVERLAYED before the page record is returned.
int$lUidLanguage UID if you want to set an alternative value to $this->sys_language_uid which is default. Should be >=0
Exceptions
UnexpectedValueException
Returns
array Page row which is overlayed with language_overlay record (or the overlay record alone)

Definition at line 402 of file PageRepository.php.

References PageRepository\getPagesOverlay().

Referenced by PageRepository\getFirstWebPage(), PageRepository\getPage(), and PageRepository\getPage_noCheck().

getPagesOverlay ( array  $pagesInput,
  $lUid = -1 
)

Returns the relevant page overlay record fields

Parameters
array$pagesInputArray 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 OVERLAYED before the page records are returned.
int$lUidLanguage UID if you want to set an alternative value to $this->sys_language_uid which is default. Should be >=0
Exceptions
UnexpectedValueException
Returns
array Page rows which are overlayed with language_overlay record. If the input was an array of integers, missing records are not included. If the input were page rows, untranslated pages are returned.

Definition at line 420 of file PageRepository.php.

References $GLOBALS, PageRepository\$sys_language_uid, GeneralUtility\getUserObj(), GeneralUtility\makeInstance(), PageRepository\purgeComputedProperties(), PageRepository\shouldFieldBeOverlaid(), and GeneralUtility\trimExplode().

Referenced by PageRepository\getPageOverlay(), and PageRepository\getSubpagesForPages().

getPathFromRootline (   $rl,
  $len = 20 
)

Creates a "path" string for the input root line array titles. Used for writing statistics.

Parameters
array$rlA rootline array!
int$lenThe max length of each title from the rootline.
Returns
string The path in the form "/page title/This is another pageti.../Another page
See also
::getConfigArray()
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 976 of file PageRepository.php.

References GeneralUtility\logDeprecatedFunction().

getRawRecord (   $table,
  $uid,
  $fields = '*',
  $noWSOL = false 
)

Returns record no matter what - except if record is deleted

Parameters
string$tableThe table name to search
int$uidThe uid to look up in $table
string$fieldsThe fields to select, default is "*
bool$noWSOLIf set, no version overlay is applied
Returns
mixed Returns array (the record) if found, otherwise blank/0 (zero)
See also
getPage_noCheck()

Definition at line 1178 of file PageRepository.php.

References $fields, $GLOBALS, GeneralUtility\makeInstance(), and GeneralUtility\trimExplode().

Referenced by PageRepository\fixVersioningPid(), and PageRepository\movePlhOL().

getRecordOverlay (   $table,
  $row,
  $sys_language_content,
  $OLmode = '' 
)

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

Parameters
string$tableTable name
array$rowRecord to overlay. Must contain uid, pid and $table]['ctrl']['languageField']
int$sys_language_contentPointer to the sys_language uid for content on the site.
string$OLmodeOverlay mode. If "hideNonTranslated" then records without translation will not be returned un-translated but unset (and return value is FALSE)
Exceptions
UnexpectedValueException
Returns
mixed Returns the input record, possibly overlaid with a translation. But if $OLmode is "hideNonTranslated" then it will return FALSE if no translation is found.

Definition at line 540 of file PageRepository.php.

References $GLOBALS, GeneralUtility\getUserObj(), GeneralUtility\makeInstance(), and PageRepository\shouldFieldBeOverlaid().

getRecordsByField (   $theTable,
  $theField,
  $theValue,
  $whereClause = '',
  $groupBy = '',
  $orderBy = '',
  $limit = '' 
)

Selects records based on matching a field (ei. other than UID) with a value

Parameters
string$theTableThe table name to search, eg. "pages" or "tt_content @param string $theField The fieldname to match, eg. "uid" or "alias
string$theValueThe value that fieldname must match, eg. "123" or "frontpage
string$whereClauseOptional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
string$groupByOptional GROUP BY field(s). If none, supply blank string.
string$orderByOptional ORDER BY field(s). If none, supply blank string.
string$limitOptional LIMIT value ([begin,]max). If none, supply blank string.
Returns
mixed Returns array (the record) if found, otherwise nothing (void)

Definition at line 1216 of file PageRepository.php.

References $GLOBALS, GeneralUtility\intExplode(), GeneralUtility\makeInstance(), QueryHelper\parseGroupBy(), QueryHelper\parseOrderBy(), and QueryHelper\stripLogicalOperatorPrefix().

getRootLine (   $uid,
  $MP = '',
  $ignoreMPerrors = false 
)

Returns array with fields of the pages from here ($uid) and back to the root

NOTICE: This function only takes deleted pages into account! So hidden, starttime and endtime restricted pages are included no matter what.

Further: If any "recycler" page is found (doktype=255) then it will also block for the rootline)

If you want more fields in the rootline records than default such can be added by listing them in $GLOBALS['TYPO3_CONF_VARS']['FE']['addRootLineFields']

Parameters
int$uidThe page uid for which to seek back to the page tree root.
string$MPCommalist of MountPoint parameters, eg. "1-2,3-4" etc. Normally this value comes from the GET var, MP
bool$ignoreMPerrorsIf set, some errors related to Mount Points in root line are ignored.
Exceptions
Exception
RuntimeException
Returns
array Array with page records from the root line as values. The array is ordered with the outer records first and root record in the bottom. The keys are numeric but in reverse order. So if you traverse/sort the array by the numeric keys order you will get the order from root and out. If an error is found (like eternal looping or invalid mountpoint) it will return an empty array.
See also
::getPageAndRootline()
See also
::getRecordArray

Definition at line 946 of file PageRepository.php.

References GeneralUtility\makeInstance().

getSubpagesForPages ( array  $pageIds,
  $fields = '*',
  $sortField = 'sorting',
  $additionalWhereClause = '',
  $checkShortcuts = true,
  $parentPages = true 
)
protected

Internal method used by getMenu() and getMenuForPages() Returns an array with page rows for subpages with pid is in $pageIds or uid is in $pageIds, depending on $parentPages This is used for menus. If there are mount points in overlay mode the _MP_PARAM field is set to the correct MPvar.

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

Parameters
int[]$pageIds The page id (or array of page ids) for which to fetch subpages (PID)
string$fieldsList of fields to select. Default is "*" = all
string$sortFieldThe field to sort by. Default is "sorting @param string $additionalWhereClause Optional additional where clauses. Like "AND title like 'blabla'" for instance.
bool$checkShortcutsCheck if shortcuts exist, checks by default
bool$parentPagesWhether the uid list is meant as list of parent pages or the page itself TRUE means id list is checked against pid field
Returns
array Array with key/value pairs; keys are page-uid numbers. values are the corresponding page records (with overlayed localized fields, if any)
See also
::getPageShortcut(), ::makeMenu()
,

Definition at line 703 of file PageRepository.php.

References $fields, PageRepository\addMountPointParameterToPage(), PageRepository\checkValidShortcutOfPage(), PageRepository\getPagesOverlay(), GeneralUtility\makeInstance(), QueryHelper\stripLogicalOperatorPrefix(), and GeneralUtility\trimExplode().

Referenced by PageRepository\getMenu(), and PageRepository\getMenuForPages().

getTypoScriptFrontendController ( )
protected
Returns

Definition at line 1957 of file PageRepository.php.

References $GLOBALS.

Referenced by PageRepository\enableFields(), and PageRepository\getMultipleGroupsWhereClause().

getWorkspaceVersionOfRecord (   $workspace,
  $table,
  $uid,
  $fields = '*',
  $bypassEnableFieldsCheck = false 
)

Select the version of a record for a workspace

Parameters
int$workspaceWorkspace ID
string$tableTable name to select from
int$uidRecord uid for which to find workspace version.
string$fieldsField list to select
bool$bypassEnableFieldsCheckIf 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 1729 of file PageRepository.php.

References $fields, $GLOBALS, GeneralUtility\makeInstance(), and GeneralUtility\trimExplode().

init (   $show_hidden)

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_hiddenIf $show_hidden is TRUE, the hidden-field is ignored!! Normally this should be FALSE. Is used for previewing.
Returns
void
See also
::fetch_the_id(), ::initialize_editor()

Definition at line 186 of file PageRepository.php.

References $GLOBALS, PageRepository\enableFields(), and GeneralUtility\makeInstance().

movePlhOL (   $table,
$row 
)

Checks if record is a move-placeholder (t3ver_state==VersionState::MOVE_PLACEHOLDER) and if so it will set $row to be the pointed-to live record (and return TRUE) Used from versionOL

Parameters
string$tableTable name
array$rowRow (passed by reference) - only online records...
Returns
bool TRUE if overlay is made.
See also
BackendUtility::movePlhOl()

Definition at line 1628 of file PageRepository.php.

References $GLOBALS, Enumeration\cast(), PageRepository\getRawRecord(), GeneralUtility\makeInstance(), VersionState\MOVE_PLACEHOLDER, and PageRepository\purgeComputedProperties().

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 1910 of file PageRepository.php.

Referenced by PageRepository\getPagesOverlay(), and PageRepository\movePlhOL().

shouldFieldBeOverlaid (   $table,
  $field,
  $value 
)
protected

Determine if a field needs an overlay

Parameters
string$tableTCA tablename
string$fieldTCA fieldname
mixed$valueCurrent value of the field
Returns
bool Returns TRUE if a given record field needs to be overlaid

Definition at line 1928 of file PageRepository.php.

References $GLOBALS.

Referenced by PageRepository\getPagesOverlay(), and PageRepository\getRecordOverlay().

static storeHash (   $hash,
  $data,
  $ident,
  $lifetime = 0 
)
static

Stores $data in the 'cache_hash' cache with the hash key, $hash and visual/symbolic identification, $ident

Can be used from your frontend plugins if you like. You can call it directly like PageRepository::storeHash()

Parameters
string$hash32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
mixed$dataThe data to store
string$identIs just a textual identification in order to inform about the content!
int$lifetimeThe lifetime for the cache entry in seconds
Returns
void
See also
tslib_TStemplate::start(), getHash()

Definition at line 1305 of file PageRepository.php.

References GeneralUtility\makeInstance().

Referenced by ExtDirectApi\getExtDirectApi().

Member Data Documentation

$cache_getMountPointInfo = []
protected

Definition at line 131 of file PageRepository.php.

$cache_getPage = []
protected

Definition at line 116 of file PageRepository.php.

$cache_getPage_noCheck = []
protected

Definition at line 121 of file PageRepository.php.

$cache_getPageIdFromAlias = []
protected

Definition at line 126 of file PageRepository.php.

$cache_getRootLine = []
protected

Definition at line 111 of file PageRepository.php.

$computedPropertyNames
protected
Initial value:
= [
'_LOCALIZED_UID',
'_MP_PARAM',
'_ORIG_uid',
'_ORIG_pid',
'_PAGES_OVERLAY',
'_PAGES_OVERLAY_UID',
'_PAGES_OVERLAY_LANGUAGE',
]

Definition at line 146 of file PageRepository.php.

$error_getRootLine = ''

Definition at line 99 of file PageRepository.php.

$error_getRootLine_failPid = 0

Definition at line 106 of file PageRepository.php.

$sys_language_uid = 0

Definition at line 66 of file PageRepository.php.

Referenced by PageRepository\getPagesOverlay().

$tableNamesAllowedOnRootLevel
protected
Initial value:
= [
'sys_file_metadata',
'sys_category',
]

Definition at line 136 of file PageRepository.php.

$urltypes = ['', 'http://', 'ftp://', 'mailto:', 'https://']

Definition at line 45 of file PageRepository.php.

$versioningPreview = false

Definition at line 75 of file PageRepository.php.

$versioningPreview_where_hid_del = ''

Definition at line 80 of file PageRepository.php.

$versioningWorkspaceId = 0

Definition at line 87 of file PageRepository.php.

$where_groupAccess = ''

Definition at line 61 of file PageRepository.php.

$where_hid_del = ' AND pages.deleted=0'

Definition at line 54 of file PageRepository.php.

$workspaceCache = []

Definition at line 92 of file PageRepository.php.

const DOKTYPE_DEFAULT = 1

Named constants for "magic numbers" of the field doktype

Definition at line 159 of file PageRepository.php.

Referenced by CreatePagesWizardModuleFunctionController\getTypeSelectData().

const SHORTCUT_MODE_FIRST_SUBPAGE = 1
const SHORTCUT_MODE_NONE = 0

Named constants for "magic numbers" of the field shortcut_mode

Definition at line 171 of file PageRepository.php.

Referenced by PageLayoutController\getHeaderFlashMessagesForCurrentPid(), and BackendUtility\titleAttribForPages().