xle/tt-rss
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clean up some virtual feed stuff in PluginHost.

Browse Source 
Among other things, this makes 'PluginHost->add_feed()' return false if the feed was not added.
This commit is contained in:
wn_
2024-12-15 16:09:40 +00:00
parent 62a6191f04
commit cfbbb9d714
1 changed files with 32 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
classes/PluginHost.php
View File

@@ -23,8 +23,8 @@ class PluginHost {
/** @var array<string, array<string, mixed>> plugin name -> (potential profile array) -> key -> value */ /** @var array<string, array<string, mixed>> plugin name -> (potential profile array) -> key -> value */
private array $storage = []; private array $storage = [];
/** @var array<int, array<int, array{'id': int, 'title': string, 'sender': Plugin, 'icon': string}>> */ /** @var array<int, array{'id': int, 'title': string, 'sender': Plugin, 'icon': string}> */
private array $feeds = []; private array $special_feeds = [];
/** @var array<string, Plugin> API method name, Plugin sender */ /** @var array<string, Plugin> API method name, Plugin sender */
private array $api_methods = []; private array $api_methods = [];
@@ -759,44 +759,51 @@ class PluginHost {
} }
} }
// Plugin feed functions are *EXPERIMENTAL*! /**
* Add a special (plugin-provided) feed
*
* @param int $cat_id only -1 (Feeds::CATEGORY_SPECIAL) is supported
* @return false|positive-int false if $cat_id was not -1 (Feeds::CATEGORY_SPECIAL),
* otherwise a positive integer ID that might change between executions
*/
function add_feed(int $cat_id, string $title, string $icon, Plugin $sender): false|int {
if ($cat_id !== Feeds::CATEGORY_SPECIAL)
return false;
// cat_id: only -1 (Feeds::CATEGORY_SPECIAL) is supported (Special) $id = count($this->special_feeds);
function add_feed(int $cat_id, string $title, string $icon, Plugin $sender): int {
if (empty($this->feeds[$cat_id])) $this->special_feeds[] = [
$this->feeds[$cat_id] = []; 'id' => $id,
'title' => $title,
$id = count($this->feeds[$cat_id]); 'sender' => $sender,
'icon' => $icon,
array_push($this->feeds[$cat_id], ];
['id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon]);
return $id; return $id;
} }
/** /**
* Get special (plugin-provided) feeds
*
* @param int $cat_id only -1 (Feeds::CATEGORY_SPECIAL) is supported
* @return array<int, array{'id': int, 'title': string, 'sender': Plugin, 'icon': string}> * @return array<int, array{'id': int, 'title': string, 'sender': Plugin, 'icon': string}>
*/ */
function get_feeds(int $cat_id) { function get_feeds(int $cat_id) {
return $this->feeds[$cat_id] ?? []; return $cat_id === Feeds::CATEGORY_SPECIAL ? $this->special_feeds : [];
} }
/** /**
* convert feed_id (e.g. -129) to pfeed_id first * Get the Plugin handling a specific virtual feed.
* @return (Plugin&IVirtualFeed)|null *
* Convert feed_id (e.g. -129) to pfeed_id first.
*
* @return (Plugin&IVirtualFeed)|null a Plugin that implements IVirtualFeed, otherwise null
*/ */
function get_feed_handler(int $pfeed_id): ?Plugin { function get_feed_handler(int $pfeed_id): ?Plugin {
foreach ($this->feeds as $cat) { foreach ($this->special_feeds as $feed) {
foreach ($cat as $feed) { if ($feed['id'] == $pfeed_id) {
if ($feed['id'] == $pfeed_id) { /** @var Plugin&IVirtualFeed $feed['sender'] */
if (implements_interface($feed['sender'], 'IVirtualFeed')) { return implements_interface($feed['sender'], 'IVirtualFeed') ? $feed['sender'] : null;
/** @var Plugin&IVirtualFeed $feed['sender'] */
return $feed['sender'];
} else {
return null;
}
}
} }
} }
return null; return null;