Browse Source

Update more PHPDoc, including in include/

pull/6482/head
Hypolite Petovan 2 years ago
parent
commit
070aa016e0
17 changed files with 99 additions and 30 deletions
  1. +33
    -8
      include/conversation.php
  2. +2
    -1
      include/dba.php
  3. +11
    -6
      include/enotify.php
  4. +9
    -0
      include/items.php
  5. +1
    -0
      include/text.php
  6. +1
    -0
      mod/item.php
  7. +5
    -0
      mod/network.php
  8. +3
    -0
      mod/uexport.php
  9. +4
    -3
      src/Content/ForumManager.php
  10. +1
    -1
      src/Content/Text/BBCode.php
  11. +2
    -0
      src/Core/NotificationsManager.php
  12. +1
    -0
      src/Model/Contact.php
  13. +15
    -11
      src/Model/Event.php
  14. +7
    -0
      src/Model/GContact.php
  15. +1
    -0
      src/Model/Queue.php
  16. +2
    -0
      src/Model/User.php
  17. +1
    -0
      src/Protocol/PortableContact.php

+ 33
- 8
include/conversation.php View File

@ -117,6 +117,10 @@ function item_redir_and_replace_images($body, $images, $cid) {
/**
* Render actions localized
*
* @param $item
* @throws ImagickException
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function localize_item(&$item)
{
@ -367,6 +371,8 @@ function localize_item(&$item)
/**
* Count the total of comments on this item and its desendants
* @TODO proper type-hint + doc-tag
* @param $item
* @return int
*/
function count_descendants($item) {
$total = count($item['children']);
@ -436,7 +442,17 @@ function conv_get_blocklist()
* The $mode parameter decides between the various renderings and also
* figures out how to determine page owner and other contextual items
* that are based on unique features of the calling module.
*
* @param App $a
* @param array $items
* @param Pager $pager
* @param $mode
* @param $update
* @param bool $preview
* @param string $order
* @param int $uid
* @return string
* @throws ImagickException
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function conversation(App $a, array $items, Pager $pager, $mode, $update, $preview = false, $order = 'commented', $uid = 0)
{
@ -783,7 +799,11 @@ function conversation(App $a, array $items, Pager $pager, $mode, $update, $previ
*
* @param array $parents Parent items
*
* @param $block_authors
* @param $order
* @param $uid
* @return array items with parents and comments
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function conversation_add_children(array $parents, $block_authors, $order, $uid) {
$max_comments = Config::get('system', 'max_comments', 100);
@ -912,9 +932,11 @@ function item_photo_menu($item) {
* @brief Checks item to see if it is one of the builtin activities (like/dislike, event attendance, consensus items, etc.)
* Increments the count of each matching activity and adds a link to the author as needed.
*
* @param array $item
* @param array $item
* @param array &$conv_responses (already created with builtin activity structure)
* @return void
* @throws ImagickException
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function builtin_activity_puller($item, &$conv_responses) {
foreach ($conv_responses as $mode => $v) {
@ -985,11 +1007,13 @@ function builtin_activity_puller($item, &$conv_responses) {
/**
* Format the vote text for a profile item
* @param int $cnt = number of people who vote the item
* @param array $arr = array of pre-linked names of likers/dislikers
*
* @param int $cnt = number of people who vote the item
* @param array $arr = array of pre-linked names of likers/dislikers
* @param string $type = one of 'like, 'dislike', 'attendyes', 'attendno', 'attendmaybe'
* @param int $id = item id
* @param int $id = item id
* @return string formatted text
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function format_like($cnt, array $arr, $type, $id) {
$o = '';
@ -1199,8 +1223,8 @@ function status_editor(App $a, $x, $notes_cid = 0, $popup = false)
*
* @param array $item_list
* @param array $parent
* @param bool $recursive
* @return type
* @param bool $recursive
* @return array
*/
function get_item_children(array &$item_list, array $parent, $recursive = true)
{
@ -1330,6 +1354,7 @@ function smart_flatten_conversation(array $parent)
* @param array $item_list A list of items belonging to one or more conversations
* @param string $order Either on "created" or "commented"
* @return array
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function conv_sort(array $item_list, $order)
{
@ -1425,7 +1450,7 @@ function sort_thr_created_rev(array $a, array $b)
*
* @param array $a
* @param array $b
* @return type
* @return int|lt
*/
function sort_thr_commented(array $a, array $b)
{


+ 2
- 1
include/dba.php View File

@ -9,8 +9,9 @@ use Friendica\Database\DBA;
* DBA::select, DBA::exists, DBA::insert
* DBA::delete, DBA::update, DBA::p, DBA::e
*
* @param $args Query parameters (1 to N parameters of different types)
* @param $sql
* @return array|bool Query array
* @throws Exception
* @deprecated
*/
function q($sql) {


+ 11
- 6
include/enotify.php View File

@ -21,10 +21,12 @@ use Friendica\Util\Strings;
* @brief Creates a notification entry and possibly sends a mail
*
* @param array $params Array with the elements:
* uid, item, parent, type, otype, verb, event,
* link, subject, body, to_name, to_email, source_name,
* source_link, activity, preamble, notify_flags,
* language, show_in_notification_page
* uid, item, parent, type, otype, verb, event,
* link, subject, body, to_name, to_email, source_name,
* source_link, activity, preamble, notify_flags,
* language, show_in_notification_page
* @return bool|object
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function notification($params)
{
@ -687,6 +689,7 @@ function notification($params)
* @brief Checks for users who should be notified
*
* @param int $itemid ID of the item for which the check should be done
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function check_user_notification($itemid) {
// fetch all users in the thread
@ -702,9 +705,11 @@ function check_user_notification($itemid) {
/**
* @brief Checks for item related notifications and sends them
*
* @param int $itemid ID of the item for which the check should be done
* @param int $uid User ID
* @param int $itemid ID of the item for which the check should be done
* @param int $uid User ID
* @param string $defaulttype (Optional) Forces a notification with this type.
* @return bool
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function check_item_notification($itemid, $uid, $defaulttype = "") {
$notification_data = ["uid" => $uid, "profiles" => []];


+ 9
- 0
include/items.php View File

@ -242,6 +242,15 @@ function add_page_info_to_body($body, $texturl = false, $no_photos = false)
* model where comments can have sub-threads. That would require some massive sorting
* to get all the feed items into a mostly linear ordering, and might still require
* recursion.
*
* @param $xml
* @param array $importer
* @param array $contact
* @param $hub
* @param int $datedir
* @param int $pass
* @throws ImagickException
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function consume_feed($xml, array $importer, array $contact, &$hub, $datedir = 0, $pass = 0)
{


+ 1
- 0
include/text.php View File

@ -160,6 +160,7 @@ function redir_private_images($a, &$item)
*
* @param string $text String with bbcode.
* @return string Formattet HTML.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function prepare_text($text) {
if (stristr($text, '[nosmile]')) {


+ 1
- 0
mod/item.php View File

@ -912,6 +912,7 @@ function item_content(App $a)
* This function removes the tag $tag from the text $body and replaces it with
* the appropriate link.
*
* @param App $a
* @param string $body the text to replace the tag in
* @param string $inform a comma-seperated string containing everybody to inform
* @param string $str_tags string to add the tag to


+ 5
- 0
mod/network.php View File

@ -328,6 +328,7 @@ function networkSetSeen($condition)
* @param integer $update Used for the automatic reloading
* @param string $ordering
* @return string HTML of the conversation
* @throws ImagickException
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function networkConversation(App $a, $items, Pager $pager, $mode, $update, $ordering = '')
@ -396,6 +397,7 @@ function network_content(App $a, $update = 0, $parent = 0)
* @param App $a The global App
* @param integer $update Used for the automatic reloading
* @return string HTML of the network content in flat view
* @throws ImagickException
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @global Pager $pager
*/
@ -489,6 +491,7 @@ function networkFlatView(App $a, $update = 0)
* @param integer $update Used for the automatic reloading
* @param integer $parent
* @return string HTML of the network content in flat view
* @throws ImagickException
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @global Pager $pager
*/
@ -949,6 +952,7 @@ function networkThreadedView(App $a, $update, $parent)
*
* @param App $a The global App
* @return string Html of the networktab
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function network_tabs(App $a)
{
@ -1048,6 +1052,7 @@ function network_tabs(App $a)
* of the page to make the correct asynchronous call. This is obtained through the Pager that was instantiated in
* networkThreadedView or networkFlatView.
*
* @param App $a
* @param string $htmlhead The head tag HTML string
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @global Pager $pager


+ 3
- 0
mod/uexport.php View File

@ -135,6 +135,9 @@ function uexport_account($a) {
/**
* echoes account data and items as separated json, one per line
*
* @param App $a
* @throws Exception
*/
function uexport_all(App $a) {


+ 4
- 3
src/Content/ForumManager.php View File

@ -188,9 +188,10 @@ class ForumManager
* Count unread items of connected forums and private groups
*
* @return array
* 'id' => contact id
* 'name' => contact/forum name
* 'count' => counted unseen forum items
* 'id' => contact id
* 'name' => contact/forum name
* 'count' => counted unseen forum items
* @throws \Exception
*/
public static function countUnseenItems()
{


+ 1
- 1
src/Content/Text/BBCode.php View File

@ -1150,7 +1150,7 @@ class BBCode extends BaseObject
* @return string
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function convert($text, $try_oembed = true, $simple_html = false, $for_plaintext = false)
public static function convert($text, $try_oembed = true, $simple_html = 0, $for_plaintext = false)
{
$a = self::getApp();


+ 2
- 0
src/Core/NotificationsManager.php View File

@ -132,6 +132,7 @@ class NotificationsManager extends BaseObject
* @param array $note note array
* @param bool $seen optional true or false, default true
* @return bool true on success, false on errors
* @throws \Exception
*/
public function setSeen($note, $seen = true)
{
@ -150,6 +151,7 @@ class NotificationsManager extends BaseObject
*
* @param bool $seen optional true or false. default true
* @return bool true on success, false on error
* @throws \Exception
*/
public function setAllSeen($seen = true)
{


+ 1
- 0
src/Model/Contact.php View File

@ -1054,6 +1054,7 @@ class Contact extends BaseObject
*
* @param int $uid uid
* @return array
* @throws \Exception
*/
public static function getUngroupedList($uid)
{


+ 15
- 11
src/Model/Event.php View File

@ -471,6 +471,7 @@ class Event extends BaseObject
* @param int $event_id The ID of the event in the event table
* @param string $sql_extra
* @return array Query result
* @throws \Exception
*/
public static function getListById($owner_uid, $event_id, $sql_extra = '')
{
@ -499,17 +500,18 @@ class Event extends BaseObject
/**
* @brief Get all events in a specific time frame.
*
* @param int $owner_uid The User ID of the owner of the events.
* @param array $event_params An associative array with
* int 'ignore' =>
* string 'start' => Start time of the timeframe.
* string 'finish' => Finish time of the timeframe.
* string 'adjust_start' =>
* string 'adjust_finish' =>
* @param int $owner_uid The User ID of the owner of the events.
* @param array $event_params An associative array with
* int 'ignore' =>
* string 'start' => Start time of the timeframe.
* string 'finish' => Finish time of the timeframe.
* string 'adjust_start' =>
* string 'adjust_finish' =>
*
* @param string $sql_extra Additional sql conditions (e.g. permission request).
* @param string $sql_extra Additional sql conditions (e.g. permission request).
*
* @return array Query results.
* @throws \Exception
*/
public static function getListByDate($owner_uid, $event_params, $sql_extra = '')
{
@ -633,12 +635,13 @@ class Event extends BaseObject
/**
* @brief Format event to export format (ical/csv).
*
* @param array $events Query result for events.
* @param string $format The output format (ical/csv).
* @param array $events Query result for events.
* @param string $format The output format (ical/csv).
*
* @param $timezone
* @return string Content according to selected export format.
*
* @todo Implement timezone support
* @todo Implement timezone support
*/
private static function formatListForExport(array $events, $format, $timezone)
{
@ -954,6 +957,7 @@ class Event extends BaseObject
* 'name' => The name of the location,<br>
* 'address' => The address of the location,<br>
* 'coordinates' => Latitude‎ and longitude‎ (e.g. '48.864716,2.349014').<br>
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
private static function locationToArray($s = '') {
if ($s == '') {


+ 7
- 0
src/Model/GContact.php View File

@ -242,6 +242,7 @@ class GContact
* @param integer $uid id
* @param integer $cid id
* @return integer
* @throws Exception
*/
public static function countCommonFriends($uid, $cid)
{
@ -269,6 +270,7 @@ class GContact
* @param integer $uid id
* @param integer $zcid zcid
* @return integer
* @throws Exception
*/
public static function countCommonFriendsZcid($uid, $zcid)
{
@ -295,6 +297,7 @@ class GContact
* @param integer $limit optional, default 9999
* @param boolean $shuffle optional, default false
* @return object
* @throws Exception
*/
public static function commonFriends($uid, $cid, $start = 0, $limit = 9999, $shuffle = false)
{
@ -333,6 +336,7 @@ class GContact
* @param integer $limit optional, default 9999
* @param boolean $shuffle optional, default false
* @return object
* @throws Exception
*/
public static function commonFriendsZcid($uid, $zcid, $start = 0, $limit = 9999, $shuffle = false)
{
@ -362,6 +366,7 @@ class GContact
* @param integer $uid user
* @param integer $cid cid
* @return integer
* @throws Exception
*/
public static function countAllFriends($uid, $cid)
{
@ -387,6 +392,7 @@ class GContact
* @param integer $start optional, default 0
* @param integer $limit optional, default 80
* @return array
* @throws Exception
*/
public static function allFriends($uid, $cid, $start = 0, $limit = 80)
{
@ -1053,6 +1059,7 @@ class GContact
/**
* @return string
* @throws Exception
*/
public static function getRandomUrl()
{


+ 1
- 0
src/Model/Queue.php View File

@ -52,6 +52,7 @@ class Queue
* @param int $cid Contact id
*
* @return bool The communication with this contact has currently problems
* @throws \Exception
*/
public static function wasDelayed($cid)
{


+ 2
- 0
src/Model/User.php View File

@ -729,6 +729,7 @@ class User
* @param string $siteurl
* @param string $password Plaintext password
* @return NULL|boolean from notification() and email() inherited
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
{
@ -764,6 +765,7 @@ class User
* @param string $siteurl
* @param string $password Plaintext password
* @return NULL|boolean from notification() and email() inherited
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function sendRegisterOpenEmail($user, $sitename, $siteurl, $password)
{


+ 1
- 0
src/Protocol/PortableContact.php View File

@ -1522,6 +1522,7 @@ class PortableContact
/**
* @brief Returns a list of all known servers
* @return array List of server urls
* @throws Exception
*/
public static function serverlist()
{


Loading…
Cancel
Save