Browse Source

@brief is removed completely

pull/8135/head
Michael 1 month ago
parent
commit
0a4119adaf
100 changed files with 520 additions and 578 deletions
  1. +1
    -1
      bin/worker.php
  2. +9
    -9
      boot.php
  3. +43
    -61
      include/api.php
  4. +13
    -15
      include/conversation.php
  5. +1
    -1
      include/dba.php
  6. +4
    -4
      include/enotify.php
  7. +4
    -3
      mod/cal.php
  8. +2
    -1
      mod/dfrn_confirm.php
  9. +1
    -1
      mod/dfrn_notify.php
  10. +1
    -1
      mod/dfrn_request.php
  11. +1
    -1
      mod/events.php
  12. +1
    -1
      mod/match.php
  13. +6
    -6
      mod/network.php
  14. +1
    -1
      mod/notifications.php
  15. +2
    -2
      mod/parse_url.php
  16. +3
    -3
      mod/ping.php
  17. +1
    -1
      mod/uimport.php
  18. +1
    -1
      mod/wall_upload.php
  19. +1
    -1
      mod/worker.php
  20. +1
    -3
      src/App.php
  21. +2
    -2
      src/App/Authentication.php
  22. +5
    -5
      src/BaseModule.php
  23. +1
    -1
      src/Console/ArchiveContact.php
  24. +1
    -1
      src/Console/Cache.php
  25. +1
    -1
      src/Console/Config.php
  26. +2
    -2
      src/Console/CreateDoxygen.php
  27. +1
    -1
      src/Console/DatabaseStructure.php
  28. +1
    -1
      src/Console/GlobalCommunityBlock.php
  29. +1
    -1
      src/Console/GlobalCommunitySilence.php
  30. +1
    -1
      src/Console/Lock.php
  31. +1
    -1
      src/Console/Maintenance.php
  32. +1
    -1
      src/Console/NewPassword.php
  33. +1
    -1
      src/Console/ServerBlock.php
  34. +1
    -1
      src/Console/Storage.php
  35. +1
    -1
      src/Content/ContactSelector.php
  36. +4
    -4
      src/Content/Feature.php
  37. +6
    -6
      src/Content/ForumManager.php
  38. +0
    -1
      src/Content/Nav.php
  39. +4
    -7
      src/Content/OEmbed.php
  40. +2
    -2
      src/Content/Pager.php
  41. +4
    -5
      src/Content/Smilies.php
  42. +12
    -13
      src/Content/Text/BBCode.php
  43. +6
    -5
      src/Content/Text/HTML.php
  44. +1
    -2
      src/Content/Text/Markdown.php
  45. +0
    -1
      src/Content/Widget.php
  46. +1
    -1
      src/Content/Widget/CalendarExport.php
  47. +0
    -5
      src/Content/Widget/TagCloud.php
  48. +4
    -4
      src/Core/Addon.php
  49. +5
    -8
      src/Core/Config.php
  50. +4
    -4
      src/Core/Config/IConfiguration.php
  51. +5
    -5
      src/Core/Hook.php
  52. +5
    -5
      src/Core/L10n.php
  53. +3
    -3
      src/Core/L10n/L10n.php
  54. +5
    -4
      src/Core/Logger.php
  55. +3
    -3
      src/Core/Process.php
  56. +9
    -9
      src/Core/Renderer.php
  57. +0
    -1
      src/Core/Search.php
  58. +1
    -1
      src/Core/Session/Handler/Cache.php
  59. +1
    -1
      src/Core/Session/Handler/Database.php
  60. +7
    -7
      src/Core/StorageManager.php
  61. +7
    -7
      src/Core/System.php
  62. +4
    -4
      src/Core/Theme.php
  63. +1
    -1
      src/Core/Update.php
  64. +2
    -2
      src/Core/UserImport.php
  65. +26
    -31
      src/Core/Worker.php
  66. +3
    -3
      src/Database/DBA.php
  67. +1
    -3
      src/Database/DBStructure.php
  68. +34
    -36
      src/Database/Database.php
  69. +6
    -6
      src/Database/PostUpdate.php
  70. +1
    -1
      src/Factory/LockFactory.php
  71. +12
    -12
      src/Model/Attach.php
  72. +42
    -42
      src/Model/Contact.php
  73. +1
    -1
      src/Model/Conversation.php
  74. +15
    -15
      src/Model/Event.php
  75. +9
    -9
      src/Model/FileTag.php
  76. +16
    -16
      src/Model/GContact.php
  77. +13
    -13
      src/Model/Group.php
  78. +33
    -37
      src/Model/Item.php
  79. +1
    -1
      src/Model/ItemContent.php
  80. +2
    -2
      src/Model/ItemURI.php
  81. +8
    -8
      src/Model/Notify.php
  82. +2
    -2
      src/Model/PermissionSet.php
  83. +14
    -14
      src/Model/Photo.php
  84. +1
    -1
      src/Model/Process.php
  85. +4
    -9
      src/Model/Profile.php
  86. +5
    -5
      src/Model/PushSubscriber.php
  87. +2
    -2
      src/Model/Storage/Database.php
  88. +4
    -4
      src/Model/Storage/Filesystem.php
  89. +7
    -7
      src/Model/Storage/IStorage.php
  90. +2
    -2
      src/Model/Storage/StorageException.php
  91. +2
    -2
      src/Model/Storage/SystemResource.php
  92. +12
    -12
      src/Model/User.php
  93. +1
    -1
      src/Module/Admin/Queue.php
  94. +2
    -2
      src/Module/Attach.php
  95. +2
    -3
      src/Module/Base/Api.php
  96. +2
    -4
      src/Module/Contact.php
  97. +0
    -2
      src/Module/Feed.php
  98. +1
    -1
      src/Module/Owa.php
  99. +2
    -2
      src/Module/Photo.php
  100. +8
    -8
      src/Module/Proxy.php

+ 1
- 1
bin/worker.php View File

@@ -2,7 +2,7 @@
<?php
/**
* @file bin/worker.php
* @brief Starts the background processing
* Starts the background processing
*/

use Dice\Dice;

+ 9
- 9
boot.php View File

@@ -34,7 +34,7 @@ define('DFRN_PROTOCOL_VERSION', '2.23');
define('NEW_UPDATE_ROUTINE_VERSION', 1170);

/**
* @brief Constant with a HTML line break.
* Constant with a HTML line break.
*
* Contains a HTML line break (br) element and a real carriage return with line
* feed for the source.
@@ -43,7 +43,7 @@ define('NEW_UPDATE_ROUTINE_VERSION', 1170);
define('EOL', "<br />\r\n");

/**
* @brief Image storage quality.
* Image storage quality.
*
* Lower numbers save space at cost of image detail.
* For ease of upgrade, please do not change here. Set system.jpegquality = n in config/local.config.php,
@@ -233,7 +233,7 @@ if (!defined('CURLE_OPERATION_TIMEDOUT')) {
}

/**
* @brief Returns the user id of locally logged in user or false.
* Returns the user id of locally logged in user or false.
*
* @return int|bool user id or false
*/
@@ -246,7 +246,7 @@ function local_user()
}

/**
* @brief Returns the public contact id of logged in user or false.
* Returns the public contact id of logged in user or false.
*
* @return int|bool public contact id or false
*/
@@ -270,7 +270,7 @@ function public_contact()
}

