[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2014 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\Component\Router;
  11  
  12  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('JPATH_PLATFORM') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * Component routing interface
  18   *
  19   * @since  3.3
  20   */
  21  interface RouterInterface
  22  {
  23      /**
  24       * Prepare-method for URLs
  25       * This method is meant to validate and complete the URL parameters.
  26       * For example it can add the Itemid or set a language parameter.
  27       * This method is executed on each URL, regardless of SEF mode switched
  28       * on or not.
  29       *
  30       * @param   array  $query  An associative array of URL arguments
  31       *
  32       * @return  array  The URL arguments to use to assemble the subsequent URL.
  33       *
  34       * @since   3.3
  35       */
  36      public function preprocess($query);
  37  
  38      /**
  39       * Build method for URLs
  40       * This method is meant to transform the query parameters into a more human
  41       * readable form. It is only executed when SEF mode is switched on.
  42       *
  43       * @param   array  &$query  An array of URL arguments
  44       *
  45       * @return  array  The URL arguments to use to assemble the subsequent URL.
  46       *
  47       * @since   3.3
  48       */
  49      public function build(&$query);
  50  
  51      /**
  52       * Parse method for URLs
  53       * This method is meant to transform the human readable URL back into
  54       * query parameters. It is only executed when SEF mode is switched on.
  55       *
  56       * @param   array  &$segments  The segments of the URL to parse.
  57       *
  58       * @return  array  The URL attributes to be used by the application.
  59       *
  60       * @since   3.3
  61       */
  62      public function parse(&$segments);
  63  }