[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Part of the Joomla Framework Session 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\Session;
  10  
  11  use Joomla\Event\Event;
  12  
  13  /**
  14   * Class representing a Session event
  15   *
  16   * @since  2.0.0
  17   */
  18  class SessionEvent extends Event
  19  {
  20      /**
  21       * SessionInterface object for this event
  22       *
  23       * @var    SessionInterface
  24       * @since  2.0.0
  25       */
  26      private $session;
  27  
  28      /**
  29       * Constructor.
  30       *
  31       * @param   string            $name     The event name.
  32       * @param   SessionInterface  $session  The SessionInterface object for this event.
  33       *
  34       * @since   2.0.0
  35       */
  36  	public function __construct(string $name, SessionInterface $session)
  37      {
  38          parent::__construct($name);
  39  
  40          $this->session = $session;
  41      }
  42  
  43      /**
  44       * Retrieve the SessionInterface object attached to this event.
  45       *
  46       * @return  SessionInterface
  47       *
  48       * @since   2.0.0
  49       */
  50  	public function getSession(): SessionInterface
  51      {
  52          return $this->session;
  53      }
  54  }