[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\Rules;
  11  
  12  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('JPATH_PLATFORM') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * RouterRules interface for Joomla
  18   *
  19   * @since  3.4
  20   */
  21  interface RulesInterface
  22  {
  23      /**
  24       * Prepares a query set to be handed over to the build() method.
  25       * This should complete a partial query set to work as a complete non-SEFed
  26       * URL and in general make sure that all information is present and properly
  27       * formatted. For example, the Itemid should be retrieved and set here.
  28       *
  29       * @param   array  &$query  The query array to process
  30       *
  31       * @return  void
  32       *
  33       * @since   3.4
  34       */
  35      public function preprocess(&$query);
  36  
  37      /**
  38       * Parses a URI to retrieve information for the right route through the component.
  39       * This method should retrieve all its input from its method arguments.
  40       *
  41       * @param   array  &$segments  The URL segments to parse
  42       * @param   array  &$vars      The vars that result from the segments
  43       *
  44       * @return  void
  45       *
  46       * @since   3.4
  47       */
  48      public function parse(&$segments, &$vars);
  49  
  50      /**
  51       * Builds URI segments from a query to encode the necessary information for a route in a human-readable URL.
  52       * This method should retrieve all its input from its method arguments.
  53       *
  54       * @param   array  &$query     The vars that should be converted
  55       * @param   array  &$segments  The URL segments to create
  56       *
  57       * @return  void
  58       *
  59       * @since   3.4
  60       */
  61      public function build(&$query, &$segments);
  62  }