[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Part of the Joomla Framework Router Package
   4   *
   5   * @copyright  Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
   6   * @license    GNU General Public License version 2 or later; see LICENSE
   7   */
   8  
   9  namespace Joomla\Router;
  10  
  11  /**
  12   * An object representing a resolved route.
  13   *
  14   * @since  2.0.0
  15   */
  16  class ResolvedRoute
  17  {
  18      /**
  19       * The controller which handles this route
  20       *
  21       * @var    mixed
  22       * @since  2.0.0
  23       */
  24      private $controller;
  25  
  26      /**
  27       * The variables matched by the route
  28       *
  29       * @var    array
  30       * @since  2.0.0
  31       */
  32      private $routeVariables;
  33  
  34      /**
  35       * The URI for this route
  36       *
  37       * @var    string
  38       * @since  2.0.0
  39       */
  40      private $uri;
  41  
  42      /**
  43       * Constructor.
  44       *
  45       * @param   mixed   $controller      The controller which handles this route
  46       * @param   array   $routeVariables  The variables matched by the route
  47       * @param   string  $uri             The URI for this route
  48       *
  49       * @since   2.0.0
  50       */
  51  	public function __construct($controller, array $routeVariables, string $uri)
  52      {
  53          $this->controller     = $controller;
  54          $this->routeVariables = $routeVariables;
  55          $this->uri            = $uri;
  56      }
  57  
  58      /**
  59       * Retrieve the controller which handles this route
  60       *
  61       * @return  mixed
  62       *
  63       * @since   2.0.0
  64       */
  65  	public function getController()
  66      {
  67          return $this->controller;
  68      }
  69  
  70      /**
  71       * Retrieve the variables matched by the route
  72       *
  73       * @return  array
  74       *
  75       * @since   2.0.0
  76       */
  77  	public function getRouteVariables(): array
  78      {
  79          return $this->routeVariables;
  80      }
  81  
  82      /**
  83       * Retrieve the URI for this route
  84       *
  85       * @return  string
  86       *
  87       * @since   2.0.0
  88       */
  89  	public function getUri(): string
  90      {
  91          return $this->uri;
  92      }
  93  }