HookType.php 3.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. <?php
  2. declare(strict_types=1);
  3. enum Minz_HookType: string {
  4. case ActionExecute = 'action_execute'; // function(Minz_ActionController $controller): bool
  5. case ApiMisc = 'api_misc'; // function(): void
  6. case BeforeLoginBtn = 'before_login_btn'; // function(): string
  7. case CheckUrlBeforeAdd = 'check_url_before_add'; // function(string $url) -> string | null
  8. case CustomFaviconBtnUrl = 'custom_favicon_btn_url'; // function(FreshRSS_Feed $feed): string | null
  9. case CustomFaviconHash = 'custom_favicon_hash'; // function(FreshRSS_Feed $feed): string | null
  10. case EntriesFavorite = 'entries_favorite'; // function(array $ids, bool $is_favorite): void
  11. case EntriesRead = 'entries_read'; // function(array $ids, bool $is_read): void
  12. case EntryAutoRead = 'entry_auto_read'; // function(FreshRSS_Entry $entry, string $why): void
  13. case EntryAutoUnread = 'entry_auto_unread'; // function(FreshRSS_Entry $entry, string $why): void
  14. case EntryBeforeAdd = 'entry_before_add'; // function(FreshRSS_Entry $entry) -> FreshRSS_Entry | null
  15. case EntryBeforeDisplay = 'entry_before_display'; // function(FreshRSS_Entry $entry) -> FreshRSS_Entry | null
  16. case EntryBeforeInsert = 'entry_before_insert'; // function(FreshRSS_Entry $entry) -> FreshRSS_Entry | null
  17. case EntryBeforeUpdate = 'entry_before_update'; // function(FreshRSS_Entry $entry) -> FreshRSS_Entry | null
  18. case FeedBeforeActualize = 'feed_before_actualize'; // function(FreshRSS_Feed $feed) -> FreshRSS_Feed | null
  19. case FeedBeforeInsert = 'feed_before_insert'; // function(FreshRSS_Feed $feed) -> FreshRSS_Feed | null
  20. case FeedsListBeforeActualize = 'feeds_list_before_actualize'; // function(array $feedsList) -> array
  21. case FreshrssInit = 'freshrss_init'; // function() -> none
  22. case FreshrssUserMaintenance = 'freshrss_user_maintenance'; // function() -> none
  23. case JsVars = 'js_vars'; // function($vars = array) -> array | null
  24. case MenuAdminEntry = 'menu_admin_entry'; // function() -> string
  25. case MenuConfigurationEntry = 'menu_configuration_entry'; // function() -> string
  26. case MenuOtherEntry = 'menu_other_entry'; // function() -> string
  27. case NavEntries = 'nav_entries'; // function() -> string
  28. case NavMenu = 'nav_menu'; // function() -> string
  29. case NavReadingModes = 'nav_reading_modes'; // function($readingModes = array) -> array | null
  30. case PostUpdate = 'post_update'; // function(none) -> none
  31. case SimplepieAfterInit = 'simplepie_after_init'; // function(FreshRSS_SimplePieCustom $simplePie, FreshRSS_Feed $feed, bool $result): void
  32. case SimplepieBeforeInit = 'simplepie_before_init'; // function(FreshRSS_SimplePieCustom $simplePie, FreshRSS_Feed $feed): void
  33. case ViewModes = 'view_modes'; // function($viewModes = array) -> array | null
  34. public function signature(): Minz_HookSignature {
  35. switch ($this) {
  36. case self::ApiMisc:
  37. case self::FreshrssInit:
  38. case self::FreshrssUserMaintenance:
  39. case self::PostUpdate:
  40. return Minz_HookSignature::NoneToNone;
  41. case self::BeforeLoginBtn:
  42. case self::MenuAdminEntry:
  43. case self::MenuConfigurationEntry:
  44. case self::MenuOtherEntry:
  45. case self::NavEntries:
  46. case self::NavMenu:
  47. return Minz_HookSignature::NoneToString;
  48. case self::ActionExecute:
  49. case self::CheckUrlBeforeAdd:
  50. case self::EntryBeforeAdd:
  51. case self::EntryBeforeDisplay:
  52. case self::EntryBeforeInsert:
  53. case self::EntryBeforeUpdate:
  54. case self::FeedBeforeActualize:
  55. case self::FeedBeforeInsert:
  56. case self::FeedsListBeforeActualize:
  57. case self::JsVars:
  58. case self::NavReadingModes:
  59. case self::ViewModes:
  60. return Minz_HookSignature::OneToOne;
  61. case self::CustomFaviconBtnUrl:
  62. case self::CustomFaviconHash:
  63. case self::EntriesFavorite:
  64. case self::EntriesRead:
  65. case self::EntryAutoRead:
  66. case self::EntryAutoUnread:
  67. case self::SimplepieAfterInit:
  68. case self::SimplepieBeforeInit:
  69. return Minz_HookSignature::PassArguments;
  70. default:
  71. throw new \RuntimeException('The hook is not configured!');
  72. }
  73. }
  74. }