Package Home

Zend Framework 2 Documentation (Manual)

PHK Home

File: /modules/zend.session.config.session-config.html

Size:13657
Storage flags:no_autoload,compress/gzip (27%)

Session Config — Zend Framework 2 2.4.2 documentation

Session Config

Zend\Session\Config\SessionConfig provides you a basic interface for implementing sessions when that leverage PHP’s ext/session. Most configuration options configure either the Zend\Session\Storage OR configure ext/session directly.

Basic Configuration Options

The following configuration options are defined by Zend\Session\Config\SessionConfig, note that it inherits all configuration from Zend\Session\Config\StandardConfig.

Option Data Type Description
cache_limiter string Specifies the cache control method used for session pages.
hash_function string Allows you to specify the hash algorithm used to generate the session IDs.
php_save_handler string Defines the name of a PHP save_handler embedded into PHP.
serialize_handler string Defines the name of the handler which is used to serialize/deserialize data.
url_rewriter_tags string Specifies which HTML tags are rewritten to include session id if transparent sid enabled.
use_trans_sid boolean Whether transparent sid support is enabled or not.

Basic Usage

A basic example is one like the following:

1
2
3
4
5
6
7
8
9
use Zend\Session\Config\SessionConfig;
use Zend\Session\SessionManager;

$config = new SessionConfig();
$config->setOptions(array(
    'phpSaveHandler' => 'redis',
    'savePath' => 'tcp://127.0.0.1:6379?weight=1&timeout=1',
));
$manager = new SessionManager($config);

Service Manager Factory

Zend\Session ships with a Service Manager factory which reads configuration data from the application configuration and injects a corresponding instance of Zend\Session\Config\SessionConfig into the session manager automatically.

To use this factory, you first need to register it with the Service Manager by adding the appropriate factory definition:

1
2
3
4
5
'service_manager' => array(
    'factories' => array(
        'Zend\Session\Config\ConfigInterface' => 'Zend\Session\Service\SessionConfigFactory',
    ),
),

Then place your application’s session configuration in the root-level configuration key session_config:

1
2
3
4
'session_config' => array(
    'phpSaveHandler' => 'redis',
    'savePath' => 'tcp://127.0.0.1:6379?weight=1&timeout=1',
),

Any of the configuration options defined in zend.session.config.session-config.options can be used there, as well as the following factory-specific configuration options:

Table Of Contents

This Page

Note: You need to stay logged into your GitHub account to contribute to the documentation.

Edit this document

Edit this document

The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.

  1. Login with your GitHub account.
  2. Go to Session Config on GitHub.
  3. Edit file contents using GitHub's text editor in your web browser
  4. Fill in the Commit message text box at the end of the page telling why you did the changes. Press Propose file change button next to it when done.
  5. On Send a pull request page you don't need to fill in text anymore. Just press Send pull request button.
  6. Your changes are now queued for review under project's Pull requests tab on GitHub.

For more information about the PHK package format: http://phk.tekwire.net