public/tt-rss
1
0
Fork 0
mirror of https://git.tt-rss.org/git/tt-rss.git synced 2025-12-13 10:15:55 +00:00
Code Issues Releases Wiki Activity

normalize some mismatching hook function definitions to match base Plugin class

Browse Source
This commit is contained in:
Andrew Dolgov
2021-11-14 11:11:49 +03:00
parent 81a10f69bc
commit 0a2dcacbcf
7 changed files with 33 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
classes/plugin.php
View File

@@ -1,4 +1,11 @@
<?php
/* TODO: I haven't yet decided if we're keeping hook prototypes which did grow (with additional params) over time and breaking all plugins
with legacy function definitions, or commenting base definitions out for the time being -fox
(It's a shame that PHP doesn't support argument overloading)
Stuff like hook_enclosure_entry() etc.
*/
abstract class Plugin {
const API_VERSION_COMPAT = 1;
@@ -142,10 +149,12 @@ abstract class Plugin {
}
/** this is a pluginhost compatibility wrapper that invokes $this->authenticate(...$args) (Auth_Base)
* @param mixed $args = ($login, $password, $service)
* @param string $login
* @param string $password
* @param string $service
* @return int|false user_id
*/
function hook_auth_user(...$args) {
function hook_auth_user($login, $password, $service = '') {
user_error("Dummy method invoked.", E_USER_ERROR);
return false;
}
@@ -153,10 +162,10 @@ abstract class Plugin {
/** IAuthModule only
* @param string $login
* @param string $password
* optional third string $service
* @param string $service
* @return int|false user_id
*/
function authenticate($login, $password) {
function authenticate($login, $password, $service = '') {
user_error("Dummy method invoked.", E_USER_ERROR);
return false;
}
@@ -257,6 +266,12 @@ abstract class Plugin {
user_error("Dummy method invoked.", E_USER_ERROR);
}
/**
* @param array<string,string> $entry
* @param int $id
* @param array{'formatted': string, 'entries': array<int, array<string, mixed>>} $rv
* @return array<string,string>
*/
function hook_enclosure_entry($entry, $id, $rv) {
user_error("Dummy method invoked.", E_USER_ERROR);
}
@@ -289,7 +304,7 @@ abstract class Plugin {
user_error("Dummy method invoked.", E_USER_ERROR);
}
function hook_article_image($enclosures, $content, $site_url) {
function hook_article_image($enclosures, $content, $site_url, $article) {
user_error("Dummy method invoked.", E_USER_ERROR);
}
@@ -317,7 +332,7 @@ abstract class Plugin {
user_error("Dummy method invoked.", E_USER_ERROR);
}
function hook_pre_subscribe($url, $auth_login, $auth_pass) {
function hook_pre_subscribe(&$url, $auth_login, $auth_pass) {
user_error("Dummy method invoked.", E_USER_ERROR);
}
}