server/lib/public/icache.php
Morris Jobke 30f4d91d01 Public API documentation fixes
refs #4883

 * http/response.php
 * config.php
 * response.php
 * files.php
 * idbconnection.php
 * app.php
 * user.php
 * template.php
 * share.php
 * db.php
 * icache.php & il10n.php
2013-10-17 00:49:15 +02:00

51 lines
1 KiB
PHP

<?php
/**
* Copyright (c) 2013 Thomas Tanghus (thomas@tanghus.net)
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OCP;
/**
* This interface defines method for accessing the file based user cache.
*/
interface ICache {
/**
* Get a value from the user cache
* @param string $key
* @return mixed
*/
public function get($key);
/**
* Set a value in the user cache
* @param string $key
* @param mixed $value
* @param int $ttl Time To Live in seconds. Defaults to 60*60*24
* @return bool
*/
public function set($key, $value, $ttl = 0);
/**
* Check if a value is set in the user cache
* @param string $key
* @return bool
*/
public function hasKey($key);
/**
* Remove an item from the user cache
* @param string $key
* @return bool
*/
public function remove($key);
/**
* Clear the user cache of all entries starting with a prefix
* @param string $prefix (optional)
* @return bool
*/
public function clear($prefix = '');
}