Class ViewBuilder
Provides an API for iteratively building a view up.
Once you have configured the view and established all the context
you can create a view instance with build().
Property Summary
-
$_autoLayout protected
bool|nullWhether or not autoLayout should be enabled.
-
$_className protected
string|nullThe view class name to use. Can either use plugin notation, a short name or a fully namespaced classname.
-
$_helpers protected
arrayThe helpers to use
-
$_layout protected
string|null|falseThe layout name to render.
-
$_layoutPath protected
string|nullThe layout path to build the view with.
-
$_name protected
string|nullThe view variables to use
-
$_options protected
arrayAdditional options used when constructing the view.
-
$_plugin protected
string|null|falseThe plugin name to use.
-
$_template protected
string|nullThe template file to render.
-
$_templatePath protected
string|nullThe subdirectory to the template.
-
$_theme protected
string|null|falseThe theme name to use.
Method Summary
-
autoLayout() public deprecated
Turns on or off CakePHP's conventional mode of applying layout files. On by default. Setting to off means that layouts will not be automatically applied to rendered views.
-
build() public
Using the data in the builder, create a view instance.
-
className() public deprecated
Get/set the view classname.
-
createFromArray() public
Configures a view builder instance from serialized config.
-
enableAutoLayout() public
Turns on or off CakePHP's conventional mode of applying layout files. On by default. Setting to off means that layouts will not be automatically applied to rendered views.
-
getClassName() public
Gets the view classname.
-
getHelpers() public
Gets the helpers to use.
-
getLayout() public
Gets the name of the layout file to render the view inside of.
-
getLayoutPath() public
Gets path for layout files.
-
getName() public
Gets the view name.
-
getOptions() public
Gets additional options for the view.
-
getPlugin() public
Gets the plugin name to use.
-
getTemplate() public
Gets the name of the view file to render. The name specified is the filename in /src/Template/
without the .ctp extension. -
getTemplatePath() public
Gets path for template files.
-
getTheme() public
Gets the view theme to use.
-
helpers() public deprecated
The helpers to use
-
isAutoLayoutEnabled() public
Returns if CakePHP's conventional mode of applying layout files is enabled. Disabled means that layouts will not be automatically applied to rendered views.
-
jsonSerialize() public
Serializes the view builder object to a value that can be natively serialized and re-used to clone this builder instance.
-
layout() public deprecated
Get/set the name of the layout file to render the view inside of. The name specified is the filename of the layout in /src/Template/Layout without the .ctp extension.
-
layoutPath() public deprecated
Get/set path for layout files.
-
name() public deprecated
Get/set the view name
-
options() public deprecated
Set additional options for the view.
-
plugin() public deprecated
The plugin name to use
-
serialize() public
Serializes the view builder object.
-
setClassName() public
Sets the view classname.
-
setHelpers() public
Sets the helpers to use.
-
setLayout() public
Sets the name of the layout file to render the view inside of. The name specified is the filename of the layout in /src/Template/Layout without the .ctp extension.
-
setLayoutPath() public
Sets path for layout files.
-
setName() public
Sets the view name.
-
setOptions() public
Sets additional options for the view.
-
setPlugin() public
Sets the plugin name to use.
-
setTemplate() public
Sets the name of the view file to render. The name specified is the filename in /src/Template/
without the .ctp extension. -
setTemplatePath() public
Sets path for template files.
-
setTheme() public
Sets the view theme to use.
-
template() public deprecated
Get/set the name of the view file to render. The name specified is the filename in /src/Template/
without the .ctp extension. -
templatePath() public deprecated
Get/set path for template files.
-
theme() public deprecated
The view theme to use.
-
unserialize() public
Unserializes the view builder object.
Method Detail
autoLayout() ¶ public
autoLayout(bool|null $enable = null): bool|$thisTurns on or off CakePHP's conventional mode of applying layout files. On by default. Setting to off means that layouts will not be automatically applied to rendered views.
Parameters
-
bool|null$enable optional Boolean to turn on/off. If null returns current value.
Returns
bool|$thisbuild() ¶ public
build(array $vars = [], Cake\Http\ServerRequest|null $request = null, Cake\Http\Response|null $response = null, Cake\Event\EventManager|null $events = null): Cake\View\ViewUsing the data in the builder, create a view instance.
If className() is null, App\View\AppView will be used. If that class does not exist, then Cake\View\View will be used.
Parameters
-
array$vars optional The view variables/context to use.
-
Cake\Http\ServerRequest|null$request optional The request to use.
-
Cake\Http\Response|null$response optional The response to use.
-
Cake\Event\EventManager|null$events optional The event manager to use.
Returns
Cake\View\ViewThrows
Cake\View\Exception\MissingViewExceptionclassName() ¶ public
className(string|null $name = null): string|$thisGet/set the view classname.
Accepts either a short name (Ajax) a plugin name (MyPlugin.Ajax) or a fully namespaced name (App\View\AppView).
Parameters
-
string|null$name optional The class name for the view. Can be a plugin.class name reference, a short alias, or a fully namespaced name.
Returns
string|$thiscreateFromArray() ¶ public
createFromArray(array $config): $thisConfigures a view builder instance from serialized config.
Parameters
-
array$config View builder configuration array.
Returns
$thisenableAutoLayout() ¶ public
enableAutoLayout(bool $enable = true): $thisTurns on or off CakePHP's conventional mode of applying layout files. On by default. Setting to off means that layouts will not be automatically applied to rendered views.
Parameters
-
bool$enable optional Boolean to turn on/off.
Returns
$thisgetLayout() ¶ public
getLayout(): stringGets the name of the layout file to render the view inside of.
Returns
stringgetPlugin() ¶ public
getPlugin(): string|null|falseGets the plugin name to use.
Returns
string|null|falsegetTemplate() ¶ public
getTemplate(): stringGets the name of the view file to render. The name specified is the
filename in /src/Template/
Returns
stringgetTheme() ¶ public
getTheme(): string|null|falseGets the view theme to use.
Returns
string|null|falsehelpers() ¶ public
helpers(array|null $helpers = null, bool $merge = true): array|$thisThe helpers to use
Parameters
-
array|null$helpers optional Helpers to use.
-
bool$merge optional Whether or not to merge existing data with the new data.
Returns
array|$thisisAutoLayoutEnabled() ¶ public
isAutoLayoutEnabled(): bool|nullReturns if CakePHP's conventional mode of applying layout files is enabled. Disabled means that layouts will not be automatically applied to rendered views.
Returns
bool|nulljsonSerialize() ¶ public
jsonSerialize(): arraySerializes the view builder object to a value that can be natively serialized and re-used to clone this builder instance.
Returns
arraylayout() ¶ public
layout(string|null $name = null): string|$thisGet/set the name of the layout file to render the view inside of. The name specified is the filename of the layout in /src/Template/Layout without the .ctp extension.
Parameters
-
string|null$name optional Layout file name to set. If null returns current name.
Returns
string|$thislayoutPath() ¶ public
layoutPath(string|null $path = null): string|$thisGet/set path for layout files.
Parameters
-
string|null$path optional Path for layout files. If null returns current path.
Returns
string|$thisname() ¶ public
name(string|null $name = null): string|$thisGet/set the view name
Parameters
-
string|null$name optional The name of the view
Returns
string|$thisoptions() ¶ public
options(array|null $options = null, bool $merge = true): array|$thisSet additional options for the view.
This lets you provide custom constructor arguments to application/plugin view classes.
Parameters
-
array|null$options optional Either an array of options or null to get current options.
-
bool$merge optional Whether or not to merge existing data with the new data.
Returns
array|$thisplugin() ¶ public
plugin(string|null|false $name = null): string|false|null|$thisThe plugin name to use
Parameters
-
string|null|false$name optional Plugin name. If null returns current plugin. Use false to remove the current plugin name.
Returns
string|false|null|$thissetClassName() ¶ public
setClassName(string $name): $thisSets the view classname.
Accepts either a short name (Ajax) a plugin name (MyPlugin.Ajax) or a fully namespaced name (App\View\AppView).
Parameters
-
string$name The class name for the view.
Returns
$thissetHelpers() ¶ public
setHelpers(array $helpers, bool $merge = true): $thisSets the helpers to use.
Parameters
-
array$helpers Helpers to use.
-
bool$merge optional Whether or not to merge existing data with the new data.
Returns
$thissetLayout() ¶ public
setLayout(string $name): $thisSets the name of the layout file to render the view inside of. The name specified is the filename of the layout in /src/Template/Layout without the .ctp extension.
Parameters
-
string$name Layout file name to set.
Returns
$thissetLayoutPath() ¶ public
setLayoutPath(string $path): $thisSets path for layout files.
Parameters
-
string$path Path for layout files.
Returns
$thissetName() ¶ public
setName(string $name): $thisSets the view name.
Parameters
-
string$name The name of the view.
Returns
$thissetOptions() ¶ public
setOptions(array $options, bool $merge = true): $thisSets additional options for the view.
This lets you provide custom constructor arguments to application/plugin view classes.
Parameters
-
array$options An array of options.
-
bool$merge optional Whether or not to merge existing data with the new data.
Returns
$thissetPlugin() ¶ public
setPlugin(string|null|false $name): $thisSets the plugin name to use.
False to remove current plugin name is deprecated as of 3.4.0. Use directly null instead.
Parameters
-
string|null|false$name Plugin name. Use null or false to remove the current plugin name.
Returns
$thissetTemplate() ¶ public
setTemplate(string $name): $thisSets the name of the view file to render. The name specified is the
filename in /src/Template/
Parameters
-
string$name View file name to set.
Returns
$thissetTemplatePath() ¶ public
setTemplatePath(string $path): $thisSets path for template files.
Parameters
-
string$path Path for view files.
Returns
$thissetTheme() ¶ public
setTheme(string|null|false $theme): $thisSets the view theme to use.
False to remove current theme is deprecated as of 3.4.0. Use directly null instead.
Parameters
-
string|null|false$theme Theme name. Use null or false to remove the current theme.
Returns
$thistemplate() ¶ public
template(string|null $name = null): string|$thisGet/set the name of the view file to render. The name specified is the
filename in /src/Template/
Parameters
-
string|null$name optional View file name to set. If null returns current name.
Returns
string|$thistemplatePath() ¶ public
templatePath(string|null $path = null): string|$thisGet/set path for template files.
Parameters
-
string|null$path optional Path for view files. If null returns current path.
Returns
string|$thistheme() ¶ public
theme(string|null|false $theme = null): string|false|null|$thisThe view theme to use.
Parameters
-
string|null|false$theme optional Theme name. If null returns current theme. Use false to remove the current theme.
Returns
string|false|null|$thisunserialize() ¶ public
unserialize(string $data): $thisUnserializes the view builder object.
Parameters
-
string$data Serialized string.
Returns
$thisProperty Detail
$_className ¶ protected
The view class name to use. Can either use plugin notation, a short name or a fully namespaced classname.
Type
string|null$_options ¶ protected
Additional options used when constructing the view.
This options array lets you provide custom constructor arguments to application/plugin view classes.
Type
array