diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/09_Technical_recommendations/index.md | 34 |
1 files changed, 19 insertions, 15 deletions
diff --git a/docs/09_Technical_recommendations/index.md b/docs/09_Technical_recommendations/index.md index a57f0bbd..c564418e 100644 --- a/docs/09_Technical_recommendations/index.md +++ b/docs/09_Technical_recommendations/index.md @@ -1,28 +1,32 @@ ## General recommendations -* Use [HTTPS](https://en.wikipedia.org/wiki/HTTPS) (`https://...`) over [HTTP](https://en.wikipedia.org/wiki/HTTPS) (`http://...`) whenever possible - ## Test a site before building a bridge -Some sites make use of anti-bot mechanisms (e.g.: by using JavaScript) in which case they work fine in regular browsers, but not in the PHP environment. To check if a site works with RSS-Bridge, create a new bridge using the [template](../05_Bridge_API/02_BridgeAbstract.md#template) and load a valid URL (not the base URL!). +Some sites make use of anti-bot mechanisms (e.g.: by using JavaScript) in which case they work fine in regular browsers, +but not in the PHP environment. + +To check if a site works with RSS-Bridge, create a new bridge using the +[template](../05_Bridge_API/02_BridgeAbstract.md#template) +and load a valid URL (not the base URL!). **Example (using github.com)** ```PHP <?php -class TestBridge extends BridgeAbstract { - const NAME = 'Unnamed bridge'; - const URI = ''; - const DESCRIPTION = 'No description provided'; - const MAINTAINER = 'No maintainer'; - const PARAMETERS = []; - const CACHE_TIMEOUT = 3600; +class TestBridge extends BridgeAbstract +{ + const NAME = 'Unnamed bridge'; + const URI = ''; + const DESCRIPTION = 'No description provided'; + const MAINTAINER = 'No maintainer'; + const PARAMETERS = []; + const CACHE_TIMEOUT = 3600; - public function collectData(){ - $html = getSimpleHTMLDOM('https://github.com/rss-bridge/rss-bridge') - or returnServerError('No contents received!'); - } + public function collectData() + { + $html = getSimpleHTMLDOM('https://github.com/rss-bridge/rss-bridge'); + } } ``` -This bridge should return an empty page (HTML format)
\ No newline at end of file +This bridge should return an empty page (HTML format) |