Skip to content

Commit

Permalink
Deploying to gh-pages from @ e6aef73 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@dvikan
dvikan committed Sep 20, 2023
1 parent eca3f60 commit 2068b00
Show file tree
Hide file tree
Showing 45 changed files with 85 additions and 74 deletions.
51 changes: 27 additions & 24 deletions Bridge_API/BridgeAbstract.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<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/BridgeAbstract.html">BridgeAbstract</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/05_Bridge_API/02_BridgeAbstract.md" target="_blank">
Edit on GitHub </a>
Expand Down Expand Up @@ -169,7 +169,7 @@ <h2><a id="step-4-implement-a-function-to-collect-feed-data" href="#step-4-imple
const MAINTAINER = 'ghost';

public function collectData() {
$item = array(); // Create an empty item
$item = []; // Create an empty item

$item['title'] = 'Hello World!';

Expand All @@ -189,11 +189,11 @@ <h1><a id="template" href="#template" class="Permalink" aria-hidden="true" title
<span class="hljs-keyword">const</span> URI = <span class="hljs-string">''</span>;
<span class="hljs-keyword">const</span> DESCRIPTION = <span class="hljs-string">'No description provided'</span>;
<span class="hljs-keyword">const</span> MAINTAINER = <span class="hljs-string">'No maintainer'</span>;
<span class="hljs-keyword">const</span> PARAMETERS = <span class="hljs-keyword">array</span>(); <span class="hljs-comment">// Can be omitted!</span>
<span class="hljs-keyword">const</span> PARAMETERS = []; <span class="hljs-comment">// Can be omitted!</span>
<span class="hljs-keyword">const</span> CACHE_TIMEOUT = <span class="hljs-number">3600</span>; <span class="hljs-comment">// Can be omitted!</span>

<span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">collectData</span><span class="hljs-params">()</span> </span>{
$item = <span class="hljs-keyword">array</span>(); <span class="hljs-comment">// Create an empty item</span>
$item = []; <span class="hljs-comment">// Create an empty item</span>

$item[<span class="hljs-string">'title'</span>] = <span class="hljs-string">'Hello World!'</span>;

Expand All @@ -207,12 +207,12 @@ <h1><a id="parameters" href="#parameters" class="Permalink" aria-hidden="true" t
<p>For information on how to read parameter values during execution, please refer to the <a href="../Helper_functions/index.html#getinput">getInput</a> function.</p>
<hr />
<h2><a id="adding-parameters-to-a-bridge" href="#adding-parameters-to-a-bridge" class="Permalink" aria-hidden="true" title="Permalink">#</a>Adding parameters to a bridge</h2>
<p>Parameters are specified as part of the bridge class. An empty list of parameters is defined as <code>const PARAMETERS = array();</code></p>
<p>Parameters are specified as part of the bridge class. An empty list of parameters is defined as <code>const PARAMETERS = [];</code></p>
<details><summary>Show example</summary><div>
<pre><code class="language-PHP">&lt;?PHP
class MyBridge extends BridgeAbstract {
/* ... */
const PARAMETERS = array(); // Empty list of parameters (can be omitted)
const PARAMETERS = []; // Empty list of parameters (can be omitted)
/* ... */
}
</code></pre>
Expand All @@ -223,36 +223,39 @@ <h2><a id="adding-parameters-to-a-bridge" href="#adding-parameters-to-a-bridge"
<h2><a id="level-1-context" href="#level-1-context" class="Permalink" aria-hidden="true" title="Permalink">#</a>Level 1 - Context</h2>
<p>A context is defined as a associative array of parameters. The name of a context is displayed by RSS-Bridge.</p>
<details><summary>Show example</summary><div>
<pre><code class="language-PHP">const PARAMETERS = array(
'My Context 1' =&gt; array(),
'My Context 2' =&gt; array()
);
<pre><code class="language-PHP">const PARAMETERS = [
'My Context 1' =&gt; [],
'My Context 2' =&gt; [],
];
</code></pre>
<p><strong>Output</strong></p>
<p><img src="../images/bridge_context_named.png" alt="bridge context named" /></p>
</div></details><br>
<p><em>Notice</em>: The name of a context can be left empty if only one context is needed!</p>
<details><summary>Show example</summary><div>
<pre><code class="language-PHP">const PARAMETERS = array(
array()
);
<pre><code class="language-PHP">const PARAMETERS = [
[]
];
</code></pre>
</div></details><br>
<p>You can also define a set of parameters that will be applied to every possible context of your bridge. To do this, specify a context named <code>global</code>.</p>
<details><summary>Show example</summary><div>
<pre><code class="language-PHP">const PARAMETERS = array(
'global' =&gt; array() // Applies to all contexts!
);
<pre><code class="language-PHP">const PARAMETERS = [
'global' =&gt; [] // Applies to all contexts!
];
</code></pre>
</div></details>
<h2><a id="level-2-parameter" href="#level-2-parameter" class="Permalink" aria-hidden="true" title="Permalink">#</a>Level 2 - Parameter</h2>
<p>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 <code>'n' =&gt; array();</code>, where <code>n</code> is the name with which the bridge can access the parameter during execution.</p>
<p>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 <code>'n' =&gt; [];</code>,
where <code>n</code> is the name with which the bridge can access the parameter during execution.</p>
<details><summary>Show example</summary><div>
<pre><code class="language-PHP">const PARAMETERS = array(
'My Context' =&gt; array(
'n' =&gt; array()
)
);
<pre><code class="language-PHP">const PARAMETERS = [
'My Context' =&gt; [
'n' =&gt; []
]
];
</code></pre>
</div></details><br>
<p>The parameter specification consists of various fields, listed in the table below.</p>
Expand Down Expand Up @@ -414,7 +417,7 @@ <h2><a id="implementing-the-collectdata-function" href="#implementing-the-collec
<p>Elements collected by this function must be stored in <code>$this-&gt;items</code>. The <code>items</code> variable is an array of item elements, each of which is an associative array that may contain arbitrary keys. RSS-Bridge specifies common keys which are used to generate most common feed formats.</p>
<details><summary>Show example</summary><div>
<pre><code class="language-PHP">
$item = array(); // Create a new item
$item = []; // Create a new item

$item['title'] = 'Hello World!';

Expand Down Expand Up @@ -480,7 +483,7 @@ <h1><a id="detectparameters" href="#detectparameters" class="Permalink" aria-hid
&amp;&amp; preg_match($regex, $url, $urlMatches) &gt; 0
&amp;&amp; preg_match($regex, static::URI, $bridgeUriMatches) &gt; 0
&amp;&amp; $urlMatches[3] === $bridgeUriMatches[3]) {
return array();
return [];
} else {
return null;
}
Expand Down
7 changes: 4 additions & 3 deletions Bridge_API/FeedExpander.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<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 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </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>
Expand Down Expand Up @@ -239,10 +239,11 @@ <h1><a id="template" href="#template" class="Permalink" aria-hidden="true" title
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-&gt;collectExpandableDatas('your feed URI');
}
}
Expand Down
2 changes: 1 addition & 1 deletion Bridge_API/How_to_create_a_new_bridge.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<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/How_to_create_a_new_bridge.html">How to create a new bridge</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/05_Bridge_API/01_How_to_create_a_new_bridge.md" target="_blank">
Edit on GitHub </a>
Expand Down
2 changes: 1 addition & 1 deletion Bridge_API/XPathAbstract.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<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/XPathAbstract.html">XPathAbstract</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/05_Bridge_API/04_XPathAbstract.md" target="_blank">
Edit on GitHub </a>
Expand Down
8 changes: 6 additions & 2 deletions Bridge_API/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,19 @@
<div class="Page__header">
<h1><a href="../Bridge_API/index.html">Bridge API</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/05_Bridge_API/index.md" target="_blank">
Edit on GitHub </a>
</span>
</div>