/**
* @brief Returns contact id of authenticated site visitor or false
* Returns contact id of authenticated site visitor or false
*
* @return int|bool visitor_id or false
*/
@@ -288,7 +288,7 @@ function remote_user()
}

/**
* @brief Show an error message to user.
* Show an error message to user.
*
* This function save text in session, to be shown to the user at next page load
*
@@ -310,7 +310,7 @@ function notice($s)
}

/**
* @brief Show an info message to user.
* Show an info message to user.
*
* This function save text in session, to be shown to the user at next page load
*
@@ -375,7 +375,7 @@ function feed_birthday($uid, $tz)
}

/**
* @brief Check if current user has admin role.
* Check if current user has admin role.
*
* @return bool true if user is an admin
*/
@@ -571,7 +571,7 @@ function get_itemcachepath()
}

/**
* @brief Returns the path where spool files are stored
* Returns the path where spool files are stored
*
* @return string Spool path
*/

+ 43
- 61
include/api.php View File

@@ -65,11 +65,11 @@ $API = [];
$called_api = [];

/**
* Auth API user
*
* It is not sufficient to use local_user() to check whether someone is allowed to use the API,
* because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
* into a page, and visitors will post something without noticing it).
*
* @brief Auth API user
*/
function api_user()
{
@@ -81,13 +81,13 @@ function api_user()
}

/**
* Get source name from API client
*
* Clients can send 'source' parameter to be show in post metadata
* as "sent via <source>".
* Some clients doesn't send a source param, we support ones we know
* (only Twidere, atm)
*
* @brief Get source name from API client
*
* @return string
* Client source name, default to "api" if unset/unknown
* @throws Exception
@@ -113,7 +113,7 @@ function api_source()
}

/**
* @brief Format date for API
* Format date for API
*
* @param string $str Source date, as UTC
* @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
@@ -128,8 +128,6 @@ function api_date($str)
/**
* Register a function to be the endpoint for defined API path.
*
* @brief Register API endpoint
*
* @param string $path API URL path, relative to DI::baseUrl()
* @param string $func Function name to call on path request
* @param bool $auth API need logged user
@@ -161,8 +159,6 @@ function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY
* Log in user via OAuth1 or Simple HTTP Auth.
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
*
* @brief Login API user
*
* @param App $a App
* @throws ForbiddenException
* @throws InternalServerErrorException
@@ -260,12 +256,12 @@ function api_login(App $a)
}

/**
* Check HTTP method of called API
*
* API endpoints can define which HTTP method to accept when called.
* This function check the current HTTP method agains endpoint
* registered method.
*
* @brief Check HTTP method of called API
*
* @param string $method Required methods, uppercase, separated by comma
* @return bool
*/
@@ -278,9 +274,9 @@ function api_check_method($method)
}

