interface SessionInterface in Zircon Profile 8

Interface for the session.

@author Drak <[e-mail]>

Hierarchy

• interface \Symfony\Component\HttpFoundation\Session\SessionInterface

4 files declare their use of SessionInterface

BatchStorage.php in core/lib/Drupal/Core/Batch/BatchStorage.php

Contains \Drupal\Core\Batch\BatchStorage.

Cookie.php in core/modules/user/src/Authentication/Provider/Cookie.php

Contains \Drupal\user\Authentication\Provider\Cookie.

Request.php in vendor/symfony/http-foundation/Request.php

TestSessionListenerTest.php in vendor/symfony/http-kernel/Tests/EventListener/TestSessionListenerTest.php

File

vendor/symfony/http-foundation/Session/SessionInterface.php, line 21

Namespace

Symfony\Component\HttpFoundation\Session

interface SessionInterface {

  /**
   * Starts the session storage.
   *
   * @return bool True if session started.
   *
   * @throws \RuntimeException If session fails to start.
   */
  public function start();

  /**
   * Returns the session ID.
   *
   * @return string The session ID.
   */
  public function getId();

  /**
   * Sets the session ID.
   *
   * @param string $id
   */
  public function setId($id);

  /**
   * Returns the session name.
   *
   * @return mixed The session name.
   */
  public function getName();

  /**
   * Sets the session name.
   *
   * @param string $name
   */
  public function setName($name);

  /**
   * Invalidates the current session.
   *
   * Clears all session attributes and flashes and regenerates the
   * session and deletes the old session from persistence.
   *
   * @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
   *                      will leave the system settings unchanged, 0 sets the cookie
   *                      to expire with browser session. Time is in seconds, and is
   *                      not a Unix timestamp.
   *
   * @return bool True if session invalidated, false if error.
   */
  public function invalidate($lifetime = null);

  /**
   * Migrates the current session to a new session id while maintaining all
   * session attributes.
   *
   * @param bool $destroy  Whether to delete the old session or leave it to garbage collection.
   * @param int  $lifetime Sets the cookie lifetime for the session cookie. A null value
   *                       will leave the system settings unchanged, 0 sets the cookie
   *                       to expire with browser session. Time is in seconds, and is
   *                       not a Unix timestamp.
   *
   * @return bool True if session migrated, false if error.
   */
  public function migrate($destroy = false, $lifetime = null);

  /**
   * Force the session to be saved and closed.
   *
   * This method is generally not required for real sessions as
   * the session will be automatically saved at the end of
   * code execution.
   */
  public function save();

  /**
   * Checks if an attribute is defined.
   *
   * @param string $name The attribute name
   *
   * @return bool true if the attribute is defined, false otherwise
   */
  public function has($name);

  /**
   * Returns an attribute.
   *
   * @param string $name    The attribute name
   * @param mixed  $default The default value if not found.
   *
   * @return mixed
   */
  public function get($name, $default = null);

  /**
   * Sets an attribute.
   *
   * @param string $name
   * @param mixed  $value
   */
  public function set($name, $value);

  /**
   * Returns attributes.
   *
   * @return array Attributes
   */
  public function all();

  /**
   * Sets attributes.
   *
   * @param array $attributes Attributes
   */
  public function replace(array $attributes);

  /**
   * Removes an attribute.
   *
   * @param string $name
   *
   * @return mixed The removed value or null when it does not exist
   */
  public function remove($name);

  /**
   * Clears all attributes.
   */
  public function clear();

  /**
   * Checks if the session was started.
   *
   * @return bool
   */
  public function isStarted();

  /**
   * Registers a SessionBagInterface with the session.
   *
   * @param SessionBagInterface $bag
   */
  public function registerBag(SessionBagInterface $bag);

  /**
   * Gets a bag instance by name.
   *
   * @param string $name
   *
   * @return SessionBagInterface
   */
  public function getBag($name);

  /**
   * Gets session meta.
   *
   * @return MetadataBag
   */
  public function getMetadataBag();

}

Members

Name	Modifiers	Type	Description	Overrides
SessionInterface::all	public	function	Returns attributes.	1
SessionInterface::clear	public	function	Clears all attributes.	1
SessionInterface::get	public	function	Returns an attribute.	1
SessionInterface::getBag	public	function	Gets a bag instance by name.	1
SessionInterface::getId	public	function	Returns the session ID.	1
SessionInterface::getMetadataBag	public	function	Gets session meta.	1
SessionInterface::getName	public	function	Returns the session name.	1
SessionInterface::has	public	function	Checks if an attribute is defined.	1
SessionInterface::invalidate	public	function	Invalidates the current session.	1
SessionInterface::isStarted	public	function	Checks if the session was started.	1
SessionInterface::migrate	public	function	Migrates the current session to a new session id while maintaining all session attributes.	1
SessionInterface::registerBag	public	function	Registers a SessionBagInterface with the session.	1
SessionInterface::remove	public	function	Removes an attribute.	1
SessionInterface::replace	public	function	Sets attributes.	1
SessionInterface::save	public	function	Force the session to be saved and closed.	1
SessionInterface::set	public	function	Sets an attribute.	1
SessionInterface::setId	public	function	Sets the session ID.	1
SessionInterface::setName	public	function	Sets the session name.	1
SessionInterface::start	public	function	Starts the session storage.	1