mirror/RSS-Bridge.rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-07-29 23:25:45 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

[BridgeAbstract] Add getIcon

LogMANOriginal 2018-08-21 17:53:08 +02:00
parent 4127a39640
commit b7e3bddcaa
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
BridgeAbstract.md

@ -7,6 +7,7 @@ To create a new Bridge extending `BridgeAbstract` you must specify some [basic m
- [`getMaintainer`](#the-getmaintainer-function) - [`getMaintainer`](#the-getmaintainer-function)
- [`getName`](#the-getname-function) - [`getName`](#the-getname-function)
- [`getURI`](#the-geturi-function) - [`getURI`](#the-geturi-function)
- [`getIcon`](#the-geticon-function)
Find a [template](#template) at the end of this file. Find a [template](#template) at the end of this file.
@ -222,6 +223,16 @@ This function returns the URI to the destination site of a bridge.
} }
``` ```
## The `getIcon` function
This function returns the URI for an icon, used as favicon in the feeds. If no icon is specified by the bridge, RSS-Bridge will use the "default" location `static::URI . '/favicon.ico'` (i.e. "https://github.com/favicon.ico") which may or may not exist.
```PHP
public function getIcon(){
return self::URI . '/favicon.ico';
}
```
## Queried context ## Queried context
The queried context is defined via `PARAMETERS` and can be accessed via `$this->queriedContext`. The queried context is defined via `PARAMETERS` and can be accessed via `$this->queriedContext`.