PHP Classes

File: src/Contracts/Session.php

Recommend this page to a friend!
  Classes of Thierry Feuzeu   Jaxon   src/Contracts/Session.php   Download  
File: src/Contracts/Session.php
Role: Class source
Content type: text/plain
Description: Class source
Class: Jaxon
Call PHP classes from JavaScript using AJAX
Author: By
Last change:
Date: 5 years ago
Size: 2,023 bytes
 

Contents

Class file image Download
<?php

namespace Jaxon\Contracts;

interface
Session
{
   
/**
     * Get the current session id
     *
     * @return string The session id
     */
   
public function getId();

   
/**
     * Generate a new session id
     *
     * @param bool $bDeleteData Whether to delete data from the previous session
     *
     * @return void
     */
   
public function newId($bDeleteData = false);

   
/**
     * Save data in the session
     *
     * @param string $sKey The session key
     * @param string $xValue The session value
     *
     * @return void
     */
   
public function set($sKey, $xValue);

   
/**
     * Save data in the session, that will be available only until the next call
     *
     * @param string $sKey The session key
     * @param string $xValue The session value
     *
     * @return void
     */
    // public function flash($sKey, $xValue);

    /**
     * Check if a session key exists
     *
     * @param string $sKey The session key
     *
     * @return bool True if the session key exists, else false
     */
   
public function has($sKey);

   
/**
     * Get data from the session
     *
     * @param string $sKey The session key
     * @param mixed|null $xDefault The default value
     *
     * @return mixed The data under the session key, or the $xDefault parameter
     */
   
public function get($sKey, $xDefault = null);

   
/**
     * Get all data in the session
     *
     * @return array An array of all data in the session
     */
   
public function all();

   
/**
     * Delete a session key and its data
     *
     * @param string $sKey The session key
     *
     * @return void
     */
   
public function delete($sKey);

   
/**
     * Delete all data in the session
     *
     * @return void
     */
   
public function clear();
}