mirror of
https://github.com/RSS-Bridge/rss-bridge.git
synced 2025-07-16 06:26:24 +02:00
Deploying to gh-pages from @ RSS-Bridge/rss-bridge@76f5de3d0f 🚀
This commit is contained in:
Bockiii
194
Cache_API/CacheInterface.html
Normal file
194
Cache_API/CacheInterface.html
Normal file
@ -0,0 +1,194 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>CacheInterface - 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></ul></li><li class='Nav__item 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 '><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 Nav__item--open 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 Nav__item--active'><a href="../Cache_API/CacheInterface.html">CacheInterface</a></li></ul></li><li class='Nav__item has-children'><a href="../Format_API/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Format API</a><ul class='Nav'><li class='Nav__item '><a href="../Format_API/How_to_create_a_new_format.html">How to create a new format</a></li><li class='Nav__item '><a href="../Format_API/FormatInterface.html">FormatInterface</a></li><li class='Nav__item '><a href="../Format_API/FormatAbstract.html">FormatAbstract</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></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="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="../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">
|
||||
March 22, 2022 at 1:33 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>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>The <code>CacheInterface</code> interface defines functions that need to be implemented. To create a new cache that implements <code>CacheInterface</code> you must implement following functions:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="#the-loaddata-function">loadData</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#the-savedata-function">saveData</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#the-gettime-function">getTime</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#the-purgecache-function">purgeCache</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Find a <a href="#template">template</a> at the end of this file.</p>
|
||||
<h1><a id="functions" href="#functions" class="Permalink" aria-hidden="true" title="Permalink">#</a>Functions</h1>
|
||||
<h2><a id="the-loaddata-function" href="#the-loaddata-function" class="Permalink" aria-hidden="true" title="Permalink">#</a>The <code>loadData</code> function</h2>
|
||||
<p>This function loads data from the cache and returns the data in the same format provided to the <a href="#the-savedata-function">saveData</a> function.</p>
|
||||
<pre><code class="language-PHP">loadData(): mixed
|
||||
</code></pre>
|
||||
<h2><a id="the-savedata-function" href="#the-savedata-function" class="Permalink" aria-hidden="true" title="Permalink">#</a>The <code>saveData</code> function</h2>
|
||||
<p>This function stores the given data into the cache and returns the object instance.</p>
|
||||
<pre><code class="language-PHP">saveData(mixed $data): self
|
||||
</code></pre>
|
||||
<h2><a id="the-gettime-function" href="#the-gettime-function" class="Permalink" aria-hidden="true" title="Permalink">#</a>The <code>getTime</code> function</h2>
|
||||
<p>This function returns the last write time for the cache, or <code>false</code> if the cache does not yet exist. Please notice that ‘cache’ refers to one specific item in the cache repository and might require additional data to identify a specific item (introduce custom functions where necessary!).</p>
|
||||
<pre><code class="language-PHP">getTime(): int, false
|
||||
</code></pre>
|
||||
<h2><a id="the-purgecache-function" href="#the-purgecache-function" class="Permalink" aria-hidden="true" title="Permalink">#</a>The <code>purgeCache</code> function</h2>
|
||||
<p>This function removes any data from the cache that is not within the given duration. The duration is specified in seconds and defines the period between now and the oldest item to keep.</p>
|
||||
<pre><code class="language-PHP">purgeCache(int $duration): null
|
||||
</code></pre>
|
||||
<h1><a id="template" href="#template" class="Permalink" aria-hidden="true" title="Permalink">#</a>Template</h1>
|
||||
<p>This is the bare minimum template for a new cache:</p>
|
||||
<pre><code class="language-PHP"><?php
|
||||
class MyTypeCache implements CacheInterface {
|
||||
public function loadData(){
|
||||
// Implement your algorithm here!
|
||||
return null;
|
||||
}
|
||||
|
||||
public function saveData($data){
|
||||
// Implement your algorithm here!
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getTime(){
|
||||
// Implement your algorithm here!
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
public function purgeCache($duration){
|
||||
// Implement your algorithm here!
|
||||
}
|
||||
}
|
||||
// Imaginary empty line!
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Cache_API/How_to_create_a_new_cache.html">Previous</a></li> <li class=Pager--next><a href="../Format_API/index.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>
|
||||
166
Cache_API/How_to_create_a_new_cache.html
Normal file
166
Cache_API/How_to_create_a_new_cache.html
Normal file
@ -0,0 +1,166 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>How to create a new cache - 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></ul></li><li class='Nav__item 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 '><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 Nav__item--open 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 Nav__item--active'><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 has-children'><a href="../Format_API/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Format API</a><ul class='Nav'><li class='Nav__item '><a href="../Format_API/How_to_create_a_new_format.html">How to create a new format</a></li><li class='Nav__item '><a href="../Format_API/FormatInterface.html">FormatInterface</a></li><li class='Nav__item '><a href="../Format_API/FormatAbstract.html">FormatAbstract</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></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="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="../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/How_to_create_a_new_cache.html">How to create a new cache</a></h1>
|
||||
<span class="ModifiedDate">
|
||||
March 22, 2022 at 1:33 PM </span>
|
||||
<span class="EditOn">
|
||||
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/07_Cache_API/01_How_to_create_a_new_cache.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>Create a new file in the <code>caches/</code> folder (see <a href="../For_Developers/Folder_structure.html">Folder structure</a>).</p>
|
||||
<p>The file must be named according to following specification:</p>
|
||||
<ul>
|
||||
<li>It starts with the type</li>
|
||||
<li>The file name must end with ‘Cache’</li>
|
||||
<li>The file type must be PHP, written in small letters (seriously!) “.php”</li>
|
||||
</ul>
|
||||
<p><strong>Examples:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Filename</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>File</td>
|
||||
<td>FileCache.php</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>MySQL</td>
|
||||
<td>MySQLCache.php</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>The file must start with the PHP tags and end with an empty line. The closing tag <code>?></code> is <a href="http://php.net/basic-syntax.instruction-separation" class="Link--external" rel="noopener noreferrer">omitted</a>.</p>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-PHP"><?PHP
|
||||
// PHP code here
|
||||
// This line is empty (just imagine it!)
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Cache_API/index.html">Previous</a></li> <li class=Pager--next><a href="../Cache_API/CacheInterface.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>
|
||||
136
Cache_API/index.html
Normal file
136
Cache_API/index.html
Normal file
@ -0,0 +1,136 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Cache API - 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></ul></li><li class='Nav__item 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 '><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 Nav__item--open 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 has-children'><a href="../Format_API/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Format API</a><ul class='Nav'><li class='Nav__item '><a href="../Format_API/How_to_create_a_new_format.html">How to create a new format</a></li><li class='Nav__item '><a href="../Format_API/FormatInterface.html">FormatInterface</a></li><li class='Nav__item '><a href="../Format_API/FormatAbstract.html">FormatAbstract</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></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="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="../Cache_API/index.html">Cache API</a></h1>
|
||||
<span class="ModifiedDate">
|
||||
March 22, 2022 at 1:33 PM </span>
|
||||
<span class="EditOn">
|
||||
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/07_Cache_API/index.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>A <em>Cache</em> is a class that allows <strong>RSS-Bridge</strong> to store fetched data in a local storage area on the server. Cache imlementations are placed in the <code>caches/</code> folder (see <a href="../For_Developers/Folder_structure.html">Folder structure</a>). A cache must implement the <a href="CacheInterface.html"><code>CacheInterface</code></a> interface.</p>
|
||||
<p>For more information about how to create a new <code>Cache</code>, read <a href="How_to_create_a_new_cache.html">How to create a new cache?</a></p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Helper_functions/index.html">Previous</a></li> <li class=Pager--next><a href="../Cache_API/How_to_create_a_new_cache.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>
|
||||
Reference in New Issue
Block a user