]> git.mxchange.org Git - friendica.git/commitdiff
Added documentation
authorMichael <heluecht@pirati.ca>
Sat, 21 Dec 2019 20:18:44 +0000 (20:18 +0000)
committerMichael <heluecht@pirati.ca>
Sat, 21 Dec 2019 20:18:44 +0000 (20:18 +0000)
src/Worker/FetchPoCo.php
src/Worker/UpdateContact.php
src/Worker/UpdateGContact.php
src/Worker/UpdateGContacts.php
src/Worker/UpdateGServer.php
src/Worker/UpdateGServers.php
src/Worker/UpdateServerDirectories.php
src/Worker/UpdateServerDirectory.php
src/Worker/UpdateSuggestions.php

index 372bd37337b5eb68370866a13c6bef96b763c973..67f2e548bd9a5d6adf91262041bcb00adc5d3945 100644 (file)
@@ -9,7 +9,14 @@ use Friendica\Protocol\PortableContact;
 
 class FetchPoCo
 {
-       // Load POCO data from a given POCO address
+       /**
+        * Fetch PortableContacts from a given PoCo server address
+        *
+        * @param integer $cid  Contact ID
+        * @param integer $uid  User ID
+        * @param integer $zcid Global Contact ID
+        * @param integer $url  PoCo address that should be polled
+        */
        public static function execute($cid, $uid, $zcid, $url)
        {
                PortableContact::load($cid, $uid, $zcid, $url);
index f23c5c0a070ff0aa4b40345027414d77d113ce49..0e5fd141281ec182a111c3f2d48befbe6ac7ecf4 100644 (file)
@@ -13,6 +13,11 @@ use Friendica\Database\DBA;
 
 class UpdateContact
 {
+       /**
+        * Update contact data via probe
+        * @param int    $contact_id Contact ID
+        * @param string $command
+        */
        public static function execute($contact_id, $command = '')
        {
                $force = ($command == "force");
index aacebcb80ae93d7482994261f06d8cd9e565ad67..1057d0a27037142cadbb59b553897eb5eb6ebc59 100644 (file)
@@ -12,6 +12,11 @@ use Friendica\Database\DBA;
 
 class UpdateGContact
 {
+       /**
+        * Update global contact via probe
+        * @param string $url     Global contact url
+        * @param string $command
+        */
        public static function execute($url, $command = '')
        {
                $force = ($command == "force");
index 64ffb2a50be952907857a4cff157b2716e0d6957..1d9d86bcf6871bdc43f15a15c6209d2c18bea5c1 100644 (file)
@@ -16,22 +16,24 @@ use Friendica\Util\Strings;
 
 class UpdateGContacts
 {
-       // Updates gcontact entries
+       /**
+        * Updates global contacts
+        */
        public static function execute()
        {
                if (!Config::get('system', 'poco_completion')) {
                        return;
                }
 
-               Logger::info('Discover contacts');
+               Logger::info('Update global contacts');
 
                $starttime = time();
 
                $contacts = DBA::p("SELECT `url`, `created`, `updated`, `last_failure`, `last_contact`, `server_url`, `network` FROM `gcontact`
                                WHERE `last_contact` < UTC_TIMESTAMP - INTERVAL 1 MONTH AND
                                        `last_failure` < UTC_TIMESTAMP - INTERVAL 1 MONTH AND
-                                       `network` IN (?, ?, ?, ?, '') ORDER BY rand()",
-                               Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, Protocol::FEED);
+                                       `network` IN (?, ?, ?, ?, ?, '') ORDER BY rand()",
+                               Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, Protocol::FEED);
 
                $checked = 0;
 
index 2e017422fee3236e106ca5ac98742700eaec3647..b94c5343a0f58815786f5b94410b7982e92c7d42 100644 (file)
@@ -10,7 +10,10 @@ use Friendica\Util\Strings;
 
 class UpdateGServer
 {
-       // Searches for the poco server list.
+       /**
+        * Update the given server
+        * @param string $server_url Server URL
+        */
        public static function execute($server_url)
        {
                if (empty($server_url)) {
index a245c34fca260b1b866d2a54897b5b6b1d3660fa..d55d8df01871f44ddc02103ee743dcd372c610c5 100644 (file)
@@ -12,8 +12,7 @@ use Friendica\Model\GServer;
 class UpdateGServers
 {
        /**
-        * @brief Updates the first 250 servers
-        *
+        * Updates the first 250 servers
         */
        public static function execute()
        {
index e1b12034ade727b4dc516abc883eecae03eaa206..433685cb29deeb37d7ac42b3f6db295451b6ee0b 100644 (file)
@@ -11,6 +11,9 @@ use Friendica\Protocol\PortableContact;
 
 class UpdateServerDirectories
 {
+       /**
+        * Query global servers for their users
+        */
        public static function execute()
        {
                if (Config::get('system', 'poco_discovery') == PortableContact::DISABLED) {
index 262da2d308196f87c1460c7fe1c600c8a719070f..fd5ee0534ba0edc3a74a4d3d40e01d3a8ea0726a 100644 (file)
@@ -9,6 +9,10 @@ use Friendica\Model\GServer;
 
 class UpdateServerDirectory
 {
+       /**
+        * Query the given server for their users
+        * @param string $gserver Server URL
+        */
        public static function execute($gserver)
        {
                GServer::updateDirectory($gserver);
index 222244c1c4bf654d1b854d28f29f32610073c598..7d45434090ef4e7f15f7ae83376e1a13264f1cba 100644 (file)
@@ -9,7 +9,9 @@ use Friendica\Model\GContact;
 
 class UpdateSuggestions
 {
-       // Discover other servers for their contacts.
+       /**
+        * Discover other servers for their contacts.
+        */
        public static function execute()
        {
                GContact::updateSuggestions();