Class ViewBuilder

Properties summary

• $_autoLayout protected
  boolean|null
  Whether or not autoLayout should be enabled.
• $_className protected
  string|null

  The view class name to use. Can either use plugin notation, a short name or a fully namespaced classname.

• $_helpers protected
  array
  The helpers to use
• $_layout protected
  string|false|null
  The layout name to render.
• $_layoutPath protected
  string|null
  The layout path to build the view with.
• $_name protected
  string|null
  The view variables to use
• $_options protected
  array
  Additional options used when constructing the view.
• $_plugin protected
  string|false|null
  The plugin name to use.
• $_template protected
  string|null
  The template file to render.
• $_templatePath protected
  string|null
  The subdirectory to the template.
• $_theme protected
  string|false|null
  The theme name to use.
• $_vars protected
  array
  View vars

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.

• disableAutoLayout() public

  Turns off CakePHP's conventional mode of applying layout files.

• 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.

• getVar() public

  Get view var

• getVars() public

  Get all view vars.

• hasVar() public

  Check if view var is set.

• 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.

• setVar() public

  Saves a variable for use inside a template.

• setVars() public

  Saves view vars for use inside templates.

• 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

Properties detail

[]

[]

[]