PageParts

FinalYes

Data object to collect sections the full response body is compiled from.

This is used and fed by various related middlewares.

This object is attached as "frontend.page.parts" attribute to the frontend application request object.

Note most of the data accumulated here is part of the page cache row, so the state is either generated from scratch during first page rendering, or recreated from cache upon consecutive renderings.

This data object is highly experimental and marked as @internal since it will likely change when the rendering and cache related parts of the frontend middleware chain see further refactorings.

Internal

Experimental, will change.

Table of Contents

Methods

addNotCachedContentElement()  : void
getContent()  : string
getHttpContentType()  : string
getLastChanged()  : int
getNotCachedContentElementRegistry()  : array<string|int, mixed>
getPageCacheExpireTimestamp()  : int|null
getPageCacheGeneratedTimestamp()  : int
getPageRendererSubstitutionHash()  : string
getPageTitle()  : array<string|int, mixed>
hasNotCachedContentElements()  : bool
hasPageContentBeenLoadedFromCache()  : bool
setContent()  : void
setHttpContentType()  : void
setLastChanged()  : void
setPageCacheExpireTimestamp()  : void
setPageCacheGeneratedTimestamp()  : void
setPageContentWasLoadedFromCache()  : void
setPageRendererSubstitutionHash()  : void
setPageTitle()  : void

Methods

addNotCachedContentElement()

public addNotCachedContentElement(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

getContent()

public getContent() : string
Return values
string

getHttpContentType()

public getHttpContentType() : string
Return values
string

getLastChanged()

public getLastChanged() : int
Return values
int

getNotCachedContentElementRegistry()

public getNotCachedContentElementRegistry() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPageCacheExpireTimestamp()

public getPageCacheExpireTimestamp() : int|null
Return values
int|null

getPageCacheGeneratedTimestamp()

public getPageCacheGeneratedTimestamp() : int
Return values
int

getPageRendererSubstitutionHash()

public getPageRendererSubstitutionHash() : string
Return values
string

getPageTitle()

public getPageTitle() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasNotCachedContentElements()

public hasNotCachedContentElements() : bool
Return values
bool

hasPageContentBeenLoadedFromCache()

public hasPageContentBeenLoadedFromCache() : bool
Return values
bool

setContent()

public setContent(string $content) : void
Parameters
$content : string

setHttpContentType()

public setHttpContentType(string $contentType) : void
Parameters
$contentType : string

setLastChanged()

public setLastChanged(int $timestamp) : void
Parameters
$timestamp : int

setPageCacheExpireTimestamp()

public setPageCacheExpireTimestamp(int $timestamp) : void
Parameters
$timestamp : int

setPageCacheGeneratedTimestamp()

public setPageCacheGeneratedTimestamp(int $timestamp) : void
Parameters
$timestamp : int

setPageContentWasLoadedFromCache()

public setPageContentWasLoadedFromCache() : void

setPageRendererSubstitutionHash()

public setPageRendererSubstitutionHash(string $hash) : void
Parameters
$hash : string

setPageTitle()

public setPageTitle(array<string|int, mixed> $pageTitle) : void
Parameters
$pageTitle : array<string|int, mixed>

        
On this page

Search results