From d9a96cd644b68d077a8aa27996832d29dcffdfb0 Mon Sep 17 00:00:00 2001
From: laminas-bot <laminas-bot@users.noreply.github.com>
Date: Sat, 13 Jan 2024 12:12:21 +0000
Subject: [PATCH] Automated deployment: Sat Jan 13 12:12:21 UTC 2024 1.14.1

---
 index.html               |  62 +++-
 installation/index.html  | 651 +++++++++++++++++++++++++++++++++++++++
 intro/index.html         |  87 ++++--
 middleware/index.html    | 116 +++++--
 pages/404.html           |  52 +++-
 persistence/index.html   |  69 +++--
 search/lunr.js           |  36 +--
 search/main.js           |  15 +-
 search/search_index.json |   2 +-
 search/worker.js         |   3 +
 session/index.html       |  71 +++--
 sitemap.xml              |  50 +--
 sitemap.xml.gz           | Bin 243 -> 252 bytes
 13 files changed, 1061 insertions(+), 153 deletions(-)
 create mode 100644 installation/index.html

diff --git a/index.html b/index.html
index 5dad4f3..0513258 100644
--- a/index.html
+++ b/index.html
@@ -5,7 +5,14 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="description" content="Sessions and session middleware for PSR-7 applications.">  
+    <meta name="description" content="Sessions and session middleware for PSR-7 applications."> 
+
+    
+    
+    <meta name="docsearch:version" content="latest">
+    <meta name="docsearch:language" content="en">
+    <meta name="docsearch:component" content="mezzio-session">
+
     <link rel="canonical" href="https://docs.mezzio.dev/mezzio-session/">
     <link rel="shortcut icon" href="https://docs.laminas.dev/img/trademark-laminas-foundation-rgb.svg">
 
@@ -143,6 +150,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -216,8 +237,8 @@ <h1 class="header__title">
                     <a href="#" class="header__link header__link--search" data-toggle="modal" data-target="#mkdocs_search_modal" title="Open search">
                         <i class="fa fa-search"></i> Search
                     </a>
-                    <a href="https://github.com/mezzio/mezzio-session/" class="header__link header__link--github" title="Go to repository of mezzio-session">
-                        <i class="fa fa-github"></i> GitHub
+                    <a href="https://github.com/mezzio/mezzio-session" class="header__link header__link--github" title="Go to repository of mezzio-session">
+                        <i class="fab fa-github"></i> GitHub
                     </a>
                 
             </div>
@@ -262,7 +283,7 @@ <h3>Using Composer</h3>
 <h2>Support</h2>
 <ul>
     <li>Issues: <a href="https://github.com/mezzio/mezzio-session/issues">github.com/mezzio/mezzio-session/issues</a></li>
-    <li>Source: <a href="https://github.com/mezzio/mezzio-session/">github.com/mezzio/mezzio-session/</a></li>
+    <li>Source: <a href="https://github.com/mezzio/mezzio-session">github.com/mezzio/mezzio-session</a></li>
     <li>Chat: <a href="https://laminas.dev/chat">laminas.dev/chat</a></li>
     <li>Forum: <a href="https://discourse.laminas.dev/">discourse.laminas.dev</a></li>
 </ul>
@@ -282,7 +303,9 @@ <h2>Support</h2>
         <li class="page-nav__item">
             
                 <a rel="next" class="page-nav__link page-nav__link--next" href="intro/">
-                    Next <i class="fa fa-chevron-right"></i>
+                    <small class="page-nav__label">Next</small>
+                    Introduction
+                    <i class="fa fa-chevron-right"></i>
                 </a>
             
         </li>
@@ -291,7 +314,6 @@ <h2>Support</h2>
 
 
 
-
                 
             </div>
             <div class="col-md-3 col-sm-12 sidebar">
@@ -343,6 +365,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -415,13 +451,13 @@ <h4 class="footer__headline">Support</h4>
                                 <a href="https://discourse.laminas.dev" class="support__link" title="Forum"><i class="fa fa-comments"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fa fa-slack"></i></a>
+                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fab fa-slack"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fa fa-github"></i></a>
+                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fab fa-github"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://twitter.com/getlaminas" class="support__link" title="Twitter"><i class="fa fa-twitter"></i></a>
+                                <a href="https://phpc.social/@getlaminas" class="support__link" title="Mastodon"><i class="fab fa-mastodon"></i></a>
                             </li>
                             <li class="support__list-item">
                                 <a href="https://getlaminas.org/blog/rss.xml" class="support__link" title="Blog feed"><i class="fa fa-rss"></i></a>
@@ -437,7 +473,7 @@ <h4 class="footer__headline">Support</h4>
                         <h4 class="footer__headline">License</h4>
                         <p>
                             Code licensed under <a
-                                href="https://github.com/mezzio/mezzio-session/blob/master/LICENSE.md">BSD 3-Clause</a>.
+                                href="https://github.com/mezzio/mezzio-session/blob/-/LICENSE.md">BSD 3-Clause</a>.
                         </p>
                     </div>
 
@@ -447,7 +483,7 @@ <h4 class="footer__headline">Copyright</h4>
                         <p>
                             <!--Built with love by the Laminas team with the help of our
                             <a href="https://github.com/mezzio/mezzio-session/graphs/contributors">contributors</a>.<br>-->
-                            &copy; 2021 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
+                            &copy; 2024 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
                         </p>
                     </div>
                 </div>
@@ -494,6 +530,6 @@ <h5 class="modal-title">Search</h5>
 </html>
 
 <!--
-MkDocs version : 1.1.2
-Build Date UTC : 2021-04-20 15:57:57.148865+00:00
+MkDocs version : 1.5.3
+Build Date UTC : 2024-01-13 12:12:21.347401+00:00
 -->
diff --git a/installation/index.html b/installation/index.html
new file mode 100644
index 0000000..40f8fc5
--- /dev/null
+++ b/installation/index.html
@@ -0,0 +1,651 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="Sessions and session middleware for PSR-7 applications."> 
+
+    
+    
+    <meta name="docsearch:version" content="latest">
+    <meta name="docsearch:language" content="en">
+    <meta name="docsearch:component" content="mezzio-session">
+
+    <link rel="canonical" href="https://docs.mezzio.dev/mezzio-session/installation/">
+    <link rel="shortcut icon" href="https://docs.laminas.dev/img/trademark-laminas-foundation-rgb.svg">
+
+    <title>Installation - mezzio-session - Laminas Docs</title>
+
+    <link rel="stylesheet" href="https://docs.laminas.dev/css/styles.css">
+    
+</head>
+<body id="page-top" class="mezzio" data-spy="scroll" data-target=".toc" data-offset="20">
+
+    
+    <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
+    <div class="container">
+        
+        <a class="logo-link navbar-brand" href="https://getlaminas.org/" data-tooltip data-placement="bottom" title="Go to the Laminas homepage">
+            <img src="https://docs.laminas.dev/img/laminas-foundation-white.svg" height="28" alt="Laminas">
+        </a>
+        <a class="navbar-title" href="https://docs.laminas.dev/" data-tooltip data-placement="bottom" title="Go to the Laminas Documentation">
+            Documentation
+        </a>
+
+        
+        <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+            <span class="navbar-toggler-icon"></span>
+        </button>
+
+        <div class="collapse navbar-collapse" id="navbarSupportedContent">
+
+            
+            <ul class="navbar-nav ml-auto">
+                <li class="nav-item">
+                    <div class="dropdown sub-project-selector">
+                        <a class="dropdown-toggle nav-link" data-toggle="dropdown" aria-expanded="false">
+                            All Docs
+                        </a>
+                        <div class="dropdown-menu" aria-labelledby="dropdownMenuButton">
+                            <a href="https://docs.mezzio.dev/" class="dropdown-item">
+                                <div class="row align-items-center">
+                                    <div class="col-md-4 col-sm-12">
+                                        <img src="https://docs.laminas.dev/img/laminas-mezzio-rgb.svg">
+                                    </div>
+                                    <div class="col-md-8 col-sm-12">
+                                        <strong>Mezzio</strong><br>
+                                        PSR-15 Middleware in Minutes
+                                    </div>
+                                </div>
+                            </a>
+                            <a href="https://docs.laminas.dev/components/" class="dropdown-item">
+                                <div class="row align-items-center">
+                                    <div class="col-md-4 col-sm-12">
+                                        <img src="https://docs.laminas.dev/img/laminas-components-rgb.svg">
+                                    </div>
+                                    <div class="col-md-8 col-sm-12">
+                                        <strong>Components</strong><br>
+                                        Components for Enterprise Applications
+                                    </div>
+                                </div>
+                            </a>
+                            <a href="https://docs.laminas.dev/mvc" class="dropdown-item">
+                                <div class="row align-items-center">
+                                    <div class="col-md-4 col-sm-12">
+                                        <img src="https://docs.laminas.dev/img/laminas-mvc-rgb.svg">
+                                    </div>
+                                    <div class="col-md-8 col-sm-12">
+                                        <strong>MVC</strong><br>
+                                        MVC for Enterprise Applications
+                                    </div>
+                                </div>
+                            </a>
+                            <a href="https://api-tools.getlaminas.org/documentation" class="dropdown-item">
+                                <div class="row align-items-center">
+                                    <div class="col-md-4 col-sm-12">
+                                        <img src="https://docs.laminas.dev/img/laminas-api-tools-rgb.svg">
+                                    </div>
+                                    <div class="col-md-8 col-sm-12">
+                                        <strong>API Tools</strong><br>
+                                        Build RESTful APIs in Minutes
+                                    </div>
+                                </div>
+                            </a>
+                            <div class="dropdown-divider"></div>
+                            <a class="dropdown-item dropdown-item--secondardy" href="https://docs.laminas.dev/migration/">
+                                <div class="row align-items-center">
+                                    <div class="col-md-8 offset-md-4 col-sm-12">
+                                        Migration to Laminas
+                                    </div>
+                                </div>
+                            </a>
+                            <a class="dropdown-item dropdown-item--secondardy" href="https://docs.laminas.dev/tutorials/">
+                                <div class="row align-items-center">
+                                    <div class="col-md-8 offset-md-4 col-sm-12">
+                                        Tutorials
+                                    </div>
+                                </div>
+                            </a>
+                        </div>
+                    </div>
+                </li>
+                <li class="nav-item">
+                    <a href="https://getlaminas.org/participate" class="nav-link">Community</a>
+                </li>
+            </ul>
+
+            
+            
+                <div class="d-block d-sm-none">
+                    
+    <div class="subnavigation hidden-print">
+        <h4 class="subnavigation__title">
+            <a href="..">mezzio-session</a>
+        </h4>
+
+        <h5 class="subnavigation__subtitle">Table of Contents</h5>
+
+        <ul class="subnavigation__list">
+            
+
+                
+                
+
+                    
+                    
+                        
+                            <li class="subnavigation__list-item ">
+                                <a href="../intro/" class="subnavigation__link">Introduction</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
+                            <li class="subnavigation__list-item subnavigation__list-item--active">
+                                <a href="./" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
+                            <li class="subnavigation__list-item">
+                                <span class="subnavigation__headline">Usage</span>
+                                <ul class="subnavigation__list">
+                                    
+                                        
+    <li class="subnavigation__list-item ">
+        <a href="../session/" class="subnavigation__link">Session Containers</a>
+    </li>
+
+                                    
+                                        
+    <li class="subnavigation__list-item ">
+        <a href="../persistence/" class="subnavigation__link">Session Persistence</a>
+    </li>
+
+                                    
+                                        
+    <li class="subnavigation__list-item ">
+        <a href="../middleware/" class="subnavigation__link">Session Middleware</a>
+    </li>
+
+                                    
+                                </ul>
+                            </li>
+                        
+                    
+                
+            
+        </ul>
+    </div>
+
+                </div>
+            
+
+            
+            <div class="d-block d-sm-none">
+                <div class="component-selector">
+    
+    <h5 class="component-selector__subtitle">Find documentation…</h5>
+    <select class="form-control component-selector__control">
+        <option value="/">Overview</option>
+        <optgroup label="Components"></optgroup>
+    </select>
+</div>
+            </div>
+        </div>
+    </div>
+</nav>
+
+    
+    <header class="header">
+    <div class="container">
+        <div class="row">
+
+            
+            <div class="col-8">
+                <h1 class="header__title">
+                    Mezzio
+
+                    
+                        <small class="header__subtitle">mezzio-session</small>
+                    
+                </h1>
+            </div>
+
+            
+            <div class="col-4 text-right">
+                
+                    
+
+                    <a href="#" class="header__link header__link--search" data-toggle="modal" data-target="#mkdocs_search_modal" title="Open search">
+                        <i class="fa fa-search"></i> Search
+                    </a>
+                    <a href="https://github.com/mezzio/mezzio-session" class="header__link header__link--github" title="Go to repository of mezzio-session">
+                        <i class="fab fa-github"></i> GitHub
+                    </a>
+                
+            </div>
+        </div>
+    </div>
+</header>
+
+    
+    <div class="container">
+        <div class="row">
+            <div class="col-md-9 col-sm-12 content" role="main">
+                
+                
+                    
+    
+
+    
+    
+
+                
+
+                
+                    <nav aria-label="breadcrumb">
+    <ol class="breadcrumb">
+        
+            <li class="breadcrumb-item"><a href="https://docs.laminas.dev/">Overview</a></li>
+            <li class="breadcrumb-item"><a href="https://docs.mezzio.dev/">Mezzio</a></li>
+
+            
+                <li class="breadcrumb-item"><a href="..">mezzio-session</a></li>
+
+                
+
+                <li class="breadcrumb-item active" aria-current="page">Installation</li>
+            
+        
+    </ol>
+</nav>
+
+
+
+
+
+    <h1>Installation</h1>
+<div class="toc">
+    <h6 class="toc__headline">On this page</h6>
+    <ul class="toc__list">
+        <li class="toc__entry">
+            <a href="#standard-installation" class="toc__link nav-link">Standard Installation</a>
+        </li>
+
+        
+        <li class="toc__entry">
+            <a href="#installation-for-mezzio-and-laminas-mvc-application" class="toc__link nav-link">
+                Installation for a
+                Mezzio
+                
+                
+                Application
+            </a>
+        </li>
+        
+    </ul>
+</div>
+
+
+<h2 id="standard-installation">Standard Installation</h2>
+<p>To install the library use <a href="https://getcomposer.org/">Composer</a>:</p>
+<pre><code class="language-bash">$ composer require mezzio/mezzio-session</code></pre>
+
+
+
+<h2 id="installation-for-mezzio-and-laminas-mvc-application">
+    Installation for a
+    Mezzio
+    
+    
+    Application
+</h2>
+
+<h3>Installation and Automated Configuration</h3>
+<p>
+    The <a href="https://docs.laminas.dev/laminas-component-installer/">laminas-component-installer</a>
+    is the recommended installation method when using in
+    a Mezzio-based
+    
+     application.
+    It will automatically inject
+    the config-provider
+    
+    
+    in the configuration during the installation process.
+</p>
+
+<blockquote>
+    <h3>Installation Requirements</h3>
+    <p>
+        The following descriptions depends on the laminas-component-installer component,
+         so be sure to have it installed before getting started.
+    </p>
+
+    <h4>Global Installation</h4>
+    <p>
+        With a <a href="https://docs.laminas.dev/laminas-component-installer/#global-installation">global installation</a>
+        of laminas-component-installer it can be used for all projects without a
+        reinstallation.
+    </p>
+    <pre><code class="language-bash">$ composer global require laminas/laminas-component-installer</code></pre>
+    <h4>As Development Dependency</h4>
+    <pre><code class="language-bash">$ composer require --dev laminas/laminas-component-installer</code></pre>
+</blockquote>
+
+<h4>Install mezzio-session and Inject Configuration</h4>
+<p>To install the library use Composer:</p>
+<pre><code class="language-bash">$ composer require mezzio/mezzio-session</code></pre>
+<p>
+    This will install an initial set of dependencies and it will also prompt to
+    inject the component configuration.
+</p>
+<ul>
+    
+    <li>For a Mezzio application, choose <code>config/config.php</code>.</li>
+    
+    
+</ul>
+<p>
+    If additional dependencies are to be installed, the option for other packages
+    can be remembered.
+</p>
+
+<details><summary>Installation and Manual Configuration</summary>
+<p>
+    If the installer is not used, the manual configuration is needed to add the
+    component to the application.
+</p>
+
+<h4>Install mezzio-session</h4>
+<p>To install the library use Composer:</p>
+<pre><code class="language-bash">$ composer require mezzio/mezzio-session</code></pre>
+
+
+    <h4>Manual Configuration for a Mezzio-based Application</h4>
+    <p>
+        Add the configuration provider of mezzio-session to the configuration file,
+        e.g. <code>config/config.php</code>:
+    </p>
+
+<pre data-line="5"><code class="language-php">
+$aggregator = new Laminas\ConfigAggregator\ConfigAggregator([
+    // …
+    Mezzio\ConfigProvider::class,
+    Mezzio\Router\ConfigProvider::class,
+    Mezzio\Session\ConfigProvider, // Add this line
+    // …
+]);
+</code></pre>
+
+
+
+</details>
+
+
+    
+
+
+
+
+    <nav>
+    <ul class="page-nav hidden-print">
+
+        
+        <li class="page-nav__item">
+            
+                <a rel="prev" class="page-nav__link page-nav__link--prev" href="../intro/">
+                    <small class="page-nav__label">Previous</small>
+                    <i class="fa fa-chevron-left"></i>
+                    Introduction
+                </a>
+            
+        </li>
+
+        
+        <li class="page-nav__item">
+            
+                <a rel="next" class="page-nav__link page-nav__link--next" href="../session/">
+                    <small class="page-nav__label">Next</small>
+                    Session Containers
+                    <i class="fa fa-chevron-right"></i>
+                </a>
+            
+        </li>
+    </ul>
+</nav>
+
+
+
+                
+            </div>
+            <div class="col-md-3 col-sm-12 sidebar">
+                <div class="donation-banner">
+    <a href="https://getlaminas.org/support/">
+        <h2>Donate</h2>
+        <p>Support Laminas Developers Directly</p>
+        <img src="https://funding.communitybridge.org/assets/cb-f-horizontal-white.svg">
+    </a>
+</div>
+
+                
+                    <div class="component-selector">
+    
+    <h5 class="component-selector__subtitle">Find documentation…</h5>
+    <select class="form-control component-selector__control">
+        <option value="/">Overview</option>
+        <optgroup label="Components"></optgroup>
+    </select>
+</div>
+                    
+    <div class="subnavigation hidden-print">
+        <h4 class="subnavigation__title">
+            <a href="..">mezzio-session</a>
+        </h4>
+
+        <h5 class="subnavigation__subtitle">Table of Contents</h5>
+
+        <ul class="subnavigation__list">
+            
+
+                
+                
+
+                    
+                    
+                        
+                            <li class="subnavigation__list-item ">
+                                <a href="../intro/" class="subnavigation__link">Introduction</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
+                            <li class="subnavigation__list-item subnavigation__list-item--active">
+                                <a href="./" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
+                            <li class="subnavigation__list-item">
+                                <span class="subnavigation__headline">Usage</span>
+                                <ul class="subnavigation__list">
+                                    
+                                        
+    <li class="subnavigation__list-item ">
+        <a href="../session/" class="subnavigation__link">Session Containers</a>
+    </li>
+
+                                    
+                                        
+    <li class="subnavigation__list-item ">
+        <a href="../persistence/" class="subnavigation__link">Session Persistence</a>
+    </li>
+
+                                    
+                                        
+    <li class="subnavigation__list-item ">
+        <a href="../middleware/" class="subnavigation__link">Session Middleware</a>
+    </li>
+
+                                    
+                                </ul>
+                            </li>
+                        
+                    
+                
+            
+        </ul>
+    </div>
+
+                    
+                
+            </div>
+        </div>
+    </div>
+
+    
+    <footer class="footer">
+    <div class="container">
+
+        
+        <div class="row">
+            <div class="col-md-12 text-center">
+                <a class="footer__button" href="#page-top"><i class="fa fa-chevron-up" aria-hidden="true"></i></a>
+            </div>
+        </div>
+
+        <div class="row">
+            <div class="col-md-12">
+                <h5>Laminas</h5>
+                <ul>
+                    <li>Laminas Project <a href="https://getlaminas.org/">The new foundation for the community-supported, open source continuation of Zend Framework</a></li>
+                    <li>Laminas Components and MVC <a href="https://docs.laminas.dev/">Components and MVC for enterprise applications</a></li>
+                    <li>Mezzio <a href="https://docs.mezzio.dev/">PSR-15 middleware in minutes</a></li>
+                    <li>Laminas API Tools <a href="https://api-tools.getlaminas.org/">Build RESTful APIs in minutes</a></li>
+                </ul>
+            </div>
+        </div>
+
+        <div class="row">
+            <div class="col-md-12">
+                <div class="row">
+
+                    
+                    <div class="col-md-4">
+                        <h4 class="footer__headline">Support</h4>
+                        <ul class="support__list">
+                            <li class="support__list-item">
+                                <a href="https://discourse.laminas.dev" class="support__link" title="Forum"><i class="fa fa-comments"></i></a>
+                            </li>
+                            <li class="support__list-item">
+                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fab fa-slack"></i></a>
+                            </li>
+                            <li class="support__list-item">
+                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fab fa-github"></i></a>
+                            </li>
+                            <li class="support__list-item">
+                                <a href="https://phpc.social/@getlaminas" class="support__link" title="Mastodon"><i class="fab fa-mastodon"></i></a>
+                            </li>
+                            <li class="support__list-item">
+                                <a href="https://getlaminas.org/blog/rss.xml" class="support__link" title="Blog feed"><i class="fa fa-rss"></i></a>
+                            </li>
+                            <li class="support__list-item">
+                                <a href="https://getlaminas.org/security/feed" class="support__link" title="Security feed"><i class="fa fa-rss-square"></i></a>
+                            </li>
+                        </ul>
+                    </div>
+
+                    
+                    <div class="col-md-4">
+                        <h4 class="footer__headline">License</h4>
+                        <p>
+                            Code licensed under <a
+                                href="https://github.com/mezzio/mezzio-session/blob/-/LICENSE.md">BSD 3-Clause</a>.
+                        </p>
+                    </div>
+
+                    
+                    <div class="col-md-4">
+                        <h4 class="footer__headline">Copyright</h4>
+                        <p>
+                            <!--Built with love by the Laminas team with the help of our
+                            <a href="https://github.com/mezzio/mezzio-session/graphs/contributors">contributors</a>.<br>-->
+                            &copy; 2024 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
+                        </p>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</footer>
+
+    <script>
+        let base_url = '..',
+            project  = "mezzio",
+            siteName = 'mezzio-session';
+    </script>
+    <script src="https://docs.laminas.dev/js/scripts.js"></script>
+    
+        <script src="../search/main.js"></script>
+    
+
+    
+    <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
+    <div class="modal-dialog" role="document">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h5 class="modal-title">Search</h5>
+                <button type="button" class="close" data-dismiss="modal" aria-label="Close">
+                    <span aria-hidden="true">&times;</span>
+                    <span class="sr-only">Close</span>
+                </button>
+            </div>
+            <div class="modal-body">
+                <form role="form">
+                    <div class="form-group">
+                        <input type="text" class="form-control" placeholder="Search in mezzio-session" id="mkdocs-search-query">
+                    </div>
+                </form>
+                <div id="mkdocs-search-results"></div>
+            </div>
+        </div>
+    </div>
+</div>
+</body>
+
+
+</html>
diff --git a/intro/index.html b/intro/index.html
index 2ac96f0..72346fe 100644
--- a/intro/index.html
+++ b/intro/index.html
@@ -5,7 +5,14 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="description" content="Sessions and session middleware for PSR-7 applications.">  
+    <meta name="description" content="Sessions and session middleware for PSR-7 applications."> 
+
+    
+    
+    <meta name="docsearch:version" content="latest">
+    <meta name="docsearch:language" content="en">
+    <meta name="docsearch:component" content="mezzio-session">
+
     <link rel="canonical" href="https://docs.mezzio.dev/mezzio-session/intro/">
     <link rel="shortcut icon" href="https://docs.laminas.dev/img/trademark-laminas-foundation-rgb.svg">
 
