pollen-solutions/cookie

Pollen Solutions - Cookie Component - HTTP Request cookie manager

v1.0.0 2021-08-13 00:00 UTC

Requires

• php: ^7.4 || ^8.0
• pollen-solutions/encryption: ^1.0
• pollen-solutions/http: ^1.0
• pollen-solutions/support: ^1.0
• pollen-solutions/validation: ^1.0

Requires (Dev)

• phpunit/phpunit: ^9.0
• roave/security-advisories: dev-latest

Suggests

• pollen-solutions/container: Pollen Solutions - Container Component - PSR-11 ready Dependencies Injection Container.
• pollen-solutions/routing: Pollen Solutions - Routing Component - HTTP request mapping and HTTP response resolution.

MIT

• Jordy Manner

• component
• cookie
• pollen-solutions

README

Pollen Solutions Cookie Component is HTTP Request cookie manager.

Installation

composer require pollen-solutions/cookie

Basic Usage

use Pollen\Cookie\CookieJar;

$cookieJar = new CookieJar();

$cookieJar->make('cookie.test.1', ['value' => 'test1']);
$cookieJar->make(
    'cookie.test.2',
    [
        'name'      => 'cookie_test_2',
        'salt'      => '_' . md5('cookie.test.2.salt'),
        'value'     => [
            'test2-value1',
            'test2-value2'
        ],
        'encrypted' => true,
        'prefix'    => 'testprefix_',
        'lifetime'  => 3600,
        //'path'      => 'site-base_path',
        //'domain'    => 'site-domaine.ltd',
        'secure'    => false,
        'httpOnly'  => false,
        'raw'       => true,
        'sameSite'  => 'strict',
    ]
);

// Get the cookie instances.
$cookie1 = $cookieJar->get('cookie.test.1');
$cookie2 = $cookieJar->get('cookie.test.2');

var_dump((string)$cookie1);
var_dump((string)$cookie2);
exit;

Send Cookie

PSR-7 environnement

use Laminas\Diactoros\Response;
use Laminas\HttpHandlerRunner\Emitter\SapiEmitter;

/** @var \Pollen\Cookie\CookieJarInterface $cookieJar */
$cookie = $cookieJar->make('cookie.test', ['value' => 'test']);

$response = new Response();
$response = $response->withAddedHeader('Set-Cookie', (string)$cookie);
(new SapiEmitter())->emit($response);
exit;

Pollen Solutions Http environnement

use Pollen\Http\Response as HttpResponse;

/** @var \Pollen\Cookie\CookieJarInterface $cookieJar */
$cookie = $cookieJar->make('cookie.test', ['value' => 'test']);

$httpResponse = new HttpResponse();
$httpResponse->headers->setCookie($cookie);
$httpResponse->send();

Get HTTP Request cookie value

use Pollen\Cookie\CookieInterface;
use Pollen\Http\Request as HttpRequest;

// In this example, we consider :
// - Global $cookieJar as an implemented instance of CookieJar.
// - An HTTP Response was already sent with cookie1 and cookie2. @see "Send Cookie" above.

/** @var \Pollen\Cookie\CookieJarInterface $cookieJar */
$cookie1 = $cookieJar->get('cookie1');
$cookie1 = $cookieJar->get('cookie2');

$httpValue1 = $cookie1->httpValue();
$httpValue2 = $cookie2->httpValue(HttpRequest::createFromGlobals());

var_dump($httpValue1, $httpValue2);

Check HTTP Request cookie value

use Pollen\Http\Request as HttpRequest;

// In this example, we consider :
// - Global $cookieJar as an implemented instance of CookieJar.
// - An HTTP Response was already sent with cookie.test with the value 'test'. @see "Send Cookie" above.

/** @var \Pollen\Cookie\CookieJarInterface $cookieJar */
$cookie = $cookieJar->make('cookie.test', ['value' => 'test']);

var_dump($cookie->checkRequestValue());

Queued Cookie and QueuedCookiesMiddleware (Pollen Routing example)

use Pollen\Cookie\CookieJar;
use Pollen\Cookie\Middleware\QueuedCookiesMiddleware;
use Pollen\Http\Request;
use Pollen\Http\Response;
use Pollen\Http\ResponseInterface;
use Pollen\Routing\Router;

// Create the Request object
$request = Request::createFromGlobals();

// CookieJar instantiation
$cookieJar = (new CookieJar())->setDefaults($request->getBasePath());

// CookieJar hydratation
$cookie = $cookieJar->make('cookie.test', ['value' => 'test2'])->queue();

// Router instantiation
$router = new Router();

// Setting QueuedCookiesMiddleware
$router->middleware(new QueuedCookiesMiddleware($cookieJar));

// Map a route
$router->map('GET', '/', function (): ResponseInterface {
    return new Response('<h1>Hello, World!</h1>');
});

// Catch HTTP Response
$response = $router->handleRequest($request);

// Send the response to the browser
$router->sendResponse($response);

// Trigger the terminate event
$router->terminateEvent($request, $response);