/**
* Authenticate user, call registered API function, set HTTP headers
* Main API entry point
*
* @brief Main API entry point
* Authenticate user, call registered API function, set HTTP headers
*
* @param App $a App
* @param App\Arguments $args The app arguments (optional, will retrieved by the DI-Container in case of missing)
@@ -379,7 +375,7 @@ function api_call(App $a, App\Arguments $args = null)
}

/**
* @brief Format API error string
* Format API error string
*
* @param string $type Return type (xml, json, rss, as)
* @param object $e HTTPException Error object
@@ -417,7 +413,7 @@ function api_error($type, $e, App\Arguments $args)
}

/**
* @brief Set values for RSS template
* Set values for RSS template
*
* @param App $a
* @param array $arr Array to be passed to template
@@ -451,7 +447,7 @@ function api_rss_extra(App $a, $arr, $user_info)


/**
* @brief Unique contact to contact url.
* Unique contact to contact url.
*
* @param int $id Contact id
* @return bool|string
@@ -470,7 +466,7 @@ function api_unique_id_to_nurl($id)
}

/**
* @brief Get user info array.
* Get user info array.
*
* @param App $a App
* @param int|string $contact_id Contact ID or URL
@@ -759,7 +755,7 @@ function api_get_user(App $a, $contact_id = null)
}

/**
* @brief return api-formatted array for item's author and owner
* return api-formatted array for item's author and owner
*
* @param App $a App
* @param array $item item from db
@@ -787,7 +783,7 @@ function api_item_get_user(App $a, $item)
}

/**
* @brief walks recursively through an array with the possibility to change value and key
* walks recursively through an array with the possibility to change value and key
*
* @param array $array The array to walk through
* @param callable $callback The callback function
@@ -815,7 +811,7 @@ function api_walk_recursive(array &$array, callable $callback)
}

/**
* @brief Callback function to transform the array in an array that can be transformed in a XML file
* Callback function to transform the array in an array that can be transformed in a XML file
*
* @param mixed $item Array item value
* @param string $key Array key
@@ -841,7 +837,7 @@ function api_reformat_xml(&$item, &$key)
}

/**
* @brief Creates the XML from a JSON style array
* Creates the XML from a JSON style array
*
* @param array $data JSON style array
* @param string $root_element Name of the root element
@@ -886,7 +882,7 @@ function api_create_xml(array $data, $root_element)
}

/**
* @brief Formats the data according to the data type
* Formats the data according to the data type
*
* @param string $root_element Name of the root element
* @param string $type Return type (atom, rss, xml, json)
@@ -1777,8 +1773,6 @@ api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline'
/**
* Returns the most recent statuses posted by users this node knows about.
*
* @brief Returns the list of public federated posts this node knows about
*
* @param string $type Return format: json, xml, atom, rss
* @return array|string
* @throws BadRequestException
@@ -2209,8 +2203,6 @@ api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
/**
* Returns the most recent statuses posted by the user.
*
* @brief Returns a user's public timeline
*
* @param string $type Either "json" or "xml"
* @return string|array
* @throws BadRequestException
@@ -2812,7 +2804,7 @@ function api_format_items_embeded_images($item, $text)
}

/**
* @brief return <a href='url'>name</a> as array
* return <a href='url'>name</a> as array
*
* @param string $txt text
* @return array
@@ -2839,7 +2831,7 @@ function api_contactlink_to_array($txt)


/**
* @brief return likes, dislikes and attend status for item
* return likes, dislikes and attend status for item
*
* @param array $item array
* @param string $type Return type (atom, rss, xml, json)
@@ -2919,7 +2911,7 @@ function api_format_items_activities($item, $type = "json")


/**
* @brief return data from profiles
* return data from profiles
*
* @param array $profile_row array containing data from db table 'profile'
* @return array
@@ -2972,7 +2964,7 @@ function api_format_items_profiles($profile_row)
}

/**
* @brief format items to be returned by api
* format items to be returned by api
*
* @param array $items array of items
* @param array $user_info
@@ -3387,11 +3379,11 @@ function api_lists_statuses($type)
api_register_func('api/lists/statuses', 'api_lists_statuses', true);

/**
* Returns either the friends of the follower list
*
* Considers friends and followers lists to be private and won't return
* anything if any user_id parameter is passed.
*
* @brief Returns either the friends of the follower list
*
* @param string $qtype Either "friends" or "followers"
* @return boolean|array
* @throws BadRequestException
@@ -3478,9 +3470,7 @@ function api_statuses_f($qtype)


/**
* Returns the user's friends.
*
* @brief Returns the list of friends of the provided user
* Returns the list of friends of the provided user
*
* @deprecated By Twitter API in favor of friends/list
*
@@ -3499,9 +3489,7 @@ function api_statuses_friends($type)
}

/**
* Returns the user's followers.
*
* @brief Returns the list of followers of the provided user
* Returns the list of followers of the provided user
*
* @deprecated By Twitter API in favor of friends/list
*
@@ -3818,9 +3806,7 @@ function api_direct_messages_new($type)
api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);

/**
* Destroys a direct message.
*
* @brief delete a direct_message from mail table through api
* delete a direct_message from mail table through api
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
@@ -3906,8 +3892,6 @@ api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy',
/**
* Unfollow Contact
*
* @brief unfollow contact
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
* @throws BadRequestException
@@ -4203,7 +4187,7 @@ api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);


/**
* @brief delete a complete photoalbum with all containing photos from database through api
* delete a complete photoalbum with all containing photos from database through api
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
@@ -4258,7 +4242,7 @@ function api_fr_photoalbum_delete($type)
}

/**
* @brief update the name of the album for all photos of an album
* update the name of the album for all photos of an album
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
@@ -4300,7 +4284,7 @@ function api_fr_photoalbum_update($type)


/**
* @brief list all photos of the authenticated user
* list all photos of the authenticated user
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
@@ -4348,7 +4332,7 @@ function api_fr_photos_list($type)
}

/**
* @brief upload a new photo or change an existing photo
* upload a new photo or change an existing photo
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
@@ -4487,7 +4471,7 @@ function api_fr_photo_create_update($type)
}

/**
* @brief delete a single photo from the database through api
* delete a single photo from the database through api
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
@@ -4540,7 +4524,7 @@ function api_fr_photo_delete($type)


/**
* @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
* returns the details of a specified photo id, if scale is given, returns the photo data in base 64
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
@@ -4569,9 +4553,7 @@ function api_fr_photo_detail($type)


/**
* Updates the user’s profile image.
*
* @brief updates the profile image for the user (either a specified profile or the default profile)
* updates the profile image for the user (either a specified profile or the default profile)
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
*
@@ -5180,7 +5162,7 @@ function api_get_announce($item)
}

/**
* @brief Return the item shared, if the item contains only the [share] tag
* Return the item shared, if the item contains only the [share] tag
*
* @param array $item Sharer item
* @return array|false Shared item or false if not a reshare
@@ -5907,7 +5889,7 @@ api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity',
api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);

/**
* @brief Returns notifications
* Returns notifications
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
@@ -5941,9 +5923,9 @@ function api_friendica_notification($type)
}

/**
* POST request with 'id' param as notification id
* Set notification as seen and returns associated item (if possible)
*
* @brief Set notification as seen and returns associated item (if possible)
* POST request with 'id' param as notification id
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
@@ -5993,7 +5975,7 @@ api_register_func('api/friendica/notification/seen', 'api_friendica_notification
api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);

/**
* @brief update a direct_message to seen state
* update a direct_message to seen state
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array (success result=ok, error result=error with error message)
@@ -6044,7 +6026,7 @@ function api_friendica_direct_messages_setseen($type)
api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);

/**
* @brief search for direct_messages containing a searchstring through api
* search for direct_messages containing a searchstring through api
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @param string $box
@@ -6115,7 +6097,7 @@ function api_friendica_direct_messages_search($type, $box = "")
api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);

/**
* @brief return data of all the profiles a user has to the client
* return data of all the profiles a user has to the client
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
@@ -6221,9 +6203,9 @@ function api_saved_searches_list($type)
api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);

/*
* Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search
* Number of comments
*
* @brief Number of comments
* Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search
*
* @param object $data [Status, Status]
*

+ 13
- 15
include/conversation.php View File

@@ -837,7 +837,7 @@ function conversation_fetch_comments($thread_items, $pinned) {
}

/**
* @brief Add comments to top level entries that had been fetched before
* Add comments to top level entries that had been fetched before
*
* The system will fetch the comments for the local user whenever possible.
* This behaviour is currently needed to allow commenting on Friendica posts.
@@ -987,7 +987,8 @@ 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.)
* 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
@@ -1281,8 +1282,6 @@ function status_editor(App $a, $x, $notes_cid = 0, $popup = false)
/**
* Plucks the children of the given parent from a given item list.
*
* @brief Plucks all the children in the given item list of the given parent
*
* @param array $item_list
* @param array $parent
* @param bool $recursive
@@ -1315,7 +1314,7 @@ function get_item_children(array &$item_list, array $parent, $recursive = true)
}

/**
* @brief Recursively sorts a tree-like item array
* Recursively sorts a tree-like item array
*
* @param array $items
* @return array
@@ -1333,7 +1332,7 @@ function sort_item_children(array $items)
}

/**
* @brief Recursively add all children items at the top level of a list
* Recursively add all children items at the top level of a list
*
* @param array $children List of items to append
* @param array $item_list
@@ -1349,6 +1348,8 @@ function add_children_to_list(array $children, array &$item_list)
}

/**
* Selectively flattens a tree-like item structure to prevent threading stairs
*
* This recursive function takes the item tree structure created by conv_sort() and
* flatten the extraneous depth levels when people reply sequentially, removing the
* stairs effect in threaded conversations limiting the available content width.
@@ -1359,8 +1360,6 @@ function add_children_to_list(array $children, array &$item_list)
* This process is rendered somewhat more complicated because items can be either
* replies or likes, and these don't factor at all in the reply count/last reply.
*
* @brief Selectively flattens a tree-like item structure to prevent threading stairs
*
* @param array $parent A tree-like array of items
* @return array
*/
@@ -1407,12 +1406,11 @@ function smart_flatten_conversation(array $parent)


/**
* Expands a flat list of items into corresponding tree-like conversation structures,
* Expands a flat list of items into corresponding tree-like conversation structures.
*
* sort the top-level posts either on "received" or "commented", and finally
* append all the items at the top level (???)
*
* @brief Expands a flat item list into a conversation array for display
*
* @param array $item_list A list of items belonging to one or more conversations
* @param string $order Either on "received" or "commented"
* @return array
@@ -1486,7 +1484,7 @@ function conv_sort(array $item_list, $order)
}

/**
* @brief usort() callback to sort item arrays by pinned and the received key
* usort() callback to sort item arrays by pinned and the received key
*
* @param array $a
* @param array $b
@@ -1504,7 +1502,7 @@ function sort_thr_pinned_received(array $a, array $b)
}

/**
* @brief usort() callback to sort item arrays by the received key
* usort() callback to sort item arrays by the received key
*
* @param array $a
* @param array $b
@@ -1516,7 +1514,7 @@ function sort_thr_received(array $a, array $b)
}

/**
* @brief usort() callback to reverse sort item arrays by the received key
* usort() callback to reverse sort item arrays by the received key
*
* @param array $a
* @param array $b
@@ -1528,7 +1526,7 @@ function sort_thr_received_rev(array $a, array $b)
}

/**
* @brief usort() callback to sort item arrays by the commented key
* usort() callback to sort item arrays by the commented key
*
* @param array $a
* @param array $b

+ 1
- 1
include/dba.php View File

@@ -3,7 +3,7 @@
use Friendica\Database\DBA;

/**
* @brief execute SQL query with printf style args - deprecated
* execute SQL query with printf style args - deprecated
*
* Please use the DBA:: functions instead:
* DBA::select, DBA::exists, DBA::insert

+ 4
- 4
include/enotify.php View File

@@ -23,7 +23,7 @@ use Friendica\Util\Emailer;
use Friendica\Util\Strings;

/**
* @brief Creates a notification entry and possibly sends a mail
* Creates a notification entry and possibly sends a mail
*
* @param array $params Array with the elements:
* uid, item, parent, type, otype, verb, event,
@@ -652,7 +652,7 @@ function notification($params)
}

/**
* @brief Checks for users who should be notified
* 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
@@ -667,7 +667,7 @@ function check_user_notification($itemid) {
}

/**
* @brief Checks for item related notifications and sends them
* 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
@@ -738,7 +738,7 @@ function check_item_notification($itemid, $uid, $notification_type) {
}

/**
* @brief Formats a notification message with the notification author
* Formats a notification message with the notification author
*
* Replace the name with {0} but ensure to make that only once. The {0} is used
* later and prints the name in bold.

+ 4
- 3
mod/cal.php View File

@@ -1,9 +1,10 @@
<?php
/**
* @file mod/cal.php
* @brief The calendar module
* This calendar is for profile visitors and contains only the events
* of the profile owner
* The calendar module
*
* This calendar is for profile visitors and contains only the events
* of the profile owner
*/

