From 88870d18be53fc38d70e842cdc35c7a1bc703b75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roland=20H=C3=A4der?= Date: Fri, 24 Jun 2022 04:42:35 +0200 Subject: [PATCH] Changes: - added some type-hints - added documentation --- src/Model/Contact.php | 8 ++++++- src/Model/FContact.php | 31 +++++++++++++++++--------- src/Module/Contact/Profile.php | 3 +++ src/Protocol/ActivityPub/Processor.php | 1 + src/Protocol/ActivityPub/Receiver.php | 2 ++ src/Worker/OnePoll.php | 5 +++-- 6 files changed, 36 insertions(+), 14 deletions(-) diff --git a/src/Model/Contact.php b/src/Model/Contact.php index 731407faf..dd130a641 100644 --- a/src/Model/Contact.php +++ b/src/Model/Contact.php @@ -2312,6 +2312,8 @@ class Contact } /** + * Updates contact record by provided id and optional network + * * @param integer $id contact id * @param string $network Optional network we are probing for * @return boolean @@ -2335,13 +2337,15 @@ class Contact } /** + * Updates contact record by provided id and probed data + * * @param integer $id contact id * @param array $ret Probed data * @return boolean * @throws HTTPException\InternalServerErrorException * @throws \ImagickException */ - private static function updateFromProbeArray(int $id, array $ret) + private static function updateFromProbeArray(int $id, array $ret): bool { /* Warning: Never ever fetch the public key via Probe::uri and write it into the contacts. @@ -2552,6 +2556,8 @@ class Contact } /** + * Updates contact record by provided URL + * * @param integer $url contact url * @return integer Contact id * @throws HTTPException\InternalServerErrorException diff --git a/src/Model/FContact.php b/src/Model/FContact.php index 97b1e98ef..cc6b2d2a7 100644 --- a/src/Model/FContact.php +++ b/src/Model/FContact.php @@ -103,17 +103,27 @@ class FContact $posts = Post::countPosts(['author-id' => $contact['id'], 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]]); } - $fields = ['name' => $arr["name"], 'photo' => $arr["photo"], - 'request' => $arr["request"], 'nick' => $arr["nick"], - 'addr' => strtolower($arr["addr"]), 'guid' => $arr["guid"], - 'batch' => $arr["batch"], 'notify' => $arr["notify"], - 'poll' => $arr["poll"], 'confirm' => $arr["confirm"], - 'alias' => $arr["alias"], 'pubkey' => $arr["pubkey"], - 'uri-id' => $uriid, 'interacting_count' => $interacting ?? 0, - 'interacted_count' => $interacted ?? 0, 'post_count' => $posts ?? 0, - 'updated' => DateTimeFormat::utcNow()]; + $fields = [ + 'name' => $arr['name'], + 'photo' => $arr['photo'], + 'request' => $arr['request'], + 'nick' => $arr['nick'], + 'addr' => strtolower($arr['addr']), + 'guid' => $arr['guid'], + 'batch' => $arr['batch'], + 'notify' => $arr['notify'], + 'poll' => $arr['poll'], + 'confirm' => $arr['confirm'], + 'alias' => $arr['alias'], + 'pubkey' => $arr['pubkey'], + 'uri-id' => $uriid, + 'interacting_count' => $interacting ?? 0, + 'interacted_count' => $interacted ?? 0, + 'post_count' => $posts ?? 0, + 'updated' => DateTimeFormat::utcNow(), + ]; - $condition = ['url' => $arr["url"], 'network' => $arr["network"]]; + $condition = ['url' => $arr['url'], 'network' => $arr['network']]; DBA::update('fcontact', $fields, $condition, true); } @@ -123,7 +133,6 @@ class FContact * fcontact guid * * @param string $fcontact_guid Hexadecimal string guid - * * @return string|null the contact url or null * @throws \Exception */ diff --git a/src/Module/Contact/Profile.php b/src/Module/Contact/Profile.php index 757ea64d8..793d0fa4a 100644 --- a/src/Module/Contact/Profile.php +++ b/src/Module/Contact/Profile.php @@ -475,7 +475,10 @@ class Profile extends BaseModule } /** + * Updates contact from probing + * * @param int $contact_id Id of the contact with uid != 0 + * @return void * @throws HTTPException\InternalServerErrorException * @throws \ImagickException */ diff --git a/src/Protocol/ActivityPub/Processor.php b/src/Protocol/ActivityPub/Processor.php index d9dd7ee5b..c6b711ab2 100644 --- a/src/Protocol/ActivityPub/Processor.php +++ b/src/Protocol/ActivityPub/Processor.php @@ -1547,6 +1547,7 @@ class Processor * Switches a contact to AP if needed * * @param integer $cid Contact ID + * @return void * @throws \Exception */ private static function switchContact(int $cid) diff --git a/src/Protocol/ActivityPub/Receiver.php b/src/Protocol/ActivityPub/Receiver.php index 38b6c4fc5..33c027933 100644 --- a/src/Protocol/ActivityPub/Receiver.php +++ b/src/Protocol/ActivityPub/Receiver.php @@ -1087,6 +1087,7 @@ class Receiver * @param integer $cid Contact ID * @param integer $uid User ID * @param string $url Profile URL + * @return void * @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \ImagickException */ @@ -1113,6 +1114,7 @@ class Receiver * * @param $receivers * @param $actor + * @return void * @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \ImagickException */ diff --git a/src/Worker/OnePoll.php b/src/Worker/OnePoll.php index 66b9851cf..65f2277b7 100644 --- a/src/Worker/OnePoll.php +++ b/src/Worker/OnePoll.php @@ -41,11 +41,11 @@ use Friendica\Util\Strings; class OnePoll { - public static function execute($contact_id = 0, $command = '') + public static function execute(int $contact_id = 0, string $command = '') { Logger::notice('Start polling/probing contact', ['id' => $contact_id]); - $force = ($command == "force"); + $force = ($command == 'force'); if (empty($contact_id)) { Logger::notice('no contact provided'); @@ -118,6 +118,7 @@ class OnePoll * * @param array $contact The personal contact entry * @param array $fields The fields that are updated + * @return void * @throws \Exception */ private static function updateContact(array $contact, array $fields)