Source for file helper.php

Documentation is available at helper.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Layout
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('JPATH_BASE') or die;
  11.  
  12. /**
  13.  * Helper to render a JLayout object, storing a base path
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Layout
  17.  * @see         http://docs.joomla.org/Sharing_layouts_across_views_or_extensions_with_JLayout
  18.  * @since       3.1
  19.  */
  20. class JLayoutHelper
  21. {
  22.     /**
  23.      * A default base path that will be used if none is provided when calling the render method.
  24.      * Note that JLayoutFile itself will defaults to JPATH_ROOT . '/layouts' if no basePath is supplied at all
  25.      *
  26.      * @var    string 
  27.      * @since  3.1
  28.      */
  29.     public static $defaultBasePath = '';
  30.  
  31.     /**
  32.      * Method to render the layout.
  33.      *
  34.      * @param   string  $layoutFile   Dot separated path to the layout file, relative to base path
  35.      * @param   object  $displayData  Object which properties are used inside the layout file to build displayed output
  36.      * @param   string  $basePath     Base path to use when loading layout files
  37.      * @param   mixed   $options      Optional custom options to load. JRegistry or array format
  38.      *
  39.      * @return  string 
  40.      *
  41.      * @since   3.1
  42.      */
  43.     public static function render($layoutFile, $displayData = null, $basePath = '', $options = null)
  44.     {
  45.         $basePath = empty($basePath) ? self::$defaultBasePath : $basePath;
  46.  
  47.         // Make sure we send null to JLayoutFile if no path set
  48.         $basePath = empty($basePath) ? null : $basePath;
  49.         $layout = new JLayoutFile($layoutFile, $basePath, $options);
  50.         $renderedLayout = $layout->render($displayData);
  51.  
  52.         return $renderedLayout;
  53.     }
  54. }

Documentation generated on Tue, 19 Nov 2013 15:04:26 +0100 by phpDocumentor 1.4.3