vendor/zendframework/zend-cache/src/Pattern/OutputCache.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Cache\Pattern;
  11
  12 use Zend\Cache\Exception;
  13
  14 class OutputCache extends AbstractPattern
  15 {
  16     /**
  17      * The key stack
  18      *
  19      * @var array
  20      */
  21     protected $keyStack = [];
  22
  23     /**
  24      * Set options
  25      *
  26      * @param  PatternOptions $options
  27      * @return OutputCache Provides a fluent interface
  28      * @throws Exception\InvalidArgumentException
  29      */
  30     public function setOptions(PatternOptions $options)
  31     {
  32         parent::setOptions($options);
  33
  34         if (! $options->getStorage()) {
  35             throw new Exception\InvalidArgumentException("Missing option 'storage'");
  36         }
  37
  38         return $this;
  39     }
  40
  41     /**
  42      * if there is a cached item with the given key display it's data and return true
  43      * else start buffering output until end() is called or the script ends.
  44      *
  45      * @param  string  $key Key
  46      * @throws Exception\MissingKeyException if key is missing
  47      * @return bool
  48      */
  49     public function start($key)
  50     {
  51         if (($key = (string) $key) === '') {
  52             throw new Exception\MissingKeyException('Missing key to read/write output from cache');
  53         }
  54
  55         $success = null;
  56         $data    = $this->getOptions()->getStorage()->getItem($key, $success);
  57         if ($success) {
  58             echo $data;
  59             return true;
  60         }
  61
  62         ob_start();
  63         ob_implicit_flush(0);
  64         $this->keyStack[] = $key;
  65         return false;
  66     }
  67
  68     /**
  69      * Stops buffering output, write buffered data to cache using the given key on start()
  70      * and displays the buffer.
  71      *
  72      * @throws Exception\RuntimeException if output cache not started or buffering not active
  73      * @return bool TRUE on success, FALSE on failure writing to cache
  74      */
  75     public function end()
  76     {
  77         $key = array_pop($this->keyStack);
  78         if ($key === null) {
  79             throw new Exception\RuntimeException('Output cache not started');
  80         }
  81
  82         $output = ob_get_flush();
  83         if ($output === false) {
  84             throw new Exception\RuntimeException('Output buffering not active');
  85         }
  86
  87         return $this->getOptions()->getStorage()->setItem($key, $output);
  88     }
  89 }