<div class="s-content">
<p>A <em>Bridge</em> is an class that allows <strong>RSS-Bridge</strong> to create an RSS-feed from a website. A <em>Bridge</em> represents one element on the <a href="../General/Screenshots.html">Welcome screen</a> and covers one or more sites to return feeds for. It is developed in a PHP file located in the <code>bridges/</code> folder (see <a href="../For_Developers/Folder_structure.html">Folder structure</a>) and extends one of the base classes of <strong>RSS-Bridge</strong>:</p>
<p>A <em>Bridge</em> is a class that allows <strong>RSS-Bridge</strong> to create an RSS-feed from a website.
A <em>Bridge</em> represents one element on the <a href="../General/Screenshots.html">Welcome screen</a>
and covers one or more sites to return feeds for.
It is developed in a PHP file located in the <code>bridges/</code> folder (see <a href="../For_Developers/Folder_structure.html">Folder structure</a>)
and extends one of the base classes of <strong>RSS-Bridge</strong>:</p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion Bridge_Specific/ActivityPub_(Mastodon).html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<div class="Page__header">
<h1><a href="../Bridge_Specific/ActivityPub_(Mastodon).html">Bridge Specific</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_Specific/ActivityPub_(Mastodon).html">ActivityPub (Mastodon)</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/10_Bridge_Specific/ActivityPub_(Mastodon).md" target="_blank">
Edit on GitHub </a>
Expand Down
2 changes: 1 addition & 1 deletion Bridge_Specific/FacebookBridge.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<div class="Page__header">
<h1><a href="../Bridge_Specific/ActivityPub_(Mastodon).html">Bridge Specific</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_Specific/FacebookBridge.html">FacebookBridge</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/10_Bridge_Specific/FacebookBridge.md" target="_blank">
Edit on GitHub </a>
Expand Down
2 changes: 1 addition & 1 deletion Bridge_Specific/FurAffinityBridge.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<div class="Page__header">
<h1><a href="../Bridge_Specific/ActivityPub_(Mastodon).html">Bridge Specific</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_Specific/FurAffinityBridge.html">FurAffinityBridge</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/10_Bridge_Specific/FurAffinityBridge.md" target="_blank">
Edit on GitHub </a>
Expand Down
2 changes: 1 addition & 1 deletion Bridge_Specific/Furaffinityuser.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<div class="Page__header">
<h1><a href="../Bridge_Specific/ActivityPub_(Mastodon).html">Bridge Specific</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_Specific/Furaffinityuser.html">Furaffinityuser</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/10_Bridge_Specific/Furaffinityuser.md" target="_blank">
Edit on GitHub </a>
Expand Down
2 changes: 1 addition & 1 deletion Bridge_Specific/Instagram.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<div class="Page__header">
<h1><a href="../Bridge_Specific/ActivityPub_(Mastodon).html">Bridge Specific</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_Specific/Instagram.html">Instagram</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/10_Bridge_Specific/Instagram.md" target="_blank">
Edit on GitHub </a>
Expand Down
2 changes: 1 addition & 1 deletion Bridge_Specific/PixivBridge.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<div class="Page__header">
<h1><a href="../Bridge_Specific/ActivityPub_(Mastodon).html">Bridge Specific</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_Specific/PixivBridge.html">PixivBridge</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/10_Bridge_Specific/PixivBridge.md" target="_blank">
Edit on GitHub </a>
Expand Down
2 changes: 1 addition & 1 deletion Bridge_Specific/TwitterV2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<div class="Page__header">
<h1><a href="../Bridge_Specific/ActivityPub_(Mastodon).html">Bridge Specific</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_Specific/TwitterV2.html">TwitterV2</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/10_Bridge_Specific/TwitterV2.md" target="_blank">
Edit on GitHub </a>
Expand Down
2 changes: 1 addition & 1 deletion CLI/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<div class="Page__header">
<h1><a href="../CLI/index.html">CLI</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/02_CLI/index.md" target="_blank">
Edit on GitHub </a>
Expand Down
2 changes: 1 addition & 1 deletion Cache_API/CacheInterface.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<div class="Page__header">
<h1><a href="../Cache_API/index.html">Cache 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="../Cache_API/CacheInterface.html">CacheInterface</a></h1>
<span class="ModifiedDate">
September 14, 2023 at 4:58 PM </span>
September 19, 2023 at 5:46 PM </span>
<span class="EditOn">
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/07_Cache_API/02_CacheInterface.md" target="_blank">
Edit on GitHub </a>
Expand Down
Loading

0 comments on commit 2068b00

Please sign in to comment.