Source for file layout.php

Documentation is available at layout.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.  * Interface to handle display layout
  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.0
  19.  */
  20. interface JLayout
  21. {
  22.     /**
  23.      * Method to escape output.
  24.      *
  25.      * @param   string  $output  The output to escape.
  26.      *
  27.      * @return  string  The escaped output.
  28.      *
  29.      * @since   3.0
  30.      */
  31.     public function escape($output);
  32.  
  33.     /**
  34.      * Method to render the layout.
  35.      *
  36.      * @param   object  $displayData  Object which properties are used inside the layout file to build displayed output
  37.      *
  38.      * @return  string  The rendered layout.
  39.      *
  40.      * @since   3.0
  41.      */
  42.     public function render($displayData);
  43. }

Documentation generated on Tue, 19 Nov 2013 15:06:43 +0100 by phpDocumentor 1.4.3