1
0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-06-23 11:24:05 +02:00

core: Improve documentation and style for BridgeAbstract and BridgeInterface

Public functions defined in BridgeAbstract also belong to BridgeInterface

getInput may only be used by this class or its children.
This commit is contained in:
logmanoriginal
2017-02-13 19:26:39 +01:00
parent 761c66d813
commit c44fb25845
2 changed files with 83 additions and 8 deletions

View File

@ -1,6 +1,50 @@
<?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();
/**
* 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 name
*
* @return string Bridge name
*/
public function getName();
/**
* 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);
}