Alpha Framework 3.0.0 API Documentation
  • Namespace
  • Class

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
      • Service
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • SessionProviderArray
  • SessionProviderPHP

Interfaces

  • SessionProviderInterface

Class SessionProviderArray

Provides a session handle that stores session data in an array, useful for testing only.

Alpha\Util\Http\Session\SessionProviderArray implements Alpha\Util\Http\Session\SessionProviderInterface
Namespace: Alpha\Util\Http\Session
Copyright:

Copyright (c) 2018, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 2.0
Located at Util/Http/Session/SessionProviderArray.php

Methods summary

public
# __construct( )

Constructor.

Constructor.

Since

2.0
public
# init( )

Starts a new session, or resumes an existing session if there is already a session ID available.

Starts a new session, or resumes an existing session if there is already a session ID available.

Implementation of

Alpha\Util\Http\Session\SessionProviderInterface::init()
public
# destroy( )

Destroys the current session.

Destroys the current session.

Implementation of

Alpha\Util\Http\Session\SessionProviderInterface::destroy()
public mixed
# get( string $key )

Get the key value from the session. Returns false if nothing is found.

Get the key value from the session. Returns false if nothing is found.

Parameters

$key

Returns

mixed

Implementation of

Alpha\Util\Http\Session\SessionProviderInterface::get()
public
# set( string $key, mixed $value )

Stores the value provided at that key in the session.

Stores the value provided at that key in the session.

Parameters

$key
$value

Implementation of

Alpha\Util\Http\Session\SessionProviderInterface::set()
public
# delete( string $key )

Deletes the value provided at that key in the session.

Deletes the value provided at that key in the session.

Parameters

$key

Implementation of

Alpha\Util\Http\Session\SessionProviderInterface::delete()
public string
# getID( )

Get the current session ID if available.

Get the current session ID if available.

Returns

string

Implementation of

Alpha\Util\Http\Session\SessionProviderInterface::getID()

Properties summary

public static array $sessionArray

The hash array containing the session items.

The hash array containing the session items.

Since

2.0
# array()
Alpha Framework 3.0.0 API Documentation API documentation generated by ApiGen