8ba817478b
* [BridgeAbstract] Implement customizable cache timeout The customizable cache timeout is used instead of the default cache timeout (CACHE_TIMEOUT) if specified by the caller. * [index] Add new global parameter '_cache_timeout' The _cache_timeout parameter is an optional parameter that can be used to specify a custom cache timeout. This option is enabled by default. It can be disabled using the named constant 'CUSTOM_CACHE_TIMEOUT' which supports two states: > true: Enabled (default) > false: Disabled * [BridgeAbstract] Change scope of 'getCacheTimeout' to public * [html] Add cache timeout parameter to all bridges The timeout parameter only shows if CUSTOM_CACHE_TIMEOUT has been set to true. The default value is automatically set to the value specified in the bridge. * [index] Disable custom cache timeout by default
87 lines
1.6 KiB
PHP
87 lines
1.6 KiB
PHP
<?php
|
|
interface BridgeInterface {
|
|
|
|
/**
|
|
* Collects data from the site
|
|
*/
|
|
public function collectData();
|
|
|
|
/**
|
|
* Returns an array of cachable elements
|
|
*
|
|
* @return array Associative array of cachable elements
|
|
*/
|
|
public function getCachable();
|
|
|
|
/**
|
|
* Returns the description
|
|
*
|
|
* @return string Description
|
|
*/
|
|
public function getDescription();
|
|
|
|
/**
|
|
* Return an array of extra information
|
|
*
|
|
* @return array Associative array of extra information
|
|
*/
|
|
public function getExtraInfos();
|
|
|
|
/**
|
|
* Returns an array of collected items
|
|
*
|
|
* @return array Associative array of items
|
|
*/
|
|
public function getItems();
|
|
|
|
/**
|
|
* Returns the bridge maintainer
|
|
*
|
|
* @return string Bridge maintainer
|
|
*/
|
|
public function getMaintainer();
|
|
|
|
/**
|
|
* Returns the bridge name
|
|
*
|
|
* @return string Bridge name
|
|
*/
|
|
public function getName();
|
|
|
|
/**
|
|
* Returns the bridge parameters
|
|
*
|
|
* @return array Bridge parameters
|
|
*/
|
|
public function getParameters();
|
|
|
|
/**
|
|
* Returns the bridge URI
|
|
*
|
|
* @return string Bridge URI
|
|
*/
|
|
public function getURI();
|
|
|
|
/**
|
|
* Sets the cache instance
|
|
*
|
|
* @param object CacheInterface The cache instance
|
|
*/
|
|
public function setCache(\CacheInterface $cache);
|
|
|
|
/**
|
|
* Sets the timeout for clearing the cache files. The timeout must be
|
|
* specified between 1..86400 seconds (max. 24 hours). The default timeout
|
|
* (specified by the bridge maintainer) applies for invalid values.
|
|
*
|
|
* @param int $timeout The cache timeout in seconds
|
|
*/
|
|
public function setCacheTimeout($timeout);
|
|
|
|
/**
|
|
* Returns the cache timeout
|
|
*
|
|
* @return int Cache timeout
|
|
*/
|
|
public function getCacheTimeout();
|
|
}
|