[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2012 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\Layout;
  11  
  12  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('JPATH_PLATFORM') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * Interface to handle display layout
  18   *
  19   * @link   https://docs.joomla.org/Special:MyLanguage/Sharing_layouts_across_views_or_extensions_with_JLayout
  20   * @since  3.0
  21   */
  22  interface LayoutInterface
  23  {
  24      /**
  25       * Method to escape output.
  26       *
  27       * @param   string  $output  The output to escape.
  28       *
  29       * @return  string  The escaped output.
  30       *
  31       * @since   3.0
  32       */
  33      public function escape($output);
  34  
  35      /**
  36       * Method to render the layout.
  37       *
  38       * @param   array  $displayData  Array of properties available for use inside the layout file to build the displayed output
  39       *
  40       * @return  string  The rendered layout.
  41       *
  42       * @since   3.0
  43       */
  44      public function render($displayData);
  45  }