Overview

Namespaces

  • Composer
    • Autoload
  • Guzzle
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Mock
    • Stream
  • Mockery
    • Adapter
      • Phpunit
    • CountValidator
    • Exception
    • Generator
      • StringManipulation
        • Pass
    • Loader
    • Matcher
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • Fatzebra
      • Message
  • PHP
  • Symfony
    • Component
      • EventDispatcher
        • Debug
        • DependencyInjection
        • Tests
          • Debug
          • DependencyInjection
      • HttpFoundation
        • File
          • Exception
          • MimeType
        • Session
          • Attribute
          • Flash
          • Storage
            • Handler
            • Proxy
        • Tests
          • File
            • MimeType
          • Session
            • Attribute
            • Flash
            • Storage
              • Handler
              • Proxy
      • Yaml
        • Exception
        • Tests

Classes

  • MemcachedSessionHandler
  • MemcacheSessionHandler
  • MongoDbSessionHandler
  • NativeFileSessionHandler
  • NativeSessionHandler
  • NullSessionHandler
  • PdoSessionHandler
  • WriteCheckSessionHandler
  • Overview
  • Namespace
  • Class
  • Tree

Class MemcachedSessionHandler

MemcachedSessionHandler.

Memcached based session storage handler based on the Memcached class provided by the PHP memcached extension.

Symfony\Component\HttpFoundation\Session\Storage\Handler\MemcachedSessionHandler implements SessionHandlerInterface
Namespace: Symfony\Component\HttpFoundation\Session\Storage\Handler
Author: Drak drak@zikula.org
See: http://php.net/memcached
Located at Session/Storage/Handler/MemcachedSessionHandler.php
Methods summary
public
# __construct( Memcached $memcached, array $options = array() )

Constructor.

Constructor.

List of available options: * prefix: The prefix to use for the memcached keys in order to avoid collision * expiretime: The time to live in seconds

Parameters

$memcached
A \Memcached instance
$options
An associative array of Memcached options

Throws

InvalidArgumentException
When unsupported options are passed
public boolean
# open( string $savePath, string $sessionName )

Re-initializes existing session, or creates a new one.

Re-initializes existing session, or creates a new one.

Parameters

$savePath
Save path
$sessionName
Session name, see http://php.net/function.session-name.php

Returns

boolean
true on success, false on failure

Implementation of

SessionHandlerInterface::open()
public boolean
# close( )

Closes the current session.

Closes the current session.

Returns

boolean
true on success, false on failure

Implementation of

SessionHandlerInterface::close()
public string
# read( string $sessionId )

Reads the session data.

Reads the session data.

Parameters

$sessionId
Session ID, see http://php.net/function.session-id

Returns

string
Same session data as passed in write() or empty string when non-existent or on failure

Implementation of

SessionHandlerInterface::read()
public boolean
# write( string $sessionId, string $data )

Writes the session data to the storage.

Writes the session data to the storage.

Parameters

$sessionId
Session ID , see http://php.net/function.session-id
$data
Serialized session data to save

Returns

boolean
true on success, false on failure

Implementation of

SessionHandlerInterface::write()
public boolean
# destroy( string $sessionId )

Destroys a session.

Destroys a session.

Parameters

$sessionId
Session ID, see http://php.net/function.session-id

Returns

boolean
true on success, false on failure

Implementation of

SessionHandlerInterface::destroy()
public boolean
# gc( string|integer $maxlifetime )

Cleans up expired sessions (garbage collection).

Cleans up expired sessions (garbage collection).

Parameters

$maxlifetime
Sessions that have not updated for the last maxlifetime seconds will be removed

Returns

boolean
true on success, false on failure

Implementation of

SessionHandlerInterface::gc()
protected Memcached
# getMemcached( )

Return a Memcached instance

Return a Memcached instance

Returns

Memcached
Omnipay Fat Zebra / Paystream Gateway Module API Documentation API documentation generated by ApiGen