[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  /**
  12   * Class defining the various states of a session
  13   *
  14   * @since  2.0.0
  15   */
  16  final class SessionState
  17  {
  18      /**
  19       * Private constructor to prevent instantiation of this class
  20       *
  21       * @since   2.0.0
  22       */
  23  	private function __construct()
  24      {
  25      }
  26  
  27      /**
  28       * State indicating the session is active.
  29       *
  30       * A `SessionInterface` instance should be in this state once the session has started.
  31       *
  32       * @var    string
  33       * @since  2.0.0
  34       */
  35      public const ACTIVE = 'active';
  36  
  37      /**
  38       * State indicating the session is closed.
  39       *
  40       * A `SessionInterface` instance should be in this state after calling the `close()` method.
  41       *
  42       * @var    string
  43       * @since  2.0.0
  44       */
  45      public const CLOSED = 'closed';
  46  
  47      /**
  48       * State indicating the session is destroyed.
  49       *
  50       * A `SessionInterface` instance should be in this state after calling the `destroy()` method.
  51       *
  52       * @var    string
  53       * @since  2.0.0
  54       */
  55      public const DESTROYED = 'destroyed';
  56  
  57      /**
  58       * State indicating the session is in an error state.
  59       *
  60       * A `SessionInterface` instance should be in this state if the session cannot be validated after being started.
  61       *
  62       * @var    string
  63       * @since  2.0.0
  64       */
  65      public const ERROR = 'error';
  66  
  67      /**
  68       * State indicating the session is expired.
  69       *
  70       * A `SessionInterface` instance should be in this state if the session has passed the allowed lifetime.
  71       * A `SessionInterface` instance may be in this state if validating a session token fails.
  72       *
  73       * @var    string
  74       * @since  2.0.0
  75       */
  76      public const EXPIRED = 'expired';
  77  
  78      /**
  79       * State indicating the session is inactive.
  80       *
  81       * A `SessionInterface` instance should begin in this state.
  82       *
  83       * @var    string
  84       * @since  2.0.0
  85       */
  86      public const INACTIVE = 'inactive';
  87  }