PageView
class PageView extends View (View source)
Traits
Properties
| static protected | $requestInstance | from AbstractView | |
| static protected | $requestInstances | from AbstractView | |
| protected | $scopeItems | from AbstractView | |
| $controller | from AbstractView | ||
| protected | $template | from AbstractView | |
| protected | $outputAssets | from AbstractView | |
| protected | $viewPath | from View | |
| protected | $innerContentFile | from View | |
| protected | $themeHandle | from View | |
| protected | $themeObject | from View | |
| protected | $themeRelativePath | from View | |
| protected | $themeAbsolutePath | from View | |
| protected | $viewPkgHandle | from View | |
| protected | $themePkgHandle | from View | |
| protected | $viewRootDirectoryName | from View | |
| protected | $c | ||
| protected | $cp | ||
| protected | $pTemplateID | ||
| protected | $customPreviewRequest |
Methods
No description
No description
No description
No description
A shortcut to posting back to the current page with a task and optional parameters. Only works in the context of.
No description
URL is a utility function that is used inside a view to setup urls w/tasks and parameters.
Given a block or page controller that we're rendering, we request all the features required by that block controller and then add them to the page's header/footer via requireAsset, if they're not already provided by the theme (which we check via getThemeSupportedFeatures)
Requires one or more features if not present in theme.
Checks to see if page editing has been manually disabled through code. This does things like hide the toolbar etc.
Load all the theme-related variables for which theme to use for this request. May update the themeHandle property on the view based on themeByRoute settings.
No description
No description
No description
No description
No description
No description
Details
getViewTemplate()
No description
addScopeItems($items)
No description
static
getRequestInstance()
No description
__construct(mixed $mixed = false)
No description
static protected
setRequestInstance(View $v)
No description
static protected
revertRequestInstance()
No description
in
View at line 235
start($state)
Begin the render.
startRender()
No description
protected
constructView($page = false)
No description
setupRender()
No description
finishRender($contents)
No description
in
View at line 136
action($action)
A shortcut to posting back to the current page with a task and optional parameters. Only works in the context of.
addHeaderAsset($asset)
No description
addFooterAsset($asset)
No description
addOutputAsset($asset)
No description
requireAsset($assetType, $assetHandle = false)
No description
setController($controller)
No description
setViewTemplate($template)
No description
post($key, $defaultValue = null)
Returns the value of the item in the POST array.
in
View at line 282
protected
onBeforeGetContents()
No description
in
View at line 382
postProcessViewContents($contents)
No description
protected
onAfterGetContents()
No description
getScopeItems()
No description
render($state = false)
No description
in
View at line 290
renderViewContents($scopeItems)
No description
static string
url(string $action, string $task = null)
URL is a utility function that is used inside a view to setup urls w/tasks and parameters.
renderError($title, $error, $errorObj = null)
No description
addHeaderItem($item)
No description
addFooterItem($item)
No description
static View
getInstance()
Get an instance of the View.
Note: In versions before 8.5.0a3, this method may return 'false' if it's called after the page is rendered (for example in middleware).
protected void
handleRequiredFeatures(mixed $controller, Theme $theme)
Given a block or page controller that we're rendering, we request all the features required by that block controller and then add them to the page's header/footer via requireAsset, if they're not already provided by the theme (which we check via getThemeSupportedFeatures)
protected void
requireFeaturesIfNotPresentInTheme(array $features, Theme $theme)
Requires one or more features if not present in theme.
in
View at line 42
setPackageHandle($pkgHandle)
No description
in
View at line 47
getThemeDirectory()
No description
in
View at line 51
getViewPath()
No description
in
View at line 59
mixed
getThemeObject()
No description
in
View at line 70
string
getThemePath()
gets the relative theme path for use in templates.
in
View at line 74
getThemeHandle()
No description
in
View at line 79
setInnerContentFile($innerContentFile)
No description
in
View at line 87
mixed
getInnerContentFile()
No description
in
View at line 92
setViewRootDirectoryName($directory)
No description
in
View at line 97
inc($file, $args = [])
No description
bool
isEditingDisabled()
Checks to see if page editing has been manually disabled through code. This does things like hide the toolbar etc.
..
in
View at line 156
setViewTheme($theme)
No description
in
View at line 170
getViewTemplateFile()
No description
in
View at line 190
protected
loadViewThemeObject()
Load all the theme-related variables for which theme to use for this request. May update the themeHandle property on the view based on themeByRoute settings.
in
View at line 312
protected string
renderInnerContents($scopeItems)
Render the file set to $this->innerContentFile
in
View at line 330
protected string
renderTemplate($scopeItems, $innerContent)
Render the file set to $this->template
in
View at line 361
markHeaderAssetPosition()
Function responsible for outputting header items.
in
View at line 369
markFooterAssetPosition()
Function responsible for outputting footer items.
in
View at line 374
protected
getAssetsToOutput()
No description
in
View at line 394
protected
postProcessAssets($assets)
No description
in
View at line 451
protected
replaceEmptyAssetPlaceholders($pageContent)
No description
in
View at line 460
protected
replaceAssetPlaceholders($outputAssets, $pageContent)
No description
in
View at line 479
protected
outputAssetIntoView($item)
No description
getThemeStyles()
No description
in
View at line 504
static
element($_file, $args = null, $_pkgHandle = null)
No description
getPageTemplate()
No description
renderSinglePageByFilename($cFilename, $pkgHandle = null)
No description
getCollectionObject()
deprecated
deprecated
No description
getPageObject()
No description
section($url)
No description
setCustomPageTheme(PageTheme $pt)
No description
void
setCustomPreviewRequest(PreviewRequestInterface $customPreviewRequest)
No description
string
getStyleSheet($stylesheet)
deprecated
deprecated
No description