From b7e3bddcaaf6f3719ad283e8a47277702f8fc30c Mon Sep 17 00:00:00 2001 From: LogMANOriginal Date: Tue, 21 Aug 2018 17:53:08 +0200 Subject: [PATCH] [BridgeAbstract] Add getIcon --- BridgeAbstract.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/BridgeAbstract.md b/BridgeAbstract.md index 65d9b47..59ca29f 100644 --- a/BridgeAbstract.md +++ b/BridgeAbstract.md @@ -7,6 +7,7 @@ To create a new Bridge extending `BridgeAbstract` you must specify some [basic m - [`getMaintainer`](#the-getmaintainer-function) - [`getName`](#the-getname-function) - [`getURI`](#the-geturi-function) +- [`getIcon`](#the-geticon-function) 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 The queried context is defined via `PARAMETERS` and can be accessed via `$this->queriedContext`.