use Friendica\App;

+ 2
- 1
mod/dfrn_confirm.php View File

@@ -1,7 +1,8 @@
<?php
/**
* @file mod/dfrn_confirm.php
* @brief Module: dfrn_confirm
* Module: dfrn_confirm
*
* Purpose: Friendship acceptance for DFRN contacts
*
* There are two possible entry points and three scenarios.

+ 1
- 1
mod/dfrn_notify.php View File

@@ -2,7 +2,7 @@

/**
* @file mod/dfrn_notify.php
* @brief The dfrn notify endpoint
* The dfrn notify endpoint
* @see PDF with dfrn specs: https://github.com/friendica/friendica/blob/master/spec/dfrn2.pdf
*/


+ 1
- 1
mod/dfrn_request.php View File

@@ -2,7 +2,7 @@

/**
* @file mod/dfrn_request.php
* @brief Module: dfrn_request
* Module: dfrn_request
*
* Purpose: Handles communication associated with the issuance of
* friend requests.

+ 1
- 1
mod/events.php View File

@@ -1,7 +1,7 @@
<?php
/**
* @file mod/events.php
* @brief The events module
* The events module
*/

use Friendica\App;

+ 1
- 1
mod/match.php View File

@@ -17,7 +17,7 @@ use Friendica\Util\Network;
use Friendica\Util\Proxy as ProxyUtils;

/**
* @brief Controller for /match.
* Controller for /match.
*
* It takes keywords from your profile and queries the directory server for
* matching keywords from other profiles.

+ 6
- 6
mod/network.php View File

@@ -200,7 +200,7 @@ function network_query_get_sel_group(App $a)
}

/**
* @brief Sets the pager data and returns SQL
* Sets the pager data and returns SQL
*
* @param App $a The global App
* @param Pager $pager
@@ -237,7 +237,7 @@ function networkPager(App $a, Pager $pager, $update)
}

/**
* @brief Sets items as seen
* Sets items as seen
*
* @param array $condition The array with the SQL condition
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
@@ -256,7 +256,7 @@ function networkSetSeen($condition)
}

/**
* @brief Create the conversation HTML
* Create the conversation HTML
*
* @param App $a The global App
* @param array $items Items of the conversation
@@ -315,7 +315,7 @@ function network_content(App $a, $update = 0, $parent = 0)
}

/**
* @brief Get the network content in flat view
* Get the network content in flat view
*
* @param App $a The global App
* @param integer $update Used for the automatic reloading
@@ -401,7 +401,7 @@ function networkFlatView(App $a, $update = 0)
}

/**
* @brief Get the network content in threaded view
* Get the network content in threaded view
*
* @param App $a The global App
* @param integer $update Used for the automatic reloading
@@ -871,7 +871,7 @@ function networkThreadedView(App $a, $update, $parent)
}

/**
* @brief Get the network tabs menu
* Get the network tabs menu
*
* @param App $a The global App
* @return string Html of the networktab

+ 1
- 1
mod/notifications.php View File

@@ -1,7 +1,7 @@
<?php
/**
* @file mod/notifications.php
* @brief The notifications module
* The notifications module
*/

use Friendica\App;

+ 2
- 2
mod/parse_url.php View File

@@ -2,7 +2,7 @@

/**
* @file mod/parse_url.php
* @brief The parse_url module
* The parse_url module
*
* This module does parse an url for embeddable content (audio, video, image files or link)
* information and does format this information to BBCode
@@ -172,7 +172,7 @@ function parse_url_content(App $a)
}

/**
* @brief Legacy function to call ParseUrl::getSiteinfoCached
* Legacy function to call ParseUrl::getSiteinfoCached
*
* Note: We have moved the function to ParseUrl.php. This function is only for
* legacy support and will be remove in the future

+ 3
- 3
mod/ping.php View File

@@ -21,7 +21,7 @@ use Friendica\Util\Proxy as ProxyUtils;
use Friendica\Util\XML;

/**
* @brief Outputs the counts and the lists of various notifications
* Outputs the counts and the lists of various notifications
*
* The output format can be controlled via the GET parameter 'format'. It can be
* - xml (deprecated legacy default)
@@ -382,7 +382,7 @@ function ping_init(App $a)
}

/**
* @brief Retrieves the notifications array for the given user ID
* Retrieves the notifications array for the given user ID
*
* @param int $uid User id
* @return array Associative array of notifications
@@ -465,7 +465,7 @@ function ping_get_notifications($uid)
}

/**
* @brief Backward-compatible XML formatting for ping.php output
* Backward-compatible XML formatting for ping.php output
* @deprecated
*
* @param array $data The initial ping data array

+ 1
- 1
mod/uimport.php View File

@@ -1,7 +1,7 @@
<?php
/**
* @file mod/uimport.php
* @brief View for user import
* View for user import
*/

use Friendica\App;

+ 1
- 1
mod/wall_upload.php View File

@@ -1,7 +1,7 @@
<?php
/**
* @file mod/wall_upload.php
* @brief Module for uploading a picture to the profile wall
* Module for uploading a picture to the profile wall
*
* By default the picture will be stored in the photo album with the name Wall Photos.
* You can specify a different album by adding an optional query string "album="

+ 1
- 1
mod/worker.php View File

@@ -1,7 +1,7 @@
<?php
/**
* @file mod/worker.php
* @brief Module for running the worker as frontend process
* Module for running the worker as frontend process
*/

use Friendica\Core\Config;

+ 1
- 3
src/App.php View File

@@ -28,7 +28,7 @@ use Psr\Log\LoggerInterface;
*
* class: App
*
* @brief Our main application structure for the life of this page.
* Our main application structure for the life of this page.
*
* Primarily deals with the URL that got us here
* and tries to make some sense of it, and
@@ -393,8 +393,6 @@ class App
}

