mirror/RSS-Bridge.rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-06-25 22:58:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

core: Improve documentation and style for BridgeAbstract and BridgeInterface

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

47
lib/BridgeAbstract.php
View file

@ -20,7 +20,10 @@ abstract class BridgeAbstract implements BridgeInterface {
* @return mixed
*/
public function getCachable(){
return array("items" => $this->getItems(), "extraInfos" => $this->getExtraInfos());
return array(
'items' => $this->getItems(),
'extraInfos' => $this->getExtraInfos()
);
}
/**
@ -31,7 +34,13 @@ abstract class BridgeAbstract implements BridgeInterface {
return $this->items;
}
/**
* Sets the input values for a given context. Existing values are
* overwritten.
*
* @param array $inputs Associative array of inputs
* @param string $context The context name
*/
protected function setInputs(array $inputs, $queriedContext){
// Import and assign all inputs to their context
foreach($inputs as $name => $value){
@ -89,7 +98,7 @@ abstract class BridgeAbstract implements BridgeInterface {
foreach(static::PARAMETERS['global'] as $name => $properties){
if(isset($inputs[$name])){
$value = $inputs[$name];
} elseif (isset($properties['value'])){
} elseif(isset($properties['value'])){
$value = $properties['value'];
} else {
continue;
@ -106,10 +115,20 @@ abstract class BridgeAbstract implements BridgeInterface {
}
}
/**
* Returns the name of the context matching the provided inputs
*
* @param array $inputs Associative array of inputs
* @return mixed Returns the context name or null if no match was found
*/
protected function getQueriedContext(array $inputs){
$queriedContexts = array();
// Detect matching context
foreach(static::PARAMETERS as $context => $set){
$queriedContexts[$context] = null;
// Check if all parameters of the context are satisfied
foreach($set as $id => $properties){
if(isset($inputs[$id]) && !empty($inputs[$id])){
$queriedContexts[$context] = true;
@ -119,8 +138,10 @@ abstract class BridgeAbstract implements BridgeInterface {
break;
}
}
}
// Abort if one of the globally required parameters is not satisfied
if(array_key_exists('global', static::PARAMETERS)
&& $queriedContexts['global'] === false){
return null;
@ -128,14 +149,15 @@ abstract class BridgeAbstract implements BridgeInterface {
unset($queriedContexts['global']);
switch(array_sum($queriedContexts)){
case 0:
case 0: // Found no match, is there a context without parameters?
foreach($queriedContexts as $context => $queried){
if (is_null($queried)){
if(is_null($queried)){
return $context;
}
}
return null;
case 1: return array_search(true, $queriedContexts);
case 1: // Found unique match
return array_search(true, $queriedContexts);
default: return false;
}
}
@ -193,7 +215,13 @@ abstract class BridgeAbstract implements BridgeInterface {
}
}
function getInput($input){
/**
* Returns the value for the provided input
*
* @param string $input The input name
* @return mixed Returns the input value or null if the input is not defined
*/
protected function getInput($input){
if(!isset($this->inputs[$this->queriedContext][$input]['value'])){
return null;
}
@ -209,7 +237,10 @@ abstract class BridgeAbstract implements BridgeInterface {
}
public function getExtraInfos(){
return array("name" => $this->getName(), "uri" => $this->getURI());
return array(
'name' => $this->getName(),
'uri' => $this->getURI()
);
}
public function setCache(\CacheInterface $cache){