PHPackages yiisoft/cookies - 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/cookies ActiveLibrary[Framework](/categories/framework) yiisoft/cookies =============== Convenient way to use cookies with PSR-7 1.2.4(5mo ago)22333.4k—0.1%6[1 issues](https://github.com/yiisoft/cookies/issues)3BSD-3-ClausePHPPHP 7.4.\* || 8.0 - 8.5CI passing Since Dec 2Pushed 3mo ago12 watchersCompare [ Source](https://github.com/yiisoft/cookies)[ Packagist](https://packagist.org/packages/yiisoft/cookies)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-cookies/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (4)Dependencies (16)Versions (9)Used By (3) [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) Yii Cookies =========== [](#yii-cookies) [![Latest Stable Version](https://camo.githubusercontent.com/21c05b2788cf8ec586a585ae2f692d896fdf888ab2343e9d838c142d59bdf278/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f636f6f6b6965732f76)](https://packagist.org/packages/yiisoft/cookies)[![Total Downloads](https://camo.githubusercontent.com/8b754e4804047082de93db1aa5cba4989cff76651cc9054daabe3b01d7d268f9/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f636f6f6b6965732f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/cookies)[![Build status](https://github.com/yiisoft/cookies/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/cookies/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/52a9561b531636518b7718a5004e96d558c13a77c642207863e86e1c3204a5bf/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f636f6f6b6965732f67726170682f62616467652e7376673f746f6b656e3d36464f4e583933494d35)](https://codecov.io/gh/yiisoft/cookies)[![Mutation testing badge](https://camo.githubusercontent.com/287d09999c89f30156afeb801319f714893f3ad685d82e570319be9da74c78d7/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f6674253246636f6f6b6965732532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/cookies/master)[![static analysis](https://github.com/yiisoft/cookies/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/cookies/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/7ca9954d01e4e5a6564e4fd7cd7d07bf7c2047e0dd3c71c4d94c000b5f454b10/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f636f6f6b6965732f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/cookies) The package helps in working with HTTP cookies in a [PSR-7](https://www.php-fig.org/psr/psr-7/) environment: - provides a handy abstraction representing a cookie - allows dealing with many cookies at once - forms and adds `Set-Cookie` headers to response - signs a cookie to prevent its value from being tampered with - encrypts a cookie to prevent its value from being tampered with - provides [PSR-15](https://www.php-fig.org/psr/psr-15/) middleware for encrypting and signing cookie values Requirements ------------ [](#requirements) - PHP 7.4 - 8.5. Installation ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/cookies ``` General usage ------------- [](#general-usage) Adding a cookie to response: ``` $cookie = (new \Yiisoft\Cookies\Cookie('cookieName', 'value')) ->withPath('/') ->withDomain('yiiframework.com') ->withHttpOnly(true) ->withSecure(true) ->withSameSite(\Yiisoft\Cookies\Cookie::SAME_SITE_STRICT) ->withMaxAge(new \DateInterval('P7D')); $response = $cookie->addToResponse($response); ``` Modifying response cookies to be sent: ``` $cookies = \Yiisoft\Cookies\CookieCollection::fromResponse($response); $cookies->expire('login'); $response = $cookies->setToResponse($response); ``` Getting request cookies: ``` $cookies = \Yiisoft\Cookies\CookieCollection::fromArray($request->getCookieParams()); ``` Signing a cookie to prevent its value from being tampered with: ``` $cookie = new \Yiisoft\Cookies\Cookie('identity', 'identityValue'); // The secret key used to sign and validate cookies. $key = '0my1xVkjCJnD_q1yr6lUxcAdpDlTMwiU'; $signer = new \Yiisoft\Cookies\CookieSigner($key); // Prefixes unique hash based on the value of the cookie and a secret key. $signedCookie = $signer->sign($cookie); // Validates and get backs the cookie with clean value. $cookie = $signer->validate($signedCookie); // Before validation, check if the cookie is signed. if ($signer->isSigned($cookie)) { $cookie = $signer->validate($cookie); } ``` Encrypting a cookie to prevent its value from being tampered with: ``` $cookie = new \Yiisoft\Cookies\Cookie('identity', 'identityValue'); // The secret key used to sign and validate cookies. $key = '0my1xVkjCJnD_q1yr6lUxcAdpDlTMwiU'; $encryptor = new \Yiisoft\Cookies\CookieEncryptor($key); // Encrypts cookie value based on the secret key. $encryptedCookie = $encryptor->encrypt($cookie); // Validates, decrypts and get backs the cookie with clean value. $cookie = $encryptor->decrypt($encryptedCookie); // Before decryption, check if the cookie is encrypted. if ($encryptor->isEncrypted($cookie)) { $cookie = $encryptor->decrypt($cookie); } ``` Using a [PSR-15](https://www.php-fig.org/psr/psr-15/) middleware to encrypt and sign cookie values. ``` /** * @var \Psr\Http\Message\ServerRequestInterface $request * @var \Psr\Http\Server\RequestHandlerInterface $handler * @var \Psr\Log\LoggerInterface $logger */ // The secret key used to sign and validate cookies. $key = '0my1xVkjCJnD_q1yr6lUxcAdpDlTMwiU'; $signer = new \Yiisoft\Cookies\CookieSigner($key); $encryptor = new \Yiisoft\Cookies\CookieEncryptor($key); $cookiesSettings = [ 'identity' => \Yiisoft\Cookies\CookieMiddleware::ENCRYPT, 'name_[1-9]' => \Yiisoft\Cookies\CookieMiddleware::SIGN, 'prefix*' => \Yiisoft\Cookies\CookieMiddleware::SIGN, ]; $middleware = new \Yiisoft\Cookies\CookieMiddleware( $logger $encryptor, $signer, $cookiesSettings, ); // The cookie parameter values from the request are decrypted/validated. // The cookie values are encrypted/signed, and appended to the response. $response = $middleware->process($request, $handler); ``` Create cookie with raw value that will not be encoded: ``` $cookie = (new \Yiisoft\Cookies\Cookie('cookieName')) ->withRawValue('ebaKUq90PhiHck_MR7st-E1SxhbYWiTsLo82mCTbNuAh7rgflx5LVsYfJJseyQCrODuVcJkTSYhm1WKte-l5lQ==') ``` 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 Cookies 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 Maintenance75 Regular maintenance activity Popularity46 Moderate usage in the ecosystem Community32 Small or concentrated contributor base Maturity76 Established project with proven stability Bus Factor3 3 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 ~305 days Recently: every ~415 days Total 7 Last Release 161d ago PHP version history (3 changes)1.0.0PHP ^7.4|^8.0 1.2.3PHP ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0 1.2.4PHP 7.4.\* || 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 [![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (22 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (19 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (11 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (6 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (6 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (3 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (3 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (2 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (2 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (2 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (1 commits)")[![roxblnfk](https://avatars.githubusercontent.com/u/4152481?v=4)](https://github.com/roxblnfk "roxblnfk (1 commits)")[![rossaddison](https://avatars.githubusercontent.com/u/8538339?v=4)](https://github.com/rossaddison "rossaddison (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)") --- Tags cookiecookieshacktoberfestpsr-15yii3psr-7cookiescookie ### Code Quality TestsPHPUnit Static AnalysisRector ### Embed Badge ![Health badge](/badges/yiisoft-cookies/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-cookies/health.svg)](https://phpackages.com/packages/yiisoft-cookies) ``` ### Alternatives [cakephp/cakephp The CakePHP framework 8.8k18.5M1.6k](/packages/cakephp-cakephp)[yiisoft/yii-middleware Yii Middleware 21151.3k1](/packages/yiisoft-yii-middleware)[neos/flow Flow Application Framework 862.0M451](/packages/neos-flow)[cakephp/authentication Authentication plugin for CakePHP 1153.6M67](/packages/cakephp-authentication)[cakephp/authorization Authorization abstraction layer plugin for CakePHP 742.2M34](/packages/cakephp-authorization)[phpro/http-tools HTTP tools for developing more consistent HTTP implementations. 28137.8k](/packages/phpro-http-tools) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)