/**
* @brief Return full URL to theme which is currently in effect.
*
* Provide a sane default if nothing is chosen or the specified theme does not exist.
*
* @return string

+ 2
- 2
src/App/Authentication.php View File

@@ -76,7 +76,7 @@ class Authentication
}

/**
* @brief Tries to auth the user from the cookie or session
* Tries to auth the user from the cookie or session
*
* @param App $a The Friendica Application context
*
@@ -283,7 +283,7 @@ class Authentication
}

/**
* @brief Sets the provided user's authenticated session
* Sets the provided user's authenticated session
*
* @param App $a The Friendica application context
* @param array $user_record The current "user" record

+ 5
- 5
src/BaseModule.php View File

@@ -17,7 +17,7 @@ use Friendica\Core\Logger;
abstract class BaseModule
{
/**
* @brief Initialization method common to both content() and post()
* Initialization method common to both content() and post()
*
* Extend this method if you need to do any shared processing before both
* content() or post()
@@ -27,7 +27,7 @@ abstract class BaseModule
}

/**
* @brief Module GET method to display raw content from technical endpoints
* Module GET method to display raw content from technical endpoints
*
* Extend this method if the module is supposed to return communication data,
* e.g. from protocol implementations.
@@ -39,7 +39,7 @@ abstract class BaseModule
}

/**
* @brief Module GET method to display any content
* Module GET method to display any content
*
* Extend this method if the module is supposed to return any display
* through a GET request. It can be an HTML page through templating or a
@@ -55,7 +55,7 @@ abstract class BaseModule
}

/**
* @brief Module POST method to process submitted data
* Module POST method to process submitted data
*
* Extend this method if the module is supposed to process POST requests.
* Doesn't display any content
@@ -67,7 +67,7 @@ abstract class BaseModule
}

/**
* @brief Called after post()
* Called after post()
*
* Unknown purpose
*/

+ 1
- 1
src/Console/ArchiveContact.php View File

@@ -9,7 +9,7 @@ use Friendica\Util\Strings;
use RuntimeException;

/**
* @brief tool to archive a contact on the server
* tool to archive a contact on the server
*
* With this tool you can archive a contact when you know that it isn't existing anymore.
* Normally this does happen automatically after a few days.

+ 1
- 1
src/Console/Cache.php View File

@@ -9,7 +9,7 @@ use Friendica\Core\Cache\ICache;
use RuntimeException;

/**
* @brief tool to access the cache from the CLI
* tool to access the cache from the CLI
*
* With this script you can access the cache of your node from the CLI.
* You can read current values stored in the cache and set new values

+ 1
- 1
src/Console/Config.php View File

@@ -8,7 +8,7 @@ use Friendica\Core\Config\IConfiguration;
use RuntimeException;

/**
* @brief tool to access the system config from the CLI
* tool to access the system config from the CLI
*
* With this script you can access the system configuration of your node from
* the CLI. You can do both, reading current values stored in the database and

+ 2
- 2
src/Console/CreateDoxygen.php View File

@@ -105,7 +105,7 @@ HELP;
}

/**
* @brief Adds a doxygen header
* Adds a doxygen header
*
* @param string $line The current line of the document
*
@@ -118,7 +118,7 @@ HELP;
$space = substr($line, 0, $length);

$block = $space . "/**\n" .
$space . " * @brief \n" .
$space . " * \n" .
$space . " *\n"; /**/



+ 1
- 1
src/Console/DatabaseStructure.php View File

@@ -9,7 +9,7 @@ use Friendica\Database\DBStructure;
use RuntimeException;

/**
* @brief Performs database updates from the command line
* Performs database updates from the command line
*
* @author Hypolite Petovan <hypolite@mrpetovan.com>
*/

+ 1
- 1
src/Console/GlobalCommunityBlock.php View File

@@ -7,7 +7,7 @@ use Friendica\Core\L10n;
use Friendica\Model\Contact;

/**
* @brief tool to block an account from the node
* tool to block an account from the node
*
* With this tool, you can block an account in such a way, that no postings
* or comments this account writes are accepted to the node.

+ 1
- 1
src/Console/GlobalCommunitySilence.php View File

@@ -8,7 +8,7 @@ use Friendica\Model\Contact;
use RuntimeException;

/**
* @brief tool to silence accounts on the global community page
* tool to silence accounts on the global community page
*
* With this tool, you can silence an account on the global community page.
* Postings from silenced accounts will not be displayed on the community

+ 1
- 1
src/Console/Lock.php View File

@@ -8,7 +8,7 @@ use Friendica\Core\Lock\ILock;
use RuntimeException;

/**
* @brief tool to access the locks from the CLI
* tool to access the locks from the CLI
*
* With this script you can access the locks of your node from the CLI.
* You can read current locks and set/remove locks.

+ 1
- 1
src/Console/Maintenance.php View File

@@ -6,7 +6,7 @@ use Friendica\App;
use Friendica\Core\Config\IConfiguration;

/**
* @brief Sets maintenance mode for this node
* Sets maintenance mode for this node
*
* @author Hypolite Petovan <hypolite@mrpetovan.com>
*/

+ 1
- 1
src/Console/NewPassword.php View File

@@ -9,7 +9,7 @@ use Friendica\Model\User;
use RuntimeException;

/**
* @brief tool to set a new password for a user
* tool to set a new password for a user
*
* With this tool, you can set a new password for a user
*

+ 1
- 1
src/Console/ServerBlock.php View File

@@ -8,7 +8,7 @@ use Console_Table;
use Friendica\Core\Config\IConfiguration;

/**
* @brief Manage blocked servers
* Manage blocked servers
*
* With this tool, you can list the current blocked servers
* or you can add / remove a blocked server from the list

+ 1
- 1
src/Console/Storage.php View File

@@ -6,7 +6,7 @@ use Asika\SimpleConsole\CommandArgsException;
use Friendica\Core\StorageManager;

/**
* @brief tool to manage storage backend and stored data from CLI
* tool to manage storage backend and stored data from CLI
*
*/
class Storage extends \Asika\SimpleConsole\Console

+ 1
- 1
src/Content/ContactSelector.php View File

@@ -12,7 +12,7 @@ use Friendica\Util\Network;
use Friendica\Util\Strings;

