[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Part of the Joomla Framework Application 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\Application;
  10  
  11  use Joomla\Session\SessionInterface;
  12  
  13  /**
  14   * Application sub-interface defining a web application class which supports sessions
  15   *
  16   * @since  2.0.0
  17   */
  18  interface SessionAwareWebApplicationInterface extends WebApplicationInterface
  19  {
  20      /**
  21       * Method to get the application session object.
  22       *
  23       * @return  SessionInterface  The session object
  24       *
  25       * @since   2.0.0
  26       */
  27  	public function getSession();
  28  
  29      /**
  30       * Sets the session for the application to use, if required.
  31       *
  32       * @param   SessionInterface  $session  A session object.
  33       *
  34       * @return  $this
  35       *
  36       * @since   2.0.0
  37       */
  38  	public function setSession(SessionInterface $session);
  39  
  40      /**
  41       * Checks for a form token in the request.
  42       *
  43       * @param   string  $method  The request method in which to look for the token key.
  44       *
  45       * @return  boolean
  46       *
  47       * @since   2.0.0
  48       */
  49  	public function checkToken($method = 'post');
  50  
  51      /**
  52       * Method to determine a hash for anti-spoofing variable names
  53       *
  54       * @param   boolean  $forceNew  If true, force a new token to be created
  55       *
  56       * @return  string  Hashed var name
  57       *
  58       * @since   2.0.0
  59       */
  60  	public function getFormToken($forceNew = false);
  61  }