vendor/contao/core-bundle/src/Resources/contao/library/Contao/Cache.php line 13

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Contao.
  5.  *
  6.  * (c) Leo Feyer
  7.  *
  8.  * @license LGPL-3.0-or-later
  9.  */
  11. namespace Contao;
  13. trigger_deprecation('contao/core-bundle', '4.13', 'Using the Cache library is deprecated and will no longer work in Contao 5.0. Use your own in-memory cache instead.');
  15. /**
  16.  * A static class to store non-persistent data
  17.  *
  18.  * The class functions as a global cache container where you can store data
  19.  * that is reused by the application. The cache content is not persisted, so
  20.  * once the process is completed, the data is gone.
  21.  *
  22.  * Usage:
  23.  *
  24.  *     public function getResult()
  25.  *     {
  26.  *         if (!Cache::has('result'))
  27.  *         {
  28.  *             Cache::set('result') = $this->complexMethod();
  29.  *         }
  30.  *         return Cache::get('result');
  31.  *     }
  32.  *
  33.  * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0;
  34.  *             use your own in-memory cache instead
  35.  */
  36. class Cache
  37. {
  38.     /**
  39.      * Object instance (Singleton)
  40.      * @var Cache
  41.      */
  42.     protected static $objInstance;
  44.     /**
  45.      * The cache data
  46.      * @var array
  47.      */
  48.     protected static $arrData = array();
  50.     /**
  51.      * Check whether a key is set
  52.      *
  53.      * @param string $strKey The cache key
  54.      *
  55.      * @return boolean True if the key is set
  56.      */
  57.     public static function has($strKey)
  58.     {
  59.         return isset(static::$arrData[$strKey]);
  60.     }
  62.     /**
  63.      * Return a cache entry
  64.      *
  65.      * @param string $strKey The cache key
  66.      *
  67.      * @return mixed The cached data
  68.      */
  69.     public static function get($strKey)
  70.     {
  71.         return static::$arrData[$strKey];
  72.     }
  74.     /**
  75.      * Add a cache entry
  76.      *
  77.      * @param string $strKey   The cache key
  78.      * @param mixed  $varValue The data to be cached
  79.      */
  80.     public static function set($strKey, $varValue)
  81.     {
  82.         static::$arrData[$strKey] = $varValue;
  83.     }
  85.     /**
  86.      * Remove a cache entry
  87.      *
  88.      * @param string $strKey The cache key
  89.      */
  90.     public static function remove($strKey)
  91.     {
  92.         unset(static::$arrData[$strKey]);
  93.     }
  95.     /**
  96.      * Prevent direct instantiation (Singleton)
  97.      *
  98.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  99.      *             The Cache class is now static.
  100.      */
  101.     protected function __construct()
  102.     {
  103.     }
  105.     /**
  106.      * Prevent cloning of the object (Singleton)
  107.      *
  108.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  109.      *             The Cache class is now static.
  110.      */
  111.     final public function __clone()
  112.     {
  113.     }
  115.     /**
  116.      * Check whether a key is set
  117.      *
  118.      * @param string $strKey The cache key
  119.      *
  120.      * @return boolean True if the key is set
  121.      *
  122.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  123.      *             Use Cache::has() instead.
  124.      */
  125.     public function __isset($strKey)
  126.     {
  127.         return static::has($strKey);
  128.     }
  130.     /**
  131.      * Return a cache entry
  132.      *
  133.      * @param string $strKey The cache key
  134.      *
  135.      * @return mixed|null The cached data
  136.      *
  137.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  138.      *             Use Cache::get() instead.
  139.      */
  140.     public function __get($strKey)
  141.     {
  142.         if (static::has($strKey))
  143.         {
  144.             return static::get($strKey);
  145.         }
  147.         return null;
  148.     }
  150.     /**
  151.      * Add a cache entry
  152.      *
  153.      * @param string $strKey   The cache key
  154.      * @param mixed  $varValue The data to be stored
  155.      *
  156.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  157.      *             Use Cache::set() instead.
  158.      */
  159.     public function __set($strKey, $varValue)
  160.     {
  161.         static::set($strKey, $varValue);
  162.     }
  164.     /**
  165.      * Remove a cache entry
  166.      *
  167.      * @param string $strKey The cache key
  168.      *
  169.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  170.      *             Use Cache::remove() instead.
  171.      */
  172.     public function __unset($strKey)
  173.     {
  174.         static::remove($strKey);
  175.     }
  177.     /**
  178.      * Instantiate the cache object (Factory)
  179.      *
  180.      * @return Cache The object instance
  181.      *
  182.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  183.      *             The Cache class is now static.
  184.      */
  185.     public static function getInstance()
  186.     {
  187.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Cache::getInstance()" has been deprecated and will no longer work in Contao 5.0. The "Contao\Cache" class is now static.');
  189.         if (static::$objInstance === null)
  190.         {
  191.             static::$objInstance = new static();
  192.         }
  194.         return static::$objInstance;
  195.     }
  196. }
  198. class_alias(Cache::class, 'Cache');