The CaptureCache pattern is useful to auto-generate static resources in base of a HTTP request. The Webserver needs to be configured to run a PHP script generating the requested resource so further requests for the same resource can be shipped without calling PHP again.
It comes with basic logic to manage generated resources.
Simplest usage as Apache-404 handler
1 2 | # .htdocs
ErrorDocument 404 /index.php
|
1 2 3 4 5 6 7 8 9 10 11 12 | // index.php
use Zend\Cache\PatternFactory; $capture = Zend\Cache\PatternFactory::factory('capture', array(
'public_dir' => __DIR__,
));
// Start capturing all output excl. headers and write to public directory
$capture->start();
// Don't forget to change HTTP response code
header('Status: 200', true, 200);
// do stuff to dynamically generate output
|
Option | Data Type | Default Value | Description |
---|---|---|---|
public_dir | string | <none> | Location of public directory to write output to |
index_filename | string | “index.html” | The name of the first file if only a directory was requested |
file_locking | boolean | true | Locking output files on writing |
file_permission | integer boolean | 0600 (false on win) | Set permissions of generated output files |
dir_permission | integer boolean | 0700 (false on win) | Set permissions of generated output directories |
umask | integer boolean | false | Using umask on generationg output files / directories |
start(string|null $pageId = null)
Start capturing output
Returns void
set(string $content, string|null $pageId = null)
Write content to page identity
Returns void
get(string|null $pageId = null)
Get content of an already cached page
Returns string|false
has(string|null $pageId = null)
Check if a page has been created
Returns boolean
remove(string|null $pageId = null)
Remove a page
Returns boolean
clearByGlob(string $pattern = '**')
Clear pages matching glob pattern
Returns void
setOptions(Zend\Cache\Pattern\PatternOptions $options)
Set pattern options
Returns Zend\Cache\Pattern\OutputCache
getOptions()
Get all pattern options
Returns PatternOptions instance.
Scaling images in base of request
1 2 | # .htdocs
ErrorDocument 404 /index.php
|
1 2 3 4 5 6 | // index.php
$captureCache = Zend\Cache\PatternFactory::factory('capture', array(
'public_dir' => __DIR__,
));
// TODO
|
The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.