@@ -143,6 +150,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="../installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -216,8 +237,8 @@ <h1 class="header__title">
                     <a href="#" class="header__link header__link--search" data-toggle="modal" data-target="#mkdocs_search_modal" title="Open search">
                         <i class="fa fa-search"></i> Search
                     </a>
-                    <a href="https://github.com/mezzio/mezzio-session/" class="header__link header__link--github" title="Go to repository of mezzio-session">
-                        <i class="fa fa-github"></i> GitHub
+                    <a href="https://github.com/mezzio/mezzio-session" class="header__link header__link--github" title="Go to repository of mezzio-session">
+                        <i class="fab fa-github"></i> GitHub
                     </a>
                 
             </div>
@@ -311,25 +332,21 @@ <h2 id="installation">Installation</h2>
 <h2 id="features">Features</h2>
 <p>mezzio-session provides the following:</p>
 <ul>
-<li>Interfaces for:<ul>
+<li>Interfaces for:</li>
 <li>session containers</li>
 <li>session persistence</li>
-</ul>
-</li>
 <li>An implementation of the session container.</li>
 <li>A "lazy-loading" implementation of the session container, to allow delaying
   any de/serialization and/or I/O processes until session data is requested;
   this implementation decorates a normal session container.</li>
-<li>PSR-7 middleware that:<ul>
+<li>PSR-7 middleware that:</li>
 <li>composes a session persistence implementation.</li>
 <li>initializes the lazy-loading session container, using the session
-  persistence implementation.</li>
+    persistence implementation.</li>
 <li>delegates to the next middleware, passing the session container into the
-  request.</li>
+    request.</li>
 <li>finalizes the session before returning the response.</li>
 </ul>
-</li>
-</ul>
 <p>Persistence implementations locate session information from the requests (e.g.,
 via a cookie) in order to initialize the session. On completion of the request,
 they examine the session container for changes and/or to see if it is empty, and
@@ -339,9 +356,9 @@ <h2 id="features">Features</h2>
 and <em>access to session data by middleware</em>. If you also need other features
 often related to session data, you may want to consider the following packages:</p>
 <ul>
-<li><a href="https://github.com/mezzio/mezzio-flash">mezzio-flash</a>: 
+<li><a href="https://github.com/mezzio/mezzio-flash">mezzio-flash</a>:
   provides flash message capabilities.</li>
-<li><a href="https://github.com/mezzio/mezzio-csrf">mezzio-csrf</a>: 
+<li><a href="https://github.com/mezzio/mezzio-csrf">mezzio-csrf</a>:
   provides CSRF token generation, storage, and verification, using either a
   session container, or flash messages.</li>
 </ul>
@@ -356,7 +373,9 @@ <h2 id="features">Features</h2>
         <li class="page-nav__item">
             
                 <a rel="prev" class="page-nav__link page-nav__link--prev" href="..">
-                    <i class="fa fa-chevron-left"></i> Previous
+                    <small class="page-nav__label">Previous</small>
+                    <i class="fa fa-chevron-left"></i>
+                    Home
                 </a>
             
         </li>
@@ -364,8 +383,10 @@ <h2 id="features">Features</h2>
         
         <li class="page-nav__item">
             
-                <a rel="next" class="page-nav__link page-nav__link--next" href="../session/">
-                    Next <i class="fa fa-chevron-right"></i>
+                <a rel="next" class="page-nav__link page-nav__link--next" href="../installation/">
+                    <small class="page-nav__label">Next</small>
+                    Installation
+                    <i class="fa fa-chevron-right"></i>
                 </a>
             
         </li>
@@ -374,16 +395,6 @@ <h2 id="features">Features</h2>
 
 
 
-
-    <div class="help-wanted">
-        <p>
-            Found a mistake or want to contribute to the documentation?
-            <a href="https://github.com/mezzio/mezzio-session/edit/master/docs/book/intro.md" target="_blank" class="help-wanted__link">
-                Edit this page on GitHub!
-            </a>
-        </p>
-    </div>
-
                 
             </div>
             <div class="col-md-3 col-sm-12 sidebar">
@@ -435,6 +446,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="../installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -507,13 +532,13 @@ <h4 class="footer__headline">Support</h4>
                                 <a href="https://discourse.laminas.dev" class="support__link" title="Forum"><i class="fa fa-comments"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fa fa-slack"></i></a>
+                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fab fa-slack"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fa fa-github"></i></a>
+                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fab fa-github"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://twitter.com/getlaminas" class="support__link" title="Twitter"><i class="fa fa-twitter"></i></a>
+                                <a href="https://phpc.social/@getlaminas" class="support__link" title="Mastodon"><i class="fab fa-mastodon"></i></a>
                             </li>
                             <li class="support__list-item">
                                 <a href="https://getlaminas.org/blog/rss.xml" class="support__link" title="Blog feed"><i class="fa fa-rss"></i></a>
@@ -529,7 +554,7 @@ <h4 class="footer__headline">Support</h4>
                         <h4 class="footer__headline">License</h4>
                         <p>
                             Code licensed under <a
-                                href="https://github.com/mezzio/mezzio-session/blob/master/LICENSE.md">BSD 3-Clause</a>.
+                                href="https://github.com/mezzio/mezzio-session/blob/-/LICENSE.md">BSD 3-Clause</a>.
                         </p>
                     </div>
 
@@ -539,7 +564,7 @@ <h4 class="footer__headline">Copyright</h4>
                         <p>
                             <!--Built with love by the Laminas team with the help of our
                             <a href="https://github.com/mezzio/mezzio-session/graphs/contributors">contributors</a>.<br>-->
-                            &copy; 2021 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
+                            &copy; 2024 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
                         </p>
                     </div>
                 </div>
diff --git a/middleware/index.html b/middleware/index.html
index bf4a4e7..f811f41 100644
--- a/middleware/index.html
+++ b/middleware/index.html
@@ -5,7 +5,14 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="description" content="Sessions and session middleware for PSR-7 applications.">  
+    <meta name="description" content="Sessions and session middleware for PSR-7 applications."> 
+
+    
+    
+    <meta name="docsearch:version" content="latest">
+    <meta name="docsearch:language" content="en">
+    <meta name="docsearch:component" content="mezzio-session">
+
     <link rel="canonical" href="https://docs.mezzio.dev/mezzio-session/middleware/">
     <link rel="shortcut icon" href="https://docs.laminas.dev/img/trademark-laminas-foundation-rgb.svg">
 
@@ -143,6 +150,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="../installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -216,8 +237,8 @@ <h1 class="header__title">
                     <a href="#" class="header__link header__link--search" data-toggle="modal" data-target="#mkdocs_search_modal" title="Open search">
                         <i class="fa fa-search"></i> Search
                     </a>
-                    <a href="https://github.com/mezzio/mezzio-session/" class="header__link header__link--github" title="Go to repository of mezzio-session">
-                        <i class="fa fa-github"></i> GitHub
+                    <a href="https://github.com/mezzio/mezzio-session" class="header__link header__link--github" title="Go to repository of mezzio-session">
+                        <i class="fab fa-github"></i> GitHub
                     </a>
                 
             </div>
