Cache.php

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2020 wemove digital solutions GmbH
 *
 * Licensed under the terms of the MIT License.
 *
 * See the LICENSE file distributed with this work for
 * additional information.
 */
namespace wcmf\lib\io;
 
/**
 * Cache defines the interface for cache implementations.
 *
 * Caches are divided into different sections, which store
 * key value pairs.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
interface Cache {
 
  /**
   * Check if a cache entry exists
   * @param $section The cache section
   * @param $key The cache key
   * @return boolean
   */
  public function exists($section, $key);
 
  /**
   * Get the date of the specified cache entry
   * @param $section The cache section
   * @param $key The cache key
   * @return DateTime or null, if not cached
   */
  public function getDate($section, $key);
 
  /**
   * Get the value of the specified cache entry
   * @param $section The cache section
   * @param $key The cache key
   * @return Mixed
   */
  public function get($section, $key);
 
  /**
   * Store the value of the specified cache entry with an optional lifetime.
   * @param $section The cache section
   * @param $key The key
   * @param $value The value
   * @param $lifetime The lifetime in seconds (optional)
   */
  public function put($section, $key, $value, $lifetime=null);
 
  /**
   * Clear the given cache section. The wildcard char '*'
   * may be added to the section name in order to
   * clear all matching sections.
   * @param $section The cache section
   */
  public function clear($section);
 
  /**
   * Clear all cache sections
   */
  public function clearAll();
}
?>