Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class LayoutHelper - list of methods

Helper to render a Layout object, storing a base path
Package: Joomla\CMS\Layout
Copyright: (C) 2013 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Layout/LayoutHelper.php
Project: Joomla

Method Summary

public static string
(mixed $layoutFile, mixed $displayData = null, mixed $basePath = '', mixed $options = null)

Method to render a layout with debug info
Parameters
  • string $layoutFile Dot separated path to the layout file, relative to base path
  • mixed $displayData Object which properties are used inside the layout file to build displayed output
  • string $basePath Base path to use when loading layout files
  • mixed $options Optional custom options to load. Registry or array format
Returns
  • string
Since
  • 3.5
Show source code of this method: debug Source Code

public static string
(mixed $layoutFile, mixed $displayData = null, mixed $basePath = '', mixed $options = null)

Method to render the layout.
Parameters
  • string $layoutFile Dot separated path to the layout file, relative to base path
  • mixed $displayData Object which properties are used inside the layout file to build displayed output
  • string $basePath Base path to use when loading layout files
  • mixed $options Optional custom options to load. Registry or array format
Returns
  • string
Since
  • 3.1
Show source code of this method: render Source Code

Properties Summary

public static string
$defaultBasePath
A default base path that will be used if none is provided when calling the render method.
Since
  • 3.1

Tags Summary

Since
3.1