@@ -248,6 +269,10 @@ <h6 class="toc__headline">On this page</h6>
                         <a href="#adding-the-middleware-to-your-application" class="toc__link nav-link">Adding the middleware to your application</a>
                     </li>
                 
+                    <li class="toc__entry">
+                        <a href="#retrieving-the-session-in-your-own-middleware" class="toc__link nav-link">Retrieving the session in your own middleware</a>
+                    </li>
+                
             </ul>
         </div>
     
@@ -357,6 +382,53 @@ <h2 id="adding-the-middleware-to-your-application">Adding the middleware to your
     \Mezzio\Session\SessionMiddleware::class,
     \User\Middleware\LoginHandler::class
 ]);</code></pre>
+<h2 id="retrieving-the-session-in-your-own-middleware">Retrieving the session in your own middleware</h2>
+<p>Whilst it is trivial to retrieve the initialised session from the request with <code>$session = $request-&gt;getAttribute(SessionInterface::class);</code>, static analysers cannot automatically infer the value assigned to <code>$session</code>.</p>
+<p>To provide a convenient and type safe way to retrieve the session from the current request without manually asserting its type, <code>SessionRetrieval::fromRequest($request)</code> can be called so that you can use the request without further assertions.</p>
+<p>Furthermore, a static method exists to optionally retrieve a session when you cannot be sure the middleware has previously been piped: <code>SessionRetrieval::fromRequestOrNull($request)</code></p>
+<pre class="highlight"><code class="language-php">namespace My\NameSpace;
+
+use Mezzio\Session\Exception\SessionNotInitializedException;
+use Mezzio\Session\RetrieveSession;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+
+class MyRequestHandler implements RequestHandlerInterface {
+
+    // ...
+
+    public function handle(ServerRequestInterface $request) : ResponseInterface
+    {
+        try {
+            $session = RetrieveSession::fromRequest($request);
+        } catch (SessionNotInitializedException $error) {
+            // Handle the uninitialized session:
+            return $this-&gt;redirectToLogin();
+        }
+
+        $value = $session-&gt;get('SomeKey');
+        $this-&gt;templateRenderer-&gt;render('some:template', ['value' =&gt; $value]);
+    }
+}
+
+class AnotherRequestHandler implements RequestHandlerInterface {
+
+    // ...
+
+    public function handle(ServerRequestInterface $request) : ResponseInterface
+    {
+        $session = RetrieveSession::fromRequestOrNull($request);
+        if (! $session) {
+            // Handle the uninitialized session:
+            return $this-&gt;redirectToLogin();
+        }
+
+        $value = $session-&gt;get('SomeKey');
+        $this-&gt;templateRenderer-&gt;render('some:template', ['value' =&gt; $value]);
+    }
+}
+</code></pre>
 
 
 
@@ -368,7 +440,9 @@ <h2 id="adding-the-middleware-to-your-application">Adding the middleware to your
         <li class="page-nav__item">
             
                 <a rel="prev" class="page-nav__link page-nav__link--prev" href="../persistence/">
-                    <i class="fa fa-chevron-left"></i> Previous
+                    <small class="page-nav__label">Previous</small>
+                    <i class="fa fa-chevron-left"></i>
+                    Session Persistence
                 </a>
             
         </li>
@@ -382,16 +456,6 @@ <h2 id="adding-the-middleware-to-your-application">Adding the middleware to your
 
 
 
-
-    <div class="help-wanted">
-        <p>
-            Found a mistake or want to contribute to the documentation?
-            <a href="https://github.com/mezzio/mezzio-session/edit/master/docs/book/middleware.md" target="_blank" class="help-wanted__link">
-                Edit this page on GitHub!
-            </a>
-        </p>
-    </div>
-
                 
             </div>
             <div class="col-md-3 col-sm-12 sidebar">
@@ -443,6 +507,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="../installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -515,13 +593,13 @@ <h4 class="footer__headline">Support</h4>
                                 <a href="https://discourse.laminas.dev" class="support__link" title="Forum"><i class="fa fa-comments"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fa fa-slack"></i></a>
+                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fab fa-slack"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fa fa-github"></i></a>
+                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fab fa-github"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://twitter.com/getlaminas" class="support__link" title="Twitter"><i class="fa fa-twitter"></i></a>
+                                <a href="https://phpc.social/@getlaminas" class="support__link" title="Mastodon"><i class="fab fa-mastodon"></i></a>
                             </li>
                             <li class="support__list-item">
                                 <a href="https://getlaminas.org/blog/rss.xml" class="support__link" title="Blog feed"><i class="fa fa-rss"></i></a>
@@ -537,7 +615,7 @@ <h4 class="footer__headline">Support</h4>
                         <h4 class="footer__headline">License</h4>
                         <p>
                             Code licensed under <a
-                                href="https://github.com/mezzio/mezzio-session/blob/master/LICENSE.md">BSD 3-Clause</a>.
+                                href="https://github.com/mezzio/mezzio-session/blob/-/LICENSE.md">BSD 3-Clause</a>.
                         </p>
                     </div>
 
@@ -547,7 +625,7 @@ <h4 class="footer__headline">Copyright</h4>
                         <p>
                             <!--Built with love by the Laminas team with the help of our
                             <a href="https://github.com/mezzio/mezzio-session/graphs/contributors">contributors</a>.<br>-->
-                            &copy; 2021 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
+                            &copy; 2024 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
                         </p>
                     </div>
                 </div>
diff --git a/pages/404.html b/pages/404.html
index e001b9a..5db6c11 100644
--- a/pages/404.html
+++ b/pages/404.html
@@ -5,7 +5,15 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="description" content="Sessions and session middleware for PSR-7 applications.">  
+    <meta name="description" content="Sessions and session middleware for PSR-7 applications."> 
+
+    
+    
+    <meta name="docsearch:version" content="latest">
+    <meta name="docsearch:language" content="en">
+    <meta name="docsearch:component" content="mezzio-session">
+
+    
     <link rel="shortcut icon" href="https://docs.laminas.dev/img/trademark-laminas-foundation-rgb.svg">
 
     <title>mezzio-session - Laminas Docs</title>
@@ -142,6 +150,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="../installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -215,8 +237,8 @@ <h1 class="header__title">
                     <a href="#" class="header__link header__link--search" data-toggle="modal" data-target="#mkdocs_search_modal" title="Open search">
                         <i class="fa fa-search"></i> Search
                     </a>
-                    <a href="https://github.com/mezzio/mezzio-session/" class="header__link header__link--github" title="Go to repository of mezzio-session">
-                        <i class="fa fa-github"></i> GitHub
+                    <a href="https://github.com/mezzio/mezzio-session" class="header__link header__link--github" title="Go to repository of mezzio-session">
+                        <i class="fab fa-github"></i> GitHub
                     </a>
                 
             </div>
@@ -296,6 +318,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="../installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -368,13 +404,13 @@ <h4 class="footer__headline">Support</h4>
                                 <a href="https://discourse.laminas.dev" class="support__link" title="Forum"><i class="fa fa-comments"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fa fa-slack"></i></a>
+                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fab fa-slack"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fa fa-github"></i></a>
+                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fab fa-github"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://twitter.com/getlaminas" class="support__link" title="Twitter"><i class="fa fa-twitter"></i></a>
+                                <a href="https://phpc.social/@getlaminas" class="support__link" title="Mastodon"><i class="fab fa-mastodon"></i></a>
                             </li>
                             <li class="support__list-item">
                                 <a href="https://getlaminas.org/blog/rss.xml" class="support__link" title="Blog feed"><i class="fa fa-rss"></i></a>
@@ -390,7 +426,7 @@ <h4 class="footer__headline">Support</h4>
                         <h4 class="footer__headline">License</h4>
                         <p>
                             Code licensed under <a
-                                href="https://github.com/mezzio/mezzio-session/blob/master/LICENSE.md">BSD 3-Clause</a>.
+                                href="https://github.com/mezzio/mezzio-session/blob/-/LICENSE.md">BSD 3-Clause</a>.
                         </p>
                     </div>
 
@@ -400,7 +436,7 @@ <h4 class="footer__headline">Copyright</h4>
                         <p>
                             <!--Built with love by the Laminas team with the help of our
                             <a href="https://github.com/mezzio/mezzio-session/graphs/contributors">contributors</a>.<br>-->
-                            &copy; 2021 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
+                            &copy; 2024 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
                         </p>
                     </div>
                 </div>
diff --git a/persistence/index.html b/persistence/index.html
index 0da5870..10ee1f8 100644
--- a/persistence/index.html
+++ b/persistence/index.html
@@ -5,7 +5,14 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="description" content="Sessions and session middleware for PSR-7 applications.">  
+    <meta name="description" content="Sessions and session middleware for PSR-7 applications."> 
+
+    
+    
+    <meta name="docsearch:version" content="latest">
+    <meta name="docsearch:language" content="en">
+    <meta name="docsearch:component" content="mezzio-session">
+
     <link rel="canonical" href="https://docs.mezzio.dev/mezzio-session/persistence/">
     <link rel="shortcut icon" href="https://docs.laminas.dev/img/trademark-laminas-foundation-rgb.svg">
 
@@ -143,6 +150,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="../installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -216,8 +237,8 @@ <h1 class="header__title">
                     <a href="#" class="header__link header__link--search" data-toggle="modal" data-target="#mkdocs_search_modal" title="Open search">
                         <i class="fa fa-search"></i> Search
                     </a>
-                    <a href="https://github.com/mezzio/mezzio-session/" class="header__link header__link--github" title="Go to repository of mezzio-session">
-                        <i class="fa fa-github"></i> GitHub
+                    <a href="https://github.com/mezzio/mezzio-session" class="header__link header__link--github" title="Go to repository of mezzio-session">
+                        <i class="fab fa-github"></i> GitHub
                     </a>
                 
             </div>
@@ -397,7 +418,9 @@ <h2 id="persistent-sessions">Persistent sessions</h2>
         <li class="page-nav__item">
             
                 <a rel="prev" class="page-nav__link page-nav__link--prev" href="../session/">
-                    <i class="fa fa-chevron-left"></i> Previous
+                    <small class="page-nav__label">Previous</small>
+                    <i class="fa fa-chevron-left"></i>
+                    Session Containers
                 </a>
             
         </li>
@@ -406,7 +429,9 @@ <h2 id="persistent-sessions">Persistent sessions</h2>
         <li class="page-nav__item">
             
                 <a rel="next" class="page-nav__link page-nav__link--next" href="../middleware/">
-                    Next <i class="fa fa-chevron-right"></i>
+                    <small class="page-nav__label">Next</small>
+                    Session Middleware
+                    <i class="fa fa-chevron-right"></i>
                 </a>
             
         </li>
@@ -415,16 +440,6 @@ <h2 id="persistent-sessions">Persistent sessions</h2>
 
 
 
-
-    <div class="help-wanted">
-        <p>
-            Found a mistake or want to contribute to the documentation?
-            <a href="https://github.com/mezzio/mezzio-session/edit/master/docs/book/persistence.md" target="_blank" class="help-wanted__link">
-                Edit this page on GitHub!
-            </a>
-        </p>
-    </div>
-
                 
             </div>
             <div class="col-md-3 col-sm-12 sidebar">
@@ -476,6 +491,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="../installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -548,13 +577,13 @@ <h4 class="footer__headline">Support</h4>
                                 <a href="https://discourse.laminas.dev" class="support__link" title="Forum"><i class="fa fa-comments"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fa fa-slack"></i></a>
+                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fab fa-slack"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fa fa-github"></i></a>
+                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fab fa-github"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://twitter.com/getlaminas" class="support__link" title="Twitter"><i class="fa fa-twitter"></i></a>
+                                <a href="https://phpc.social/@getlaminas" class="support__link" title="Mastodon"><i class="fab fa-mastodon"></i></a>
                             </li>
                             <li class="support__list-item">
                                 <a href="https://getlaminas.org/blog/rss.xml" class="support__link" title="Blog feed"><i class="fa fa-rss"></i></a>
@@ -570,7 +599,7 @@ <h4 class="footer__headline">Support</h4>
                         <h4 class="footer__headline">License</h4>
                         <p>
                             Code licensed under <a
-                                href="https://github.com/mezzio/mezzio-session/blob/master/LICENSE.md">BSD 3-Clause</a>.
+                                href="https://github.com/mezzio/mezzio-session/blob/-/LICENSE.md">BSD 3-Clause</a>.
                         </p>
                     </div>
 
@@ -580,7 +609,7 @@ <h4 class="footer__headline">Copyright</h4>
                         <p>
                             <!--Built with love by the Laminas team with the help of our
                             <a href="https://github.com/mezzio/mezzio-session/graphs/contributors">contributors</a>.<br>-->
-                            &copy; 2021 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
+                            &copy; 2024 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
                         </p>
                     </div>
                 </div>
diff --git a/search/lunr.js b/search/lunr.js
index c353765..aca0a16 100644
--- a/search/lunr.js
+++ b/search/lunr.js
@@ -1,6 +1,6 @@
 /**
- * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.8
- * Copyright (C) 2019 Oliver Nightingale
+ * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9
+ * Copyright (C) 2020 Oliver Nightingale
  * @license MIT
  */
 
@@ -54,10 +54,10 @@ var lunr = function (config) {
   return builder.build()
 }
 
-lunr.version = "2.3.8"
+lunr.version = "2.3.9"
 /*!
  * lunr.utils
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -177,7 +177,7 @@ lunr.FieldRef.prototype.toString = function () {
 }
 /*!
  * lunr.Set
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -211,8 +211,8 @@ lunr.Set.complete = {
     return other
   },
 
-  union: function (other) {
-    return other
+  union: function () {
+    return this
   },
 
   contains: function () {
@@ -389,7 +389,7 @@ lunr.Token.prototype.clone = function (fn) {
 }
 /*!
  * lunr.tokenizer
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -465,7 +465,7 @@ lunr.tokenizer = function (obj, metadata) {
 lunr.tokenizer.separator = /[\s\-]+/
 /*!
  * lunr.Pipeline
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -732,7 +732,7 @@ lunr.Pipeline.prototype.toJSON = function () {
 }
 /*!
  * lunr.Vector
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -929,7 +929,7 @@ lunr.Vector.prototype.toJSON = function () {
 /* eslint-disable */
 /*!
  * lunr.stemmer
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt
  */
 
