PHPackages yiisoft/session - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. yiisoft/session ActiveLibrary[Framework](/categories/framework) yiisoft/session =============== A session service, PSR-15 session middleware, and a flash message service which helps use one-time messages. 3.0.1(5mo ago)20311.6k—3.2%6[1 PRs](https://github.com/yiisoft/session/pulls)12BSD-3-ClausePHPPHP 8.0 - 8.5CI passing Since Dec 26Pushed 5mo ago12 watchersCompare [ Source](https://github.com/yiisoft/session)[ Packagist](https://packagist.org/packages/yiisoft/session)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-session/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (5)Dependencies (13)Versions (12)Used By (12) [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) Yii Session =========== [](#yii-session) [![Latest Stable Version](https://camo.githubusercontent.com/c62e1a63e2226b8be99b898efb6047efbed4e8d94094d66d347c36f77aa4142c/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f73657373696f6e2f76)](https://packagist.org/packages/yiisoft/session)[![Total Downloads](https://camo.githubusercontent.com/6e398323ddcae019567e5db14ccfa1823310f590e350b96dd8d0f5d28bf7d649/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f73657373696f6e2f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/session)[![Build status](https://github.com/yiisoft/session/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/session/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/95c1dcd9601478d276d0637f601dddfca5af4c04c7ef891784e83241d9eacd45/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f73657373696f6e2f67726170682f62616467652e7376673f746f6b656e3d43414430584f394a5a4d)](https://codecov.io/gh/yiisoft/session)[![Mutation testing badge](https://camo.githubusercontent.com/85a12e1c80d64f3a3b038b43647785ce88dc782236695a9cec4f102b6437d30a/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f667425324673657373696f6e2532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/session/master)[![static analysis](https://github.com/yiisoft/session/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/session/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/b3659c88c37d48ad63c967548ed76e5effd61031f91901632f09b3840cd5e39f/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f73657373696f6e2f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/session) The package implements a session service, [PSR-15](https://www.php-fig.org/psr/psr-15/) session middleware, and a flash message service which helps use one-time messages. Requirements ------------ [](#requirements) - PHP 8.0 - 8.5. Installation ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/session ``` In order to maintain a session between requests you need to add `SessionMiddleware` to your route group or application middlewares. Route group should be preferred when you have both API with token-based authentication and regular web routes in the same application. Having it this way avoids starting the session for API endpoints. ### Yii 3 configuration [](#yii-3-configuration) In order to add a session for a certain group of routes, edit `config/routes.php` like the following: ``` use Yiisoft\Router\Group; use Yiisoft\Session\SessionMiddleware; return [ Group::create('/blog') ->middleware(SessionMiddleware::class) ->routes( // ... ) ]; ``` To add a session to the whole application, edit `config/application.php` like the following: ``` return [ Yiisoft\Yii\Http\Application::class => [ '__construct()' => [ 'dispatcher' => DynamicReference::to(static function (Injector $injector) { return ($injector->make(MiddlewareDispatcher::class)) ->withMiddlewares( [ ErrorCatcher::class, SessionMiddleware::class, // get('lastAccessTime'); // get all values $sessionData = $session->all(); // set a value $session->set('lastAccessTime', time()); // check if value exists if ($session->has('lastAccessTime')) { // ... } // remove value $session->remove('lastAccessTime'); // get value and then remove it $sessionData = $session->pull('lastAccessTime'); // clear session data from runtime $session->clear(); } ``` In case you need some data to remain in session until read, such as in case with displaying a message on the next page flash messages is what you need. A flash message is a special type of data, that is available only in the current request and the next request. After that, it will be deleted automatically. `FlashInteface` usage is the following: ``` /** @var Yiisoft\Session\Flash\FlashInterface $flash */ // request 1 $flash->set('warning', 'Oh no, not again.'); // request 2 $warning = $flash->get('warning'); if ($warning !== null) { // do something with it } ``` Opening and closing session --------------------------- [](#opening-and-closing-session) ``` public function actionProfile(\Yiisoft\Session\SessionInterface $session) { // start session if it's not yet started $session->open(); // work with session // write session values and then close it $session->close(); } ``` > Note: Closing session as early as possible is a good practice since many session implementations are blocking other requests while session is open. There are two more ways to close session: ``` public function actionProfile(\Yiisoft\Session\SessionInterface $session) { // discard changes and close session $session->discard(); // destroy session completely $session->destroy(); } ``` Custom session storage ---------------------- [](#custom-session-storage) When using `Yiisoft\Session\Session` as session component, you can provide your own storage implementation: ``` $handler = new MySessionHandler(); $session = new \Yiisoft\Session\Session([], $handler); ``` Custom storage must implement `\SessionHandlerInterface`. Documentation ------------- [](#documentation) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). License ------- [](#license) The Yii Session is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). Support the project ------------------- [](#support-the-project) [![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft) Follow updates -------------- [](#follow-updates) [![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack) ### Health Score 60 — FairBetter than 99% of packages Maintenance73 Regular maintenance activity Popularity45 Moderate usage in the ecosystem Community36 Small or concentrated contributor base Maturity77 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~201 days Recently: every ~286 days Total 10 Last Release 152d ago Major Versions 1.1.0 → 2.0.02023-02-13 2.1.0 → 3.0.02025-03-04 PHP version history (4 changes)1.0.0PHP ^7.4|^8.0 2.1.0PHP ^8.0 3.0.0PHP 8.0 - 8.4 3.0.1PHP 8.0 - 8.5 ### Community Maintainers ![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe) ![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark) ![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire) ![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol) --- Top Contributors [![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (39 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (27 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (16 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (9 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (5 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (5 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (2 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (1 commits)")[![iamsaint](https://avatars.githubusercontent.com/u/1016350?v=4)](https://github.com/iamsaint "iamsaint (1 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![roxblnfk](https://avatars.githubusercontent.com/u/4152481?v=4)](https://github.com/roxblnfk "roxblnfk (1 commits)")[![thenotsoft](https://avatars.githubusercontent.com/u/44147615?v=4)](https://github.com/thenotsoft "thenotsoft (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (1 commits)")[![dood-](https://avatars.githubusercontent.com/u/10099592?v=4)](https://github.com/dood- "dood- (1 commits)") --- Tags flash-messageshacktoberfestpsr-15sessionyii3middlewarepsr-15sessionflash ### Code Quality TestsPHPUnit Static AnalysisPsalm, Rector Type Coverage Yes ### Embed Badge ![Health badge](/badges/yiisoft-session/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-session/health.svg)](https://phpackages.com/packages/yiisoft-session) ``` ### Alternatives [cakephp/authentication Authentication plugin for CakePHP 1153.6M67](/packages/cakephp-authentication)[yiisoft/yii-middleware Yii Middleware 21151.3k1](/packages/yiisoft-yii-middleware)[chubbyphp/chubbyphp-framework A minimal, highly performant middleware PSR-15 microframework built with as little complexity as possible, aimed primarily at those developers who want to understand all the vendors they use. 13544.4k4](/packages/chubbyphp-chubbyphp-framework)[yiisoft/csrf Yii CSRF Protection Library 27253.1k10](/packages/yiisoft-csrf)[yiisoft/rate-limiter Yii Rate Limiter Middleware 2965.5k](/packages/yiisoft-rate-limiter)[kafkiansky/symfony-middleware PSR-15 Middleware for symfony. 7959.6k](/packages/kafkiansky-symfony-middleware) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)