/**
* @brief ContactSelector class
* ContactSelector class
*/
class ContactSelector
{

+ 4
- 4
src/Content/Feature.php View File

@@ -1,7 +1,7 @@
<?php
/**
* @file src/Content/Feature.php
* @brief Features management
* Features management
*/
namespace Friendica\Content;

@@ -13,7 +13,7 @@ use Friendica\DI;
class Feature
{
/**
* @brief check if feature is enabled
* check if feature is enabled
*
* @param integer $uid user id
* @param string $feature feature
@@ -42,7 +42,7 @@ class Feature
}

/**
* @brief check if feature is enabled or disabled by default
* check if feature is enabled or disabled by default
*
* @param string $feature feature
* @return boolean
@@ -62,7 +62,7 @@ class Feature
}

/**
* @brief Get a list of all available features
* Get a list of all available features
*
* The array includes the setting group, the setting name,
* explainations for the setting and if it's enabled or disabled

+ 6
- 6
src/Content/ForumManager.php View File

@@ -1,7 +1,7 @@
<?php
/**
* @file src/Content/ForumManager.php
* @brief ForumManager class with its methods related to forum functionality
* ForumManager class with its methods related to forum functionality
*/
namespace Friendica\Content;

@@ -15,12 +15,12 @@ use Friendica\Model\Contact;
use Friendica\Util\Proxy as ProxyUtils;

/**
* @brief This class handles methods related to the forum functionality
* This class handles methods related to the forum functionality
*/
class ForumManager
{
/**
* @brief Function to list all forums a user is connected with
* Function to list all forums a user is connected with
*
* @param int $uid of the profile owner
* @param boolean $lastitem Sort by lastitem
@@ -80,7 +80,7 @@ class ForumManager


/**
* @brief Forumlist widget
* Forumlist widget
*
* Sidebar widget to show subcribed friendica forums. If activated
* in the settings, it appears at the notwork page sidebar
@@ -140,7 +140,7 @@ class ForumManager
}

/**
* @brief Format forumlist as contact block
* Format forumlist as contact block
*
* This function is used to show the forumlist in
* the advanced profile.
@@ -184,7 +184,7 @@ class ForumManager
}

/**
* @brief count unread forum items
* count unread forum items
*
* Count unread items of connected forums and private groups
*

+ 0
- 1
src/Content/Nav.php View File

@@ -119,7 +119,6 @@ class Nav
/**
* Prepares a list of navigation links
*
* @brief Prepares a list of navigation links
* @param App $a
* @return array Navigation links
* string 'sitelocation' => The webbie (username@site.com)

+ 4
- 7
src/Content/OEmbed.php View File

@@ -45,7 +45,7 @@ class OEmbed
}

/**
* @brief Get data from an URL to embed its content.
* Get data from an URL to embed its content.
*
* @param string $embedurl The URL from which the data should be fetched.
* @param bool $no_rich_type If set to true rich type content won't be fetched.
@@ -297,7 +297,6 @@ class OEmbed
/**
* Determines if rich content OEmbed is allowed for the provided URL
*
* @brief Determines if rich content OEmbed is allowed for the provided URL
* @param string $url
* @return boolean
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
@@ -345,7 +344,7 @@ class OEmbed
}

/**
* @brief Generates the iframe HTML for an oembed attachment.
* Generates the iframe HTML for an oembed attachment.
*
* Width and height are given by the remote, and are regularly too small for
* the generated iframe.
@@ -378,11 +377,11 @@ class OEmbed
}

/**
* Generates attribute search XPath string
*
* Generates an XPath query to select elements whose provided attribute contains
* the provided value in a space-separated list.
*
* @brief Generates attribute search XPath string
*
* @param string $attr Name of the attribute to seach
* @param string $value Value to search in a space-separated list
* @return string
@@ -396,8 +395,6 @@ class OEmbed
/**
* Returns the inner XML string of a provided DOMNode
*
* @brief Returns the inner XML string of a provided DOMNode
*
* @param DOMNode $node
* @return string
*/

+ 2
- 2
src/Content/Pager.php View File

@@ -124,7 +124,7 @@ class Pager
}

/**
* @brief Minimal pager (newer/older)
* Minimal pager (newer/older)
*
* This mode is intended for reverse chronological pages and presents only two links, newer (previous) and older (next).
* The itemCount is the number of displayed items. If no items are displayed, the older button is disabled.
@@ -165,7 +165,7 @@ class Pager
}

/**
* @brief Full pager (first / prev / 1 / 2 / ... / 14 / 15 / next / last)
* Full pager (first / prev / 1 / 2 / ... / 14 / 15 / next / last)
*
* This mode presents page numbers as well as first, previous, next and last links.
* The itemCount is the total number of items including those not displayed.

+ 4
- 5
src/Content/Smilies.php View File

@@ -2,7 +2,7 @@

/**
* @file src/Content/Smilies.php
* @brief This file contains the Smilies class which contains functions to handle smiles
* This file contains the Smilies class which contains functions to handle smiles
*
* @todo Use the shortcodes from here:
* https://github.com/iamcal/emoji-data/blob/master/emoji_pretty.json?raw=true
@@ -26,7 +26,7 @@ use Friendica\Util\Strings;
class Smilies
{
/**
* @brief Replaces/adds the emoticon list
* Replaces/adds the emoticon list
*
* This function should be used whenever emoticons are added
*
@@ -49,7 +49,7 @@ class Smilies
}

/**
* @brief Function to list all smilies
* Function to list all smilies
*
* Get an array of all smilies, both internal and from addons.
*
@@ -179,7 +179,6 @@ class Smilies
* function from being executed by the prepare_text() routine when preparing
* bbcode source for HTML display
*
* @brief Replaces text emoticons with graphical images
* @param string $s Text that should be replaced
* @param boolean $no_images Only replace emoticons without images
*
@@ -261,7 +260,7 @@ class Smilies


/**
* @brief expand <3333 to the correct number of hearts
* expand <3333 to the correct number of hearts
*
* @param string $x string
*

+ 12
- 13
src/Content/Text/BBCode.php View File

@@ -35,7 +35,7 @@ use Friendica\Util\XML;
class BBCode
{
/**
* @brief Fetches attachment data that were generated the old way
* Fetches attachment data that were generated the old way
*
* @param string $body Message body
* @return array
@@ -106,7 +106,7 @@ class BBCode
}

/**
* @brief Fetches attachment data that were generated with the "attachment" element
* Fetches attachment data that were generated with the "attachment" element
*
* @param string $body Message body
* @return array
@@ -411,7 +411,7 @@ class BBCode
}

/**
* @brief Converts a BBCode text into plaintext
* Converts a BBCode text into plaintext
*
* @param $text
* @param bool $keep_urls Whether to keep URLs in the resulting plaintext
@@ -486,10 +486,11 @@ class BBCode
}

/**
* Truncates imported message body string length to max_import_size
*
* The purpose of this function is to apply system message length limits to
* imported messages without including any embedded photos in the length
*
* @brief Truncates imported message body string length to max_import_size
* @param string $body
* @return string
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
@@ -578,7 +579,6 @@ class BBCode
*
* Note: Can produce a [bookmark] tag in the returned string
*
* @brief Processes [attachment] tags
* @param string $text
* @param bool|int $simplehtml
* @param bool $tryoembed
@@ -691,7 +691,6 @@ class BBCode
/**
* Converts [url] BBCodes in a format that looks fine on Mastodon. (callback function)
*
* @brief Converts [url] BBCodes in a format that looks fine on Mastodon. (callback function)
* @param array $match Array with the matching values
* @return string reformatted link including HTML codes
*/
@@ -712,7 +711,7 @@ class BBCode
}

/**
* @brief Converts [url] BBCodes in a format that looks fine on ActivityPub systems.
* Converts [url] BBCodes in a format that looks fine on ActivityPub systems.
* @param string $url URL that is about to be reformatted
* @return string reformatted link including HTML codes
*/
@@ -1206,7 +1205,7 @@ class BBCode
}

