phpfastcache/phpfastcache-bundle

Phpfastcache Bundle for Symfony integration

Sunday, May 27, 2018
by khoaofgod
Repository
3 Watchers
15 Stars
5,710 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
29 Versions
26 % Grown

The README.md

, _(*1)

Symfony Flex PhpFastCache Bundle

:warning: Please note that the V3 is a major (BC breaking) update of the PhpFastCache Bundle !

As of the V3 the bundle is absolutely not compatible with previous versions.\ To ensure you the smoothest migration possible, please check the migration guide in the Resources/Docs directory.\ One of the biggest change is the Phpfastcache's dependency which is not set to the v7 which it not backward compatible at all., _(*2)

:thumbsup: Step 1: Include phpFastCache Bundle in your project with composer:

composer require phpfastcache/phpfastcache-bundle

:construction: Step 2: Setup your `config/packages/phpfastcache.yaml` to configure your cache(s) instance(s)

# PhpFastCache configuration
phpfastcache:
    twig_driver: "filecache" # This option must be a valid declared driver, in our example: "filecache"
    twig_block_debug: false # This option will wrap CACHE/ENDCACHE blocks with block debug as HTML comment
    drivers:
        filecache:
            type: Files
            parameters:
                path: "%kernel.cache_dir%/phpfastcache/"

This step can be skipped using Symfony recipes.

:rocket: Step 3: Accelerate your app by making use of PhpFastCache service

Caching data in your controller:, _(*3)

public function indexAction(Request $request, Phpfastcache $phpfastcache)
{
    $cache = $phpfastcache->get('filecache');
    $item = $cache->getItem('myAppData');

    if (!$item->isHit() || $item->get() === null) {
        $item->set('Wy app has now superpowers !!')->expiresAfter(3600);//1 hour
        $cache->save($item);
    } 

    // replace this example code with whatever you need
    return $this->render('default/index.html.twig', [
        'myAppData' => $item->get(),
        'base_dir' => realpath($this->getParameter('kernel.root_dir').'/..'),
    ]);
}

Or in your template:, _(*4)

<div>
    {#
     * 'myrandom6' Is your cache key identifier, must be unique
     * 300 Is the time to live (TTL) before the cache expires and get regenerated
    #}
    {% cache 'myrandom6' 300 %}
        <textarea>
            <!-- Some heavy stuff like Doctrine Lazy Entities -->
            {% for i in 1..1000 %}{{ random() }}{% endfor %}
        </textarea>
    {% endcache %}
</div>

:computer: CLI command interactions

As of the V3, some command-line tools were introduced, mostly for CRUD-like operations., _(*5)

GET operation

php bin/console phpfastcache:get filecache cacheKey

This will display the content of a cache item if it eventually exists., _(*6)

SET operation

php bin/console phpfastcache:get filecache cacheKey '{"a": 14}' 300 -a 1

This will set the content of a cache item.\ The TTL (300), in seconds, is optional and take the default value filled in your configuration file.\ The auto-type-cast option "-a"_ (enabled by default) will let allows you to automatically type cast your variable: - false and true will be respectively converted to _boolean. - 1337 and 1337.666 will be respectively be converted to integer or float. - null will be converted to null. - {"a": 14} will be converted to an associative array using a JSON detection - a regular string will remains unchanged and stays a string, _(*7)

You can obviously disable this behavior by turning off the auto-type-cast option: -a 0, _(*8)

DELETE operation

php bin/console phpfastcache:del filecache cacheKey

This will delete the specified cache item., _(*9)

CLEAR operation

php bin/console phpfastcache:clear filecache
# OR to clear every caches:
php bin/console phpfastcache:clear

This will clear a single cache instance if specified or all the configured cache instances otherwise., _(*10)

:bulb: Introducing Cacheable Responses (V3 only)

As of the V3 there's a new, easier and cleaner way to setup HTTP cache to decrease your server bandwidth along with your CPU load: Cacheable Responses. And it's pretty easy to implement:, _(*11)

    /**
     * @Route("/cached", name="cached")
     */
    public function cachedAction(Phpfastcache $phpfastcache, Request $request): Response
    {
        return (new CacheableResponse($phpfastcache->get('filecache'), $request))->getResponse('cache_key', 3600, function () {
            return new Response('Random bytes: ' . \random_bytes(255));
        });
    }

CacheableResponse is provided by \Phpfastcache\Bundle\Response\CacheableResponse. This class will handle responses headers (cache-control, etag, etc...) and http status (304 Not modified)., _(*12)

:boom: phpFastCache Bundle support

Found an issue or had an idea ? Come here here and let us know !, _(*13)

The Versions

27/05 2018

dev-master

9999999-dev http://www.phpfastcache.com

Phpfastcache Bundle for Symfony integration

symfony-bundle phpfastcache-bundle

Phpfastcache Bundle for Symfony integration

phpfastcache/phpfastcache-bundle

The README.md

Symfony Flex PhpFastCache Bundle

:warning: Please note that the V3 is a major (BC breaking) update of the PhpFastCache Bundle !

:thumbsup: Step 1: Include phpFastCache Bundle in your project with composer:

:construction: Step 2: Setup your config/packages/phpfastcache.yaml to configure your cache(s) instance(s)

:rocket: Step 3: Accelerate your app by making use of PhpFastCache service

:computer: CLI command interactions

GET operation

SET operation

DELETE operation

CLEAR operation

:bulb: Introducing Cacheable Responses (V3 only)

:boom: phpFastCache Bundle support

The Versions

dev-master

The Requires

The Development Requires

by Khoa Bui

by Georges.L

by PastisD

3.0.0

The Requires

The Development Requires

by Khoa Bui

by Georges.L

by PastisD

3.x-dev

The Requires

The Development Requires

by Khoa Bui

by Georges.L

by PastisD

3.0.0-rc

The Requires

The Development Requires

by Khoa Bui

by Georges.L

by PastisD

3.0.0-beta

The Requires

The Development Requires

by Khoa Bui

by Georges.L

by PastisD

3.0.0-alpha3

The Requires

by Khoa Bui

by Georges.L

by PastisD

3.0.0-alpha2

The Requires

by Khoa Bui

by Georges.L

by PastisD

3.0.0-alpha

The Requires

by Khoa Bui

by Georges.L

by PastisD

2.x-dev

The Requires

by Khoa Bui

by Georges.L

by PastisD

2.0.3

The Requires

by Khoa Bui

by Georges.L

by PastisD

1.x-dev

The Requires

by Khoa Bui

by Georges.L

by PastisD

1.0.5

The Requires

by Khoa Bui

:construction: Step 2: Setup your `config/packages/phpfastcache.yaml` to configure your cache(s) instance(s)