View
class View extends AbstractView (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 | ||
| protected | $innerContentFile | ||
| protected | $themeHandle | ||
| protected | $themeObject | ||
| protected | $themeRelativePath | ||
| protected | $themeAbsolutePath | ||
| protected | $viewPkgHandle | ||
| protected | $themePkgHandle | ||
| protected | $viewRootDirectoryName |
Methods
Begin the render.
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
No description
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.
No description
No description
No description
No description
gets the relative theme path for use in templates.
No description
No description
No description
No description
No description
No description
No description
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.
Render the file set to $this->innerContentFile
Render the file set to $this->template
Function responsible for outputting header items.
Function responsible for outputting footer items.
No description
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
start($state)
Begin the render.
startRender()
No description
protected
constructView($path = false)
No description
setupRender()
No description
finishRender($contents)
No description
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.
protected
onBeforeGetContents()
No description
postProcessViewContents($contents)
No description
protected
onAfterGetContents()
No description
getScopeItems()
No description
render($state = false)
No description
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.
setPackageHandle($pkgHandle)
No description
getThemeDirectory()
No description
getViewPath()
No description
mixed
getThemeObject()
No description
string
getThemePath()
gets the relative theme path for use in templates.
getThemeHandle()
No description
setInnerContentFile($innerContentFile)
No description
mixed
getInnerContentFile()
No description
setViewRootDirectoryName($directory)
No description
inc($file, $args = [])
No description
bool
isEditingDisabled()
setViewTheme($theme)
No description
getViewTemplateFile()
No description
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.
protected string
renderInnerContents($scopeItems)
Render the file set to $this->innerContentFile
protected string
renderTemplate($scopeItems, $innerContent)
Render the file set to $this->template
markHeaderAssetPosition()
Function responsible for outputting header items.
markFooterAssetPosition()
Function responsible for outputting footer items.
protected
getAssetsToOutput()
No description
protected
postProcessAssets($assets)
No description
protected
replaceEmptyAssetPlaceholders($pageContent)
No description
protected
replaceAssetPlaceholders($outputAssets, $pageContent)
No description
protected
outputAssetIntoView($item)
No description
getThemeStyles()
No description
static
element($_file, $args = null, $_pkgHandle = null)
No description