====== Session Handlers ======

// This page refers to VuFind 2.x and newer; for 1.x session support, see [[legacy:vufind_1.x_developer_manual:creating_a_session_handler|Creating a Session Handler]]. //

VuFind currently has the capability of supporting sessions stored on disk, in a database or in MemCache. You can also create your own handlers.

===== Key Plugin Details =====

**Default Namespace:** \VuFind\Session

**Base Class:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Session/AbstractBase.php|\VuFind\Session\AbstractBase]]

**Interface:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Session/HandlerInterface.php|\VuFind\Session\HandlerInterface]] (//introduced in VuFind 5.0//)

**Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['session']

**Service Manager Name for Service Locator:** VuFind\SessionPluginManager (VuFind 2.x-4.x), VuFind\Session\PluginManager (VuFind 5.0+)

See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind plugins.

===== Notes =====

  * Although you could implement the \Laminas\Session\SaveHandler\SaveHandlerInterface instead of extending \VuFind\Session\AbstractBase, it is recommended that you extend the base class since it includes some standard cleanup functionality that all handlers should use.
  * For more details on sessions, see the [[http://php.net/manual/en/function.session-set-save-handler.php|PHP Documentation]].