mirror of
https://github.com/RSS-Bridge/rss-bridge.git
synced 2025-04-05 00:59:35 +00:00
283 lines
17 KiB
HTML
283 lines
17 KiB
HTML
<!DOCTYPE html>
|
||
<html class="no-js" lang="en">
|
||
<head>
|
||
<title>FeedExpander - RSS-Bridge</title>
|
||
<meta name="description" content="The RSS feed for websites missing it">
|
||
<meta name="author" content="RSS-Bridge Contributors">
|
||
<meta charset="UTF-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
||
<link rel="icon" href="../themes/daux/img/favicon-blue.png" type="image/x-icon">
|
||
|
||
<!-- Mobile -->
|
||
<meta name="apple-mobile-web-app-capable" content="yes" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<!-- JS -->
|
||
<script>
|
||
window.base_url = "../";
|
||
document.documentElement.classList.remove('no-js');
|
||
</script>
|
||
|
||
<!-- Font -->
|
||
|
||
<!-- CSS -->
|
||
<link href='../themes/daux/css/theme-blue.min.css' rel='stylesheet' type='text/css'>
|
||
<link href='../daux_libraries/search.css' rel='stylesheet' type='text/css'>
|
||
</head>
|
||
<body class="">
|
||
<div class="Columns content">
|
||
<aside class="Columns__left Collapsible">
|
||
<button type="button" class="Button Collapsible__trigger" aria-controls="sidebar_content" aria-expanded="false" aria-label="Toggle navigation">
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
</button>
|
||
|
||
<a class="Brand" href="../index.html">RSS-Bridge</a>
|
||
|
||
<form role='search' action="/" method="get" class="Search" id="search_form">
|
||
<label for="search_input">
|
||
<span class='u-visuallyHidden'>Search</span>
|
||
</label>
|
||
<input
|
||
type="search"
|
||
id="search_input"
|
||
class="Search__field"
|
||
placeholder="Search..."
|
||
aria-label="Search..."
|
||
autocomplete="on"
|
||
results=25
|
||
autosave=text_search
|
||
>
|
||
<label>
|
||
<input type="submit" class='u-visuallyHidden' />
|
||
<span class='u-visuallyHidden'>Search...</span>
|
||
<svg class="Search__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 451 451">
|
||
<path d="M447.05 428l-109.6-109.6c29.4-33.8 47.2-77.9 47.2-126.1C384.65 86.2 298.35 0 192.35 0 86.25 0 .05 86.3.05 192.3s86.3 192.3 192.3 192.3c48.2 0 92.3-17.8 126.1-47.2L428.05 447c2.6 2.6 6.1 4 9.5 4s6.9-1.3 9.5-4c5.2-5.2 5.2-13.8 0-19zM26.95 192.3c0-91.2 74.2-165.3 165.3-165.3 91.2 0 165.3 74.2 165.3 165.3s-74.1 165.4-165.3 165.4c-91.1 0-165.3-74.2-165.3-165.4z"/>
|
||
</svg>
|
||
</label>
|
||
</form>
|
||
|
||
<div class="Collapsible__content" id="sidebar_content">
|
||
<!-- Navigation -->
|
||
<ul class='Nav'><li class='Nav__item has-children'><a href="../General/Project_goals.html" class="Nav__item__link"><i class="Nav__arrow"> </i>General</a><ul class='Nav'><li class='Nav__item '><a href="../General/Project_goals.html">Project-goals</a></li><li class='Nav__item '><a href="../General/Contribute.html">Contribute</a></li><li class='Nav__item '><a href="../General/Requirements.html">Requirements</a></li><li class='Nav__item '><a href="../General/Screenshots.html">Screenshots</a></li><li class='Nav__item '><a href="../General/FAQ.html">FAQ</a></li><li class='Nav__item '><a href="../General/Public_Hosts.html">Public Hosts</a></li></ul></li><li class='Nav__item '><a href="../CLI/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>CLI</a><ul class='Nav'></ul></li><li class='Nav__item has-children'><a href="../For_Hosts/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>For Hosts</a><ul class='Nav'><li class='Nav__item '><a href="../For_Hosts/Installation.html">Installation</a></li><li class='Nav__item '><a href="../For_Hosts/Updating.html">Updating</a></li><li class='Nav__item '><a href="../For_Hosts/Docker_Installation.html">Docker Installation</a></li><li class='Nav__item '><a href="../For_Hosts/Heroku_Installation.html">Heroku Installation</a></li><li class='Nav__item '><a href="../For_Hosts/Whitelisting.html">Whitelisting</a></li><li class='Nav__item '><a href="../For_Hosts/Authentication.html">Authentication</a></li><li class='Nav__item '><a href="../For_Hosts/Customizations.html">Customizations</a></li><li class='Nav__item '><a href="../For_Hosts/Custom_Configuration.html">Custom Configuration</a></li></ul></li><li class='Nav__item has-children'><a href="../For_Developers/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>For Developers</a><ul class='Nav'><li class='Nav__item '><a href="../For_Developers/Coding_style_policy.html">Coding style policy</a></li><li class='Nav__item '><a href="../For_Developers/Pull_Request_policy.html">Pull Request policy</a></li><li class='Nav__item '><a href="../For_Developers/Folder_structure.html">Folder structure</a></li><li class='Nav__item '><a href="../For_Developers/Actions.html">Actions</a></li><li class='Nav__item '><a href="../For_Developers/Debug_mode.html">Debug mode</a></li><li class='Nav__item '><a href="../For_Developers/Github_Codespaces_Tutorial.html">Github Codespaces Tutorial</a></li><li class='Nav__item '><a href="../For_Developers/Development_Environment_Setup.html">Development Environment Setup</a></li></ul></li><li class='Nav__item Nav__item--open has-children'><a href="../Bridge_API/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Bridge API</a><ul class='Nav'><li class='Nav__item '><a href="../Bridge_API/How_to_create_a_new_bridge.html">How to create a new bridge</a></li><li class='Nav__item '><a href="../Bridge_API/BridgeAbstract.html">BridgeAbstract</a></li><li class='Nav__item Nav__item--active'><a href="../Bridge_API/FeedExpander.html">FeedExpander</a></li><li class='Nav__item '><a href="../Bridge_API/XPathAbstract.html">XPathAbstract</a></li></ul></li><li class='Nav__item '><a href="../Helper_functions/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Helper functions</a><ul class='Nav'></ul></li><li class='Nav__item has-children'><a href="../Cache_API/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Cache API</a><ul class='Nav'><li class='Nav__item '><a href="../Cache_API/How_to_create_a_new_cache.html">How to create a new cache</a></li><li class='Nav__item '><a href="../Cache_API/CacheInterface.html">CacheInterface</a></li></ul></li><li class='Nav__item '><a href="../Technical_recommendations/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Technical recommendations</a><ul class='Nav'></ul></li><li class='Nav__item has-children'><a href="../Bridge_Specific/ActivityPub_(Mastodon).html" class="Nav__item__link"><i class="Nav__arrow"> </i>Bridge Specific</a><ul class='Nav'><li class='Nav__item '><a href="../Bridge_Specific/ActivityPub_(Mastodon).html">ActivityPub (Mastodon)</a></li><li class='Nav__item '><a href="../Bridge_Specific/FacebookBridge.html">FacebookBridge</a></li><li class='Nav__item '><a href="../Bridge_Specific/FurAffinityBridge.html">FurAffinityBridge</a></li><li class='Nav__item '><a href="../Bridge_Specific/Furaffinityuser.html">Furaffinityuser</a></li><li class='Nav__item '><a href="../Bridge_Specific/Instagram.html">Instagram</a></li><li class='Nav__item '><a href="../Bridge_Specific/PixivBridge.html">PixivBridge</a></li><li class='Nav__item '><a href="../Bridge_Specific/TwitterV2.html">TwitterV2</a></li></ul></li></ul>
|
||
<div class="Links">
|
||
<hr/>
|
||
<a href="https://github.com/RSS-Bridge/rss-bridge" target="_blank" rel="noopener noreferrer">GitHub Repository</a>
|
||
<br />
|
||
<a href="https://github.com/RSS-Bridge/rss-bridge/issues" target="_blank" rel="noopener noreferrer">Help/Support/Bugs</a>
|
||
<br />
|
||
<a href="https://github.com/RSS-Bridge/rss-bridge/pkgs/container/rss-bridge" target="_blank" rel="noopener noreferrer">Docker Images</a>
|
||
<br />
|
||
</div>
|
||
|
||
<div class="CodeToggler">
|
||
<hr/>
|
||
<label class="Checkbox">Show Code Blocks <input type="checkbox" class="CodeToggler__button--main" checked="checked"/>
|
||
<div class="Checkbox__indicator"></div>
|
||
</label>
|
||
</div>
|
||
|
||
<div class="DarkModeToggler">
|
||
<hr/>
|
||
<label class="Checkbox">Dark Mode <input type="checkbox" class="ColorMode__button" />
|
||
<div class="Checkbox__indicator"></div>
|
||
</label>
|
||
</div>
|
||
|
||
|
||
<div class="PoweredBy">
|
||
<hr/>
|
||
Powered by Daux.io </div>
|
||
</div>
|
||
</aside>
|
||
<div class="Columns__right">
|
||
<div class="Columns__right__content">
|
||
<div class="doc_content">
|
||
<article class="Page">
|
||
|
||
<div class="Page__header">
|
||
<h1><a href="../Bridge_API/index.html">Bridge API</a> <svg class="Page__header--separator" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 477.175 477.175"><path d="M360.73 229.075l-225.1-225.1c-5.3-5.3-13.8-5.3-19.1 0s-5.3 13.8 0 19.1l215.5 215.5-215.5 215.5c-5.3 5.3-5.3 13.8 0 19.1 2.6 2.6 6.1 4 9.5 4 3.4 0 6.9-1.3 9.5-4l225.1-225.1c5.3-5.2 5.3-13.8.1-19z"/></svg> <a href="../Bridge_API/FeedExpander.html">FeedExpander</a></h1>
|
||
<span class="ModifiedDate">
|
||
September 30, 2023 at 6:07 AM </span>
|
||
<span class="EditOn">
|
||
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/05_Bridge_API/03_FeedExpander.md" target="_blank">
|
||
Edit on GitHub </a>
|
||
</span>
|
||
</div>
|
||
|
||
<div class="s-content">
|
||
<p><code>FeedExpander</code> extends <a href="BridgeAbstract.html"><code>BridgeAbstract</code></a> and adds functions to collect data from existing feeds.</p>
|
||
<p><strong>Usage example</strong>: <em>You have discovered a site that provides feeds which are hidden and inaccessible by normal means. You want your bridge to directly read the feeds and provide them via <strong>RSS-Bridge</strong></em></p>
|
||
<p>To create a new Bridge extending <code>FeedExpander</code> you must implement all required functions of <a href="BridgeAbstract.html"><code>BridgeAbstract</code></a>. <code>FeedExpander</code> additionally provides following functions:</p>
|
||
<ul>
|
||
<li>
|
||
<a href="#the-parseitem-function"><code>parseItem</code></a>
|
||
</li>
|
||
<li>
|
||
<a href="#the-getname-function"><code>getName</code></a>
|
||
</li>
|
||
<li>
|
||
<a href="#the-geturi-function"><code>getURI</code></a>
|
||
</li>
|
||
<li>
|
||
<a href="#the-getdescription-function"><code>getDescription</code></a>
|
||
</li>
|
||
</ul>
|
||
<p>Find a <a href="#template">template</a> at the end of this file.</p>
|
||
<p><strong>Notice:</strong> For a standard feed only <code>collectData</code> need to be implemented. <code>collectData</code> should call <code>$this->collectExpandableDatas('your URI here');</code> to automatically load feed items and header data (will subsequently call <code>parseItem</code> for each item in the feed). You can limit the number of items to fetch by specifying an additional parameter for: <code>$this->collectExpandableDatas('your URI here', 10)</code> (limited to 10 items).</p>
|
||
<h2><a id="the-parseitem-function" href="#the-parseitem-function" class="Permalink" aria-hidden="true" title="Permalink">#</a>The <code>parseItem</code> function</h2>
|
||
<p>This function receives one item from the current feed and should return one <strong>RSS-Bridge</strong> item.
|
||
The default function does all the work to get the item data from the feed, whether it is RSS 1.0,
|
||
RSS 2.0 or Atom 1.0. If you have to redefine this function in your <strong>RSS-Bridge</strong> for whatever reason,
|
||
you should first call the parent function to initialize the item, then apply the changes that you require.</p>
|
||
<p><strong>Notice:</strong> The following code sample is just an example. Implementation depends on your requirements!</p>
|
||
<pre><code class="language-PHP">protected function parseItem($feedItem){
|
||
$item = parent::parseItem($feedItem);
|
||
$item['content'] = str_replace('rssbridge','RSS-Bridge',$feedItem->content);
|
||
|
||
return $item;
|
||
}
|
||
</code></pre>
|
||
<h3><a id="helper-functions" href="#helper-functions" class="Permalink" aria-hidden="true" title="Permalink">#</a>Helper functions</h3>
|
||
<p>The <code>FeedExpander</code> already provides a set of functions to parse RSS or Atom items based on the specifications. Where possible make use of these functions:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Function</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code>parseATOMItem</code></td>
|
||
<td>Parses an Atom 1.0 feed item</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>parseRSS_0_9_1_Item</code></td>
|
||
<td>Parses an RSS 0.91 feed item</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>parseRSS_1_0_Item</code></td>
|
||
<td>Parses an RSS 1.0 feed item</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>parseRSS_2_0_Item</code></td>
|
||
<td>Parses an RSS 2.0 feed item</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>In the following list you’ll find the feed tags assigned to the the <strong>RSS-Bridge</strong> item keys:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Function</th>
|
||
<th>uri</th>
|
||
<th>title</th>
|
||
<th>timestamp</th>
|
||
<th>author</th>
|
||
<th>content</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code>parseATOMItem</code></td>
|
||
<td>id</td>
|
||
<td>title</td>
|
||
<td>updated</td>
|
||
<td>author</td>
|
||
<td>content</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>parseRSS_0_9_1_Item</code></td>
|
||
<td>link</td>
|
||
<td>title</td>
|
||
<td></td>
|
||
<td></td>
|
||
<td>description</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>parseRSS_1_0_Item</code></td>
|
||
<td>link</td>
|
||
<td>title</td>
|
||
<td>dc:date</td>
|
||
<td>dc:creator</td>
|
||
<td>description</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>parseRSS_2_0_Item</code></td>
|
||
<td>link, guid</td>
|
||
<td>title</td>
|
||
<td>pubDate, dc:date</td>
|
||
<td>author, dc:creator</td>
|
||
<td>description</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2><a id="the-getname-function" href="#the-getname-function" class="Permalink" aria-hidden="true" title="Permalink">#</a>The <code>getName</code> function</h2>
|
||
<p>Returns the name of the current feed.</p>
|
||
<pre><code class="language-PHP">return $this->name;
|
||
</code></pre>
|
||
<p><strong>Notice:</strong> Only implement this function if you require different behavior!</p>
|
||
<h2><a id="the-geturi-function" href="#the-geturi-function" class="Permalink" aria-hidden="true" title="Permalink">#</a>The <code>getURI</code> function</h2>
|
||
<p>Return the uri for the current feed.</p>
|
||
<pre><code class="language-PHP">return $this->uri;
|
||
</code></pre>
|
||
<p><strong>Notice:</strong> Only implement this function if you require different behavior!</p>
|
||
<h2><a id="the-getdescription-function" href="#the-getdescription-function" class="Permalink" aria-hidden="true" title="Permalink">#</a>The <code>getDescription</code> function</h2>
|
||
<p>Returns the description for the current bridge.</p>
|
||
<pre><code class="language-PHP">return $this->description;
|
||
</code></pre>
|
||
<p><strong>Notice:</strong> Only implement this function if you require different behavior!</p>
|
||
<h1><a id="template" href="#template" class="Permalink" aria-hidden="true" title="Permalink">#</a>Template</h1>
|
||
<p>This is the template for a new bridge:</p>
|
||
<pre><code class="language-PHP"><?php
|
||
class MySiteBridge extends FeedExpander {
|
||
|
||
const MAINTAINER = 'No maintainer';
|
||
const NAME = 'Unnamed bridge';
|
||
const URI = '';
|
||
const DESCRIPTION = 'No description provided';
|
||
const PARAMETERS = [];
|
||
const CACHE_TIMEOUT = 3600;
|
||
|
||
public function collectData()
|
||
{
|
||
$this->collectExpandableDatas('your feed URI');
|
||
}
|
||
}
|
||
// Imaginary empty line!
|
||
</code></pre>
|
||
</div>
|
||
|
||
<nav>
|
||
<ul class="Pager">
|
||
<li class=Pager--prev><a href="../Bridge_API/BridgeAbstract.html">Previous</a></li> <li class=Pager--next><a href="../Bridge_API/XPathAbstract.html">Next</a></li> </ul>
|
||
</nav>
|
||
</article>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<!-- JS -->
|
||
<script src="../themes/daux/js/daux.min.js"></script>
|
||
|
||
<script>
|
||
|
||
window.searchLanguage = "";
|
||
window.searchTranslation = {"Search_one_result":"1 result","Search_results":"!count results","Search_no_results":"Nothing found","Search_common_words_ignored":"Common words are largely ignored","Search_too_short":"Search too short","Search_one_character_or_more":"Should be one character or more","Search_should_be_x_or_more":"Should be !min characters or more","Link_previous":"Previous","Link_next":"Next"};
|
||
</script>
|
||
|
||
<!-- Search -->
|
||
<script type="text/javascript" src="../daux_libraries/search.min.js"></script>
|
||
|
||
<script>
|
||
window.search({'base_url': '../'})
|
||
</script>
|
||
</body>
|
||
</html>
|