knplabs/php-valid

A HTTP cache validation toolkit

php-valid

What

A php 5.3+ library to help manage HTTP/1.1 cache validation headers, using the symfony/HttpFoundation layer., _(*1)

Why

Because there is no known library that provides a clean, decoupled way to manage them. The actual docs just shows dirty controller examples., _(*2)

How

By observing requests and asking Rule instances if response has changed since last time client asked, either using If-Modified-Since or ETag headers., _(*3)

Install

``` shell, <sub>(*4)</sub>

composer require "knplabs/valid=~0.1@dev", <sub>(*5)</sub>

## Use

``` php

<?php

class CustomRule implements Knp\Valid\Rule\LastModified, Knp\Valid\Rule\ETag
{
    public function supports(Request $request)
    {
        return true;
    }

    public function getETag(Request $request)
    {
        return 'something';
    }

    public function getLastModified(Request $request)
    {
        return new \DateTime;
    }
}

$kernel = new AppCache(
    new Knp\Valid\Kernel(
        new AppKernel('prod', false),
        new Knp\Valid\ResponseManipulator(array(
            new Knp\Valid\Doctrine\ListenerRule,
            new CustomRule,
        ))
    )
);

$kernel->handle(Request::createFromGlobals())->send();

Contribute

``` shell, <sub>(*6)</sub>

composer install --dev --prefer-dist, <sub>(*7)</sub>

vim features/**/*.feature behat phpspec desc Knp\Valid* phpspec run, <sub>(*8)</sub>

```, <sub>(*9)</sub>