mirror/RSS-Bridge.rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-07-10 05:54:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor (#3668)

Browse source
This commit is contained in:
Dag 2023-09-20 02:45:48 +02:00 • committed by GitHub
parent cf7e3eea56
commit e6aef73a02
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 134 additions and 384 deletions
Download patch file Download diff file Expand all files Collapse all files

49
docs/05_Bridge_API/02_BridgeAbstract.md
View file

@ -94,7 +94,7 @@ class MyBridge extends BridgeAbstract {
const MAINTAINER = 'ghost';
public function collectData() {
$item = array(); // Create an empty item
$item = []; // Create an empty item
$item['title'] = 'Hello World!';
@ -121,11 +121,11 @@ class MyBridge extends BridgeAbstract {
const URI = '';
const DESCRIPTION = 'No description provided';
const MAINTAINER = 'No maintainer';
const PARAMETERS = array(); // Can be omitted!
const PARAMETERS = []; // Can be omitted!
const CACHE_TIMEOUT = 3600; // Can be omitted!
public function collectData() {
$item = array(); // Create an empty item
$item = []; // Create an empty item
$item['title'] = 'Hello World!';
@ -145,7 +145,7 @@ For information on how to read parameter values during execution, please refer t
## Adding parameters to a bridge
Parameters are specified as part of the bridge class. An empty list of parameters is defined as `const PARAMETERS = array();`
Parameters are specified as part of the bridge class. An empty list of parameters is defined as `const PARAMETERS = [];`
<details><summary>Show example</summary><div>
@ -153,7 +153,7 @@ Parameters are specified as part of the bridge class. An empty list of parameter
<?PHP
class MyBridge extends BridgeAbstract {
/* ... */
const PARAMETERS = array(); // Empty list of parameters (can be omitted)
const PARAMETERS = []; // Empty list of parameters (can be omitted)
/* ... */
}
```
@ -172,10 +172,10 @@ A context is defined as a associative array of parameters. The name of a context
<details><summary>Show example</summary><div>
```PHP
const PARAMETERS = array(
'My Context 1' => array(),
'My Context 2' => array()
);
const PARAMETERS = [
'My Context 1' => [],
'My Context 2' => [],
];
```
**Output**
@ -189,9 +189,9 @@ _Notice_: The name of a context can be left empty if only one context is needed!
<details><summary>Show example</summary><div>
```PHP
const PARAMETERS = array(
array()
);
const PARAMETERS = [
[]
];
```
</div></details><br>
@ -201,25 +201,28 @@ You can also define a set of parameters that will be applied to every possible c
<details><summary>Show example</summary><div>
```PHP
const PARAMETERS = array(
'global' => array() // Applies to all contexts!
);
const PARAMETERS = [
'global' => [] // Applies to all contexts!
];
```
</div></details>
## Level 2 - Parameter
Parameters are placed inside a context. They are defined as associative array of parameter specifications. Each parameter is defined by it's internal input name, a definition in the form `'n' => array();`, where `n` is the name with which the bridge can access the parameter during execution.
Parameters are placed inside a context.
They are defined as associative array of parameter specifications.
Each parameter is defined by it's internal input name, a definition in the form `'n' => [];`,
where `n` is the name with which the bridge can access the parameter during execution.
<details><summary>Show example</summary><div>
```PHP
const PARAMETERS = array(
'My Context' => array(
'n' => array()
)
);
const PARAMETERS = [
'My Context' => [
'n' => []
]
];
```
</div></details><br>
@ -351,7 +354,7 @@ Elements collected by this function must be stored in `$this->items`. The `items
```PHP
$item = array(); // Create a new item
$item = []; // Create a new item
$item['title'] = 'Hello World!';
@ -448,7 +451,7 @@ public function detectParameters($url){
&& preg_match($regex, $url, $urlMatches) > 0
&& preg_match($regex, static::URI, $bridgeUriMatches) > 0
&& $urlMatches[3] === $bridgeUriMatches[3]) {
return array();
return [];
} else {
return null;
}

5
docs/05_Bridge_API/03_FeedExpander.md
View file

@ -93,10 +93,11 @@ class MySiteBridge extends FeedExpander {
const NAME = 'Unnamed bridge';
const URI = '';
const DESCRIPTION = 'No description provided';
const PARAMETERS = array();
const PARAMETERS = [];
const CACHE_TIMEOUT = 3600;
public function collectData(){
public function collectData()
{
$this->collectExpandableDatas('your feed URI');
}
}

6
docs/05_Bridge_API/index.md
View file

@ -1,4 +1,8 @@
A _Bridge_ is an class that allows **RSS-Bridge** to create an RSS-feed from a website. A _Bridge_ represents one element on the [Welcome screen](../01_General/04_Screenshots.md) and covers one or more sites to return feeds for. It is developed in a PHP file located in the `bridges/` folder (see [Folder structure](../04_For_Developers/03_Folder_structure.md)) and extends one of the base classes of **RSS-Bridge**:
A _Bridge_ is a class that allows **RSS-Bridge** to create an RSS-feed from a website.
A _Bridge_ represents one element on the [Welcome screen](../01_General/04_Screenshots.md)
and covers one or more sites to return feeds for.
It is developed in a PHP file located in the `bridges/` folder (see [Folder structure](../04_For_Developers/03_Folder_structure.md))
and extends one of the base classes of **RSS-Bridge**:
Base class | Description
-----------|------------