<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Cache\Pattern;
use Zend\Cache\Exception;
class OutputCache extends AbstractPattern
{
/**
* The key stack
*
* @var array
*/
protected $keyStack = array();
/**
* Set options
*
* @param PatternOptions $options
* @return OutputCache
* @throws Exception\InvalidArgumentException
*/
public function setOptions(PatternOptions $options)
{
parent::setOptions($options);
if (!$options->getStorage()) {
throw new Exception\InvalidArgumentException("Missing option 'storage'");
}
return $this;
}
/**
* if there is a cached item with the given key display it's data and return true
* else start buffering output until end() is called or the script ends.
*
* @param string $key Key
* @throws Exception\MissingKeyException if key is missing
* @return bool
*/
public function start($key)
{
if (($key = (string) $key) === '') {
throw new Exception\MissingKeyException('Missing key to read/write output from cache');
}
$success = null;
$data = $this->getOptions()->getStorage()->getItem($key, $success);
if ($success) {
echo $data;
return true;
}
ob_start();
ob_implicit_flush(false);
$this->keyStack[] = $key;
return false;
}
/**
* Stops buffering output, write buffered data to cache using the given key on start()
* and displays the buffer.
*
* @throws Exception\RuntimeException if output cache not started or buffering not active
* @return bool TRUE on success, FALSE on failure writing to cache
*/
public function end()
{
$key = array_pop($this->keyStack);
if ($key === null) {
throw new Exception\RuntimeException('Output cache not started');
}
$output = ob_get_flush();
if ($output === false) {
throw new Exception\RuntimeException('Output buffering not active');
}
return $this->getOptions()->getStorage()->setItem($key, $output);
}
}