@@ -1151,7 +1151,7 @@ lunr.stemmer = (function(){
 lunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')
 /*!
  * lunr.stopWordFilter
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -1316,7 +1316,7 @@ lunr.stopWordFilter = lunr.generateStopWordFilter([
 lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')
 /*!
  * lunr.trimmer
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -1343,7 +1343,7 @@ lunr.trimmer = function (token) {
 lunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')
 /*!
  * lunr.TokenSet
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -1827,7 +1827,7 @@ lunr.TokenSet.Builder.prototype.minimize = function (downTo) {
 }
 /*!
  * lunr.Index
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -1994,7 +1994,7 @@ lunr.Index.prototype.query = function (fn) {
      */
     var clause = query.clauses[i],
         terms = null,
-        clauseMatches = lunr.Set.complete
+        clauseMatches = lunr.Set.empty
 
     if (clause.usePipeline) {
       terms = this.pipeline.runString(clause.term, {
@@ -2319,7 +2319,7 @@ lunr.Index.load = function (serializedIndex) {
 }
 /*!
  * lunr.Builder
- * Copyright (C) 2019 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -3456,7 +3456,7 @@ lunr.QueryParser.parseBoost = function (parser) {
     } else if (typeof exports === 'object') {
       /**
        * Node. Does not work with strict CommonJS, but
-       * only CommonJS-like enviroments that support module.exports,
+       * only CommonJS-like environments that support module.exports,
        * like Node.
        */
       module.exports = factory()
diff --git a/search/main.js b/search/main.js
index 0e1fc81..a5e469d 100644
--- a/search/main.js
+++ b/search/main.js
@@ -21,8 +21,15 @@ function joinUrl (base, path) {
   return base + "/" + path;
 }
 
+function escapeHtml (value) {
+  return value.replace(/&/g, '&amp;')
+    .replace(/"/g, '&quot;')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;');
+}
+
 function formatResult (location, title, summary) {
-  return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ title + '</a></h3><p>' + summary +'</p></article>';
+  return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ escapeHtml(title) + '</a></h3><p>' + escapeHtml(summary) +'</p></article>';
 }
 
 function displayResults (results) {
@@ -37,7 +44,11 @@ function displayResults (results) {
       search_results.insertAdjacentHTML('beforeend', html);
     }
   } else {
-    search_results.insertAdjacentHTML('beforeend', "<p>No results found</p>");
+    var noResultsText = search_results.getAttribute('data-no-results-text');
+    if (!noResultsText) {
+      noResultsText = "No results found";
+    }
+    search_results.insertAdjacentHTML('beforeend', '<p>' + noResultsText + '</p>');
   }
 }
 
diff --git a/search/search_index.json b/search/search_index.json
index e46ca37..1e8dede 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"mezzio-session This library provides session handling middleware for PSR-7 applications, using an adapter-based approach that will allow usage of ext-session, JWT, or other approaches. Installation Run the following to install this library: $ composer require mezzio/mezzio-session However, the package is not immediately useful unless you have a persistence adapter. If you are okay with using ext-session, you can install the following package as well: $ composer require mezzio/mezzio-session-ext Documentation Documentation is in the doc tree , and can be compiled using mkdocs : $ mkdocs build You may also browse the documentation online .","title":"Home"},{"location":"#mezzio-session","text":"This library provides session handling middleware for PSR-7 applications, using an adapter-based approach that will allow usage of ext-session, JWT, or other approaches.","title":"mezzio-session"},{"location":"#installation","text":"Run the following to install this library: $ composer require mezzio/mezzio-session However, the package is not immediately useful unless you have a persistence adapter. If you are okay with using ext-session, you can install the following package as well: $ composer require mezzio/mezzio-session-ext","title":"Installation"},{"location":"#documentation","text":"Documentation is in the doc tree , and can be compiled using mkdocs : $ mkdocs build You may also browse the documentation online .","title":"Documentation"},{"location":"intro/","text":"mezzio-session Web applications often need to persist user state between requests, and the generally accepted way to do so is via sessions . While PHP provides its own session extension, it: uses global functions that affect global state. relies on a superglobal for access to both read and write the session data. incurs either filesystem or network I/O on every request, depending on the session storage handler. can clobber the Set-Cookie header when other processes also set it. Some projects, such as psr-7-sessions/storageless , take a different approach, using JSON Web Tokens (JWT). The goals of mezzio-session are: to abstract the way users interact with session storage. to abstract how sessions are persisted, to allow both standard ext-session, but also other paradigms such as JWT. to provide session capabilities that \"play nice\" with PSR-7 and middleware. Installation Use Composer to install this package: $ composer require mezzio/mezzio-session However, the package is not immediately useful unless you have a persistence adapter. If you are okay with using ext-session, you can install the following package as well: $ composer require mezzio/mezzio-session-ext Features mezzio-session provides the following: Interfaces for: session containers session persistence An implementation of the session container. A \"lazy-loading\" implementation of the session container, to allow delaying any de/serialization and/or I/O processes until session data is requested; this implementation decorates a normal session container. PSR-7 middleware that: composes a session persistence implementation. initializes the lazy-loading session container, using the session persistence implementation. delegates to the next middleware, passing the session container into the request. finalizes the session before returning the response. Persistence implementations locate session information from the requests (e.g., via a cookie) in order to initialize the session. On completion of the request, they examine the session container for changes and/or to see if it is empty, and provide data to the response so as to notify the client of the session (e.g., via a Set-Cookie header). Note that the goals of this package are solely focused on session persistence and access to session data by middleware . If you also need other features often related to session data, you may want to consider the following packages: mezzio-flash : provides flash message capabilities. mezzio-csrf : provides CSRF token generation, storage, and verification, using either a session container, or flash messages.","title":"Introduction"},{"location":"intro/#mezzio-session","text":"Web applications often need to persist user state between requests, and the generally accepted way to do so is via sessions . While PHP provides its own session extension, it: uses global functions that affect global state. relies on a superglobal for access to both read and write the session data. incurs either filesystem or network I/O on every request, depending on the session storage handler. can clobber the Set-Cookie header when other processes also set it. Some projects, such as psr-7-sessions/storageless , take a different approach, using JSON Web Tokens (JWT). The goals of mezzio-session are: to abstract the way users interact with session storage. to abstract how sessions are persisted, to allow both standard ext-session, but also other paradigms such as JWT. to provide session capabilities that \"play nice\" with PSR-7 and middleware.","title":"mezzio-session"},{"location":"intro/#installation","text":"Use Composer to install this package: $ composer require mezzio/mezzio-session However, the package is not immediately useful unless you have a persistence adapter. If you are okay with using ext-session, you can install the following package as well: $ composer require mezzio/mezzio-session-ext","title":"Installation"},{"location":"intro/#features","text":"mezzio-session provides the following: Interfaces for: session containers session persistence An implementation of the session container. A \"lazy-loading\" implementation of the session container, to allow delaying any de/serialization and/or I/O processes until session data is requested; this implementation decorates a normal session container. PSR-7 middleware that: composes a session persistence implementation. initializes the lazy-loading session container, using the session persistence implementation. delegates to the next middleware, passing the session container into the request. finalizes the session before returning the response. Persistence implementations locate session information from the requests (e.g., via a cookie) in order to initialize the session. On completion of the request, they examine the session container for changes and/or to see if it is empty, and provide data to the response so as to notify the client of the session (e.g., via a Set-Cookie header). Note that the goals of this package are solely focused on session persistence and access to session data by middleware . If you also need other features often related to session data, you may want to consider the following packages: mezzio-flash : provides flash message capabilities. mezzio-csrf : provides CSRF token generation, storage, and verification, using either a session container, or flash messages.","title":"Features"},{"location":"middleware/","text":"Session Middleware mezzio-session provides middleware consuming PSR-7 HTTP message instances, via implementation of PSR-15 interfaces. This middleware composes a persistence instance, and uses that in order to generate a session container, which it pushes into the request it delegates to the next middleware. Once a response is returned, it uses the persistence instance to persist the session data and provide information back to the client. The above two paragraphs are longer than the body of the middleware implementation: namespace Mezzio\\Session; use Psr\\Http\\Message\\ServerRequestInterface; use Psr\\Http\\Message\\ResponseInterface; use Psr\\Http\\Server\\MiddlewareInterface; use Psr\\Http\\Server\\RequestHandlerInterface; class SessionMiddleware implements MiddlewareInterface { public const SESSION_ATTRIBUTE = 'session'; private $persistence; public function __construct(SessionPersistenceInterface $persistence) { $this-&gt;persistence = $persistence; } public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface { $session = new LazySession($this-&gt;persistence, $request); $response = $handler-&gt;handle( $request -&gt;withAttribute(self::SESSION_ATTRIBUTE, $session) -&gt;withAttribute(SessionInterface::class, $session) ); return $this-&gt;persistence-&gt;persistSession($session, $response); } } Configuration This package provides a factory for Mezzio\\Session\\SessionMiddleware via Mezzio\\Session\\SessionMiddlewareFactory ; this factory is auto-wired if you are using Mezzio and the laminas-component-installer Composer plugin. If not, you will need to wire these into your application. The factory depends on one service: Mezzio\\Session\\SessionPersistenceInterface . You will need to either wire in your persistence implementation of choice, or have the package providing it do so for you. Adding the middleware to your application You may pipe this middleware anywhere in your application. If you want to have it available anywhere, pipe it early in your application, prior to any routing. As an example, within Mezzio, you could pipe it in the config/pipeline.php file: $app-&gt;pipe(\\Mezzio\\Session\\SessionMiddleware::class); $app-&gt;pipe(\\Mezzio\\Router\\Middleware\\RouteMiddleware::class); This will generally be an inexpensive operation; since the middleware uses a LazySession instance, unless your persistence implementation does any work in its constructor, the cost is just that of instantiating a few objects. However, it's often useful to specifically include such middleware directly in the routed middleware pipelines, to ensure other developers are aware of its presence in that route's workflow. Within Mezzio, you can do this when routing, in your config/routes.php file, or within a delegator factory : $app-&gt;post('/login', [ \\Mezzio\\Session\\SessionMiddleware::class, \\User\\Middleware\\LoginHandler::class ]);","title":"Session Middleware"},{"location":"middleware/#session-middleware","text":"mezzio-session provides middleware consuming PSR-7 HTTP message instances, via implementation of PSR-15 interfaces. This middleware composes a persistence instance, and uses that in order to generate a session container, which it pushes into the request it delegates to the next middleware. Once a response is returned, it uses the persistence instance to persist the session data and provide information back to the client. The above two paragraphs are longer than the body of the middleware implementation: namespace Mezzio\\Session; use Psr\\Http\\Message\\ServerRequestInterface; use Psr\\Http\\Message\\ResponseInterface; use Psr\\Http\\Server\\MiddlewareInterface; use Psr\\Http\\Server\\RequestHandlerInterface; class SessionMiddleware implements MiddlewareInterface { public const SESSION_ATTRIBUTE = 'session'; private $persistence; public function __construct(SessionPersistenceInterface $persistence) { $this-&gt;persistence = $persistence; } public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface { $session = new LazySession($this-&gt;persistence, $request); $response = $handler-&gt;handle( $request -&gt;withAttribute(self::SESSION_ATTRIBUTE, $session) -&gt;withAttribute(SessionInterface::class, $session) ); return $this-&gt;persistence-&gt;persistSession($session, $response); } }","title":"Session Middleware"},{"location":"middleware/#configuration","text":"This package provides a factory for Mezzio\\Session\\SessionMiddleware via Mezzio\\Session\\SessionMiddlewareFactory ; this factory is auto-wired if you are using Mezzio and the laminas-component-installer Composer plugin. If not, you will need to wire these into your application. The factory depends on one service: Mezzio\\Session\\SessionPersistenceInterface . You will need to either wire in your persistence implementation of choice, or have the package providing it do so for you.","title":"Configuration"},{"location":"middleware/#adding-the-middleware-to-your-application","text":"You may pipe this middleware anywhere in your application. If you want to have it available anywhere, pipe it early in your application, prior to any routing. As an example, within Mezzio, you could pipe it in the config/pipeline.php file: $app-&gt;pipe(\\Mezzio\\Session\\SessionMiddleware::class); $app-&gt;pipe(\\Mezzio\\Router\\Middleware\\RouteMiddleware::class); This will generally be an inexpensive operation; since the middleware uses a LazySession instance, unless your persistence implementation does any work in its constructor, the cost is just that of instantiating a few objects. However, it's often useful to specifically include such middleware directly in the routed middleware pipelines, to ensure other developers are aware of its presence in that route's workflow. Within Mezzio, you can do this when routing, in your config/routes.php file, or within a delegator factory : $app-&gt;post('/login', [ \\Mezzio\\Session\\SessionMiddleware::class, \\User\\Middleware\\LoginHandler::class ]);","title":"Adding the middleware to your application"},{"location":"persistence/","text":"Session Persistence Session persistence within mezzio-session refers to one or both of the following: Identifying session information provided by the client making the request. Storing session data for access on subsequent requests. Providing session information to the client making the request. In some scenarios, such as usage of JSON Web Tokens (JWT), the serialized session data is provided by the client, and provided to the client directly, without any server-side storage whatsoever. To describe these operations, we provide Mezzio\\Session\\SessionPersistenceInterface : namespace Mezzio\\Session; use Psr\\Http\\Message\\ResponseInterface; use Psr\\Http\\Message\\ServerRequestInterface; interface SessionPersistenceInterface { /** * Generate a session data instance based on the request. */ public function initializeSessionFromRequest(ServerRequestInterface $request) : SessionInterface; /** * Persist the session data instance. * * Persists the session data, returning a response instance with any * artifacts required to return to the client. */ public function persistSession(SessionInterface $session, ResponseInterface $response) : ResponseInterface; } Session initialization pulls data from the request (a cookie, a header value, etc.) in order to produce a session container. Session persistence pulls data from the session container, does something with it, and then optionally provides a response containing session artifacts (a cookie, a header value, etc.). For sessions to work, you must provide a persistence implementation . We provide one such implementation using PHP's session extension via the package mezzio-session-ext . Session identifiers Typically, the session identifier will be retrieved from the request (usually via a cookie), and a new identifier created if none was discovered. During persistence, if an existing session's contents have changed, or regenerateId() was called on the session, the persistence implementation becomes responsible for: Removing the original session. Generating a new identifier for the session. In all situations, it then needs to store the session data in such a way that a later lookup by the current identifier will retrieve that data. Prior to version 1.1.0, persistence engines had two ways to determine what the original session identifier was when it came time to regenerate or persist a session: Store the identifier as a property of the persistence implementation. Store the identifier in the session data under a \"magic\" key (e.g., __SESSION_ID__ ). The first approach is problematic when using mezzio-session in an async environment such as Swoole or ReactPHP , as the same persistence instance may be used by several simultaneous requests. As such, version 1.1.0 introduces a new interface for Mezzio\\Session\\SessionInterface implementations to use: Mezzio\\Session\\SessionIdentifierAwareInterface . This interface defines a single method, getId() ; implementations can thus store the identifier internally, and, when it comes time to store the session data, persistence implementations can query that method in order to retrieve the session identifier. Considering that persistence implementations also create the session instance, we recommend that implementations only create instances that implement the SessionIdentifierAwareInterface going forward in order to make themselves async compatible. Persistent sessions Since 1.2.0. If your persistence implementation supports persistent sessions — for example, by setting an Expires or Max-Age cookie directive — then you can opt to globally set a default session duration, or allow developers to hint a desired session duration via the session container using SessionContainerPersistenceInterface::persistSessionFor() . Implementations SHOULD honor the value of SessionContainerPersistenceInterface::getSessionLifetime() when persisting the session data. This could mean either or both of the following: Ensuring that the session data will not be purged until after the specified TTL value. Setting an Expires or Max-Age cookie directive. In each case, the persistence engine should query the Session instance for a TTL value: $ttl = $session instanceof SessionContainerPersistenceInterface ? $session-&gt;getSessionLifetime() : $defaultLifetime; // likely 0, to indicate automatic expiry getSessionLifetime() returns an integer value indicating the number of seconds the session should persist.","title":"Session Persistence"},{"location":"persistence/#session-persistence","text":"Session persistence within mezzio-session refers to one or both of the following: Identifying session information provided by the client making the request. Storing session data for access on subsequent requests. Providing session information to the client making the request. In some scenarios, such as usage of JSON Web Tokens (JWT), the serialized session data is provided by the client, and provided to the client directly, without any server-side storage whatsoever. To describe these operations, we provide Mezzio\\Session\\SessionPersistenceInterface : namespace Mezzio\\Session; use Psr\\Http\\Message\\ResponseInterface; use Psr\\Http\\Message\\ServerRequestInterface; interface SessionPersistenceInterface { /** * Generate a session data instance based on the request. */ public function initializeSessionFromRequest(ServerRequestInterface $request) : SessionInterface; /** * Persist the session data instance. * * Persists the session data, returning a response instance with any * artifacts required to return to the client. */ public function persistSession(SessionInterface $session, ResponseInterface $response) : ResponseInterface; } Session initialization pulls data from the request (a cookie, a header value, etc.) in order to produce a session container. Session persistence pulls data from the session container, does something with it, and then optionally provides a response containing session artifacts (a cookie, a header value, etc.). For sessions to work, you must provide a persistence implementation . We provide one such implementation using PHP's session extension via the package mezzio-session-ext .","title":"Session Persistence"},{"location":"persistence/#session-identifiers","text":"Typically, the session identifier will be retrieved from the request (usually via a cookie), and a new identifier created if none was discovered. During persistence, if an existing session's contents have changed, or regenerateId() was called on the session, the persistence implementation becomes responsible for: Removing the original session. Generating a new identifier for the session. In all situations, it then needs to store the session data in such a way that a later lookup by the current identifier will retrieve that data. Prior to version 1.1.0, persistence engines had two ways to determine what the original session identifier was when it came time to regenerate or persist a session: Store the identifier as a property of the persistence implementation. Store the identifier in the session data under a \"magic\" key (e.g., __SESSION_ID__ ). The first approach is problematic when using mezzio-session in an async environment such as Swoole or ReactPHP , as the same persistence instance may be used by several simultaneous requests. As such, version 1.1.0 introduces a new interface for Mezzio\\Session\\SessionInterface implementations to use: Mezzio\\Session\\SessionIdentifierAwareInterface . This interface defines a single method, getId() ; implementations can thus store the identifier internally, and, when it comes time to store the session data, persistence implementations can query that method in order to retrieve the session identifier. Considering that persistence implementations also create the session instance, we recommend that implementations only create instances that implement the SessionIdentifierAwareInterface going forward in order to make themselves async compatible.","title":"Session identifiers"},{"location":"persistence/#persistent-sessions","text":"Since 1.2.0. If your persistence implementation supports persistent sessions — for example, by setting an Expires or Max-Age cookie directive — then you can opt to globally set a default session duration, or allow developers to hint a desired session duration via the session container using SessionContainerPersistenceInterface::persistSessionFor() . Implementations SHOULD honor the value of SessionContainerPersistenceInterface::getSessionLifetime() when persisting the session data. This could mean either or both of the following: Ensuring that the session data will not be purged until after the specified TTL value. Setting an Expires or Max-Age cookie directive. In each case, the persistence engine should query the Session instance for a TTL value: $ttl = $session instanceof SessionContainerPersistenceInterface ? $session-&gt;getSessionLifetime() : $defaultLifetime; // likely 0, to indicate automatic expiry getSessionLifetime() returns an integer value indicating the number of seconds the session should persist.","title":"Persistent sessions"},{"location":"session/","text":"Session Containers Session containers are the primary interface with which most application developers will work; they contain the data currently in the session, and allow you to push data to the session. All session containers implement Mezzio\\Session\\SessionInterface : namespace Mezzio\\Session; interface SessionInterface { /** * Serialize the session data to an array for storage purposes. */ public function toArray() : array; /** * Retrieve a value from the session. * * @param mixed $default Default value to return if $name does not exist. * @return mixed */ public function get(string $name, $default = null); /** * Whether or not the container has the given key. */ public function has(string $name) : bool; /** * Set a value within the session. * * Values MUST be serializable in any format; we recommend ensuring the * values are JSON serializable for greatest portability. * * @param mixed $value */ public function set(string $name, $value) : void; /** * Remove a value from the session. */ public function unset(string $name) : void; /** * Clear all values. */ public function clear() : void; /** * Does the session contain changes? If not, the middleware handling * session persistence may not need to do more work. */ public function hasChanged() : bool; /** * Regenerate the session. * * This can be done to prevent session fixation. When executed, it SHOULD * return a new instance; that instance should always return true for * isRegenerated(). * * An example of where this WOULD NOT return a new instance is within the * shipped LazySession, where instead it would return itself, after * internally re-setting the proxied session. */ public function regenerate(): SessionInterface; /** * Method to determine if the session was regenerated; should return * true if the instance was produced via regenerate(). */ public function isRegenerated() : bool; } The default implementation, and the one you'll most likely interact with, is Mezzio\\Session\\Session . Since version 1.1.0, we provide Mezzio\\Session\\SessionIdentifierAwareInterface : namespace Mezzio\\Session; interface SessionIdentifierAwareInterface { /** * Retrieve the session identifier. * * This feature was added in 1.1.0 to allow the session persistence to be * stateless. Previously, persistence implementations had to store the * session identifier between calls to initializeSessionFromRequest() and * persistSession(). When SessionInterface implementations also implement * this method, the persistence implementation no longer needs to store it. * * This method will become a part of the SessionInterface in 2.0.0. * * @since 1.1.0 */ public function getId() : string; } Since version 1.2.0, we provide Mezzio\\Session\\SessionCookiePersistenceInterface : namespace Mezzio\\Session; /** * Allow marking session cookies as persistent. * * It can be useful to mark a session as persistent: e.g., for a \"Remember Me\" * feature when logging a user into your system. PHP provides this capability * via ext-session with the $lifetime argument to session_set_cookie_params() * as well as by the session.cookie_lifetime INI setting. The latter will set * the value for all session cookies sent (or until the value is changed via * an ini_set() call), while the former will only affect cookies created during * the current script lifetime. * * Persistence engines may, of course, allow setting a global lifetime. This * interface allows developers to set the lifetime programmatically. Persistence * implementations are encouraged to use the value to set the cookie lifetime * when creating and returning a cookie. Additionally, to ensure the cookie * lifetime originally requested is honored when a session is regenerated, we * recommend persistence engines to store the TTL in the session data itself, * so that it can be re-sent in such scenarios. */ interface SessionCookiePersistenceInterface { const SESSION_LIFETIME_KEY = '__SESSION_TTL__'; /** * Define how long the session cookie should live. * * Use this value to detail to the session persistence engine how long the * session cookie should live. * * This value could be passed as the $lifetime value of * session_set_cookie_params(), or used to create an Expires or Max-Age * parameter for a session cookie. * * Since cookie lifetime is communicated by the server to the client, and * not vice versa, the value should likely be persisted in the session * itself, to ensure that session regeneration uses the same value. We * recommend using the SESSION_LIFETIME_KEY value to communicate this. * * @param int $duration Number of seconds the cookie should persist for. */ public function persistSessionFor(int $duration) : void; /** * Determine how long the session cookie should live. * * Generally, this will return the value provided to persistFor(). * * If that method has not been called, the value can return one of the * following: * * - 0 or a negative value, to indicate the cookie should be treated as a * session cookie, and expire when the window is closed. This should be * the default behavior. * - If persistFor() was provided during session creation or anytime later, * the persistence engine should pull the TTL value from the session itself * and return it here. Typically, this value should be communicated via * the SESSION_LIFETIME_KEY value of the session. */ public function getSessionLifetime() : int; } Mezzio\\Session\\Session and Mezzio\\Session\\LazySession both implement each of the interfaces listed above. Session accepts an optional identifier to its constructor, and will use the value of the SessionCookiePersistenceInterface::SESSION_LIFETIME_KEY in the provided data to seed the session cookie lifetime, if present. Usage Session containers will typically be passed to your middleware using the SessionMiddleware , via the Mezzio\\Session\\SessionMiddleware::SESSION_ATTRIBUTE (\"session\") or the Mezzio\\Session\\SessionInterface::class (\"Mezzio\\Session\\SessionInterface\"; available since version 1.4.0) request attribute. Once you have the container, you can check for data: if ($session-&gt;has('user')) { } and retrieve it: $user = $session-&gt;get('user'); You can combine those operations, by passing a default value as a second argument to the get() method: $user = $session-&gt;get('user', new GuestUser()); If a datum is no longer relevant in the session, unset() it: $session-&gt;unset('user'); If none of the data is relevant, clear() the session: $session-&gt;clear(); Persistent Sessions Since 1.2.0 You can hint to the session persistence engine how long the session should persist: $session-&gt;persistSessionFor(60 * 60 * 24 * 7); // persist for 7 days To make the session expire when the browser session is terminated (default behavior), use zero or a negative integer: $session-&gt;persistSessionFor(0); // expire data after session is over Lazy Sessions This package provides another implementation of SessionInterface via Mezzio\\Session\\LazySession . This implementation does the following: It composes a persistence instance, along with the current request. On first access (e.g., get() , set() , etc.), it uses the composed persistence and request instances to generate the actual session container. All methods then proxy to this container. This approach helps delay any I/O or network operations, and/or deserialization, until they are actually needed. The shipped SessionMiddleware produces a LazySession . Session Regeneration Some application events benefit from session regeneration . In particular, after a user has successfully logged in or out, you will generally want to regenerate the session in order to prevent session fixation and the attack vectors it invites. In those situations, call regenerate() : $newSession = $session-&gt;regenerate(); The interface indicates that a new instance should be returned. However, in the default usage, you will have a LazySession instance (as described above), which decorates the underlying session storage. This is done for two reasons: First, the stated reasons of preventing the need to deserialize data and/or perform I/O access until the last moment. Second, to ensure that the SessionMiddleware always has a pointer to the session . This latter is what allows you to regenerate the session in middleware nested deep in your application, but still have the data persisted correctly.","title":"Session Containers"},{"location":"session/#session-containers","text":"Session containers are the primary interface with which most application developers will work; they contain the data currently in the session, and allow you to push data to the session. All session containers implement Mezzio\\Session\\SessionInterface : namespace Mezzio\\Session; interface SessionInterface { /** * Serialize the session data to an array for storage purposes. */ public function toArray() : array; /** * Retrieve a value from the session. * * @param mixed $default Default value to return if $name does not exist. * @return mixed */ public function get(string $name, $default = null); /** * Whether or not the container has the given key. */ public function has(string $name) : bool; /** * Set a value within the session. * * Values MUST be serializable in any format; we recommend ensuring the * values are JSON serializable for greatest portability. * * @param mixed $value */ public function set(string $name, $value) : void; /** * Remove a value from the session. */ public function unset(string $name) : void; /** * Clear all values. */ public function clear() : void; /** * Does the session contain changes? If not, the middleware handling * session persistence may not need to do more work. */ public function hasChanged() : bool; /** * Regenerate the session. * * This can be done to prevent session fixation. When executed, it SHOULD * return a new instance; that instance should always return true for * isRegenerated(). * * An example of where this WOULD NOT return a new instance is within the * shipped LazySession, where instead it would return itself, after * internally re-setting the proxied session. */ public function regenerate(): SessionInterface; /** * Method to determine if the session was regenerated; should return * true if the instance was produced via regenerate(). */ public function isRegenerated() : bool; } The default implementation, and the one you'll most likely interact with, is Mezzio\\Session\\Session . Since version 1.1.0, we provide Mezzio\\Session\\SessionIdentifierAwareInterface : namespace Mezzio\\Session; interface SessionIdentifierAwareInterface { /** * Retrieve the session identifier. * * This feature was added in 1.1.0 to allow the session persistence to be * stateless. Previously, persistence implementations had to store the * session identifier between calls to initializeSessionFromRequest() and * persistSession(). When SessionInterface implementations also implement * this method, the persistence implementation no longer needs to store it. * * This method will become a part of the SessionInterface in 2.0.0. * * @since 1.1.0 */ public function getId() : string; } Since version 1.2.0, we provide Mezzio\\Session\\SessionCookiePersistenceInterface : namespace Mezzio\\Session; /** * Allow marking session cookies as persistent. * * It can be useful to mark a session as persistent: e.g., for a \"Remember Me\" * feature when logging a user into your system. PHP provides this capability * via ext-session with the $lifetime argument to session_set_cookie_params() * as well as by the session.cookie_lifetime INI setting. The latter will set * the value for all session cookies sent (or until the value is changed via * an ini_set() call), while the former will only affect cookies created during * the current script lifetime. * * Persistence engines may, of course, allow setting a global lifetime. This * interface allows developers to set the lifetime programmatically. Persistence * implementations are encouraged to use the value to set the cookie lifetime * when creating and returning a cookie. Additionally, to ensure the cookie * lifetime originally requested is honored when a session is regenerated, we * recommend persistence engines to store the TTL in the session data itself, * so that it can be re-sent in such scenarios. */ interface SessionCookiePersistenceInterface { const SESSION_LIFETIME_KEY = '__SESSION_TTL__'; /** * Define how long the session cookie should live. * * Use this value to detail to the session persistence engine how long the * session cookie should live. * * This value could be passed as the $lifetime value of * session_set_cookie_params(), or used to create an Expires or Max-Age * parameter for a session cookie. * * Since cookie lifetime is communicated by the server to the client, and * not vice versa, the value should likely be persisted in the session * itself, to ensure that session regeneration uses the same value. We * recommend using the SESSION_LIFETIME_KEY value to communicate this. * * @param int $duration Number of seconds the cookie should persist for. */ public function persistSessionFor(int $duration) : void; /** * Determine how long the session cookie should live. * * Generally, this will return the value provided to persistFor(). * * If that method has not been called, the value can return one of the * following: * * - 0 or a negative value, to indicate the cookie should be treated as a * session cookie, and expire when the window is closed. This should be * the default behavior. * - If persistFor() was provided during session creation or anytime later, * the persistence engine should pull the TTL value from the session itself * and return it here. Typically, this value should be communicated via * the SESSION_LIFETIME_KEY value of the session. */ public function getSessionLifetime() : int; } Mezzio\\Session\\Session and Mezzio\\Session\\LazySession both implement each of the interfaces listed above. Session accepts an optional identifier to its constructor, and will use the value of the SessionCookiePersistenceInterface::SESSION_LIFETIME_KEY in the provided data to seed the session cookie lifetime, if present.","title":"Session Containers"},{"location":"session/#usage","text":"Session containers will typically be passed to your middleware using the SessionMiddleware , via the Mezzio\\Session\\SessionMiddleware::SESSION_ATTRIBUTE (\"session\") or the Mezzio\\Session\\SessionInterface::class (\"Mezzio\\Session\\SessionInterface\"; available since version 1.4.0) request attribute. Once you have the container, you can check for data: if ($session-&gt;has('user')) { } and retrieve it: $user = $session-&gt;get('user'); You can combine those operations, by passing a default value as a second argument to the get() method: $user = $session-&gt;get('user', new GuestUser()); If a datum is no longer relevant in the session, unset() it: $session-&gt;unset('user'); If none of the data is relevant, clear() the session: $session-&gt;clear();","title":"Usage"},{"location":"session/#lazy-sessions","text":"This package provides another implementation of SessionInterface via Mezzio\\Session\\LazySession . This implementation does the following: It composes a persistence instance, along with the current request. On first access (e.g., get() , set() , etc.), it uses the composed persistence and request instances to generate the actual session container. All methods then proxy to this container. This approach helps delay any I/O or network operations, and/or deserialization, until they are actually needed. The shipped SessionMiddleware produces a LazySession .","title":"Lazy Sessions"},{"location":"session/#session-regeneration","text":"Some application events benefit from session regeneration . In particular, after a user has successfully logged in or out, you will generally want to regenerate the session in order to prevent session fixation and the attack vectors it invites. In those situations, call regenerate() : $newSession = $session-&gt;regenerate(); The interface indicates that a new instance should be returned. However, in the default usage, you will have a LazySession instance (as described above), which decorates the underlying session storage. This is done for two reasons: First, the stated reasons of preventing the need to deserialize data and/or perform I/O access until the last moment. Second, to ensure that the SessionMiddleware always has a pointer to the session . This latter is what allows you to regenerate the session in middleware nested deep in your application, but still have the data persisted correctly.","title":"Session Regeneration"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"mezzio-session 🇷🇺 Русским гражданам Мы, участники Laminas, родились и живем в разных странах. У многих из нас есть друзья, родственники и коллеги как в России, так и в Украине. Некоторые из нас родились в России. Некоторые из нас живут в России. У некоторых бабушки и дедушки сражались с фашистами во Второй мировой войне. Здесь никто не поддерживает фашизм. У одного из нас есть украинская родственница, которая спаслась из дома вместе с сыном. Поезд задержался из-за бомбежки на дороге впереди. У нас есть друзья, которые прячутся в бомбоубежищах. Мы с тревогой ждем весточки от них после воздушных налетов, которые беспорядочно наносят удары и попадают по больницам, школам, детским садам и домам. Мы не берем это из каких-либо СМИ. Мы наблюдаем это напрямую. Вы доверяете нам достаточно, чтоб использовать наши программы, и мы просим вас довериться нам вновь. Мы нуждаемся в помощи. Выходите и протестуйте против этой бесполезной войны. Остановите кровопролитие. Скажите \"Нет войне!\" 🇺🇸 To Citizens of Russia We at Laminas come from all over the world. Many of us have friends, family and colleagues in both Russia and Ukraine. Some of us were born in Russia. Some of us currently live in Russia. Some have grandparents who fought Nazis in World War II. Nobody here supports fascism. One team member has a Ukrainian relative who fled her home with her son. The train was delayed due to bombing on the road ahead. We have friends who are hiding in bomb shelters. We anxiously follow up on them after the air raids, which indiscriminately fire at hospitals, schools, kindergartens and houses. We're not taking this from any media. These are our actual experiences. You trust us enough to use our software. We ask that you trust us to say the truth on this. We need your help. Go out and protest this unnecessary war. Stop the bloodshed. Say \"stop the war!\" This library provides session handling middleware for PSR-7 applications, using an adapter-based approach that will allow usage of ext-session, JWT, or other approaches. Installation Run the following to install this library: $ composer require mezzio/mezzio-session However, the package is not immediately useful unless you have a persistence adapter. If you are okay with using ext-session, you can install the following package as well: $ composer require mezzio/mezzio-session-ext Documentation Documentation is in the doc tree , and can be compiled using mkdocs : $ mkdocs build You may also browse the documentation online .","title":"Home"},{"location":"#mezzio-session","text":"","title":"mezzio-session"},{"location":"#_1","text":"Мы, участники Laminas, родились и живем в разных странах. У многих из нас есть друзья, родственники и коллеги как в России, так и в Украине. Некоторые из нас родились в России. Некоторые из нас живут в России. У некоторых бабушки и дедушки сражались с фашистами во Второй мировой войне. Здесь никто не поддерживает фашизм. У одного из нас есть украинская родственница, которая спаслась из дома вместе с сыном. Поезд задержался из-за бомбежки на дороге впереди. У нас есть друзья, которые прячутся в бомбоубежищах. Мы с тревогой ждем весточки от них после воздушных налетов, которые беспорядочно наносят удары и попадают по больницам, школам, детским садам и домам. Мы не берем это из каких-либо СМИ. Мы наблюдаем это напрямую. Вы доверяете нам достаточно, чтоб использовать наши программы, и мы просим вас довериться нам вновь. Мы нуждаемся в помощи. Выходите и протестуйте против этой бесполезной войны. Остановите кровопролитие. Скажите \"Нет войне!\"","title":"🇷🇺 Русским гражданам"},{"location":"#to-citizens-of-russia","text":"We at Laminas come from all over the world. Many of us have friends, family and colleagues in both Russia and Ukraine. Some of us were born in Russia. Some of us currently live in Russia. Some have grandparents who fought Nazis in World War II. Nobody here supports fascism. One team member has a Ukrainian relative who fled her home with her son. The train was delayed due to bombing on the road ahead. We have friends who are hiding in bomb shelters. We anxiously follow up on them after the air raids, which indiscriminately fire at hospitals, schools, kindergartens and houses. We're not taking this from any media. These are our actual experiences. You trust us enough to use our software. We ask that you trust us to say the truth on this. We need your help. Go out and protest this unnecessary war. Stop the bloodshed. Say \"stop the war!\" This library provides session handling middleware for PSR-7 applications, using an adapter-based approach that will allow usage of ext-session, JWT, or other approaches.","title":"🇺🇸 To Citizens of Russia"},{"location":"#installation","text":"Run the following to install this library: $ composer require mezzio/mezzio-session However, the package is not immediately useful unless you have a persistence adapter. If you are okay with using ext-session, you can install the following package as well: $ composer require mezzio/mezzio-session-ext","title":"Installation"},{"location":"#documentation","text":"Documentation is in the doc tree , and can be compiled using mkdocs : $ mkdocs build You may also browse the documentation online .","title":"Documentation"},{"location":"installation/","text":"This Is Only a Placeholder The content of this page can be found under: https://github.com/laminas/documentation-theme/blob/master/theme/pages/installation.html","title":"Installation"},{"location":"installation/#this-is-only-a-placeholder","text":"The content of this page can be found under: https://github.com/laminas/documentation-theme/blob/master/theme/pages/installation.html","title":"This Is Only a Placeholder"},{"location":"intro/","text":"mezzio-session Web applications often need to persist user state between requests, and the generally accepted way to do so is via sessions . While PHP provides its own session extension, it: uses global functions that affect global state. relies on a superglobal for access to both read and write the session data. incurs either filesystem or network I/O on every request, depending on the session storage handler. can clobber the Set-Cookie header when other processes also set it. Some projects, such as psr-7-sessions/storageless , take a different approach, using JSON Web Tokens (JWT). The goals of mezzio-session are: to abstract the way users interact with session storage. to abstract how sessions are persisted, to allow both standard ext-session, but also other paradigms such as JWT. to provide session capabilities that \"play nice\" with PSR-7 and middleware. Installation Use Composer to install this package: $ composer require mezzio/mezzio-session However, the package is not immediately useful unless you have a persistence adapter. If you are okay with using ext-session, you can install the following package as well: $ composer require mezzio/mezzio-session-ext Features mezzio-session provides the following: Interfaces for: session containers session persistence An implementation of the session container. A \"lazy-loading\" implementation of the session container, to allow delaying any de/serialization and/or I/O processes until session data is requested; this implementation decorates a normal session container. PSR-7 middleware that: composes a session persistence implementation. initializes the lazy-loading session container, using the session persistence implementation. delegates to the next middleware, passing the session container into the request. finalizes the session before returning the response. Persistence implementations locate session information from the requests (e.g., via a cookie) in order to initialize the session. On completion of the request, they examine the session container for changes and/or to see if it is empty, and provide data to the response so as to notify the client of the session (e.g., via a Set-Cookie header). Note that the goals of this package are solely focused on session persistence and access to session data by middleware . If you also need other features often related to session data, you may want to consider the following packages: mezzio-flash : provides flash message capabilities. mezzio-csrf : provides CSRF token generation, storage, and verification, using either a session container, or flash messages.","title":"Introduction"},{"location":"intro/#mezzio-session","text":"Web applications often need to persist user state between requests, and the generally accepted way to do so is via sessions . While PHP provides its own session extension, it: uses global functions that affect global state. relies on a superglobal for access to both read and write the session data. incurs either filesystem or network I/O on every request, depending on the session storage handler. can clobber the Set-Cookie header when other processes also set it. Some projects, such as psr-7-sessions/storageless , take a different approach, using JSON Web Tokens (JWT). The goals of mezzio-session are: to abstract the way users interact with session storage. to abstract how sessions are persisted, to allow both standard ext-session, but also other paradigms such as JWT. to provide session capabilities that \"play nice\" with PSR-7 and middleware.","title":"mezzio-session"},{"location":"intro/#installation","text":"Use Composer to install this package: $ composer require mezzio/mezzio-session However, the package is not immediately useful unless you have a persistence adapter. If you are okay with using ext-session, you can install the following package as well: $ composer require mezzio/mezzio-session-ext","title":"Installation"},{"location":"intro/#features","text":"mezzio-session provides the following: Interfaces for: session containers session persistence An implementation of the session container. A \"lazy-loading\" implementation of the session container, to allow delaying any de/serialization and/or I/O processes until session data is requested; this implementation decorates a normal session container. PSR-7 middleware that: composes a session persistence implementation. initializes the lazy-loading session container, using the session persistence implementation. delegates to the next middleware, passing the session container into the request. finalizes the session before returning the response. Persistence implementations locate session information from the requests (e.g., via a cookie) in order to initialize the session. On completion of the request, they examine the session container for changes and/or to see if it is empty, and provide data to the response so as to notify the client of the session (e.g., via a Set-Cookie header). Note that the goals of this package are solely focused on session persistence and access to session data by middleware . If you also need other features often related to session data, you may want to consider the following packages: mezzio-flash : provides flash message capabilities. mezzio-csrf : provides CSRF token generation, storage, and verification, using either a session container, or flash messages.","title":"Features"},{"location":"middleware/","text":"Session Middleware mezzio-session provides middleware consuming PSR-7 HTTP message instances, via implementation of PSR-15 interfaces. This middleware composes a persistence instance, and uses that in order to generate a session container, which it pushes into the request it delegates to the next middleware. Once a response is returned, it uses the persistence instance to persist the session data and provide information back to the client. The above two paragraphs are longer than the body of the middleware implementation: namespace Mezzio\\Session; use Psr\\Http\\Message\\ServerRequestInterface; use Psr\\Http\\Message\\ResponseInterface; use Psr\\Http\\Server\\MiddlewareInterface; use Psr\\Http\\Server\\RequestHandlerInterface; class SessionMiddleware implements MiddlewareInterface { public const SESSION_ATTRIBUTE = 'session'; private $persistence; public function __construct(SessionPersistenceInterface $persistence) { $this-&gt;persistence = $persistence; } public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface { $session = new LazySession($this-&gt;persistence, $request); $response = $handler-&gt;handle( $request -&gt;withAttribute(self::SESSION_ATTRIBUTE, $session) -&gt;withAttribute(SessionInterface::class, $session) ); return $this-&gt;persistence-&gt;persistSession($session, $response); } } Configuration This package provides a factory for Mezzio\\Session\\SessionMiddleware via Mezzio\\Session\\SessionMiddlewareFactory ; this factory is auto-wired if you are using Mezzio and the laminas-component-installer Composer plugin. If not, you will need to wire these into your application. The factory depends on one service: Mezzio\\Session\\SessionPersistenceInterface . You will need to either wire in your persistence implementation of choice, or have the package providing it do so for you. Adding the middleware to your application You may pipe this middleware anywhere in your application. If you want to have it available anywhere, pipe it early in your application, prior to any routing. As an example, within Mezzio, you could pipe it in the config/pipeline.php file: $app-&gt;pipe(\\Mezzio\\Session\\SessionMiddleware::class); $app-&gt;pipe(\\Mezzio\\Router\\Middleware\\RouteMiddleware::class); This will generally be an inexpensive operation; since the middleware uses a LazySession instance, unless your persistence implementation does any work in its constructor, the cost is just that of instantiating a few objects. However, it's often useful to specifically include such middleware directly in the routed middleware pipelines, to ensure other developers are aware of its presence in that route's workflow. Within Mezzio, you can do this when routing, in your config/routes.php file, or within a delegator factory : $app-&gt;post('/login', [ \\Mezzio\\Session\\SessionMiddleware::class, \\User\\Middleware\\LoginHandler::class ]); Retrieving the session in your own middleware Whilst it is trivial to retrieve the initialised session from the request with $session = $request-&gt;getAttribute(SessionInterface::class); , static analysers cannot automatically infer the value assigned to $session . To provide a convenient and type safe way to retrieve the session from the current request without manually asserting its type, SessionRetrieval::fromRequest($request) can be called so that you can use the request without further assertions. Furthermore, a static method exists to optionally retrieve a session when you cannot be sure the middleware has previously been piped: SessionRetrieval::fromRequestOrNull($request) namespace My\\NameSpace; use Mezzio\\Session\\Exception\\SessionNotInitializedException; use Mezzio\\Session\\RetrieveSession; use Psr\\Http\\Message\\ResponseInterface; use Psr\\Http\\Message\\ServerRequestInterface; use Psr\\Http\\Server\\RequestHandlerInterface; class MyRequestHandler implements RequestHandlerInterface { // ... public function handle(ServerRequestInterface $request) : ResponseInterface { try { $session = RetrieveSession::fromRequest($request); } catch (SessionNotInitializedException $error) { // Handle the uninitialized session: return $this-&gt;redirectToLogin(); } $value = $session-&gt;get('SomeKey'); $this-&gt;templateRenderer-&gt;render('some:template', ['value' =&gt; $value]); } } class AnotherRequestHandler implements RequestHandlerInterface { // ... public function handle(ServerRequestInterface $request) : ResponseInterface { $session = RetrieveSession::fromRequestOrNull($request); if (! $session) { // Handle the uninitialized session: return $this-&gt;redirectToLogin(); } $value = $session-&gt;get('SomeKey'); $this-&gt;templateRenderer-&gt;render('some:template', ['value' =&gt; $value]); } }","title":"Session Middleware"},{"location":"middleware/#session-middleware","text":"mezzio-session provides middleware consuming PSR-7 HTTP message instances, via implementation of PSR-15 interfaces. This middleware composes a persistence instance, and uses that in order to generate a session container, which it pushes into the request it delegates to the next middleware. Once a response is returned, it uses the persistence instance to persist the session data and provide information back to the client. The above two paragraphs are longer than the body of the middleware implementation: namespace Mezzio\\Session; use Psr\\Http\\Message\\ServerRequestInterface; use Psr\\Http\\Message\\ResponseInterface; use Psr\\Http\\Server\\MiddlewareInterface; use Psr\\Http\\Server\\RequestHandlerInterface; class SessionMiddleware implements MiddlewareInterface { public const SESSION_ATTRIBUTE = 'session'; private $persistence; public function __construct(SessionPersistenceInterface $persistence) { $this-&gt;persistence = $persistence; } public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface { $session = new LazySession($this-&gt;persistence, $request); $response = $handler-&gt;handle( $request -&gt;withAttribute(self::SESSION_ATTRIBUTE, $session) -&gt;withAttribute(SessionInterface::class, $session) ); return $this-&gt;persistence-&gt;persistSession($session, $response); } }","title":"Session Middleware"},{"location":"middleware/#configuration","text":"This package provides a factory for Mezzio\\Session\\SessionMiddleware via Mezzio\\Session\\SessionMiddlewareFactory ; this factory is auto-wired if you are using Mezzio and the laminas-component-installer Composer plugin. If not, you will need to wire these into your application. The factory depends on one service: Mezzio\\Session\\SessionPersistenceInterface . You will need to either wire in your persistence implementation of choice, or have the package providing it do so for you.","title":"Configuration"},{"location":"middleware/#adding-the-middleware-to-your-application","text":"You may pipe this middleware anywhere in your application. If you want to have it available anywhere, pipe it early in your application, prior to any routing. As an example, within Mezzio, you could pipe it in the config/pipeline.php file: $app-&gt;pipe(\\Mezzio\\Session\\SessionMiddleware::class); $app-&gt;pipe(\\Mezzio\\Router\\Middleware\\RouteMiddleware::class); This will generally be an inexpensive operation; since the middleware uses a LazySession instance, unless your persistence implementation does any work in its constructor, the cost is just that of instantiating a few objects. However, it's often useful to specifically include such middleware directly in the routed middleware pipelines, to ensure other developers are aware of its presence in that route's workflow. Within Mezzio, you can do this when routing, in your config/routes.php file, or within a delegator factory : $app-&gt;post('/login', [ \\Mezzio\\Session\\SessionMiddleware::class, \\User\\Middleware\\LoginHandler::class ]);","title":"Adding the middleware to your application"},{"location":"middleware/#retrieving-the-session-in-your-own-middleware","text":"Whilst it is trivial to retrieve the initialised session from the request with $session = $request-&gt;getAttribute(SessionInterface::class); , static analysers cannot automatically infer the value assigned to $session . To provide a convenient and type safe way to retrieve the session from the current request without manually asserting its type, SessionRetrieval::fromRequest($request) can be called so that you can use the request without further assertions. Furthermore, a static method exists to optionally retrieve a session when you cannot be sure the middleware has previously been piped: SessionRetrieval::fromRequestOrNull($request) namespace My\\NameSpace; use Mezzio\\Session\\Exception\\SessionNotInitializedException; use Mezzio\\Session\\RetrieveSession; use Psr\\Http\\Message\\ResponseInterface; use Psr\\Http\\Message\\ServerRequestInterface; use Psr\\Http\\Server\\RequestHandlerInterface; class MyRequestHandler implements RequestHandlerInterface { // ... public function handle(ServerRequestInterface $request) : ResponseInterface { try { $session = RetrieveSession::fromRequest($request); } catch (SessionNotInitializedException $error) { // Handle the uninitialized session: return $this-&gt;redirectToLogin(); } $value = $session-&gt;get('SomeKey'); $this-&gt;templateRenderer-&gt;render('some:template', ['value' =&gt; $value]); } } class AnotherRequestHandler implements RequestHandlerInterface { // ... public function handle(ServerRequestInterface $request) : ResponseInterface { $session = RetrieveSession::fromRequestOrNull($request); if (! $session) { // Handle the uninitialized session: return $this-&gt;redirectToLogin(); } $value = $session-&gt;get('SomeKey'); $this-&gt;templateRenderer-&gt;render('some:template', ['value' =&gt; $value]); } }","title":"Retrieving the session in your own middleware"},{"location":"persistence/","text":"Session Persistence Session persistence within mezzio-session refers to one or both of the following: Identifying session information provided by the client making the request. Storing session data for access on subsequent requests. Providing session information to the client making the request. In some scenarios, such as usage of JSON Web Tokens (JWT), the serialized session data is provided by the client, and provided to the client directly, without any server-side storage whatsoever. To describe these operations, we provide Mezzio\\Session\\SessionPersistenceInterface : namespace Mezzio\\Session; use Psr\\Http\\Message\\ResponseInterface; use Psr\\Http\\Message\\ServerRequestInterface; interface SessionPersistenceInterface { /** * Generate a session data instance based on the request. */ public function initializeSessionFromRequest(ServerRequestInterface $request) : SessionInterface; /** * Persist the session data instance. * * Persists the session data, returning a response instance with any * artifacts required to return to the client. */ public function persistSession(SessionInterface $session, ResponseInterface $response) : ResponseInterface; } Session initialization pulls data from the request (a cookie, a header value, etc.) in order to produce a session container. Session persistence pulls data from the session container, does something with it, and then optionally provides a response containing session artifacts (a cookie, a header value, etc.). For sessions to work, you must provide a persistence implementation . We provide one such implementation using PHP's session extension via the package mezzio-session-ext . Session identifiers Typically, the session identifier will be retrieved from the request (usually via a cookie), and a new identifier created if none was discovered. During persistence, if an existing session's contents have changed, or regenerateId() was called on the session, the persistence implementation becomes responsible for: Removing the original session. Generating a new identifier for the session. In all situations, it then needs to store the session data in such a way that a later lookup by the current identifier will retrieve that data. Prior to version 1.1.0, persistence engines had two ways to determine what the original session identifier was when it came time to regenerate or persist a session: Store the identifier as a property of the persistence implementation. Store the identifier in the session data under a \"magic\" key (e.g., __SESSION_ID__ ). The first approach is problematic when using mezzio-session in an async environment such as Swoole or ReactPHP , as the same persistence instance may be used by several simultaneous requests. As such, version 1.1.0 introduces a new interface for Mezzio\\Session\\SessionInterface implementations to use: Mezzio\\Session\\SessionIdentifierAwareInterface . This interface defines a single method, getId() ; implementations can thus store the identifier internally, and, when it comes time to store the session data, persistence implementations can query that method in order to retrieve the session identifier. Considering that persistence implementations also create the session instance, we recommend that implementations only create instances that implement the SessionIdentifierAwareInterface going forward in order to make themselves async compatible. Persistent sessions Since 1.2.0. If your persistence implementation supports persistent sessions — for example, by setting an Expires or Max-Age cookie directive — then you can opt to globally set a default session duration, or allow developers to hint a desired session duration via the session container using SessionContainerPersistenceInterface::persistSessionFor() . Implementations SHOULD honor the value of SessionContainerPersistenceInterface::getSessionLifetime() when persisting the session data. This could mean either or both of the following: Ensuring that the session data will not be purged until after the specified TTL value. Setting an Expires or Max-Age cookie directive. In each case, the persistence engine should query the Session instance for a TTL value: $ttl = $session instanceof SessionContainerPersistenceInterface ? $session-&gt;getSessionLifetime() : $defaultLifetime; // likely 0, to indicate automatic expiry getSessionLifetime() returns an integer value indicating the number of seconds the session should persist.","title":"Session Persistence"},{"location":"persistence/#session-persistence","text":"Session persistence within mezzio-session refers to one or both of the following: Identifying session information provided by the client making the request. Storing session data for access on subsequent requests. Providing session information to the client making the request. In some scenarios, such as usage of JSON Web Tokens (JWT), the serialized session data is provided by the client, and provided to the client directly, without any server-side storage whatsoever. To describe these operations, we provide Mezzio\\Session\\SessionPersistenceInterface : namespace Mezzio\\Session; use Psr\\Http\\Message\\ResponseInterface; use Psr\\Http\\Message\\ServerRequestInterface; interface SessionPersistenceInterface { /** * Generate a session data instance based on the request. */ public function initializeSessionFromRequest(ServerRequestInterface $request) : SessionInterface; /** * Persist the session data instance. * * Persists the session data, returning a response instance with any * artifacts required to return to the client. */ public function persistSession(SessionInterface $session, ResponseInterface $response) : ResponseInterface; } Session initialization pulls data from the request (a cookie, a header value, etc.) in order to produce a session container. Session persistence pulls data from the session container, does something with it, and then optionally provides a response containing session artifacts (a cookie, a header value, etc.). For sessions to work, you must provide a persistence implementation . We provide one such implementation using PHP's session extension via the package mezzio-session-ext .","title":"Session Persistence"},{"location":"persistence/#session-identifiers","text":"Typically, the session identifier will be retrieved from the request (usually via a cookie), and a new identifier created if none was discovered. During persistence, if an existing session's contents have changed, or regenerateId() was called on the session, the persistence implementation becomes responsible for: Removing the original session. Generating a new identifier for the session. In all situations, it then needs to store the session data in such a way that a later lookup by the current identifier will retrieve that data. Prior to version 1.1.0, persistence engines had two ways to determine what the original session identifier was when it came time to regenerate or persist a session: Store the identifier as a property of the persistence implementation. Store the identifier in the session data under a \"magic\" key (e.g., __SESSION_ID__ ). The first approach is problematic when using mezzio-session in an async environment such as Swoole or ReactPHP , as the same persistence instance may be used by several simultaneous requests. As such, version 1.1.0 introduces a new interface for Mezzio\\Session\\SessionInterface implementations to use: Mezzio\\Session\\SessionIdentifierAwareInterface . This interface defines a single method, getId() ; implementations can thus store the identifier internally, and, when it comes time to store the session data, persistence implementations can query that method in order to retrieve the session identifier. Considering that persistence implementations also create the session instance, we recommend that implementations only create instances that implement the SessionIdentifierAwareInterface going forward in order to make themselves async compatible.","title":"Session identifiers"},{"location":"persistence/#persistent-sessions","text":"Since 1.2.0. If your persistence implementation supports persistent sessions — for example, by setting an Expires or Max-Age cookie directive — then you can opt to globally set a default session duration, or allow developers to hint a desired session duration via the session container using SessionContainerPersistenceInterface::persistSessionFor() . Implementations SHOULD honor the value of SessionContainerPersistenceInterface::getSessionLifetime() when persisting the session data. This could mean either or both of the following: Ensuring that the session data will not be purged until after the specified TTL value. Setting an Expires or Max-Age cookie directive. In each case, the persistence engine should query the Session instance for a TTL value: $ttl = $session instanceof SessionContainerPersistenceInterface ? $session-&gt;getSessionLifetime() : $defaultLifetime; // likely 0, to indicate automatic expiry getSessionLifetime() returns an integer value indicating the number of seconds the session should persist.","title":"Persistent sessions"},{"location":"session/","text":"Session Containers Session containers are the primary interface with which most application developers will work; they contain the data currently in the session, and allow you to push data to the session. All session containers implement Mezzio\\Session\\SessionInterface : namespace Mezzio\\Session; interface SessionInterface { /** * Serialize the session data to an array for storage purposes. */ public function toArray() : array; /** * Retrieve a value from the session. * * @param mixed $default Default value to return if $name does not exist. * @return mixed */ public function get(string $name, $default = null); /** * Whether or not the container has the given key. */ public function has(string $name) : bool; /** * Set a value within the session. * * Values MUST be serializable in any format; we recommend ensuring the * values are JSON serializable for greatest portability. * * @param mixed $value */ public function set(string $name, $value) : void; /** * Remove a value from the session. */ public function unset(string $name) : void; /** * Clear all values. */ public function clear() : void; /** * Does the session contain changes? If not, the middleware handling * session persistence may not need to do more work. */ public function hasChanged() : bool; /** * Regenerate the session. * * This can be done to prevent session fixation. When executed, it SHOULD * return a new instance; that instance should always return true for * isRegenerated(). * * An example of where this WOULD NOT return a new instance is within the * shipped LazySession, where instead it would return itself, after * internally re-setting the proxied session. */ public function regenerate(): SessionInterface; /** * Method to determine if the session was regenerated; should return * true if the instance was produced via regenerate(). */ public function isRegenerated() : bool; } The default implementation, and the one you'll most likely interact with, is Mezzio\\Session\\Session . Since version 1.1.0, we provide Mezzio\\Session\\SessionIdentifierAwareInterface : namespace Mezzio\\Session; interface SessionIdentifierAwareInterface { /** * Retrieve the session identifier. * * This feature was added in 1.1.0 to allow the session persistence to be * stateless. Previously, persistence implementations had to store the * session identifier between calls to initializeSessionFromRequest() and * persistSession(). When SessionInterface implementations also implement * this method, the persistence implementation no longer needs to store it. * * This method will become a part of the SessionInterface in 2.0.0. * * @since 1.1.0 */ public function getId() : string; } Since version 1.2.0, we provide Mezzio\\Session\\SessionCookiePersistenceInterface : namespace Mezzio\\Session; /** * Allow marking session cookies as persistent. * * It can be useful to mark a session as persistent: e.g., for a \"Remember Me\" * feature when logging a user into your system. PHP provides this capability * via ext-session with the $lifetime argument to session_set_cookie_params() * as well as by the session.cookie_lifetime INI setting. The latter will set * the value for all session cookies sent (or until the value is changed via * an ini_set() call), while the former will only affect cookies created during * the current script lifetime. * * Persistence engines may, of course, allow setting a global lifetime. This * interface allows developers to set the lifetime programmatically. Persistence * implementations are encouraged to use the value to set the cookie lifetime * when creating and returning a cookie. Additionally, to ensure the cookie * lifetime originally requested is honored when a session is regenerated, we * recommend persistence engines to store the TTL in the session data itself, * so that it can be re-sent in such scenarios. */ interface SessionCookiePersistenceInterface { const SESSION_LIFETIME_KEY = '__SESSION_TTL__'; /** * Define how long the session cookie should live. * * Use this value to detail to the session persistence engine how long the * session cookie should live. * * This value could be passed as the $lifetime value of * session_set_cookie_params(), or used to create an Expires or Max-Age * parameter for a session cookie. * * Since cookie lifetime is communicated by the server to the client, and * not vice versa, the value should likely be persisted in the session * itself, to ensure that session regeneration uses the same value. We * recommend using the SESSION_LIFETIME_KEY value to communicate this. * * @param int $duration Number of seconds the cookie should persist for. */ public function persistSessionFor(int $duration) : void; /** * Determine how long the session cookie should live. * * Generally, this will return the value provided to persistFor(). * * If that method has not been called, the value can return one of the * following: * * - 0 or a negative value, to indicate the cookie should be treated as a * session cookie, and expire when the window is closed. This should be * the default behavior. * - If persistFor() was provided during session creation or anytime later, * the persistence engine should pull the TTL value from the session itself * and return it here. Typically, this value should be communicated via * the SESSION_LIFETIME_KEY value of the session. */ public function getSessionLifetime() : int; } Mezzio\\Session\\Session and Mezzio\\Session\\LazySession both implement each of the interfaces listed above. Session accepts an optional identifier to its constructor, and will use the value of the SessionCookiePersistenceInterface::SESSION_LIFETIME_KEY in the provided data to seed the session cookie lifetime, if present. Usage Session containers will typically be passed to your middleware using the SessionMiddleware , via the Mezzio\\Session\\SessionMiddleware::SESSION_ATTRIBUTE (\"session\") or the Mezzio\\Session\\SessionInterface::class (\"Mezzio\\Session\\SessionInterface\"; available since version 1.4.0) request attribute. Once you have the container, you can check for data: if ($session-&gt;has('user')) { } and retrieve it: $user = $session-&gt;get('user'); You can combine those operations, by passing a default value as a second argument to the get() method: $user = $session-&gt;get('user', new GuestUser()); If a datum is no longer relevant in the session, unset() it: $session-&gt;unset('user'); If none of the data is relevant, clear() the session: $session-&gt;clear(); Persistent Sessions Since 1.2.0 You can hint to the session persistence engine how long the session should persist: $session-&gt;persistSessionFor(60 * 60 * 24 * 7); // persist for 7 days To make the session expire when the browser session is terminated (default behavior), use zero or a negative integer: $session-&gt;persistSessionFor(0); // expire data after session is over Lazy Sessions This package provides another implementation of SessionInterface via Mezzio\\Session\\LazySession . This implementation does the following: It composes a persistence instance, along with the current request. On first access (e.g., get() , set() , etc.), it uses the composed persistence and request instances to generate the actual session container. All methods then proxy to this container. This approach helps delay any I/O or network operations, and/or deserialization, until they are actually needed. The shipped SessionMiddleware produces a LazySession . Session Regeneration Some application events benefit from session regeneration . In particular, after a user has successfully logged in or out, you will generally want to regenerate the session in order to prevent session fixation and the attack vectors it invites. In those situations, call regenerate() : $newSession = $session-&gt;regenerate(); The interface indicates that a new instance should be returned. However, in the default usage, you will have a LazySession instance (as described above), which decorates the underlying session storage. This is done for two reasons: First, the stated reasons of preventing the need to deserialize data and/or perform I/O access until the last moment. Second, to ensure that the SessionMiddleware always has a pointer to the session . This latter is what allows you to regenerate the session in middleware nested deep in your application, but still have the data persisted correctly.","title":"Session Containers"},{"location":"session/#session-containers","text":"Session containers are the primary interface with which most application developers will work; they contain the data currently in the session, and allow you to push data to the session. All session containers implement Mezzio\\Session\\SessionInterface : namespace Mezzio\\Session; interface SessionInterface { /** * Serialize the session data to an array for storage purposes. */ public function toArray() : array; /** * Retrieve a value from the session. * * @param mixed $default Default value to return if $name does not exist. * @return mixed */ public function get(string $name, $default = null); /** * Whether or not the container has the given key. */ public function has(string $name) : bool; /** * Set a value within the session. * * Values MUST be serializable in any format; we recommend ensuring the * values are JSON serializable for greatest portability. * * @param mixed $value */ public function set(string $name, $value) : void; /** * Remove a value from the session. */ public function unset(string $name) : void; /** * Clear all values. */ public function clear() : void; /** * Does the session contain changes? If not, the middleware handling * session persistence may not need to do more work. */ public function hasChanged() : bool; /** * Regenerate the session. * * This can be done to prevent session fixation. When executed, it SHOULD * return a new instance; that instance should always return true for * isRegenerated(). * * An example of where this WOULD NOT return a new instance is within the * shipped LazySession, where instead it would return itself, after * internally re-setting the proxied session. */ public function regenerate(): SessionInterface; /** * Method to determine if the session was regenerated; should return * true if the instance was produced via regenerate(). */ public function isRegenerated() : bool; } The default implementation, and the one you'll most likely interact with, is Mezzio\\Session\\Session . Since version 1.1.0, we provide Mezzio\\Session\\SessionIdentifierAwareInterface : namespace Mezzio\\Session; interface SessionIdentifierAwareInterface { /** * Retrieve the session identifier. * * This feature was added in 1.1.0 to allow the session persistence to be * stateless. Previously, persistence implementations had to store the * session identifier between calls to initializeSessionFromRequest() and * persistSession(). When SessionInterface implementations also implement * this method, the persistence implementation no longer needs to store it. * * This method will become a part of the SessionInterface in 2.0.0. * * @since 1.1.0 */ public function getId() : string; } Since version 1.2.0, we provide Mezzio\\Session\\SessionCookiePersistenceInterface : namespace Mezzio\\Session; /** * Allow marking session cookies as persistent. * * It can be useful to mark a session as persistent: e.g., for a \"Remember Me\" * feature when logging a user into your system. PHP provides this capability * via ext-session with the $lifetime argument to session_set_cookie_params() * as well as by the session.cookie_lifetime INI setting. The latter will set * the value for all session cookies sent (or until the value is changed via * an ini_set() call), while the former will only affect cookies created during * the current script lifetime. * * Persistence engines may, of course, allow setting a global lifetime. This * interface allows developers to set the lifetime programmatically. Persistence * implementations are encouraged to use the value to set the cookie lifetime * when creating and returning a cookie. Additionally, to ensure the cookie * lifetime originally requested is honored when a session is regenerated, we * recommend persistence engines to store the TTL in the session data itself, * so that it can be re-sent in such scenarios. */ interface SessionCookiePersistenceInterface { const SESSION_LIFETIME_KEY = '__SESSION_TTL__'; /** * Define how long the session cookie should live. * * Use this value to detail to the session persistence engine how long the * session cookie should live. * * This value could be passed as the $lifetime value of * session_set_cookie_params(), or used to create an Expires or Max-Age * parameter for a session cookie. * * Since cookie lifetime is communicated by the server to the client, and * not vice versa, the value should likely be persisted in the session * itself, to ensure that session regeneration uses the same value. We * recommend using the SESSION_LIFETIME_KEY value to communicate this. * * @param int $duration Number of seconds the cookie should persist for. */ public function persistSessionFor(int $duration) : void; /** * Determine how long the session cookie should live. * * Generally, this will return the value provided to persistFor(). * * If that method has not been called, the value can return one of the * following: * * - 0 or a negative value, to indicate the cookie should be treated as a * session cookie, and expire when the window is closed. This should be * the default behavior. * - If persistFor() was provided during session creation or anytime later, * the persistence engine should pull the TTL value from the session itself * and return it here. Typically, this value should be communicated via * the SESSION_LIFETIME_KEY value of the session. */ public function getSessionLifetime() : int; } Mezzio\\Session\\Session and Mezzio\\Session\\LazySession both implement each of the interfaces listed above. Session accepts an optional identifier to its constructor, and will use the value of the SessionCookiePersistenceInterface::SESSION_LIFETIME_KEY in the provided data to seed the session cookie lifetime, if present.","title":"Session Containers"},{"location":"session/#usage","text":"Session containers will typically be passed to your middleware using the SessionMiddleware , via the Mezzio\\Session\\SessionMiddleware::SESSION_ATTRIBUTE (\"session\") or the Mezzio\\Session\\SessionInterface::class (\"Mezzio\\Session\\SessionInterface\"; available since version 1.4.0) request attribute. Once you have the container, you can check for data: if ($session-&gt;has('user')) { } and retrieve it: $user = $session-&gt;get('user'); You can combine those operations, by passing a default value as a second argument to the get() method: $user = $session-&gt;get('user', new GuestUser()); If a datum is no longer relevant in the session, unset() it: $session-&gt;unset('user'); If none of the data is relevant, clear() the session: $session-&gt;clear();","title":"Usage"},{"location":"session/#lazy-sessions","text":"This package provides another implementation of SessionInterface via Mezzio\\Session\\LazySession . This implementation does the following: It composes a persistence instance, along with the current request. On first access (e.g., get() , set() , etc.), it uses the composed persistence and request instances to generate the actual session container. All methods then proxy to this container. This approach helps delay any I/O or network operations, and/or deserialization, until they are actually needed. The shipped SessionMiddleware produces a LazySession .","title":"Lazy Sessions"},{"location":"session/#session-regeneration","text":"Some application events benefit from session regeneration . In particular, after a user has successfully logged in or out, you will generally want to regenerate the session in order to prevent session fixation and the attack vectors it invites. In those situations, call regenerate() : $newSession = $session-&gt;regenerate(); The interface indicates that a new instance should be returned. However, in the default usage, you will have a LazySession instance (as described above), which decorates the underlying session storage. This is done for two reasons: First, the stated reasons of preventing the need to deserialize data and/or perform I/O access until the last moment. Second, to ensure that the SessionMiddleware always has a pointer to the session . This latter is what allows you to regenerate the session in middleware nested deep in your application, but still have the data persisted correctly.","title":"Session Regeneration"}]}
\ No newline at end of file
diff --git a/search/worker.js b/search/worker.js
index 9cce2f7..8628dbc 100644
--- a/search/worker.js
+++ b/search/worker.js
@@ -44,6 +44,9 @@ function onJSONLoaded () {
     if (lang.length > 1) {
       scriptsToLoad.push('lunr.multi.js');
     }
+    if (lang.includes("ja") || lang.includes("jp")) {
+      scriptsToLoad.push('tinyseg.js');
+    }
     for (var i=0; i < lang.length; i++) {
       if (lang[i] != 'en') {
         scriptsToLoad.push(['lunr', lang[i], 'js'].join('.'));
diff --git a/session/index.html b/session/index.html
index 442de41..5188216 100644
--- a/session/index.html
+++ b/session/index.html
@@ -5,7 +5,14 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="description" content="Sessions and session middleware for PSR-7 applications.">  
+    <meta name="description" content="Sessions and session middleware for PSR-7 applications."> 
+
+    
+    
+    <meta name="docsearch:version" content="latest">
+    <meta name="docsearch:language" content="en">
+    <meta name="docsearch:component" content="mezzio-session">
+
     <link rel="canonical" href="https://docs.mezzio.dev/mezzio-session/session/">
     <link rel="shortcut icon" href="https://docs.laminas.dev/img/trademark-laminas-foundation-rgb.svg">
 
@@ -143,6 +150,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="../installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -216,8 +237,8 @@ <h1 class="header__title">
                     <a href="#" class="header__link header__link--search" data-toggle="modal" data-target="#mkdocs_search_modal" title="Open search">
                         <i class="fa fa-search"></i> Search
                     </a>
-                    <a href="https://github.com/mezzio/mezzio-session/" class="header__link header__link--github" title="Go to repository of mezzio-session">
-                        <i class="fa fa-github"></i> GitHub
+                    <a href="https://github.com/mezzio/mezzio-session" class="header__link header__link--github" title="Go to repository of mezzio-session">
+                        <i class="fab fa-github"></i> GitHub
                     </a>
                 
             </div>
@@ -524,8 +545,10 @@ <h2 id="session-regeneration">Session Regeneration</h2>
         
         <li class="page-nav__item">
             
-                <a rel="prev" class="page-nav__link page-nav__link--prev" href="../intro/">
-                    <i class="fa fa-chevron-left"></i> Previous
+                <a rel="prev" class="page-nav__link page-nav__link--prev" href="../installation/">
+                    <small class="page-nav__label">Previous</small>
+                    <i class="fa fa-chevron-left"></i>
+                    Installation
                 </a>
             
         </li>
@@ -534,7 +557,9 @@ <h2 id="session-regeneration">Session Regeneration</h2>
         <li class="page-nav__item">
             
                 <a rel="next" class="page-nav__link page-nav__link--next" href="../persistence/">
-                    Next <i class="fa fa-chevron-right"></i>
+                    <small class="page-nav__label">Next</small>
+                    Session Persistence
+                    <i class="fa fa-chevron-right"></i>
                 </a>
             
         </li>
@@ -543,16 +568,6 @@ <h2 id="session-regeneration">Session Regeneration</h2>
 
 
 
-
-    <div class="help-wanted">
-        <p>
-            Found a mistake or want to contribute to the documentation?
-            <a href="https://github.com/mezzio/mezzio-session/edit/master/docs/book/session.md" target="_blank" class="help-wanted__link">
-                Edit this page on GitHub!
-            </a>
-        </p>
-    </div>
-
                 
             </div>
             <div class="col-md-3 col-sm-12 sidebar">
@@ -604,6 +619,20 @@ <h5 class="subnavigation__subtitle">Table of Contents</h5>
                     
                     
                         
+                            <li class="subnavigation__list-item ">
+                                <a href="../installation/" class="subnavigation__link">Installation</a>
+                            </li>
+                        
+                    
+                
+            
+
+                
+                
+
+                    
+                    
+                        
                             <li class="subnavigation__list-item">
                                 <span class="subnavigation__headline">Usage</span>
                                 <ul class="subnavigation__list">
@@ -676,13 +705,13 @@ <h4 class="footer__headline">Support</h4>
                                 <a href="https://discourse.laminas.dev" class="support__link" title="Forum"><i class="fa fa-comments"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fa fa-slack"></i></a>
+                                <a href="https://laminas.dev/chat" class="support__link" title="Chat"><i class="fab fa-slack"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fa fa-github"></i></a>
+                                <a href="https://github.com/laminas" class="support__link" title="Github"><i class="fab fa-github"></i></a>
                             </li>
                             <li class="support__list-item">
-                                <a href="https://twitter.com/getlaminas" class="support__link" title="Twitter"><i class="fa fa-twitter"></i></a>
+                                <a href="https://phpc.social/@getlaminas" class="support__link" title="Mastodon"><i class="fab fa-mastodon"></i></a>
                             </li>
                             <li class="support__list-item">
                                 <a href="https://getlaminas.org/blog/rss.xml" class="support__link" title="Blog feed"><i class="fa fa-rss"></i></a>
@@ -698,7 +727,7 @@ <h4 class="footer__headline">Support</h4>
                         <h4 class="footer__headline">License</h4>
                         <p>
                             Code licensed under <a
-                                href="https://github.com/mezzio/mezzio-session/blob/master/LICENSE.md">BSD 3-Clause</a>.
+                                href="https://github.com/mezzio/mezzio-session/blob/-/LICENSE.md">BSD 3-Clause</a>.
                         </p>
                     </div>
 
@@ -708,7 +737,7 @@ <h4 class="footer__headline">Copyright</h4>
                         <p>
                             <!--Built with love by the Laminas team with the help of our
                             <a href="https://github.com/mezzio/mezzio-session/graphs/contributors">contributors</a>.<br>-->
-                            &copy; 2021 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
+                            &copy; 2024 <a href="https://getlaminas.org/">Laminas Project</a> a Series of LF Projects, LLC.
                         </p>
                     </div>
                 </div>
diff --git a/sitemap.xml b/sitemap.xml
index 7b0c115..e804ddd 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1,23 +1,33 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
-     <loc>https://docs.mezzio.dev/mezzio-session/</loc>
-     <lastmod>2021-04-20</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://docs.mezzio.dev/mezzio-session/intro/</loc>
-     <lastmod>2021-04-20</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://docs.mezzio.dev/mezzio-session/session/</loc>
-     <lastmod>2021-04-20</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://docs.mezzio.dev/mezzio-session/persistence/</loc>
-     <lastmod>2021-04-20</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://docs.mezzio.dev/mezzio-session/middleware/</loc>
-     <lastmod>2021-04-20</lastmod>
-     <changefreq>daily</changefreq>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+    <url>
+         <loc>https://docs.mezzio.dev/mezzio-session/</loc>
+         <lastmod>2024-01-13</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://docs.mezzio.dev/mezzio-session/installation/</loc>
+         <lastmod>2024-01-13</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://docs.mezzio.dev/mezzio-session/intro/</loc>
+         <lastmod>2024-01-13</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://docs.mezzio.dev/mezzio-session/middleware/</loc>
+         <lastmod>2024-01-13</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://docs.mezzio.dev/mezzio-session/persistence/</loc>
+         <lastmod>2024-01-13</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://docs.mezzio.dev/mezzio-session/session/</loc>
+         <lastmod>2024-01-13</lastmod>
+         <changefreq>daily</changefreq>
     </url>
 </urlset>
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index b0728b55f3bf825a15cab6962d3bb18410344495..bad4eb18167f6cb13814a83737930e422395b543 100644
GIT binary patch
literal 252
zcmV<Y00aLYiwFoMexhXp|8r?{Wo=<_E_iKh0M(SuPQ)M-h4=Fm4f}H2(S;hy?0f=!
z00P&RgrCaAsm{|2(~0Tc#MHata&kENHV1L~^sYH$A{)cNdfu@HgO0|AabT}6&+P*{
z$%FVvjxaaH9B5!u&hrz%vMiizMz3b#F^xcaDi?yA2pxZ9^3as20qb@h;i8r`g-VQx
znz+Zy#YS%M4C~qwQiTEm)x3SHDEnySu{++kUElV1#d6a&Ha)2@;#<OZX_R$e0yfGD
z1wT~3;Io0Ua!%#{0h?3YJ*BtCI9yc1-J{O6I+ROi_Rsofjk+G?zmVSxDze~T1ONa*
CJAcOj

literal 243
zcmV<P01W>hiwFn>`hH*n|8r?{Wo=<_E_iKh0L_!lPQ@S)h4+1mhJ6`s<3bJP?tB7$
z00Lu6!cS%JR`1gb*P6ICF)15n&YY8cA%i@B1m9mUlS^@8CoWiz(Io5QJh7MOr{SKR
zRVUxGCoFw6N1E7D%K8YfZ5t<7FzA(d$}^BzYD2J#Aov4QEvve|9qE%%Elf3SlOZ1P
zdUc6gyuf!k5K?0S3C;YI(^NvTY82yX5O>2U>Uh_7i&=D>@ipU{vfBAi3BQz^M?xd{
tBaVwDr=vj~^sUymPE_h1;nC27v)1FL^Z$``x2ygZ^##fAa_(IN008ojbw~gJ