Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2025-04-26 03:50:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

@brief is removed completely

Browse source
This commit is contained in:
Michael 2020-01-19 06:05:23 +00:00
parent fd1f1999f0
commit 0a4119adaf
170 changed files with 901 additions and 962 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/Protocol/ActivityPub.php
View file

@ -12,7 +12,8 @@ use Friendica\Model\User;
use Friendica\Util\HTTPSignature;
/**
* @brief ActivityPub Protocol class
* ActivityPub Protocol class
*
* The ActivityPub Protocol is a message exchange protocol defined by the W3C.
* https://www.w3.org/TR/activitypub/
* https://www.w3.org/TR/activitystreams-core/

2
src/Protocol/ActivityPub/Receiver.php
View file

@ -23,7 +23,7 @@ use Friendica\Util\LDSignature;
use Friendica\Util\Strings;
/**
* @brief ActivityPub Receiver Protocol class
* ActivityPub Receiver Protocol class
*
* To-Do:
* - Undo Announce

4
src/Protocol/ActivityPub/Transmitter.php
View file

@ -37,7 +37,7 @@ require_once 'include/api.php';
require_once 'mod/share.php';
/**
* @brief ActivityPub Transmitter Protocol class
* ActivityPub Transmitter Protocol class
*
* To-Do:
* - Undo Announce
@ -1107,7 +1107,7 @@ class Transmitter
}
/**
* @brief Callback function to replace a Friendica style mention in a mention that is used on AP
* Callback function to replace a Friendica style mention in a mention that is used on AP
*
* @param array $match Matching values for the callback
* @return string Replaced mention

66
src/Protocol/DFRN.php
View file

@ -1,7 +1,7 @@
<?php
/**
* @file include/dfrn.php
* @brief The implementation of the dfrn protocol
* The implementation of the dfrn protocol
*
* @see https://github.com/friendica/friendica/wiki/Protocol and
* https://github.com/friendica/friendica/blob/master/spec/dfrn2.pdf
@ -40,7 +40,7 @@ use HTMLPurifier;
use HTMLPurifier_Config;
/**
* @brief This class contain functions to create and send DFRN XML files
* This class contain functions to create and send DFRN XML files
*/
class DFRN
{
@ -50,7 +50,7 @@ class DFRN
const REPLY_RC = 2; // Reply that will be relayed
/**
* @brief Generates an array of contact and user for DFRN imports
* Generates an array of contact and user for DFRN imports
*
* This array contains not only the receiver but also the sender of the message.
*
@ -91,7 +91,7 @@ class DFRN
}
/**
* @brief Generates the atom entries for delivery.php
* Generates the atom entries for delivery.php
*
* This function is used whenever content is transmitted via DFRN.
*
@ -130,7 +130,7 @@ class DFRN
}
/**
* @brief Generate an atom feed for the given user
* Generate an atom feed for the given user
*
* This function is called when another server is pulling data from the user feed.
*
@ -340,7 +340,7 @@ class DFRN
}
/**
* @brief Generate an atom entry for a given item id
* Generate an atom entry for a given item id
*
* @param int $item_id The item id
* @param boolean $conversation Show the conversation. If false show the single post.
@ -409,7 +409,7 @@ class DFRN
}
/**
* @brief Create XML text for DFRN mails
* Create XML text for DFRN mails
*
* @param array $item message elements
* @param array $owner Owner record
@ -446,7 +446,7 @@ class DFRN
}
/**
* @brief Create XML text for DFRN friend suggestions
* Create XML text for DFRN friend suggestions
*
* @param array $item suggestion elements
* @param array $owner Owner record
@ -476,7 +476,7 @@ class DFRN
}
/**
* @brief Create XML text for DFRN relocations
* Create XML text for DFRN relocations
*
* @param array $owner Owner record
* @param int $uid User ID
@ -535,7 +535,7 @@ class DFRN
}
/**
* @brief Adds the header elements for the DFRN protocol
* Adds the header elements for the DFRN protocol
*
* @param DOMDocument $doc XML document
* @param array $owner Owner record
@ -613,7 +613,7 @@ class DFRN
}
/**
* @brief Adds the author element in the header for the DFRN protocol
* Adds the author element in the header for the DFRN protocol
*
* @param DOMDocument $doc XML document
* @param array $owner Owner record
@ -758,7 +758,7 @@ class DFRN
}
/**
* @brief Adds the author elements in the "entry" elements of the DFRN protocol
* Adds the author elements in the "entry" elements of the DFRN protocol
*
* @param DOMDocument $doc XML document
* @param string $element Element name for the author
@ -803,7 +803,7 @@ class DFRN
}
/**
* @brief Adds the activity elements
* Adds the activity elements
*
* @param DOMDocument $doc XML document
* @param string $element Element name for the activity
@ -870,7 +870,7 @@ class DFRN
}
/**
* @brief Adds the elements for attachments
* Adds the elements for attachments
*
* @param object $doc XML document
* @param object $root XML root
@ -906,7 +906,7 @@ class DFRN
}
/**
* @brief Adds the "entry" elements for the DFRN protocol
* Adds the "entry" elements for the DFRN protocol
*
* @param DOMDocument $doc XML document
* @param string $type "text" or "html"
@ -1143,7 +1143,7 @@ class DFRN
}
/**
* @brief encrypts data via AES
* encrypts data via AES
*
* @param string $data The data that is to be encrypted
* @param string $key The AES key
@ -1156,7 +1156,7 @@ class DFRN
}
/**
* @brief decrypts data via AES
* decrypts data via AES
*
* @param string $encrypted The encrypted data
* @param string $key The AES key
@ -1169,7 +1169,7 @@ class DFRN
}
/**
* @brief Delivers the atom content to the contacts
* Delivers the atom content to the contacts
*
* @param array $owner Owner record
* @param array $contact Contact record of the receiver
@ -1405,7 +1405,7 @@ class DFRN
}
/**
* @brief Transmits atom content to the contacts via the Diaspora transport layer
* Transmits atom content to the contacts via the Diaspora transport layer
*
* @param array $owner Owner record
* @param array $contact Contact record of the receiver
@ -1495,7 +1495,7 @@ class DFRN
}
/**
* @brief Fetch the author data from head or entry items
* Fetch the author data from head or entry items
*
* @param object $xpath XPath object
* @param object $context In which context should the data be searched
@ -1729,7 +1729,7 @@ class DFRN
}
/**
* @brief Transforms activity objects into an XML string
* Transforms activity objects into an XML string
*
* @param object $xpath XPath object
* @param object $activity Activity object
@ -1784,7 +1784,7 @@ class DFRN
}
/**
* @brief Processes the mail elements
* Processes the mail elements
*
* @param object $xpath XPath object
* @param object $mail mail elements
@ -1813,7 +1813,7 @@ class DFRN
}
/**
* @brief Processes the suggestion elements
* Processes the suggestion elements
*
* @param object $xpath XPath object
* @param object $suggestion suggestion elements
@ -1912,7 +1912,7 @@ class DFRN
}
/**
* @brief Processes the relocation elements
* Processes the relocation elements
*
* @param object $xpath XPath object
* @param object $relocation relocation elements
@ -1997,7 +1997,7 @@ class DFRN
}
/**
* @brief Updates an item
* Updates an item
*
* @param array $current the current item record
* @param array $item the new item record
@ -2030,7 +2030,7 @@ class DFRN
}
/**
* @brief Detects the entry type of the item
* Detects the entry type of the item
*
* @param array $importer Record of the importer user mixed with contact of the content
* @param array $item the new item record
@ -2098,7 +2098,7 @@ class DFRN
}
/**
* @brief Send a "poke"
* Send a "poke"
*
* @param array $item The new item record
* @param array $importer Record of the importer user mixed with contact of the content
@ -2158,7 +2158,7 @@ class DFRN
}
/**
* @brief Processes several actions, depending on the verb
* Processes several actions, depending on the verb
*
* @param int $entrytype Is it a toplevel entry, a comment or a relayed comment?
* @param array $importer Record of the importer user mixed with contact of the content
@ -2260,7 +2260,7 @@ class DFRN
}
/**
* @brief Processes the link elements
* Processes the link elements
*
* @param object $links link elements
* @param array $item the item record
@ -2304,7 +2304,7 @@ class DFRN
}
/**
* @brief Processes the entry elements which contain the items and comments
* Processes the entry elements which contain the items and comments
*
* @param array $header Array of the header elements that always stay the same
* @param object $xpath XPath object
@ -2649,7 +2649,7 @@ class DFRN
}
/**
* @brief Deletes items
* Deletes items
*
* @param object $xpath XPath object
* @param object $deletion deletion elements
@ -2710,7 +2710,7 @@ class DFRN
}
/**
* @brief Imports a DFRN message
* Imports a DFRN message
*
* @param string $xml The DFRN message
* @param array $importer Record of the importer user mixed with contact of the content
@ -2853,7 +2853,7 @@ class DFRN
}
/**
* @brief Returns the activity verb
* Returns the activity verb
*
* @param array $item Item array
*

166
src/Protocol/Diaspora.php
View file

@ -1,7 +1,7 @@
<?php
/**
* @file src/Protocol/diaspora.php
* @brief The implementation of the diaspora protocol
* The implementation of the diaspora protocol
*
* The new protocol is described here: http://diaspora.github.io/diaspora_federation/index.html
* This implementation here interprets the old and the new protocol and sends the new one.
@ -41,7 +41,7 @@ use Friendica\Worker\Delivery;
use SimpleXMLElement;
/**
* @brief This class contain functions to create and send Diaspora XML files
* This class contain functions to create and send Diaspora XML files
*
*/
class Diaspora
@ -77,7 +77,7 @@ class Diaspora
}
/**
* @brief Return a list of relay servers
* Return a list of relay servers
*
* The list contains not only the official relays but also servers that we serve directly
*
@ -167,7 +167,7 @@ class Diaspora
}
/**
* @brief Return a contact for a given server address or creates a dummy entry
* Return a contact for a given server address or creates a dummy entry
*
* @param string $server_url The url of the server
* @param array $fields Fieldlist
@ -200,7 +200,7 @@ class Diaspora
}
/**
* @brief Update or insert a relay contact
* Update or insert a relay contact
*
* @param string $server_url The url of the server
* @param array $network_fields Optional network specific fields
@ -234,7 +234,7 @@ class Diaspora
}
/**
* @brief Return a list of participating contacts for a thread
* Return a list of participating contacts for a thread
*
* This is used for the participation feature.
* One of the parameters is a contact array.
@ -286,7 +286,7 @@ class Diaspora
}
/**
* @brief repairs a signature that was double encoded
* repairs a signature that was double encoded
*
* The function is unused at the moment. It was copied from the old implementation.
*
@ -317,7 +317,7 @@ class Diaspora
}
/**
* @brief verify the envelope and return the verified data
* verify the envelope and return the verified data
*
* @param string $envelope The magic envelope
*
@ -382,7 +382,7 @@ class Diaspora
}
/**
* @brief encrypts data via AES
* encrypts data via AES
*
* @param string $key The AES key
* @param string $iv The IV (is used for CBC encoding)
@ -396,7 +396,7 @@ class Diaspora
}
/**
* @brief decrypts data via AES
* decrypts data via AES
*
* @param string $key The AES key
* @param string $iv The IV (is used for CBC encoding)
@ -659,7 +659,7 @@ class Diaspora
/**
* @brief Dispatches public messages and find the fitting receivers
* Dispatches public messages and find the fitting receivers
*
* @param array $msg The post that will be dispatched
*
@ -687,7 +687,7 @@ class Diaspora
}
/**
* @brief Dispatches the different message types to the different functions
* Dispatches the different message types to the different functions
*
* @param array $importer Array of the importer user
* @param array $msg The post that will be dispatched
@ -792,7 +792,7 @@ class Diaspora
}
/**
* @brief Checks if a posting is valid and fetches the data fields.
* Checks if a posting is valid and fetches the data fields.
*
* This function does not only check the signature.
* It also does the conversion between the old and the new diaspora format.
@ -945,7 +945,7 @@ class Diaspora
}
/**
* @brief Fetches the public key for a given handle
* Fetches the public key for a given handle
*
* @param string $handle The handle
*
@ -968,7 +968,7 @@ class Diaspora
}
/**
* @brief Fetches data for a given handle
* Fetches data for a given handle
*
* @param string $handle The handle
* @param boolean $update true = always update, false = never update, null = update when not found or outdated
@ -1022,7 +1022,7 @@ class Diaspora
}
/**
* @brief Updates the fcontact table
* Updates the fcontact table
*
* @param array $arr The fcontact data
* @throws \Exception
@ -1043,7 +1043,7 @@ class Diaspora
}
/**
* @brief get a handle (user@domain.tld) from a given contact id
* get a handle (user@domain.tld) from a given contact id
*
* @param int $contact_id The id in the contact table
* @param int $pcontact_id The id in the contact table (Used for the public contact)
@ -1090,7 +1090,7 @@ class Diaspora
}
/**
* @brief get a url (scheme://domain.tld/u/user) from a given Diaspora*
* get a url (scheme://domain.tld/u/user) from a given Diaspora*
* fcontact guid
*
* @param mixed $fcontact_guid Hexadecimal string guid
@ -1116,7 +1116,7 @@ class Diaspora
}
/**
* @brief Get a contact id for a given handle
* Get a contact id for a given handle
*
* @todo Move to Friendica\Model\Contact
*
@ -1160,7 +1160,7 @@ class Diaspora
}
/**
* @brief Check if posting is allowed for this contact
* Check if posting is allowed for this contact
*
* @param array $importer Array of the importer user
* @param array $contact The contact that is checked
@ -1213,7 +1213,7 @@ class Diaspora
}
/**
* @brief Fetches the contact id for a handle and checks if posting is allowed
* Fetches the contact id for a handle and checks if posting is allowed
*
* @param array $importer Array of the importer user
* @param string $handle The checked handle in the format user@domain.tld
@ -1245,7 +1245,7 @@ class Diaspora
}
/**
* @brief Does the message already exists on the system?
* Does the message already exists on the system?
*
* @param int $uid The user id
* @param string $guid The guid of the message
@ -1265,7 +1265,7 @@ class Diaspora
}
/**
* @brief Checks for links to posts in a message
* Checks for links to posts in a message
*
* @param array $item The item array
* @return void
@ -1291,7 +1291,7 @@ class Diaspora
}
/**
* @brief Checks for relative /people/* links in an item body to match local
* Checks for relative /people/* links in an item body to match local
* contacts or prepends the remote host taken from the author link.
*
* @param string $body The item body to replace links from
@ -1327,7 +1327,7 @@ class Diaspora
}
/**
* @brief sub function of "fetchGuid" which checks for links in messages
* sub function of "fetchGuid" which checks for links in messages
*
* @param array $match array containing a link that has to be checked for a message link
* @param array $item The item array
@ -1343,7 +1343,7 @@ class Diaspora
}
/**
* @brief Fetches an item with a given guid from a given server
* Fetches an item with a given guid from a given server
*
* @param string $guid the message guid
* @param string $server The server address
@ -1378,7 +1378,7 @@ class Diaspora
}
/**
* @brief Fetches a message from a server
* Fetches a message from a server
*
* @param string $guid message guid
* @param string $server The url of the server
@ -1457,7 +1457,7 @@ class Diaspora
}
/**
* @brief Fetches an item with a given URL
* Fetches an item with a given URL
*
* @param string $url the message url
*
@ -1490,7 +1490,7 @@ class Diaspora
}
/**
* @brief Fetches the item record of a given guid
* Fetches the item record of a given guid
*
* @param int $uid The user id
* @param string $guid message guid
@ -1534,7 +1534,7 @@ class Diaspora
}
/**
* @brief returns contact details
* returns contact details
*
* @param array $def_contact The default contact if the person isn't found
* @param array $person The record of the person
@ -1561,7 +1561,7 @@ class Diaspora
}
/**
* @brief Is the profile a hubzilla profile?
* Is the profile a hubzilla profile?
*
* @param string $url The profile link
*
@ -1573,7 +1573,7 @@ class Diaspora
}
/**
* @brief Generate a post link with a given handle and message guid
* Generate a post link with a given handle and message guid
*
* @param string $addr The user handle
* @param string $guid message guid
@ -1612,7 +1612,7 @@ class Diaspora
}
/**
* @brief Receives account migration
* Receives account migration
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -1675,7 +1675,7 @@ class Diaspora
}
/**
* @brief Processes an account deletion
* Processes an account deletion
*
* @param object $data The message object
*
@ -1699,7 +1699,7 @@ class Diaspora
}
/**
* @brief Fetch the uri from our database if we already have this item (maybe from ourselves)
* Fetch the uri from our database if we already have this item (maybe from ourselves)
*
* @param string $author Author handle
* @param string $guid Message guid
@ -1728,7 +1728,7 @@ class Diaspora
}
/**
* @brief Fetch the guid from our database with a given uri
* Fetch the guid from our database with a given uri
*
* @param string $uri Message uri
* @param string $uid Author handle
@ -1747,7 +1747,7 @@ class Diaspora
}
/**
* @brief Find the best importer for a comment, like, ...
* Find the best importer for a comment, like, ...
*
* @param string $guid The guid of the item
*
@ -1768,7 +1768,7 @@ class Diaspora
}
/**
* @brief Processes an incoming comment
* Processes an incoming comment
*
* @param array $importer Array of the importer user
* @param string $sender The sender of the message
@ -1885,7 +1885,7 @@ class Diaspora
}
/**
* @brief processes and stores private messages
* processes and stores private messages
*
* @param array $importer Array of the importer user
* @param array $contact The contact of the message
@ -1945,7 +1945,7 @@ class Diaspora
}
/**
* @brief Processes new private messages (answers to private messages are processed elsewhere)
* Processes new private messages (answers to private messages are processed elsewhere)
*
* @param array $importer Array of the importer user
* @param array $msg Array of the processed message, author handle and key
@ -2004,7 +2004,7 @@ class Diaspora
}
/**
* @brief Processes "like" messages
* Processes "like" messages
*
* @param array $importer Array of the importer user
* @param string $sender The sender of the message
@ -2116,7 +2116,7 @@ class Diaspora
}
/**
* @brief Processes private messages
* Processes private messages
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2177,7 +2177,7 @@ class Diaspora
}
/**
* @brief Processes participations - unsupported by now
* Processes participations - unsupported by now
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2241,7 +2241,7 @@ class Diaspora
}
/**
* @brief Processes photos - unneeded
* Processes photos - unneeded
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2256,7 +2256,7 @@ class Diaspora
}
/**
* @brief Processes poll participations - unssupported
* Processes poll participations - unssupported
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2270,7 +2270,7 @@ class Diaspora
}
/**
* @brief Processes incoming profile updates
* Processes incoming profile updates
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2368,7 +2368,7 @@ class Diaspora
}
/**
* @brief Processes incoming friend requests
* Processes incoming friend requests
*
* @param array $importer Array of the importer user
* @param array $contact The contact that send the request
@ -2387,7 +2387,7 @@ class Diaspora
}
/**
* @brief Processes incoming sharing notification
* Processes incoming sharing notification
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2499,7 +2499,7 @@ class Diaspora
}
/**
* @brief Fetches a message with a given guid
* Fetches a message with a given guid
*
* @param string $guid message guid
* @param string $orig_author handle of the original post
@ -2579,7 +2579,7 @@ class Diaspora
}
/**
* @brief Stores a reshare activity
* Stores a reshare activity
*
* @param array $item Array of reshare post
* @param integer $parent_message_id Id of the parent post
@ -2627,7 +2627,7 @@ class Diaspora
}
/**
* @brief Processes a reshare message
* Processes a reshare message
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2732,7 +2732,7 @@ class Diaspora
}
/**
* @brief Processes retractions
* Processes retractions
*
* @param array $importer Array of the importer user
* @param array $contact The contact of the item owner
@ -2797,7 +2797,7 @@ class Diaspora
}
/**
* @brief Receives retraction messages
* Receives retraction messages
*
* @param array $importer Array of the importer user
* @param string $sender The sender of the message
@ -2843,7 +2843,7 @@ class Diaspora
}
/**
* @brief Receives status messages
* Receives status messages
*
* @param array $importer Array of the importer user
* @param SimpleXMLElement $data The message object
@ -2967,7 +2967,7 @@ class Diaspora
* ************************************************************************************** */
/**
* @brief returnes the handle of a contact
* returnes the handle of a contact
*
* @param array $contact contact array
*
@ -2993,7 +2993,7 @@ class Diaspora
/**
* @brief Creates the data for a private message in the new format
* Creates the data for a private message in the new format
*
* @param string $msg The message that is to be transmitted
* @param array $user The record of the sender
@ -3035,7 +3035,7 @@ class Diaspora
}
/**
* @brief Creates the envelope for the "fetch" endpoint and for the new format
* Creates the envelope for the "fetch" endpoint and for the new format
*
* @param string $msg The message that is to be transmitted
* @param array $user The record of the sender
@ -3075,7 +3075,7 @@ class Diaspora
}
/**
* @brief Create the envelope for a message
* Create the envelope for a message
*
* @param string $msg The message that is to be transmitted
* @param array $user The record of the sender
@ -3101,7 +3101,7 @@ class Diaspora
}
/**
* @brief Creates a signature for a message
* Creates a signature for a message
*
* @param array $owner the array of the owner of the message
* @param array $message The message that is to be signed
@ -3120,7 +3120,7 @@ class Diaspora
}
/**
* @brief Transmit a message to a target server
* Transmit a message to a target server
*
* @param array $owner the array of the item owner
* @param array $contact Target of the communication
@ -3178,7 +3178,7 @@ class Diaspora
/**
* @brief Build the post xml
* Build the post xml
*
* @param string $type The message type
* @param array $message The message data
@ -3193,7 +3193,7 @@ class Diaspora
}
/**
* @brief Builds and transmit messages
* Builds and transmit messages
*
* @param array $owner the array of the item owner
* @param array $contact Target of the communication
@ -3228,7 +3228,7 @@ class Diaspora
}
/**
* @brief sends a participation (Used to get all further updates)
* sends a participation (Used to get all further updates)
*
* @param array $contact Target of the communication
* @param array $item Item array
@ -3277,7 +3277,7 @@ class Diaspora
}
/**
* @brief sends an account migration
* sends an account migration
*
* @param array $owner the array of the item owner
* @param array $contact Target of the communication
@ -3305,7 +3305,7 @@ class Diaspora
}
/**
* @brief Sends a "share" message
* Sends a "share" message
*
* @param array $owner the array of the item owner
* @param array $contact Target of the communication
@ -3349,7 +3349,7 @@ class Diaspora
}
/**
* @brief sends an "unshare"
* sends an "unshare"
*
* @param array $owner the array of the item owner
* @param array $contact Target of the communication
@ -3370,7 +3370,7 @@ class Diaspora
}
/**
* @brief Checks a message body if it is a reshare
* Checks a message body if it is a reshare
*
* @param string $body The message body that is to be check
* @param bool $complete Should it be a complete check or a simple check?
@ -3428,7 +3428,7 @@ class Diaspora
}
/**
* @brief Create an event array
* Create an event array
*
* @param integer $event_id The id of the event
*
@ -3508,7 +3508,7 @@ class Diaspora
}
/**
* @brief Create a post (status message or reshare)
* Create a post (status message or reshare)
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3647,7 +3647,7 @@ class Diaspora
}
/**
* @brief Sends a post
* Sends a post
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3666,7 +3666,7 @@ class Diaspora
}
/**
* @brief Creates a "like" object
* Creates a "like" object
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3698,7 +3698,7 @@ class Diaspora
}
/**
* @brief Creates an "EventParticipation" object
* Creates an "EventParticipation" object
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3736,7 +3736,7 @@ class Diaspora
}
/**
* @brief Creates the object for a comment
* Creates the object for a comment
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3803,7 +3803,7 @@ class Diaspora
}
/**
* @brief Send a like or a comment
* Send a like or a comment
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3837,7 +3837,7 @@ class Diaspora
}
/**
* @brief Creates a message from a signature record entry
* Creates a message from a signature record entry
*
* @param array $item The item that will be exported
* @return array The message
@ -3882,7 +3882,7 @@ class Diaspora
}
/**
* @brief Relays messages (like, comment, retraction) to other servers if we are the thread owner
* Relays messages (like, comment, retraction) to other servers if we are the thread owner
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3938,7 +3938,7 @@ class Diaspora
}
/**
* @brief Sends a retraction (deletion) of a message, like or comment
* Sends a retraction (deletion) of a message, like or comment
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3973,7 +3973,7 @@ class Diaspora
}
/**
* @brief Sends a mail
* Sends a mail
*
* @param array $item The item that will be exported
* @param array $owner The owner
@ -4024,7 +4024,7 @@ class Diaspora
}
/**
* @brief Split a name into first name and last name
* Split a name into first name and last name
*
* @param string $name The name
*
@ -4080,7 +4080,7 @@ class Diaspora
}
/**
* @brief Create profile data
* Create profile data
*
* @param int $uid The user id
*
@ -4165,7 +4165,7 @@ class Diaspora
}
/**
* @brief Sends profile data
* Sends profile data
*
* @param int $uid The user id
* @param bool $recips optional, default false
@ -4207,7 +4207,7 @@ class Diaspora
}
/**
* @brief Creates the signature for likes that are created on our system
* Creates the signature for likes that are created on our system
*
* @param integer $uid The user of that comment
* @param array $item Item array
@ -4238,7 +4238,7 @@ class Diaspora
}
/**
* @brief Creates the signature for Comments that are created on our system
* Creates the signature for Comments that are created on our system
*
* @param integer $uid The user of that comment
* @param array $item Item array

2
src/Protocol/Email.php
View file

@ -12,7 +12,7 @@ use Friendica\Model\Item;
use Friendica\Util\Strings;
/**
* @brief Email class
* Email class
*/
class Email
{

6
src/Protocol/Feed.php
View file

@ -1,7 +1,7 @@
<?php
/**
* @file src/Protocol/Feed.php
* @brief Imports RSS/RDF/Atom feeds
* Imports RSS/RDF/Atom feeds
*
*/
namespace Friendica\Protocol;
@ -19,12 +19,12 @@ use Friendica\Util\ParseUrl;
use Friendica\Util\XML;
/**
* @brief This class contain functions to import feeds
* This class contain functions to import feeds
*
*/
class Feed {
/**
* @brief Read a RSS/RDF/Atom feed and create an item entry for it
* Read a RSS/RDF/Atom feed and create an item entry for it
*
* @param string $xml The feed data
* @param array $importer The user record of the importer

70
src/Protocol/OStatus.php
View file

@ -33,7 +33,7 @@ require_once 'mod/share.php';
require_once 'include/api.php';
/**
* @brief This class contain functions for the OStatus protocol
* This class contain functions for the OStatus protocol
*/
class OStatus
{
@ -41,7 +41,7 @@ class OStatus
private static $conv_list = [];
/**
* @brief Fetches author data
* Fetches author data
*
* @param DOMXPath $xpath The xpath object
* @param object $context The xml context of the author details
@ -240,7 +240,7 @@ class OStatus
}
/**
* @brief Fetches author data from a given XML string
* Fetches author data from a given XML string
*
* @param string $xml The XML
* @param array $importer user record of the importing user
@ -277,7 +277,7 @@ class OStatus
}
/**
* @brief Read attributes from element
* Read attributes from element
*
* @param object $element Element object
*
@ -295,7 +295,7 @@ class OStatus
}
/**
* @brief Imports an XML string containing OStatus elements
* Imports an XML string containing OStatus elements
*
* @param string $xml The XML
* @param array $importer user record of the importing user
@ -311,7 +311,7 @@ class OStatus
}
/**
* @brief Internal feed processing
* Internal feed processing
*
* @param string $xml The XML
* @param array $importer user record of the importing user
@ -576,7 +576,7 @@ class OStatus
}
/**
* @brief Processes the XML for a post
* Processes the XML for a post
*
* @param DOMXPath $xpath The xpath object
* @param object $entry The xml entry that is processed
@ -725,7 +725,7 @@ class OStatus
}
/**
* @brief Fetch the conversation for posts
* Fetch the conversation for posts
*
* @param string $conversation The link to the conversation
* @param string $conversation_uri The conversation in "uri" format
@ -787,7 +787,7 @@ class OStatus
}
/**
* @brief Store a feed in several conversation entries
* Store a feed in several conversation entries
*
* @param string $xml The feed
* @param string $conversation conversation
@ -868,7 +868,7 @@ class OStatus
}
/**
* @brief Fetch the own post so that it can be stored later
* Fetch the own post so that it can be stored later
*
* We want to store the original data for later processing.
* This function is meant for cases where we process a feed with multiple entries.
@ -907,7 +907,7 @@ class OStatus
}
/**
* @brief Fetch related posts and processes them
* Fetch related posts and processes them
*
* @param string $related The link to the related item
* @param string $related_uri The related item in "uri" format
@ -1016,7 +1016,7 @@ class OStatus
}
/**
* @brief Processes the XML for a repeated post
* Processes the XML for a repeated post
*
* @param DOMXPath $xpath The xpath object
* @param object $entry The xml entry that is processed
@ -1085,7 +1085,7 @@ class OStatus
}
/**
* @brief Processes links in the XML
* Processes links in the XML
*
* @param object $links The xml data that contain links
* @param array $item The item array
@ -1155,7 +1155,7 @@ class OStatus
}
/**
* @brief Create an url out of an uri
* Create an url out of an uri
*
* @param string $href URI in the format "parameter1:parameter1:..."
*
@ -1187,7 +1187,7 @@ class OStatus
}
/**
* @brief Checks if the current post is a reshare
* Checks if the current post is a reshare
*
* @param array $item The item array of thw post
*
@ -1204,7 +1204,7 @@ class OStatus
}
/**
* @brief Cleans the body of a post if it contains picture links
* Cleans the body of a post if it contains picture links
*
* @param string $body The body
*
@ -1242,7 +1242,7 @@ class OStatus
}
/**
* @brief Adds the header elements to the XML document
* Adds the header elements to the XML document
*
* @param DOMDocument $doc XML document
* @param array $owner Contact data of the poster
@ -1331,7 +1331,7 @@ class OStatus
}
/**
* @brief Add the link to the push hubs to the XML document
* Add the link to the push hubs to the XML document
*
* @param DOMDocument $doc XML document
* @param object $root XML root element where the hub links are added
@ -1346,7 +1346,7 @@ class OStatus
}
/**
* @brief Adds attachment data to the XML document
* Adds attachment data to the XML document
*
* @param DOMDocument $doc XML document
* @param object $root XML root element where the hub links are added
@ -1419,7 +1419,7 @@ class OStatus
}
/**
* @brief Adds the author element to the XML document
* Adds the author element to the XML document
*
* @param DOMDocument $doc XML document
* @param array $owner Contact data of the poster
@ -1505,7 +1505,7 @@ class OStatus
*/
/**
* @brief Returns the given activity if present - otherwise returns the "post" activity
* Returns the given activity if present - otherwise returns the "post" activity
*
* @param array $item Data of the item that is to be posted
*
@ -1521,7 +1521,7 @@ class OStatus
}
/**
* @brief Returns the given object type if present - otherwise returns the "note" object type
* Returns the given object type if present - otherwise returns the "note" object type
*
* @param array $item Data of the item that is to be posted
*
@ -1537,7 +1537,7 @@ class OStatus
}
/**
* @brief Adds an entry element to the XML document
* Adds an entry element to the XML document
*
* @param DOMDocument $doc XML document
* @param array $item Data of the item that is to be posted
@ -1572,7 +1572,7 @@ class OStatus
}
/**
* @brief Adds a source entry to the XML document
* Adds a source entry to the XML document
*
* @param DOMDocument $doc XML document
* @param array $contact Array of the contact that is added
@ -1594,7 +1594,7 @@ class OStatus
}
/**
* @brief Fetches contact data from the contact or the gcontact table
* Fetches contact data from the contact or the gcontact table
*
* @param string $url URL of the contact
* @param array $owner Contact data of the poster
@ -1647,7 +1647,7 @@ class OStatus
}
/**
* @brief Adds an entry element with reshared content
* Adds an entry element with reshared content
*
* @param DOMDocument $doc XML document
* @param array $item Data of the item that is to be posted
@ -1713,7 +1713,7 @@ class OStatus
}
/**
* @brief Adds an entry element with a "like"
* Adds an entry element with a "like"
*
* @param DOMDocument $doc XML document
* @param array $item Data of the item that is to be posted
@ -1752,7 +1752,7 @@ class OStatus
}
/**
* @brief Adds the person object element to the XML document
* Adds the person object element to the XML document
*
* @param DOMDocument $doc XML document
* @param array $owner Contact data of the poster
@ -1797,7 +1797,7 @@ class OStatus
}
/**
* @brief Adds a follow/unfollow entry element
* Adds a follow/unfollow entry element
*
* @param DOMDocument $doc XML document
* @param array $item Data of the follow/unfollow message
@ -1861,7 +1861,7 @@ class OStatus
}
/**
* @brief Adds a regular entry element
* Adds a regular entry element
*
* @param DOMDocument $doc XML document
* @param array $item Data of the item that is to be posted
@ -1901,7 +1901,7 @@ class OStatus
}
/**
* @brief Adds a header element to the XML document
* Adds a header element to the XML document
*
* @param DOMDocument $doc XML document
* @param array $owner Contact data of the poster
@ -1942,7 +1942,7 @@ class OStatus
}
/**
* @brief Adds elements to the XML document
* Adds elements to the XML document
*
* @param DOMDocument $doc XML document
* @param \DOMElement $entry Entry element where the content is added
@ -1991,7 +1991,7 @@ class OStatus
}
/**
* @brief Adds the elements at the foot of an entry to the XML document
* Adds the elements at the foot of an entry to the XML document
*
* @param DOMDocument $doc XML document
* @param object $entry The entry element where the elements are added
@ -2155,8 +2155,6 @@ class OStatus
* Updates the provided last_update parameter if the result comes from the
* cache or it is empty
*
* @brief Creates the XML feed for a given nickname
*
* @param string $owner_nick Nickname of the feed owner
* @param string $last_update Date of the last update
* @param integer $max_items Number of maximum items to fetch
@ -2252,7 +2250,7 @@ class OStatus
}
/**
* @brief Creates the XML for a salmon message
* Creates the XML for a salmon message
*
* @param array $item Data of the item that is to be posted
* @param array $owner Contact data of the poster

8
src/Protocol/PortableContact.php
View file

@ -37,7 +37,7 @@ class PortableContact
const USERS_GCONTACTS_FALLBACK = 3;
/**
* @brief Fetch POCO data
* Fetch POCO data
*
* @param integer $cid Contact ID
* @param integer $uid User ID
@ -61,7 +61,7 @@ class PortableContact
}
/**
* @brief Fetch POCO data from the worker
* Fetch POCO data from the worker
*
* @param integer $cid Contact ID
* @param integer $uid User ID
@ -215,7 +215,7 @@ class PortableContact
}
/**
* @brief Returns a list of all known servers
* Returns a list of all known servers
* @return array List of server urls
* @throws Exception
*/
@ -239,7 +239,7 @@ class PortableContact
}
/**
* @brief Fetch server list from remote servers and adds them when they are new.
* Fetch server list from remote servers and adds them when they are new.
*
* @param string $poco URL to the POCO endpoint
* @throws \Friendica\Network\HTTPException\InternalServerErrorException

3
src/Protocol/Salmon.php
View file

@ -12,7 +12,8 @@ use Friendica\Util\Strings;
use Friendica\Util\XML;
/**
* @brief Salmon Protocol class
* Salmon Protocol class
*
* The Salmon Protocol is a message exchange protocol running over HTTP designed to decentralize commentary
* and annotations made against newsfeed articles such as blog posts.
*/