[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Dummy object caching.
   4   *
   5   * This program is free software; you can redistribute it and/or modify
   6   * it under the terms of the GNU General Public License as published by
   7   * the Free Software Foundation; either version 2 of the License, or
   8   * (at your option) any later version.
   9   *
  10   * This program is distributed in the hope that it will be useful,
  11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13   * GNU General Public License for more details.
  14   *
  15   * You should have received a copy of the GNU General Public License along
  16   * with this program; if not, write to the Free Software Foundation, Inc.,
  17   * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18   * http://www.gnu.org/copyleft/gpl.html
  19   *
  20   * @file
  21   * @ingroup Cache
  22   */
  23  
  24  /**
  25   * A BagOStuff object with no objects in it. Used to provide a no-op object to calling code.
  26   *
  27   * @ingroup Cache
  28   */
  29  class EmptyBagOStuff extends BagOStuff {
  30  
  31      /**
  32       * @param string $key
  33       * @param mixed $casToken [optional]
  34       * @return bool
  35       */
  36  	function get( $key, &$casToken = null ) {
  37          return false;
  38      }
  39  
  40      /**
  41       * @param string $key
  42       * @param mixed $value
  43       * @param int $exp
  44       * @return bool
  45       */
  46  	function set( $key, $value, $exp = 0 ) {
  47          return true;
  48      }
  49  
  50      /**
  51       * @param mixed $casToken
  52       * @param string $key
  53       * @param mixed $value
  54       * @param int $exp
  55       * @return bool
  56       */
  57  	function cas( $casToken, $key, $value, $exp = 0 ) {
  58          return true;
  59      }
  60  
  61      /**
  62       * @param string $key
  63       * @param int $time
  64       * @return bool
  65       */
  66  	function delete( $key, $time = 0 ) {
  67          return true;
  68      }
  69  
  70      /**
  71       * @param string $key
  72       * @param Closure $callback Callback method to be executed
  73       * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
  74       * @param int $attempts The amount of times to attempt a merge in case of failure
  75       * @return bool Success
  76       */
  77  	public function merge( $key, Closure $callback, $exptime = 0, $attempts = 10 ) {
  78          return true;
  79      }
  80  }