nextcloud/lib/public/icache.php

75 lines
1.8 KiB
PHP
Raw Normal View History

<?php
/**
* ownCloud
*
* @author Thomas Tanghus
* @copyright 2013 Thomas Tanghus thomas@tanghus.net
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* Public interface of ownCloud for apps to use.
* Cache interface
*
*/
2013-11-03 16:38:25 +04:00
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
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
2013-09-19 00:22:51 +04:00
* @param string $prefix (optional)
* @return bool
*/
public function clear($prefix = '');
}