mirror of
https://github.com/FreshRSS/FreshRSS.git
synced 2026-05-20 09:30:36 +00:00
pe1uca
bca9a5586e
* Add FeedsListBeforeActualize hook. Closes #8650 Implement new hook to allow extensions to modify the list of feeds to actualize. How to test the feature manually: 1. Add several feeds from a single site (e.g. reddit and YT). 2. Add feeds to other sites. 3. Add and enable the extension https://github.com/pe1uca/xExtension-Declumping 4. Call `php app/actualize_script.php` to update feeds with a different order. A log like this one is needed to properly see the behavior. ```php foreach ($feeds as $key => $value) { syslog(LOG_INFO, "$key: {$value->name()} ({$value->url()})"); } ``` Sort in alphabetical order. * Implement call to hook * Remove duplicate return * Fix PHPStan error * Update documentation * Sanitize hook response * Markdown cleaning --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
75 lines
3.8 KiB
PHP
75 lines
3.8 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
|
|
enum Minz_HookType: string {
|
|
case ActionExecute = 'action_execute'; // function(Minz_ActionController $controller): bool
|
|
case ApiMisc = 'api_misc'; // function(): void
|
|
case BeforeLoginBtn = 'before_login_btn'; // function(): string
|
|
case CheckUrlBeforeAdd = 'check_url_before_add'; // function(string $url) -> string | null
|
|
case CustomFaviconBtnUrl = 'custom_favicon_btn_url'; // function(FreshRSS_Feed $feed): string | null
|
|
case CustomFaviconHash = 'custom_favicon_hash'; // function(FreshRSS_Feed $feed): string | null
|
|
case EntriesFavorite = 'entries_favorite'; // function(array $ids, bool $is_favorite): void
|
|
case EntryAutoRead = 'entry_auto_read'; // function(FreshRSS_Entry $entry, string $why): void
|
|
case EntryAutoUnread = 'entry_auto_unread'; // function(FreshRSS_Entry $entry, string $why): void
|
|
case EntryBeforeAdd = 'entry_before_add'; // function(FreshRSS_Entry $entry) -> FreshRSS_Entry | null
|
|
case EntryBeforeDisplay = 'entry_before_display'; // function(FreshRSS_Entry $entry) -> FreshRSS_Entry | null
|
|
case EntryBeforeInsert = 'entry_before_insert'; // function(FreshRSS_Entry $entry) -> FreshRSS_Entry | null
|
|
case EntryBeforeUpdate = 'entry_before_update'; // function(FreshRSS_Entry $entry) -> FreshRSS_Entry | null
|
|
case FeedBeforeActualize = 'feed_before_actualize'; // function(FreshRSS_Feed $feed) -> FreshRSS_Feed | null
|
|
case FeedBeforeInsert = 'feed_before_insert'; // function(FreshRSS_Feed $feed) -> FreshRSS_Feed | null
|
|
case FeedsListBeforeActualize = 'feeds_list_before_actualize'; // function(array $feedsList) -> array
|
|
case FreshrssInit = 'freshrss_init'; // function() -> none
|
|
case FreshrssUserMaintenance = 'freshrss_user_maintenance'; // function() -> none
|
|
case JsVars = 'js_vars'; // function($vars = array) -> array | null
|
|
case MenuAdminEntry = 'menu_admin_entry'; // function() -> string
|
|
case MenuConfigurationEntry = 'menu_configuration_entry'; // function() -> string
|
|
case MenuOtherEntry = 'menu_other_entry'; // function() -> string
|
|
case NavEntries = 'nav_entries'; // function() -> string
|
|
case NavMenu = 'nav_menu'; // function() -> string
|
|
case NavReadingModes = 'nav_reading_modes'; // function($readingModes = array) -> array | null
|
|
case PostUpdate = 'post_update'; // function(none) -> none
|
|
case SimplepieAfterInit = 'simplepie_after_init'; // function(FreshRSS_SimplePieCustom $simplePie, FreshRSS_Feed $feed, bool $result): void
|
|
case SimplepieBeforeInit = 'simplepie_before_init'; // function(FreshRSS_SimplePieCustom $simplePie, FreshRSS_Feed $feed): void
|
|
case ViewModes = 'view_modes'; // function($viewModes = array) -> array | null
|
|
|
|
public function signature(): Minz_HookSignature {
|
|
switch ($this) {
|
|
case self::ApiMisc:
|
|
case self::FreshrssInit:
|
|
case self::FreshrssUserMaintenance:
|
|
case self::PostUpdate:
|
|
return Minz_HookSignature::NoneToNone;
|
|
case self::BeforeLoginBtn:
|
|
case self::MenuAdminEntry:
|
|
case self::MenuConfigurationEntry:
|
|
case self::MenuOtherEntry:
|
|
case self::NavEntries:
|
|
case self::NavMenu:
|
|
return Minz_HookSignature::NoneToString;
|
|
case self::ActionExecute:
|
|
case self::CheckUrlBeforeAdd:
|
|
case self::EntryBeforeAdd:
|
|
case self::EntryBeforeDisplay:
|
|
case self::EntryBeforeInsert:
|
|
case self::EntryBeforeUpdate:
|
|
case self::FeedBeforeActualize:
|
|
case self::FeedBeforeInsert:
|
|
case self::FeedsListBeforeActualize:
|
|
case self::JsVars:
|
|
case self::NavReadingModes:
|
|
case self::ViewModes:
|
|
return Minz_HookSignature::OneToOne;
|
|
case self::CustomFaviconBtnUrl:
|
|
case self::CustomFaviconHash:
|
|
case self::EntriesFavorite:
|
|
case self::EntryAutoRead:
|
|
case self::EntryAutoUnread:
|
|
case self::SimplepieAfterInit:
|
|
case self::SimplepieBeforeInit:
|
|
return Minz_HookSignature::PassArguments;
|
|
default:
|
|
throw new \RuntimeException('The hook is not configured!');
|
|
}
|
|
}
|
|
}
|