/**
* @brief Converts a BBCode message to HTML message
* Converts a BBCode message to HTML message
*
* BBcode 2 HTML was written by WAY2WEB.net
* extended to work with Mistpark/Friendica - Mike Macgirvin
@@ -1906,7 +1905,7 @@ class BBCode
}

/**
* @brief Strips the "abstract" tag from the provided text
* Strips the "abstract" tag from the provided text
*
* @param string $text The text with BBCode
* @return string The same text - but without "abstract" element
@@ -1920,7 +1919,7 @@ class BBCode
}

/**
* @brief Returns the value of the "abstract" element
* Returns the value of the "abstract" element
*
* @param string $text The text that maybe contains the element
* @param string $addon The addon for which the abstract is meant for
@@ -1950,7 +1949,7 @@ class BBCode
}

/**
* @brief Callback function to replace a Friendica style mention in a mention for Diaspora
* Callback function to replace a Friendica style mention in a mention for Diaspora
*
* @param array $match Matching values for the callback
* [1] = Mention type (! or @)
@@ -1977,7 +1976,7 @@ class BBCode
}

/**
* @brief Converts a BBCode text into Markdown
* Converts a BBCode text into Markdown
*
* This function converts a BBCode item body to be sent to Markdown-enabled
* systems like Diaspora and Libertree
@@ -2064,7 +2063,7 @@ class BBCode
}

/**
* @brief Pull out all #hashtags and @person tags from $string.
* Pull out all #hashtags and @person tags from $string.
*
* We also get @person@domain.com - which would make
* the regex quite complicated as tags can also

+ 6
- 5
src/Content/Text/HTML.php View File

@@ -137,11 +137,12 @@ class HTML
}

/**
* Converter for HTML to BBCode
*
* Made by: ike@piratenpartei.de
* Originally made for the syncom project: http://wiki.piratenpartei.de/Syncom
* https://github.com/annando/Syncom
*
* @brief Converter for HTML to BBCode
* @param string $message
* @param string $basepath
* @return string
@@ -411,7 +412,7 @@ class HTML
}

/**
* @brief Sub function to complete incomplete URL
* Sub function to complete incomplete URL
*
* @param array $matches Result of preg_replace_callback
* @param string $basepath Basepath that is used to complete the URL
@@ -438,7 +439,7 @@ class HTML
}

/**
* @brief Complete incomplete URLs in BBCode
* Complete incomplete URLs in BBCode
*
* @param string $body Body with URLs
* @param string $basepath Base path that is used to complete the URL
@@ -710,7 +711,7 @@ class HTML
}

/**
* @brief Convert video HTML to BBCode tags
* Convert video HTML to BBCode tags
*
* @param string $s
* @return string
@@ -820,7 +821,7 @@ class HTML
}

/**
* @brief Format contacts as picture links or as text links
* Format contacts as picture links or as text links
*
* @param array $contact Array with contacts which contains an array with
* int 'id' => The ID of the contact

+ 1
- 2
src/Content/Text/Markdown.php View File

@@ -21,7 +21,6 @@ class Markdown
* Converts a Markdown string into HTML. The hardwrap parameter maximizes
* compatibility with Diaspora in spite of the Markdown standard.
*
* @brief Converts a Markdown string into HTML
* @param string $text
* @param bool $hardwrap
* @return string
@@ -49,7 +48,7 @@ class Markdown
}

/**
* @brief Callback function to replace a Diaspora style mention in a mention for Friendica
* Callback function to replace a Diaspora style mention in a mention for Friendica
*
* @param array $match Matching values for the callback
* [1] = mention type (@ or !)

+ 0
- 1
src/Content/Widget.php View File

@@ -411,7 +411,6 @@ class Widget
/**
* Insert a tag cloud widget for the present profile.
*
* @brief Insert a tag cloud widget for the present profile.
* @param int $limit Max number of displayed tags.
* @return string HTML formatted output.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException

+ 1
- 1
src/Content/Widget/CalendarExport.php View File

@@ -19,7 +19,7 @@ use Friendica\DI;
class CalendarExport
{
/**
* @brief Get the events widget.
* Get the events widget.
*
* @return string Formated HTML of the calendar widget.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException

+ 0
- 5
src/Content/Widget/TagCloud.php View File

@@ -22,7 +22,6 @@ class TagCloud
/**
* Construct a tag/term cloud block for an user.
*
* @brief Construct a tag/term cloud block for an user.
* @param int $uid The user ID.
* @param int $count Max number of displayed tags/terms.
* @param int $owner_id The contact ID of the owner of the tagged items.
@@ -62,8 +61,6 @@ class TagCloud
* Get alphabetical sorted array of used tags/terms of an user including
* a weighting by frequency of use.
*
* @brief Get alphabetical sorted array of used tags/terms of an user including
* a weighting by frequency of use.
* @param int $uid The user ID.
* @param int $count Max number of displayed tags/terms.
* @param int $owner_id The contact id of the owner of the tagged items.
@@ -112,7 +109,6 @@ class TagCloud
/**
* Calculate weighting of tags according to the frequency of use.
*
* @brief Calculate weighting of tags according to the frequency of use.
* @param array $arr Array of tags/terms with tag/term name and total count of use.
* @return array Alphabetical sorted array of used tags/terms of an user.
*/
@@ -149,7 +145,6 @@ class TagCloud
/**
* Compare function to sort tags/terms alphabetically.
*
* @brief Compare function to sort tags/terms alphabetically.
* @param string $a
* @param string $b
*

+ 4
- 4
src/Core/Addon.php View File

@@ -83,7 +83,7 @@ class Addon


/**
* @brief Synchronize addons:
* Synchronize addons:
*
* system.addon contains a comma-separated list of names
* of addons which are used on this system.
@@ -130,7 +130,7 @@ class Addon
}

/**
* @brief uninstalls an addon.
* uninstalls an addon.
*
* @param string $addon name of the addon
* @return void
@@ -157,7 +157,7 @@ class Addon
}

/**
* @brief installs an addon.
* installs an addon.
*
* @param string $addon name of the addon
* @return bool
@@ -249,7 +249,7 @@ class Addon
}

/**
* @brief Parse addon comment in search of addon infos.
* Parse addon comment in search of addon infos.
*
* like
* \code

+ 5
- 8
src/Core/Config.php View File

@@ -4,14 +4,14 @@
*
* @file include/Core/Config.php
*
* @brief Contains the class with methods for system configuration
* Contains the class with methods for system configuration
*/
namespace Friendica\Core;

use Friendica\DI;

