Back to LayoutHelper class

Method render

public static string
render
(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
Class: LayoutHelper
Project: Joomla

Method render - Source code

/**
 * Method to render the layout.
 *
 * @param   string  $layoutFile   Dot separated path to the layout file, relative to base path
 * @param   mixed   $displayData  Object which properties are used inside the layout file to build displayed output
 * @param   string  $basePath     Base path to use when loading layout files
 * @param   mixed   $options      Optional custom options to load. Registry or array format
 *
 * @return  string
 *
 * @since   3.1
 */
public static function render($layoutFile, $displayData = null, $basePath = '', $options = null)
{
    $basePath = empty($basePath) ? self::$defaultBasePath : $basePath;
    // Make sure we send null to FileLayout if no path set
    $basePath = empty($basePath) ? null : $basePath;
    $layout = new FileLayout($layoutFile, $basePath, $options);
    return $layout->render($displayData);
}