Andrew Nicols
83 lines
2.9 KiB
PHP
83 lines
2.9 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle 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 General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
namespace core_cache;
|
|
|
|
/**
|
|
* Cache store interface.
|
|
*
|
|
* This interface defines the static methods that must be implemented by every cache store plugin.
|
|
* To ensure plugins implement this class the abstract store class implements this interface.
|
|
*
|
|
* @package core_cache
|
|
* @category cache
|
|
* @copyright 2012 Sam Hemelryk
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
interface store_interface {
|
|
/**
|
|
* Static method to check if the store requirements are met.
|
|
*
|
|
* @return bool True if the stores software/hardware requirements have been met and it can be used. False otherwise.
|
|
*/
|
|
public static function are_requirements_met();
|
|
|
|
/**
|
|
* Static method to check if a store is usable with the given mode.
|
|
*
|
|
* @param int $mode One of store::MODE_*
|
|
*/
|
|
public static function is_supported_mode($mode);
|
|
|
|
/**
|
|
* Returns the supported features as a binary flag.
|
|
*
|
|
* @param array $configuration The configuration of a store to consider specifically.
|
|
* @return int The supported features.
|
|
*/
|
|
public static function get_supported_features(array $configuration = []);
|
|
|
|
/**
|
|
* Returns the supported modes as a binary flag.
|
|
*
|
|
* @param array $configuration The configuration of a store to consider specifically.
|
|
* @return int The supported modes.
|
|
*/
|
|
public static function get_supported_modes(array $configuration = []);
|
|
|
|
/**
|
|
* Generates an instance of the cache store that can be used for testing.
|
|
*
|
|
* Returns an instance of the cache store, or false if one cannot be created.
|
|
*
|
|
* @param definition $definition
|
|
* @return store_interface|false
|
|
*/
|
|
public static function initialise_test_instance(definition $definition);
|
|
|
|
/**
|
|
* Generates the appropriate configuration required for unit testing.
|
|
*
|
|
* @return array Array of unit test configuration data to be used by initialise().
|
|
*/
|
|
public static function unit_test_configuration();
|
|
}
|
|
|
|
// Alias this class to the old name.
|
|
// This file will be autoloaded by the legacyclasses autoload system.
|
|
// In future all uses of this class will be corrected and the legacy references will be removed.
|
|
class_alias(store_interface::class, \cache_store_interface::class);
|