/**
* @brief Arbitrary system configuration storage
* Arbitrary system configuration storage
*
* Note:
* If we ever would decide to return exactly the variable type as entered,
@@ -20,7 +20,7 @@ use Friendica\DI;
class Config
{
/**
* @brief Loads all configuration values of family into a cached storage.
* Loads all configuration values of family into a cached storage.
*
* @param string $cat The category of the configuration value
*
@@ -32,8 +32,7 @@ class Config
}

/**
* @brief Get a particular user's config variable given the category name
* ($family) and a key.
* Get a particular user's config variable given the category name ($family) and a key.
*
* @param string $cat The category of the configuration value
* @param string $key The configuration key to query
@@ -48,8 +47,6 @@ class Config
}

/**
* @brief Sets a configuration value for system config
*
* Stores a config value ($value) in the category ($cat) under the key ($key)
*
* Note: Please do not store booleans - convert to 0/1 integer values!
@@ -66,7 +63,7 @@ class Config
}

/**
* @brief Deletes the given key from the system configuration.
* Deletes the given key from the system configuration.
*
* @param string $cat The category of the configuration value
* @param string $key The configuration key to delete

+ 4
- 4
src/Core/Config/IConfiguration.php View File

@@ -9,7 +9,7 @@ interface IConfiguration
{

/**
* @brief Loads all configuration values of family into a cached storage.
* Loads all configuration values of family into a cached storage.
*
* All configuration values of the system are stored in the cache ( @see ConfigCache )
*
@@ -20,7 +20,7 @@ interface IConfiguration
function load(string $cat = 'config');

/**
* @brief Get a particular user's config variable given the category name
* Get a particular user's config variable given the category name
* ($cat) and a $key.
*
* Get a particular config value from the given category ($cat)
@@ -37,7 +37,7 @@ interface IConfiguration
function get(string $cat, string $key, $default_value = null, bool $refresh = false);

/**
* @brief Sets a configuration value for system config
* Sets a configuration value for system config
*
* Stores a config value ($value) in the category ($cat) under the key ($key)
*
@@ -52,7 +52,7 @@ interface IConfiguration
function set(string $cat, string $key, $value);

/**
* @brief Deletes the given key from the system configuration.
* Deletes the given key from the system configuration.
*
* Removes the configured value from the stored cache in $this->configCache
* (@see ConfigCache) and removes it from the database (@see IConfigAdapter).

+ 5
- 5
src/Core/Hook.php View File

@@ -45,7 +45,7 @@ class Hook
}

/**
* @brief Adds a new hook to the hooks array.
* Adds a new hook to the hooks array.
*
* This function is meant to be called by modules on each page load as it works after loadHooks has been called.
*
@@ -62,7 +62,7 @@ class Hook
}

/**
* @brief Registers a hook.
* Registers a hook.
*
* This function is meant to be called once when an addon is enabled for example as it doesn't add to the current hooks.
*
@@ -127,7 +127,7 @@ class Hook
}

/**
* @brief Forks a hook.
* Forks a hook.
*
* Use this function when you want to fork a hook via the worker.
*
@@ -162,7 +162,7 @@ class Hook
}

/**
* @brief Calls a hook.
* Calls a hook.
*
* Use this function when you want to be able to allow a hook to manipulate
* the provided data.
@@ -181,7 +181,7 @@ class Hook
}

/**
* @brief Calls a single hook.
* Calls a single hook.
*
* @param App $a
* @param string $name of the hook to call

+ 5
- 5
src/Core/L10n.php View File

@@ -36,7 +36,7 @@ class L10n
}

/**
* @brief Return the localized version of the provided string with optional string interpolation
* Return the localized version of the provided string with optional string interpolation
*
* This function takes a english string as parameter, and if a localized version
* exists for the current language, substitutes it before performing an eventual
@@ -58,7 +58,7 @@ class L10n
}

/**
* @brief Return the localized version of a singular/plural string with optional string interpolation
* Return the localized version of a singular/plural string with optional string interpolation
*
* This function takes two english strings as parameters, singular and plural, as
* well as a count. If a localized version exists for the current language, they
@@ -83,7 +83,7 @@ class L10n
}

/**
* @brief Return installed languages codes as associative array
* Return installed languages codes as associative array
*
* Scans the view/lang directory for the existence of "strings.php" files, and
* returns an alphabetical list of their folder names (@-char language codes).
@@ -99,7 +99,7 @@ class L10n
}

/**
* @brief Translate days and months names.
* Translate days and months names.
*
* @param string $s String with day or month name.
*
@@ -111,7 +111,7 @@ class L10n
}

/**
* @brief Translate short days and months names.
* Translate short days and months names.
*
* @param string $s String with short day or month name.
*

+ 3
- 3
src/Core/L10n/L10n.php View File

@@ -132,7 +132,7 @@ class L10n
}

/**
* @brief Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header
* Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header
*
* @param string $sysLang The default fallback language
* @param array $server The $_SERVER array
@@ -210,7 +210,7 @@ class L10n
}

/**
* @brief Return the localized version of the provided string with optional string interpolation
* Return the localized version of the provided string with optional string interpolation
*
* This function takes a english string as parameter, and if a localized version
* exists for the current language, substitutes it before performing an eventual
@@ -245,7 +245,7 @@ class L10n
}

/**
* @brief Return the localized version of a singular/plural string with optional string interpolation
* Return the localized version of a singular/plural string with optional string interpolation
*
* This function takes two english strings as parameters, singular and plural, as
* well as a count. If a localized version exists for the current language, they

+ 5
- 4
src/Core/Logger.php View File

@@ -10,7 +10,7 @@ use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;

/**
* @brief Logger functions
* Logger functions
*/
class Logger
{
@@ -231,8 +231,8 @@ class Logger
self::getWorker()->debug($message, $context);
}

/**
* @brief Logs the given message at the given log level
/**
* Logs the given message at the given log level
*
* @param string $msg
* @param string $level
@@ -246,7 +246,8 @@ class Logger
}

/**
* @brief An alternative logger for development.
* An alternative logger for development.
*
* Works largely as log() but allows developers
* to isolate particular elements they are targetting
* personally without background noise

+ 3
- 3
src/Core/Process.php View File

@@ -46,7 +46,7 @@ final class Process
}

/**
* @brief Checks if the maximum number of database processes is reached
* Checks if the maximum number of database processes is reached
*
* @return bool Is the limit reached?
*/
@@ -86,7 +86,7 @@ final class Process
}

/**
* @brief Checks if the minimal memory is reached
* Checks if the minimal memory is reached
*
* @return bool Is the memory limit reached?
*/
@@ -130,7 +130,7 @@ final class Process
}

/**
* @brief Checks if the maximum load is reached
* Checks if the maximum load is reached
*
* @return bool Is the load reached?
*/

+ 9
- 9
src/Core/Renderer.php View File

@@ -11,22 +11,22 @@ use Friendica\Render\FriendicaSmarty;
use Friendica\Render\ITemplateEngine;

/**
* @brief This class handles Renderer related functions.
* This class handles Renderer related functions.
*/
class Renderer
{
/**
* @brief An array of registered template engines ('name'=>'class name')
* An array of registered template engines ('name'=>'class name')
*/
public static $template_engines = [];

/**
* @brief An array of instanced template engines ('name'=>'instance')
* An array of instanced template engines ('name'=>'instance')
*/
public static $template_engine_instance = [];

/**
* @brief An array for all theme-controllable parameters
* An array for all theme-controllable parameters
*
* Mostly unimplemented yet. Only options 'template_engine' and
* beyond are used.
@@ -50,7 +50,7 @@ class Renderer
];

/**
* @brief This is our template processor
* This is our template processor
*
* @param string|FriendicaSmarty $s The string requiring macro substitution or an instance of FriendicaSmarty
* @param array $vars Key value pairs (search => replace)
@@ -80,7 +80,7 @@ class Renderer
}

/**
* @brief Load a given template $s
* Load a given template $s
*
* @param string $s Template to load.
* @param string $root Optional.
@@ -107,7 +107,7 @@ class Renderer
}

/**
* @brief Register template engine class
* Register template engine class
*
* @param string $class
*/
@@ -126,7 +126,7 @@ class Renderer
}

/**
* @brief Return template engine instance.
* Return template engine instance.
*
* If $name is not defined, return engine defined by theme,
* or default
@@ -153,7 +153,7 @@ class Renderer
}

/**
* @brief Returns the active template engine.
* Returns the active template engine.
*
* @return string the active template engine
*/

+ 0
- 1
src/Core/Search.php View File

@@ -245,7 +245,6 @@ class Search
/**
* Searching for global contacts for autocompletion
*
* @brief Searching for global contacts for autocompletion
* @param string $search Name or part of a name or nick
* @param string $mode Search mode (e.g. "community")
* @param int $page Page number (starts at 1)

+ 1
- 1
src/Core/Session/Handler/Cache.php View File

@@ -51,7 +51,7 @@ final class Cache implements SessionHandlerInterface
}

/**
* @brief Standard PHP session write callback
* Standard PHP session write callback
*
* This callback updates the stored session data and/or the expiration depending
* on the case. Uses the Session::expire for existing session, 5 minutes

+ 1
- 1
src/Core/Session/Handler/Database.php View File