mexon/friendica
1
0
Fork 0
Code Pull requests 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
Show stats Download patch file Download diff file Expand all files Collapse all files

2
bin/worker.php
View file

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

18
boot.php
View file

@ -34,7 +34,7 @@ define('DFRN_PROTOCOL_VERSION', '2.23');
define('NEW_UPDATE_ROUTINE_VERSION', 1170); 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 * Contains a HTML line break (br) element and a real carriage return with line
* feed for the source. * feed for the source.
@ -43,7 +43,7 @@ define('NEW_UPDATE_ROUTINE_VERSION', 1170);
define('EOL', "<br />\r\n"); define('EOL', "<br />\r\n");
/** /**
* @brief Image storage quality. * Image storage quality.
* *
* Lower numbers save space at cost of image detail. * 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, * 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 * @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 * @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 * @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 * 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 * 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 * @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 * @return string Spool path
*/ */

104
include/api.php
View file

@ -65,11 +65,11 @@ $API = [];
$called_api = []; $called_api = [];
/** /**
* Auth API user
*
* It is not sufficient to use local_user() to check whether someone is allowed to use the API, * 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 * 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). * into a page, and visitors will post something without noticing it).
*
* @brief Auth API user
*/ */
function 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 * Clients can send 'source' parameter to be show in post metadata
* as "sent via <source>". * as "sent via <source>".
* Some clients doesn't send a source param, we support ones we know * Some clients doesn't send a source param, we support ones we know
* (only Twidere, atm) * (only Twidere, atm)
* *
* @brief Get source name from API client
*
* @return string * @return string
* Client source name, default to "api" if unset/unknown * Client source name, default to "api" if unset/unknown
* @throws Exception * @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 * @param string $str Source date, as UTC
* @return string Date in UTC formatted as "D M d H:i:s +0000 Y" * @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. * 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 $path API URL path, relative to DI::baseUrl()
* @param string $func Function name to call on path request * @param string $func Function name to call on path request
* @param bool $auth API need logged user * @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. * Log in user via OAuth1 or Simple HTTP Auth.
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
* *
* @brief Login API user
*
* @param App $a App * @param App $a App
* @throws ForbiddenException * @throws ForbiddenException
* @throws InternalServerErrorException * @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. * API endpoints can define which HTTP method to accept when called.
* This function check the current HTTP method agains endpoint * This function check the current HTTP method agains endpoint
* registered method. * registered method.
* *
* @brief Check HTTP method of called API
*
* @param string $method Required methods, uppercase, separated by comma * @param string $method Required methods, uppercase, separated by comma
* @return bool * @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 $a App
* @param App\Arguments $args The app arguments (optional, will retrieved by the DI-Container in case of missing) * @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 string $type Return type (xml, json, rss, as)
* @param object $e HTTPException Error object * @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 App $a
* @param array $arr Array to be passed to template * @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 * @param int $id Contact id
* @return bool|string * @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 App $a App
* @param int|string $contact_id Contact ID or URL * @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 App $a App
* @param array $item item from db * @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 array $array The array to walk through
* @param callable $callback The callback function * @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 mixed $item Array item value
* @param string $key Array key * @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 array $data JSON style array
* @param string $root_element Name of the root element * @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 $root_element Name of the root element
* @param string $type Return type (atom, rss, xml, json) * @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. * 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 * @param string $type Return format: json, xml, atom, rss
* @return array|string * @return array|string
* @throws BadRequestException * @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. * Returns the most recent statuses posted by the user.
* *
* @brief Returns a user's public timeline
*
* @param string $type Either "json" or "xml" * @param string $type Either "json" or "xml"
* @return string|array * @return string|array
* @throws BadRequestException * @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 * @param string $txt text
* @return array * @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 array $item array
* @param string $type Return type (atom, rss, xml, json) * @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' * @param array $profile_row array containing data from db table 'profile'
* @return array * @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 $items array of items
* @param array $user_info * @param array $user_info
@ -3387,11 +3379,11 @@ function api_lists_statuses($type)
api_register_func('api/lists/statuses', 'api_lists_statuses', true); 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 * Considers friends and followers lists to be private and won't return
* anything if any user_id parameter is passed. * anything if any user_id parameter is passed.
* *
* @brief Returns either the friends of the follower list
*
* @param string $qtype Either "friends" or "followers" * @param string $qtype Either "friends" or "followers"
* @return boolean|array * @return boolean|array
* @throws BadRequestException * @throws BadRequestException
@ -3478,9 +3470,7 @@ function api_statuses_f($qtype)
/** /**
* Returns the user's friends. * Returns the list of friends of the provided user
*
* @brief Returns the list of friends of the provided user
* *
* @deprecated By Twitter API in favor of friends/list * @deprecated By Twitter API in favor of friends/list
* *
@ -3499,9 +3489,7 @@ function api_statuses_friends($type)
} }
/** /**
* Returns the user's followers. * Returns the list of followers of the provided user
*
* @brief Returns the list of followers of the provided user
* *
* @deprecated By Twitter API in favor of friends/list * @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); api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
/** /**
* Destroys a direct message. * delete a direct_message from mail table through api
*
* @brief delete a direct_message from mail table through api
* *
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @return string|array
@ -3906,8 +3892,6 @@ api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy',
/** /**
* Unfollow Contact * Unfollow Contact
* *
* @brief unfollow contact
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @return string|array
* @throws BadRequestException * @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' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @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' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @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' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @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' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @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' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @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' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @return string|array
@ -4569,9 +4553,7 @@ function api_fr_photo_detail($type)
/** /**
* Updates the user’s profile image. * updates the profile image for the user (either a specified profile or the default profile)
*
* @brief 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' * @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 * @param array $item Sharer item
* @return array|false Shared item or false if not a reshare * @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); 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' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @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' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @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); 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' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array (success result=ok, error result=error with error message) * @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); 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 $type Known types are 'atom', 'rss', 'xml' and 'json'
* @param string $box * @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); 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' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @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); 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] * @param object $data [Status, Status]
* *

28
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. * The system will fetch the comments for the local user whenever possible.
* This behaviour is currently needed to allow commenting on Friendica posts. * 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. * Increments the count of each matching activity and adds a link to the author as needed.
* *
* @param array $item * @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. * 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 $item_list
* @param array $parent * @param array $parent
* @param bool $recursive * @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 * @param array $items
* @return array * @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 $children List of items to append
* @param array $item_list * @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 * This recursive function takes the item tree structure created by conv_sort() and
* flatten the extraneous depth levels when people reply sequentially, removing the * flatten the extraneous depth levels when people reply sequentially, removing the
* stairs effect in threaded conversations limiting the available content width. * 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 * 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. * 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 * @param array $parent A tree-like array of items
* @return array * @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 * sort the top-level posts either on "received" or "commented", and finally
* append all the items at the top level (???) * 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 array $item_list A list of items belonging to one or more conversations
* @param string $order Either on "received" or "commented" * @param string $order Either on "received" or "commented"
* @return array * @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 $a
* @param array $b * @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 $a
* @param array $b * @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 $a
* @param array $b * @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 $a
* @param array $b * @param array $b

2
include/dba.php
View file

@ -3,7 +3,7 @@
use Friendica\Database\DBA; 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: * Please use the DBA:: functions instead:
* DBA::select, DBA::exists, DBA::insert * DBA::select, DBA::exists, DBA::insert

8
include/enotify.php
View file

@ -23,7 +23,7 @@ use Friendica\Util\Emailer;
use Friendica\Util\Strings; 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: * @param array $params Array with the elements:
* uid, item, parent, type, otype, verb, event, * 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 * @param int $itemid ID of the item for which the check should be done
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @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 $itemid ID of the item for which the check should be done
* @param int $uid User ID * @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 * Replace the name with {0} but ensure to make that only once. The {0} is used
* later and prints the name in bold. * later and prints the name in bold.

7
mod/cal.php
View file

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

3
mod/dfrn_confirm.php
View file

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

2
mod/dfrn_notify.php
View file

@ -2,7 +2,7 @@
/** /**
* @file mod/dfrn_notify.php * @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 * @see PDF with dfrn specs: https://github.com/friendica/friendica/blob/master/spec/dfrn2.pdf
*/ */

2
mod/dfrn_request.php
View file

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

2
mod/events.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file mod/events.php * @file mod/events.php
* @brief The events module * The events module
*/ */
use Friendica\App; use Friendica\App;

2
mod/match.php
View file

@ -17,7 +17,7 @@ use Friendica\Util\Network;
use Friendica\Util\Proxy as ProxyUtils; 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 * It takes keywords from your profile and queries the directory server for
* matching keywords from other profiles. * matching keywords from other profiles.

12
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 App $a The global App
* @param Pager $pager * @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 * @param array $condition The array with the SQL condition
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @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 App $a The global App
* @param array $items Items of the conversation * @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 App $a The global App
* @param integer $update Used for the automatic reloading * @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 App $a The global App
* @param integer $update Used for the automatic reloading * @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 * @param App $a The global App
* @return string Html of the networktab * @return string Html of the networktab

2
mod/notifications.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file mod/notifications.php * @file mod/notifications.php
* @brief The notifications module * The notifications module
*/ */
use Friendica\App; use Friendica\App;

4
mod/parse_url.php
View file

@ -2,7 +2,7 @@
/** /**
* @file mod/parse_url.php * @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) * This module does parse an url for embeddable content (audio, video, image files or link)
* information and does format this information to BBCode * 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 * Note: We have moved the function to ParseUrl.php. This function is only for
* legacy support and will be remove in the future * legacy support and will be remove in the future

6
mod/ping.php
View file

@ -21,7 +21,7 @@ use Friendica\Util\Proxy as ProxyUtils;
use Friendica\Util\XML; 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 * The output format can be controlled via the GET parameter 'format'. It can be
* - xml (deprecated legacy default) * - 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 * @param int $uid User id
* @return array Associative array of notifications * @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 * @deprecated
* *
* @param array $data The initial ping data array * @param array $data The initial ping data array

2
mod/uimport.php
View file

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

2
mod/wall_upload.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file mod/wall_upload.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. * 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=" * You can specify a different album by adding an optional query string "album="

2
mod/worker.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file mod/worker.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; use Friendica\Core\Config;

4
src/App.php
View file

@ -28,7 +28,7 @@ use Psr\Log\LoggerInterface;
* *
* class: App * 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 * Primarily deals with the URL that got us here
* and tries to make some sense of it, and * 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. * Provide a sane default if nothing is chosen or the specified theme does not exist.
* *
* @return string * @return string

4
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 * @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 App $a The Friendica application context
* @param array $user_record The current "user" record * @param array $user_record The current "user" record

10
src/BaseModule.php
View file

@ -17,7 +17,7 @@ use Friendica\Core\Logger;
abstract class BaseModule 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 * Extend this method if you need to do any shared processing before both
* content() or post() * 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, * Extend this method if the module is supposed to return communication data,
* e.g. from protocol implementations. * 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 * 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 * 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. * Extend this method if the module is supposed to process POST requests.
* Doesn't display any content * Doesn't display any content
@ -67,7 +67,7 @@ abstract class BaseModule
} }
/** /**
* @brief Called after post() * Called after post()
* *
* Unknown purpose * Unknown purpose
*/ */

2
src/Console/ArchiveContact.php
View file

@ -9,7 +9,7 @@ use Friendica\Util\Strings;
use RuntimeException; 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. * 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. * Normally this does happen automatically after a few days.

2
src/Console/Cache.php
View file

@ -9,7 +9,7 @@ use Friendica\Core\Cache\ICache;
use RuntimeException; 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. * 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 * You can read current values stored in the cache and set new values

2
src/Console/Config.php
View file

@ -8,7 +8,7 @@ use Friendica\Core\Config\IConfiguration;
use RuntimeException; 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 * 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 * the CLI. You can do both, reading current values stored in the database and

4
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 * @param string $line The current line of the document
* *
@ -118,7 +118,7 @@ HELP;
$space = substr($line, 0, $length); $space = substr($line, 0, $length);
$block = $space . "/**\n" . $block = $space . "/**\n" .
$space . " * @brief \n" . $space . " * \n" .
$space . " *\n"; /**/ $space . " *\n"; /**/

2
src/Console/DatabaseStructure.php
View file

@ -9,7 +9,7 @@ use Friendica\Database\DBStructure;
use RuntimeException; use RuntimeException;
/** /**
* @brief Performs database updates from the command line * Performs database updates from the command line
* *
* @author Hypolite Petovan <hypolite@mrpetovan.com> * @author Hypolite Petovan <hypolite@mrpetovan.com>
*/ */

2
src/Console/GlobalCommunityBlock.php
View file

@ -7,7 +7,7 @@ use Friendica\Core\L10n;
use Friendica\Model\Contact; 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 * 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. * or comments this account writes are accepted to the node.

2
src/Console/GlobalCommunitySilence.php
View file

@ -8,7 +8,7 @@ use Friendica\Model\Contact;
use RuntimeException; 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. * With this tool, you can silence an account on the global community page.
* Postings from silenced accounts will not be displayed on the community * Postings from silenced accounts will not be displayed on the community

2
src/Console/Lock.php
View file

@ -8,7 +8,7 @@ use Friendica\Core\Lock\ILock;
use RuntimeException; 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. * With this script you can access the locks of your node from the CLI.
* You can read current locks and set/remove locks. * You can read current locks and set/remove locks.

2
src/Console/Maintenance.php
View file

@ -6,7 +6,7 @@ use Friendica\App;
use Friendica\Core\Config\IConfiguration; use Friendica\Core\Config\IConfiguration;
/** /**
* @brief Sets maintenance mode for this node * Sets maintenance mode for this node
* *
* @author Hypolite Petovan <hypolite@mrpetovan.com> * @author Hypolite Petovan <hypolite@mrpetovan.com>
*/ */

2
src/Console/NewPassword.php
View file

@ -9,7 +9,7 @@ use Friendica\Model\User;
use RuntimeException; 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 * With this tool, you can set a new password for a user
* *

2
src/Console/ServerBlock.php
View file

@ -8,7 +8,7 @@ use Console_Table;
use Friendica\Core\Config\IConfiguration; use Friendica\Core\Config\IConfiguration;
/** /**
* @brief Manage blocked servers * Manage blocked servers
* *
* With this tool, you can list the current blocked servers * With this tool, you can list the current blocked servers
* or you can add / remove a blocked server from the list * or you can add / remove a blocked server from the list

2
src/Console/Storage.php
View file

@ -6,7 +6,7 @@ use Asika\SimpleConsole\CommandArgsException;
use Friendica\Core\StorageManager; 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 class Storage extends \Asika\SimpleConsole\Console

2
src/Content/ContactSelector.php
View file

@ -12,7 +12,7 @@ use Friendica\Util\Network;
use Friendica\Util\Strings; use Friendica\Util\Strings;
/** /**
* @brief ContactSelector class * ContactSelector class
*/ */
class ContactSelector class ContactSelector
{ {

8
src/Content/Feature.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file src/Content/Feature.php * @file src/Content/Feature.php
* @brief Features management * Features management
*/ */
namespace Friendica\Content; namespace Friendica\Content;
@ -13,7 +13,7 @@ use Friendica\DI;
class Feature class Feature
{ {
/** /**
* @brief check if feature is enabled * check if feature is enabled
* *
* @param integer $uid user id * @param integer $uid user id
* @param string $feature feature * @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 * @param string $feature feature
* @return boolean * @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, * The array includes the setting group, the setting name,
* explainations for the setting and if it's enabled or disabled * explainations for the setting and if it's enabled or disabled

12
src/Content/ForumManager.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file src/Content/ForumManager.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; namespace Friendica\Content;
@ -15,12 +15,12 @@ use Friendica\Model\Contact;
use Friendica\Util\Proxy as ProxyUtils; 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 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 int $uid of the profile owner
* @param boolean $lastitem Sort by lastitem * @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 * Sidebar widget to show subcribed friendica forums. If activated
* in the settings, it appears at the notwork page sidebar * 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 * This function is used to show the forumlist in
* the advanced profile. * 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 * Count unread items of connected forums and private groups
* *

1
src/Content/Nav.php
View file

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

11
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 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. * @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 * 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 * @param string $url
* @return boolean * @return boolean
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @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 * Width and height are given by the remote, and are regularly too small for
* the generated iframe. * 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 * Generates an XPath query to select elements whose provided attribute contains
* the provided value in a space-separated list. * 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 $attr Name of the attribute to seach
* @param string $value Value to search in a space-separated list * @param string $value Value to search in a space-separated list
* @return string * @return string
@ -396,8 +395,6 @@ class OEmbed
/** /**
* Returns the inner XML string of a provided DOMNode * Returns the inner XML string of a provided DOMNode
* *
* @brief Returns the inner XML string of a provided DOMNode
*
* @param DOMNode $node * @param DOMNode $node
* @return string * @return string
*/ */

4
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). * 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. * 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. * 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. * The itemCount is the total number of items including those not displayed.

9
src/Content/Smilies.php
View file

@ -2,7 +2,7 @@
/** /**
* @file src/Content/Smilies.php * @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: * @todo Use the shortcodes from here:
* https://github.com/iamcal/emoji-data/blob/master/emoji_pretty.json?raw=true * https://github.com/iamcal/emoji-data/blob/master/emoji_pretty.json?raw=true
@ -26,7 +26,7 @@ use Friendica\Util\Strings;
class Smilies class Smilies
{ {
/** /**
* @brief Replaces/adds the emoticon list * Replaces/adds the emoticon list
* *
* This function should be used whenever emoticons are added * 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. * 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 * function from being executed by the prepare_text() routine when preparing
* bbcode source for HTML display * bbcode source for HTML display
* *
* @brief Replaces text emoticons with graphical images
* @param string $s Text that should be replaced * @param string $s Text that should be replaced
* @param boolean $no_images Only replace emoticons without images * @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 * @param string $x string
* *

25
src/Content/Text/BBCode.php
View file

@ -35,7 +35,7 @@ use Friendica\Util\XML;
class BBCode 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 * @param string $body Message body
* @return array * @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 * @param string $body Message body
* @return array * @return array
@ -411,7 +411,7 @@ class BBCode
} }
/** /**
* @brief Converts a BBCode text into plaintext * Converts a BBCode text into plaintext
* *
* @param $text * @param $text
* @param bool $keep_urls Whether to keep URLs in the resulting plaintext * @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 * The purpose of this function is to apply system message length limits to
* imported messages without including any embedded photos in the length * imported messages without including any embedded photos in the length
* *
* @brief Truncates imported message body string length to max_import_size
* @param string $body * @param string $body
* @return string * @return string
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -578,7 +579,6 @@ class BBCode
* *
* Note: Can produce a [bookmark] tag in the returned string * Note: Can produce a [bookmark] tag in the returned string
* *
* @brief Processes [attachment] tags
* @param string $text * @param string $text
* @param bool|int $simplehtml * @param bool|int $simplehtml
* @param bool $tryoembed * @param bool $tryoembed
@ -691,7 +691,6 @@ class BBCode
/** /**
* Converts [url] BBCodes in a format that looks fine on Mastodon. (callback function) * 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 * @param array $match Array with the matching values
* @return string reformatted link including HTML codes * @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 * @param string $url URL that is about to be reformatted
* @return string reformatted link including HTML codes * @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 * BBcode 2 HTML was written by WAY2WEB.net
* extended to work with Mistpark/Friendica - Mike Macgirvin * 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 * @param string $text The text with BBCode
* @return string The same text - but without "abstract" element * @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 $text The text that maybe contains the element
* @param string $addon The addon for which the abstract is meant for * @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 * @param array $match Matching values for the callback
* [1] = Mention type (! or @) * [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 * This function converts a BBCode item body to be sent to Markdown-enabled
* systems like Diaspora and Libertree * 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 * We also get @person@domain.com - which would make
* the regex quite complicated as tags can also * the regex quite complicated as tags can also

11
src/Content/Text/HTML.php
View file

@ -137,11 +137,12 @@ class HTML
} }
/** /**
* Converter for HTML to BBCode
*
* Made by: ike@piratenpartei.de * Made by: ike@piratenpartei.de
* Originally made for the syncom project: http://wiki.piratenpartei.de/Syncom * Originally made for the syncom project: http://wiki.piratenpartei.de/Syncom
* https://github.com/annando/Syncom * https://github.com/annando/Syncom
* *
* @brief Converter for HTML to BBCode
* @param string $message * @param string $message
* @param string $basepath * @param string $basepath
* @return string * @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 array $matches Result of preg_replace_callback
* @param string $basepath Basepath that is used to complete the URL * @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 $body Body with URLs
* @param string $basepath Base path that is used to complete the URL * @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 * @param string $s
* @return string * @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 * @param array $contact Array with contacts which contains an array with
* int 'id' => The ID of the contact * int 'id' => The ID of the contact

3
src/Content/Text/Markdown.php
View file

@ -21,7 +21,6 @@ class Markdown
* Converts a Markdown string into HTML. The hardwrap parameter maximizes * Converts a Markdown string into HTML. The hardwrap parameter maximizes
* compatibility with Diaspora in spite of the Markdown standard. * compatibility with Diaspora in spite of the Markdown standard.
* *
* @brief Converts a Markdown string into HTML
* @param string $text * @param string $text
* @param bool $hardwrap * @param bool $hardwrap
* @return string * @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 * @param array $match Matching values for the callback
* [1] = mention type (@ or !) * [1] = mention type (@ or !)

1
src/Content/Widget.php
View file

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

2
src/Content/Widget/CalendarExport.php
View file

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

5
src/Content/Widget/TagCloud.php
View file

@ -22,7 +22,6 @@ class TagCloud
/** /**
* Construct a tag/term cloud block for an user. * 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 $uid The user ID.
* @param int $count Max number of displayed tags/terms. * @param int $count Max number of displayed tags/terms.
* @param int $owner_id The contact ID of the owner of the tagged items. * @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 * Get alphabetical sorted array of used tags/terms of an user including
* a weighting by frequency of use. * 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 $uid The user ID.
* @param int $count Max number of displayed tags/terms. * @param int $count Max number of displayed tags/terms.
* @param int $owner_id The contact id of the owner of the tagged items. * @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. * 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. * @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. * @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. * Compare function to sort tags/terms alphabetically.
* *
* @brief Compare function to sort tags/terms alphabetically.
* @param string $a * @param string $a
* @param string $b * @param string $b
* *

8
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 * system.addon contains a comma-separated list of names
* of addons which are used on this system. * 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 * @param string $addon name of the addon
* @return void * @return void
@ -157,7 +157,7 @@ class Addon
} }
/** /**
* @brief installs an addon. * installs an addon.
* *
* @param string $addon name of the addon * @param string $addon name of the addon
* @return bool * @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 * like
* \code * \code

13
src/Core/Config.php
View file

@ -4,14 +4,14 @@
* *
* @file include/Core/Config.php * @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; namespace Friendica\Core;
use Friendica\DI; use Friendica\DI;
/** /**
* @brief Arbitrary system configuration storage * Arbitrary system configuration storage
* *
* Note: * Note:
* If we ever would decide to return exactly the variable type as entered, * If we ever would decide to return exactly the variable type as entered,
@ -20,7 +20,7 @@ use Friendica\DI;
class Config 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 * @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 * Get a particular user's config variable given the category name ($family) and a key.
* ($family) and a key.
* *
* @param string $cat The category of the configuration value * @param string $cat The category of the configuration value
* @param string $key The configuration key to query * @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) * 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! * 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 $cat The category of the configuration value
* @param string $key The configuration key to delete * @param string $key The configuration key to delete

8
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 ) * All configuration values of the system are stored in the cache ( @see ConfigCache )
* *
@ -20,7 +20,7 @@ interface IConfiguration
function load(string $cat = 'config'); 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. * ($cat) and a $key.
* *
* Get a particular config value from the given category ($cat) * 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); 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) * 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); 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 * Removes the configured value from the stored cache in $this->configCache
* (@see ConfigCache) and removes it from the database (@see IConfigAdapter). * (@see ConfigCache) and removes it from the database (@see IConfigAdapter).

10
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. * 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. * 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. * 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 * Use this function when you want to be able to allow a hook to manipulate
* the provided data. * the provided data.
@ -181,7 +181,7 @@ class Hook
} }
/** /**
* @brief Calls a single hook. * Calls a single hook.
* *
* @param App $a * @param App $a
* @param string $name of the hook to call * @param string $name of the hook to call

10
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 * This function takes a english string as parameter, and if a localized version
* exists for the current language, substitutes it before performing an eventual * 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 * 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 * 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 * Scans the view/lang directory for the existence of "strings.php" files, and
* returns an alphabetical list of their folder names (@-char language codes). * 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. * @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. * @param string $s String with short day or month name.
* *

6
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 string $sysLang The default fallback language
* @param array $server The $_SERVER array * @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 * This function takes a english string as parameter, and if a localized version
* exists for the current language, substitutes it before performing an eventual * 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 * 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 * well as a count. If a localized version exists for the current language, they

9
src/Core/Logger.php
View file

@ -10,7 +10,7 @@ use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel; use Psr\Log\LogLevel;
/** /**
* @brief Logger functions * Logger functions
*/ */
class Logger class Logger
{ {
@ -231,8 +231,8 @@ class Logger
self::getWorker()->debug($message, $context); 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 $msg
* @param string $level * @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 * Works largely as log() but allows developers
* to isolate particular elements they are targetting * to isolate particular elements they are targetting
* personally without background noise * personally without background noise

6
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? * @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? * @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? * @return bool Is the load reached?
*/ */

18
src/Core/Renderer.php
View file

@ -11,22 +11,22 @@ use Friendica\Render\FriendicaSmarty;
use Friendica\Render\ITemplateEngine; use Friendica\Render\ITemplateEngine;
/** /**
* @brief This class handles Renderer related functions. * This class handles Renderer related functions.
*/ */
class Renderer 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 = []; 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 = []; 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 * Mostly unimplemented yet. Only options 'template_engine' and
* beyond are used. * 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 string|FriendicaSmarty $s The string requiring macro substitution or an instance of FriendicaSmarty
* @param array $vars Key value pairs (search => replace) * @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 $s Template to load.
* @param string $root Optional. * @param string $root Optional.
@ -107,7 +107,7 @@ class Renderer
} }
/** /**
* @brief Register template engine class * Register template engine class
* *
* @param string $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, * If $name is not defined, return engine defined by theme,
* or default * 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 * @return string the active template engine
*/ */

1
src/Core/Search.php
View file

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

2
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 * This callback updates the stored session data and/or the expiration depending
* on the case. Uses the Session::expire for existing session, 5 minutes * on the case. Uses the Session::expire for existing session, 5 minutes

2
src/Core/Session/Handler/Database.php
View file

@ -58,7 +58,7 @@ final class Database implements SessionHandlerInterface
} }
/** /**
* @brief Standard PHP session write callback * Standard PHP session write callback
* *
* This callback updates the DB-stored session data and/or the expiration depending * This callback updates the DB-stored session data and/or the expiration depending
* on the case. Uses the Session::expire global for existing session, 5 minutes * on the case. Uses the Session::expire global for existing session, 5 minutes

14
src/Core/StorageManager.php
View file

@ -11,7 +11,7 @@ use Psr\Log\LoggerInterface;
/** /**
* @brief Manage storage backends * Manage storage backends
* *
* Core code uses this class to get and set current storage backend class. * Core code uses this class to get and set current storage backend class.
* Addons use this class to register and unregister additional backends. * Addons use this class to register and unregister additional backends.
@ -67,7 +67,7 @@ class StorageManager
} }
/** /**
* @brief Return current storage backend class * Return current storage backend class
* *
* @return Storage\IStorage|null * @return Storage\IStorage|null
*/ */
@ -77,7 +77,7 @@ class StorageManager
} }
/** /**
* @brief Return storage backend class by registered name * Return storage backend class by registered name
* *
* @param string|null $name Backend name * @param string|null $name Backend name
* @param boolean $onlyUserBackend True, if just user specific instances should be returrned (e.g. not SystemResource) * @param boolean $onlyUserBackend True, if just user specific instances should be returrned (e.g. not SystemResource)
@ -163,7 +163,7 @@ class StorageManager
} }
/** /**
* @brief Set current storage backend class * Set current storage backend class
* *
* @param string $name Backend class name * @param string $name Backend class name
* *
@ -184,7 +184,7 @@ class StorageManager
} }
/** /**
* @brief Get registered backends * Get registered backends
* *
* @return array * @return array
*/ */
@ -222,7 +222,7 @@ class StorageManager
} }
/** /**
* @brief Unregister a storage backend class * Unregister a storage backend class
* *
* @param string $class Backend class name * @param string $class Backend class name
* *
@ -247,7 +247,7 @@ class StorageManager
} }
/** /**
* @brief Move up to 5000 resources to storage $dest * Move up to 5000 resources to storage $dest
* *
* Copy existing data to destination storage and delete from source. * Copy existing data to destination storage and delete from source.
* This method cannot move to legacy in-table `data` field. * This method cannot move to legacy in-table `data` field.

14
src/Core/System.php
View file

@ -11,17 +11,17 @@ use Friendica\Util\XML;
/** /**
* @file include/Core/System.php * @file include/Core/System.php
* *
* @brief Contains the class with system relevant stuff * Contains the class with system relevant stuff
*/ */
/** /**
* @brief System methods * System methods
*/ */
class System class System
{ {
/** /**
* @brief Returns a string with a callstack. Can be used for logging. * Returns a string with a callstack. Can be used for logging.
* @param integer $depth optional, default 4 * @param integer $depth optional, default 4
* @return string * @return string
*/ */
@ -93,7 +93,7 @@ class System
} }
/** /**
* @brief Send HTTP status header and exit. * Send HTTP status header and exit.
* *
* @param integer $val HTTP status result value * @param integer $val HTTP status result value
* @param string $message Error message. Optional. * @param string $message Error message. Optional.
@ -117,7 +117,7 @@ class System
} }
/** /**
* @brief Encodes content to json. * Encodes content to json.
* *
* This function encodes an array to json format * This function encodes an array to json format
* and adds an application/json HTTP header to the output. * and adds an application/json HTTP header to the output.
@ -227,7 +227,7 @@ class System
} }
/** /**
* @brief Returns the system user that is executing the script * Returns the system user that is executing the script
* *
* This mostly returns something like "www-data". * This mostly returns something like "www-data".
* *
@ -244,7 +244,7 @@ class System
} }
/** /**
* @brief Checks if a given directory is usable for the system * Checks if a given directory is usable for the system
* *
* @param $directory * @param $directory
* @param bool $check_writable * @param bool $check_writable

8
src/Core/Theme.php
View file

@ -40,7 +40,7 @@ class Theme
} }
/** /**
* @brief Parse theme comment in search of theme infos. * Parse theme comment in search of theme infos.
* *
* like * like
* \code * \code
@ -110,7 +110,7 @@ class Theme
} }
/** /**
* @brief Returns the theme's screenshot. * Returns the theme's screenshot.
* *
* The screenshot is expected as view/theme/$theme/screenshot.[png|jpg]. * The screenshot is expected as view/theme/$theme/screenshot.[png|jpg].
* *
@ -182,7 +182,7 @@ class Theme
} }
/** /**
* @brief Get the full path to relevant theme files by filename * Get the full path to relevant theme files by filename
* *
* This function searches in order in the current theme directory, in the current theme parent directory, and lastly * This function searches in order in the current theme directory, in the current theme parent directory, and lastly
* in the base view/ folder. * in the base view/ folder.
@ -215,7 +215,7 @@ class Theme
} }
/** /**
* @brief Return relative path to theme stylesheet file * Return relative path to theme stylesheet file
* *
* Provide a sane default if nothing is chosen or the specified theme does not exist. * Provide a sane default if nothing is chosen or the specified theme does not exist.
* *

2
src/Core/Update.php
View file

@ -14,7 +14,7 @@ class Update
const FAILED = 1; const FAILED = 1;
/** /**
* @brief Function to check if the Database structure needs an update. * Function to check if the Database structure needs an update.
* *
* @param string $basePath The base path of this application * @param string $basePath The base path of this application
* @param boolean $via_worker Is the check run via the worker? * @param boolean $via_worker Is the check run via the worker?

4
src/Core/UserImport.php
View file

@ -14,7 +14,7 @@ use Friendica\Util\Strings;
use Friendica\Worker\Delivery; use Friendica\Worker\Delivery;
/** /**
* @brief UserImport class * UserImport class
*/ */
class UserImport class UserImport
{ {
@ -84,7 +84,7 @@ class UserImport
} }
/** /**
* @brief Import account file exported from mod/uexport * Import account file exported from mod/uexport
* *
* @param array $file array from $_FILES * @param array $file array from $_FILES
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException

57
src/Core/Worker.php
View file

@ -14,11 +14,11 @@ use Friendica\Util\Network;
/** /**
* @file src/Core/Worker.php * @file src/Core/Worker.php
* *
* @brief Contains the class for the worker background job processing * Contains the class for the worker background job processing
*/ */
/** /**
* @brief Worker methods * Worker methods
*/ */
class Worker class Worker
{ {
@ -40,7 +40,7 @@ class Worker
private static $state; private static $state;
/** /**
* @brief Processes the tasks that are in the workerqueue table * Processes the tasks that are in the workerqueue table
* *
* @param boolean $run_cron Should the cron processes be executed? * @param boolean $run_cron Should the cron processes be executed?
* @return void * @return void
@ -163,7 +163,7 @@ class Worker
} }
/** /**
* @brief Check if non executed tasks do exist in the worker queue * Check if non executed tasks do exist in the worker queue
* *
* @return boolean Returns "true" if tasks are existing * @return boolean Returns "true" if tasks are existing
* @throws \Exception * @throws \Exception
@ -177,7 +177,7 @@ class Worker
} }
/** /**
* @brief Returns the number of deferred entries in the worker queue * Returns the number of deferred entries in the worker queue
* *
* @return integer Number of deferred entries in the worker queue * @return integer Number of deferred entries in the worker queue
* @throws \Exception * @throws \Exception
@ -192,7 +192,7 @@ class Worker
} }
/** /**
* @brief Returns the number of non executed entries in the worker queue * Returns the number of non executed entries in the worker queue
* *
* @return integer Number of non executed entries in the worker queue * @return integer Number of non executed entries in the worker queue
* @throws \Exception * @throws \Exception
@ -207,7 +207,7 @@ class Worker
} }
/** /**
* @brief Returns the highest priority in the worker queue that isn't executed * Returns the highest priority in the worker queue that isn't executed
* *
* @return integer Number of active worker processes * @return integer Number of active worker processes
* @throws \Exception * @throws \Exception
@ -226,7 +226,7 @@ class Worker
} }
/** /**
* @brief Returns if a process with the given priority is running * Returns if a process with the given priority is running
* *
* @param integer $priority The priority that should be checked * @param integer $priority The priority that should be checked
* *
@ -240,7 +240,7 @@ class Worker
} }
/** /**
* @brief Execute a worker entry * Execute a worker entry
* *
* @param array $queue Workerqueue entry * @param array $queue Workerqueue entry
* *
@ -359,7 +359,7 @@ class Worker
} }
/** /**
* @brief Execute a function from the queue * Execute a function from the queue
* *
* @param array $queue Workerqueue entry * @param array $queue Workerqueue entry
* @param string $funcname name of the function * @param string $funcname name of the function
@ -450,7 +450,7 @@ class Worker
} }
/** /**
* @brief Checks if the number of database connections has reached a critical limit. * Checks if the number of database connections has reached a critical limit.
* *
* @return bool Are more than 3/4 of the maximum connections used? * @return bool Are more than 3/4 of the maximum connections used?
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -533,7 +533,7 @@ class Worker
} }
/** /**
* @brief fix the queue entry if the worker process died * fix the queue entry if the worker process died
* @return void * @return void
* @throws \Exception * @throws \Exception
*/ */
@ -605,7 +605,7 @@ class Worker
} }
/** /**
* @brief Checks if the number of active workers exceeds the given limits * Checks if the number of active workers exceeds the given limits
* *
* @return bool Are there too much workers running? * @return bool Are there too much workers running?
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -735,7 +735,7 @@ class Worker
} }
/** /**
* @brief Returns the number of active worker processes * Returns the number of active worker processes
* *
* @return integer Number of active worker processes * @return integer Number of active worker processes
* @throws \Exception * @throws \Exception
@ -749,7 +749,7 @@ class Worker
} }
/** /**
* @brief Returns waiting jobs for the current process id * Returns waiting jobs for the current process id
* *
* @return array waiting workerqueue jobs * @return array waiting workerqueue jobs
* @throws \Exception * @throws \Exception
@ -768,7 +768,7 @@ class Worker
} }
/** /**
* @brief Returns the next jobs that should be executed * Returns the next jobs that should be executed
* *
* @return array array with next jobs * @return array array with next jobs
* @throws \Exception * @throws \Exception
@ -803,7 +803,7 @@ class Worker
} }
/** /**
* @brief Returns the priority of the next workerqueue job * Returns the priority of the next workerqueue job
* *
* @return string priority * @return string priority
* @throws \Exception * @throws \Exception
@ -876,7 +876,7 @@ class Worker
} }
/** /**
* @brief Find and claim the next worker process for us * Find and claim the next worker process for us
* *
* @return boolean Have we found something? * @return boolean Have we found something?
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -919,7 +919,7 @@ class Worker
} }
/** /**
* @brief Returns the next worker process * Returns the next worker process
* *
* @return string SQL statement * @return string SQL statement
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -952,7 +952,7 @@ class Worker
} }
/** /**
* @brief Removes a workerqueue entry from the current process * Removes a workerqueue entry from the current process
* @return void * @return void
* @throws \Exception * @throws \Exception
*/ */
@ -967,7 +967,7 @@ class Worker
} }
/** /**
* @brief Call the front end worker * Call the front end worker
* @return void * @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/ */
@ -982,7 +982,7 @@ class Worker
} }
/** /**
* @brief Call the front end worker if there aren't any active * Call the front end worker if there aren't any active
* @return void * @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/ */
@ -1033,7 +1033,7 @@ class Worker
} }
/** /**
* @brief Removes long running worker processes * Removes long running worker processes
* @return void * @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/ */
@ -1051,7 +1051,7 @@ class Worker
} }
/** /**
* @brief Runs the cron processes * Runs the cron processes
* @return void * @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/ */
@ -1070,7 +1070,7 @@ class Worker
} }
/** /**
* @brief Spawns a new worker * Spawns a new worker
* @param bool $do_cron * @param bool $do_cron
* @return void * @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -1092,7 +1092,7 @@ class Worker
} }
/** /**
* @brief Adds tasks to the worker queue * Adds tasks to the worker queue
* *
* @param (integer|array) priority or parameter array, strings are deprecated and are ignored * @param (integer|array) priority or parameter array, strings are deprecated and are ignored
* *
@ -1272,8 +1272,6 @@ class Worker
/** /**
* Log active processes into the "process" table * Log active processes into the "process" table
*
* @brief Log active processes into the "process" table
*/ */
public static function startProcess() public static function startProcess()
{ {
@ -1289,7 +1287,6 @@ class Worker
/** /**
* Remove the active process from the "process" table * Remove the active process from the "process" table
* *
* @brief Remove the active process from the "process" table
* @return bool * @return bool
* @throws \Exception * @throws \Exception
*/ */
@ -1301,7 +1298,6 @@ class Worker
/** /**
* Set the flag if some job is waiting * Set the flag if some job is waiting
* *
* @brief Set the flag if some job is waiting
* @param boolean $jobs Is there a waiting job? * @param boolean $jobs Is there a waiting job?
* @throws \Exception * @throws \Exception
*/ */
@ -1316,7 +1312,6 @@ class Worker
/** /**
* Checks if some worker job waits to be executed * Checks if some worker job waits to be executed
* *
* @brief Checks if some worker job waits to be executed
* @return bool * @return bool
* @throws \Exception * @throws \Exception
*/ */

6
src/Database/DBA.php
View file

@ -207,7 +207,6 @@ class DBA
* *
* Please use DBA::selectFirst or DBA::exists whenever this is possible. * Please use DBA::selectFirst or DBA::exists whenever this is possible.
* *
* @brief Fetches the first row
* @param string $sql SQL statement * @param string $sql SQL statement
* @return array first row of query * @return array first row of query
* @throws \Exception * @throws \Exception
@ -360,7 +359,9 @@ class DBA
} }
/** /**
* Updates rows in the database. When $old_fields is set to an array, * Updates rows in the database.
*
* When $old_fields is set to an array,
* the system will only do an update if the fields in that array changed. * the system will only do an update if the fields in that array changed.
* *
* Attention: * Attention:
@ -378,7 +379,6 @@ class DBA
* Only set $old_fields to a boolean value when you are sure that you will update a single row. * Only set $old_fields to a boolean value when you are sure that you will update a single row.
* When you set $old_fields to "true" then $fields must contain all relevant fields! * When you set $old_fields to "true" then $fields must contain all relevant fields!
* *
* @brief Updates rows
* @param string|array $table Table name or array [schema => table] * @param string|array $table Table name or array [schema => table]
* @param array $fields contains the fields that are updated * @param array $fields contains the fields that are updated
* @param array $condition condition array with the key values * @param array $condition condition array with the key values

4
src/Database/DBStructure.php
View file

@ -15,8 +15,6 @@ use Friendica\Util\DateTimeFormat;
require_once __DIR__ . '/../../include/dba.php'; require_once __DIR__ . '/../../include/dba.php';
/** /**
* @brief This class contain functions for the database management
*
* This class contains functions that doesn't need to know if pdo, mysqli or whatever is used. * This class contains functions that doesn't need to know if pdo, mysqli or whatever is used.
*/ */
class DBStructure class DBStructure
@ -63,7 +61,7 @@ class DBStructure
} }
/** /**
* @brief Print out database error messages * Print out database error messages
* *
* @param string $message Message to be added to the error message * @param string $message Message to be added to the error message
* *

70
src/Database/Database.php
View file

@ -226,7 +226,7 @@ class Database
} }
/** /**
* @brief Returns the MySQL server version string * Returns the MySQL server version string
* *
* This function discriminate between the deprecated mysql API and the current * This function discriminate between the deprecated mysql API and the current
* object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1 * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
@ -249,7 +249,7 @@ class Database
} }
/** /**
* @brief Returns the selected database name * Returns the selected database name
* *
* @return string * @return string
* @throws \Exception * @throws \Exception
@ -262,7 +262,7 @@ class Database
} }
/** /**
* @brief Analyze a database query and log this if some conditions are met. * Analyze a database query and log this if some conditions are met.
* *
* @param string $query The database query that will be analyzed * @param string $query The database query that will be analyzed
* *
@ -378,8 +378,8 @@ class Database
} }
/** /**
* @brief Replaces ANY_VALUE() function by MIN() function, * Replaces ANY_VALUE() function by MIN() function,
* if the database server does not support ANY_VALUE(). * if the database server does not support ANY_VALUE().
* *
* Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5). * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
* ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
@ -400,7 +400,7 @@ class Database
} }
/** /**
* @brief Replaces the ? placeholders with the parameters in the $args array * Replaces the ? placeholders with the parameters in the $args array
* *
* @param string $sql SQL query * @param string $sql SQL query
* @param array $args The parameters that are to replace the ? placeholders * @param array $args The parameters that are to replace the ? placeholders
@ -427,7 +427,7 @@ class Database
} }
/** /**
* @brief Executes a prepared statement that returns data * Executes a prepared statement that returns data
* @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid); * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
* *
* Please only use it with complicated queries. * Please only use it with complicated queries.
@ -667,7 +667,7 @@ class Database
} }
/** /**
* @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data * Executes a prepared statement like UPDATE or INSERT that doesn't return data
* *
* Please use DBA::delete, DBA::insert, DBA::update, ... instead * Please use DBA::delete, DBA::insert, DBA::update, ... instead
* *
@ -733,7 +733,7 @@ class Database
} }
/** /**
* @brief Check if data exists * Check if data exists
* *
* @param string|array $table Table name or array [schema => table] * @param string|array $table Table name or array [schema => table]
* @param array $condition array of fields for condition * @param array $condition array of fields for condition
@ -777,7 +777,7 @@ class Database
* *
* Please use DBA::selectFirst or DBA::exists whenever this is possible. * Please use DBA::selectFirst or DBA::exists whenever this is possible.
* *
* @brief Fetches the first row * Fetches the first row
* *
* @param string $sql SQL statement * @param string $sql SQL statement
* *
@ -802,7 +802,7 @@ class Database
} }
/** /**
* @brief Returns the number of affected rows of the last statement * Returns the number of affected rows of the last statement
* *
* @return int Number of rows * @return int Number of rows
*/ */
@ -812,7 +812,7 @@ class Database
} }
/** /**
* @brief Returns the number of columns of a statement * Returns the number of columns of a statement
* *
* @param object Statement object * @param object Statement object
* *
@ -833,7 +833,7 @@ class Database
} }
/** /**
* @brief Returns the number of rows of a statement * Returns the number of rows of a statement
* *
* @param PDOStatement|mysqli_result|mysqli_stmt Statement object * @param PDOStatement|mysqli_result|mysqli_stmt Statement object
* *
@ -854,7 +854,7 @@ class Database
} }
/** /**
* @brief Fetch a single row * Fetch a single row
* *
* @param mixed $stmt statement object * @param mixed $stmt statement object
* *
@ -914,7 +914,7 @@ class Database
} }
/** /**
* @brief Insert a row into a table * Insert a row into a table
* *
* @param string|array $table Table name or array [schema => table] * @param string|array $table Table name or array [schema => table]
* @param array $param parameter array * @param array $param parameter array
@ -951,7 +951,7 @@ class Database
} }
/** /**
* @brief Fetch the id of the last insert command * Fetch the id of the last insert command
* *
* @return integer Last inserted id * @return integer Last inserted id
*/ */
@ -969,7 +969,7 @@ class Database
} }
/** /**
* @brief Locks a table for exclusive write access * Locks a table for exclusive write access
* *
* This function can be extended in the future to accept a table array as well. * This function can be extended in the future to accept a table array as well.
* *
@ -1007,7 +1007,7 @@ class Database
} }
/** /**
* @brief Unlocks all locked tables * Unlocks all locked tables
* *
* @return boolean was the unlock successful? * @return boolean was the unlock successful?
* @throws \Exception * @throws \Exception
@ -1035,7 +1035,7 @@ class Database
} }
/** /**
* @brief Starts a transaction * Starts a transaction
* *
* @return boolean Was the command executed successfully? * @return boolean Was the command executed successfully?
*/ */
@ -1081,7 +1081,7 @@ class Database
} }
/** /**
* @brief Does a commit * Does a commit
* *
* @return boolean Was the command executed successfully? * @return boolean Was the command executed successfully?
*/ */
@ -1095,7 +1095,7 @@ class Database
} }
/** /**
* @brief Does a rollback * Does a rollback
* *
* @return boolean Was the command executed successfully? * @return boolean Was the command executed successfully?
*/ */
@ -1121,7 +1121,7 @@ class Database
} }
/** /**
* @brief Build the array with the table relations * Build the array with the table relations
* *
* The array is build from the database definitions in DBStructure.php * The array is build from the database definitions in DBStructure.php
* *
@ -1143,7 +1143,7 @@ class Database
} }
/** /**
* @brief Delete a row from a table * Delete a row from a table
* *
* Note: this methods does NOT accept schema => table arrays because of the complex relation stuff. * Note: this methods does NOT accept schema => table arrays because of the complex relation stuff.
* *
@ -1292,7 +1292,7 @@ class Database
} }
/** /**
* @brief Updates rows * Updates rows
* *
* Updates rows in the database. When $old_fields is set to an array, * Updates rows in the database. When $old_fields is set to an array,
* the system will only do an update if the fields in that array changed. * the system will only do an update if the fields in that array changed.
@ -1374,8 +1374,6 @@ class Database
/** /**
* Retrieve a single record from a table and returns it in an associative array * Retrieve a single record from a table and returns it in an associative array
* *
* @brief Retrieve a single record from a table
*
* @param string|array $table * @param string|array $table
* @param array $fields * @param array $fields
* @param array $condition * @param array $condition
@ -1400,7 +1398,7 @@ class Database
} }
/** /**
* @brief Select rows from a table and fills an array with the data * Select rows from a table and fills an array with the data
* *
* @param string|array $table Table name or array [schema => table] * @param string|array $table Table name or array [schema => table]
* @param array $fields Array of selected fields, empty for all * @param array $fields Array of selected fields, empty for all
@ -1417,7 +1415,7 @@ class Database
} }
/** /**
* @brief Select rows from a table * Select rows from a table
* *
* @param string|array $table Table name or array [schema => table] * @param string|array $table Table name or array [schema => table]
* @param array $fields Array of selected fields, empty for all * @param array $fields Array of selected fields, empty for all
@ -1465,7 +1463,7 @@ class Database
} }
/** /**
* @brief Counts the rows from a table satisfying the provided condition * Counts the rows from a table satisfying the provided condition
* *
* @param string|array $table Table name or array [schema => table] * @param string|array $table Table name or array [schema => table]
* @param array $condition Array of fields for condition * @param array $condition Array of fields for condition
@ -1509,7 +1507,7 @@ class Database
} }
/** /**
* @brief Fills an array with data from a query * Fills an array with data from a query
* *
* @param object $stmt statement object * @param object $stmt statement object
* @param bool $do_close * @param bool $do_close
@ -1535,7 +1533,7 @@ class Database
} }
/** /**
* @brief Returns the error number of the last query * Returns the error number of the last query
* *
* @return string Error number (0 if no error) * @return string Error number (0 if no error)
*/ */
@ -1545,7 +1543,7 @@ class Database
} }
/** /**
* @brief Returns the error message of the last query * Returns the error message of the last query
* *
* @return string Error message ('' if no error) * @return string Error message ('' if no error)
*/ */
@ -1555,7 +1553,7 @@ class Database
} }
/** /**
* @brief Closes the current statement * Closes the current statement
* *
* @param object $stmt statement object * @param object $stmt statement object
* *
@ -1596,7 +1594,7 @@ class Database
} }
/** /**
* @brief Return a list of database processes * Return a list of database processes
* *
* @return array * @return array
* 'list' => List of processes, separated in their different states * 'list' => List of processes, separated in their different states
@ -1652,7 +1650,7 @@ class Database
} }
/** /**
* @brief Callback function for "esc_array" * Callback function for "esc_array"
* *
* @param mixed $value Array value * @param mixed $value Array value
* @param string $key Array key * @param string $key Array key
@ -1681,7 +1679,7 @@ class Database
} }
/** /**
* @brief Escapes a whole array * Escapes a whole array
* *
* @param mixed $arr Array with values to be escaped * @param mixed $arr Array with values to be escaped
* @param boolean $add_quotation add quotation marks for string values * @param boolean $add_quotation add quotation marks for string values

12
src/Database/PostUpdate.php
View file

@ -19,7 +19,7 @@ use Friendica\Model\PermissionSet;
class PostUpdate class PostUpdate
{ {
/** /**
* @brief Calls the post update functions * Calls the post update functions
*/ */
public static function update() public static function update()
{ {
@ -49,7 +49,7 @@ class PostUpdate
} }
/** /**
* @brief Updates the "global" field in the item table * Updates the "global" field in the item table
* *
* @return bool "true" when the job is done * @return bool "true" when the job is done
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -118,7 +118,7 @@ class PostUpdate
} }
/** /**
* @brief update the "last-item" field in the "self" contact * update the "last-item" field in the "self" contact
* *
* This field avoids cost intensive calls in the admin panel and in "nodeinfo" * This field avoids cost intensive calls in the admin panel and in "nodeinfo"
* *
@ -153,7 +153,7 @@ class PostUpdate
} }
/** /**
* @brief update the item related tables * update the item related tables
* *
* @return bool "true" when the job is done * @return bool "true" when the job is done
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -305,7 +305,7 @@ class PostUpdate
} }
/** /**
* @brief update item-uri data. Prerequisite for the next item structure update. * update item-uri data. Prerequisite for the next item structure update.
* *
* @return bool "true" when the job is done * @return bool "true" when the job is done
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -459,7 +459,7 @@ class PostUpdate
} }
/** /**
* @brief update user-item data with notifications * update user-item data with notifications
* *
* @return bool "true" when the job is done * @return bool "true" when the job is done
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException

2
src/Factory/LockFactory.php
View file

@ -87,7 +87,7 @@ class LockFactory
} }
/** /**
* @brief This method tries to find the best - local - locking method for Friendica * This method tries to find the best - local - locking method for Friendica
* *
* The following sequence will be tried: * The following sequence will be tried:
* 1. Semaphore Locking * 1. Semaphore Locking

24
src/Model/Attach.php
View file

@ -2,7 +2,7 @@
/** /**
* @file src/Model/Attach.php * @file src/Model/Attach.php
* @brief This file contains the Attach class for database interface * This file contains the Attach class for database interface
*/ */
namespace Friendica\Model; namespace Friendica\Model;
@ -22,7 +22,7 @@ class Attach
{ {
/** /**
* @brief Return a list of fields that are associated with the attach table * Return a list of fields that are associated with the attach table
* *
* @return array field list * @return array field list
* @throws \Exception * @throws \Exception
@ -36,7 +36,7 @@ class Attach
} }
/** /**
* @brief Select rows from the attach table and return them as array * Select rows from the attach table and return them as array
* *
* @param array $fields Array of selected fields, empty for all * @param array $fields Array of selected fields, empty for all
* @param array $conditions Array of fields for conditions * @param array $conditions Array of fields for conditions
@ -57,7 +57,7 @@ class Attach
} }
/** /**
* @brief Retrieve a single record from the attach table * Retrieve a single record from the attach table
* *
* @param array $fields Array of selected fields, empty for all * @param array $fields Array of selected fields, empty for all
* @param array $conditions Array of fields for conditions * @param array $conditions Array of fields for conditions
@ -78,7 +78,7 @@ class Attach
} }
/** /**
* @brief Check if attachment with given conditions exists * Check if attachment with given conditions exists
* *
* @param array $conditions Array of extra conditions * @param array $conditions Array of extra conditions
* *
@ -91,7 +91,7 @@ class Attach
} }
/** /**
* @brief Retrive a single record given the ID * Retrive a single record given the ID
* *
* @param int $id Row id of the record * @param int $id Row id of the record
* *
@ -106,7 +106,7 @@ class Attach
} }
/** /**
* @brief Retrive a single record given the ID * Retrive a single record given the ID
* *
* @param int $id Row id of the record * @param int $id Row id of the record
* *
@ -135,7 +135,7 @@ class Attach
} }
/** /**
* @brief Get file data for given row id. null if row id does not exist * Get file data for given row id. null if row id does not exist
* *
* @param array $item Attachment data. Needs at least 'id', 'backend-class', 'backend-ref' * @param array $item Attachment data. Needs at least 'id', 'backend-class', 'backend-ref'
* *
@ -159,7 +159,7 @@ class Attach
} }
/** /**
* @brief Store new file metadata in db and binary in default backend * Store new file metadata in db and binary in default backend
* *
* @param string $data Binary data * @param string $data Binary data
* @param integer $uid User ID * @param integer $uid User ID
@ -215,7 +215,7 @@ class Attach
} }
/** /**
* @brief Store new file metadata in db and binary in default backend from existing file * Store new file metadata in db and binary in default backend from existing file
* *
* @param $src * @param $src
* @param $uid * @param $uid
@ -240,7 +240,7 @@ class Attach
/** /**
* @brief Update an attached file * Update an attached file
* *
* @param array $fields Contains the fields that are updated * @param array $fields Contains the fields that are updated
* @param array $conditions Condition array with the key values * @param array $conditions Condition array with the key values
@ -275,7 +275,7 @@ class Attach
/** /**
* @brief Delete info from table and data from storage * Delete info from table and data from storage
* *
* @param array $conditions Field condition(s) * @param array $conditions Field condition(s)
* @param array $options Options array, Optional * @param array $options Options array, Optional

84
src/Model/Contact.php
View file

@ -29,7 +29,7 @@ use Friendica\Util\Network;
use Friendica\Util\Strings; use Friendica\Util\Strings;
/** /**
* @brief functions for interacting with a contact * functions for interacting with a contact
*/ */
class Contact class Contact
{ {
@ -174,7 +174,7 @@ class Contact
} }
/** /**
* @brief Tests if the given contact is a follower * Tests if the given contact is a follower
* *
* @param int $cid Either public contact id or user's contact id * @param int $cid Either public contact id or user's contact id
* @param int $uid User ID * @param int $uid User ID
@ -199,7 +199,7 @@ class Contact
} }
/** /**
* @brief Tests if the given contact url is a follower * Tests if the given contact url is a follower
* *
* @param string $url Contact URL * @param string $url Contact URL
* @param int $uid User ID * @param int $uid User ID
@ -220,7 +220,7 @@ class Contact
} }
/** /**
* @brief Tests if the given user follow the given contact * Tests if the given user follow the given contact
* *
* @param int $cid Either public contact id or user's contact id * @param int $cid Either public contact id or user's contact id
* @param int $uid User ID * @param int $uid User ID
@ -245,7 +245,7 @@ class Contact
} }
/** /**
* @brief Tests if the given user follow the given contact url * Tests if the given user follow the given contact url
* *
* @param string $url Contact URL * @param string $url Contact URL
* @param int $uid User ID * @param int $uid User ID
@ -266,7 +266,7 @@ class Contact
} }
/** /**
* @brief Get the basepath for a given contact link * Get the basepath for a given contact link
* *
* @param string $url The contact link * @param string $url The contact link
* @param boolean $dont_update Don't update the contact * @param boolean $dont_update Don't update the contact
@ -355,7 +355,7 @@ class Contact
} }
/** /**
* @brief Returns the contact id for the user and the public contact id for a given contact id * Returns the contact id for the user and the public contact id for a given contact id
* *
* @param int $cid Either public contact id or user's contact id * @param int $cid Either public contact id or user's contact id
* @param int $uid User ID * @param int $uid User ID
@ -417,7 +417,7 @@ class Contact
} }
/** /**
* @brief Block contact id for user id * Block contact id for user id
* *
* @param int $cid Either public contact id or user's contact id * @param int $cid Either public contact id or user's contact id
* @param int $uid User ID * @param int $uid User ID
@ -439,7 +439,7 @@ class Contact
} }
/** /**
* @brief Returns "block" state for contact id and user id * Returns "block" state for contact id and user id
* *
* @param int $cid Either public contact id or user's contact id * @param int $cid Either public contact id or user's contact id
* @param int $uid User ID * @param int $uid User ID
@ -480,7 +480,7 @@ class Contact
} }
/** /**
* @brief Ignore contact id for user id * Ignore contact id for user id
* *
* @param int $cid Either public contact id or user's contact id * @param int $cid Either public contact id or user's contact id
* @param int $uid User ID * @param int $uid User ID
@ -502,7 +502,7 @@ class Contact
} }
/** /**
* @brief Returns "ignore" state for contact id and user id * Returns "ignore" state for contact id and user id
* *
* @param int $cid Either public contact id or user's contact id * @param int $cid Either public contact id or user's contact id
* @param int $uid User ID * @param int $uid User ID
@ -543,7 +543,7 @@ class Contact
} }
/** /**
* @brief Set "collapsed" for contact id and user id * Set "collapsed" for contact id and user id
* *
* @param int $cid Either public contact id or user's contact id * @param int $cid Either public contact id or user's contact id
* @param int $uid User ID * @param int $uid User ID
@ -561,7 +561,7 @@ class Contact
} }
/** /**
* @brief Returns "collapsed" state for contact id and user id * Returns "collapsed" state for contact id and user id
* *
* @param int $cid Either public contact id or user's contact id * @param int $cid Either public contact id or user's contact id
* @param int $uid User ID * @param int $uid User ID
@ -590,7 +590,7 @@ class Contact
} }
/** /**
* @brief Returns a list of contacts belonging in a group * Returns a list of contacts belonging in a group
* *
* @param int $gid * @param int $gid
* @return array * @return array
@ -625,7 +625,7 @@ class Contact
} }
/** /**
* @brief Returns the count of OStatus contacts in a group * Returns the count of OStatus contacts in a group
* *
* @param int $gid * @param int $gid
* @return int * @return int
@ -807,7 +807,7 @@ class Contact
} }
/** /**
* @brief Marks a contact for removal * Marks a contact for removal
* *
* @param int $id contact id * @param int $id contact id
* @return null * @return null
@ -829,7 +829,7 @@ class Contact
} }
/** /**
* @brief Sends an unfriend message. Does not remove the contact * Sends an unfriend message. Does not remove the contact
* *
* @param array $user User unfriending * @param array $user User unfriending
* @param array $contact Contact unfriended * @param array $contact Contact unfriended
@ -878,7 +878,7 @@ class Contact
} }
/** /**
* @brief Marks a contact for archival after a communication issue delay * Marks a contact for archival after a communication issue delay
* *
* Contact has refused to recognise us as a friend. We will start a countdown. * Contact has refused to recognise us as a friend. We will start a countdown.
* If they still don't recognise us in 32 days, the relationship is over, * If they still don't recognise us in 32 days, the relationship is over,
@ -936,7 +936,7 @@ class Contact
} }
/** /**
* @brief Cancels the archival countdown * Cancels the archival countdown
* *
* @see Contact::markForArchival() * @see Contact::markForArchival()
* *
@ -979,7 +979,7 @@ class Contact
} }
/** /**
* @brief Get contact data for a given profile link * Get contact data for a given profile link
* *
* The function looks at several places (contact table and gcontact table) for the contact * The function looks at several places (contact table and gcontact table) for the contact
* It caches its result for the same script execution to prevent duplicate calls * It caches its result for the same script execution to prevent duplicate calls
@ -1126,7 +1126,7 @@ class Contact
} }
/** /**
* @brief Get contact data for a given address * Get contact data for a given address
* *
* The function looks at several places (contact table and gcontact table) for the contact * The function looks at several places (contact table and gcontact table) for the contact
* *
@ -1184,7 +1184,7 @@ class Contact
} }
/** /**
* @brief Returns the data array for the photo menu of a given contact * Returns the data array for the photo menu of a given contact
* *
* @param array $contact contact * @param array $contact contact
* @param int $uid optional, default 0 * @param int $uid optional, default 0
@ -1313,7 +1313,7 @@ class Contact
} }
/** /**
* @brief Returns ungrouped contact count or list for user * Returns ungrouped contact count or list for user
* *
* Returns either the total number of ungrouped contacts for the given user * Returns either the total number of ungrouped contacts for the given user
* id or a paginated list of ungrouped contacts. * id or a paginated list of ungrouped contacts.
@ -1424,7 +1424,7 @@ class Contact
} }
/** /**
* @brief Fetch the contact id for a given URL and user * Fetch the contact id for a given URL and user
* *
* First lookup in the contact table to find a record matching either `url`, `nurl`, * First lookup in the contact table to find a record matching either `url`, `nurl`,
* `addr` or `alias`. * `addr` or `alias`.
@ -1662,7 +1662,7 @@ class Contact
} }
/** /**
* @brief Checks if the contact is archived * Checks if the contact is archived
* *
* @param int $cid contact id * @param int $cid contact id
* *
@ -1706,7 +1706,7 @@ class Contact
} }
/** /**
* @brief Checks if the contact is blocked * Checks if the contact is blocked
* *
* @param int $cid contact id * @param int $cid contact id
* *
@ -1732,7 +1732,7 @@ class Contact
} }
/** /**
* @brief Checks if the contact is hidden * Checks if the contact is hidden
* *
* @param int $cid contact id * @param int $cid contact id
* *
@ -1753,7 +1753,7 @@ class Contact
} }
/** /**
* @brief Returns posts from a given contact url * Returns posts from a given contact url
* *
* @param string $contact_url Contact URL * @param string $contact_url Contact URL
* *
@ -1816,7 +1816,7 @@ class Contact
} }
/** /**
* @brief Returns the account type name * Returns the account type name
* *
* The function can be called with either the user or the contact array * The function can be called with either the user or the contact array
* *
@ -1871,7 +1871,7 @@ class Contact
} }
/** /**
* @brief Blocks a contact * Blocks a contact
* *
* @param int $cid * @param int $cid
* @return bool * @return bool
@ -1885,7 +1885,7 @@ class Contact
} }
/** /**
* @brief Unblocks a contact * Unblocks a contact
* *
* @param int $cid * @param int $cid
* @return bool * @return bool
@ -1899,7 +1899,7 @@ class Contact
} }
/** /**
* @brief Updates the avatar links in a contact only if needed * Updates the avatar links in a contact only if needed
* *
* @param string $avatar Link to avatar picture * @param string $avatar Link to avatar picture
* @param int $uid User id of contact owner * @param int $uid User id of contact owner
@ -1949,8 +1949,8 @@ class Contact
return $data; return $data;
} }
/** /**
* @brief Helper function for "updateFromProbe". Updates personal and public contact * Helper function for "updateFromProbe". Updates personal and public contact
* *
* @param integer $id contact id * @param integer $id contact id
* @param integer $uid user id * @param integer $uid user id
@ -2008,8 +2008,8 @@ class Contact
DBA::update('contact', $fields, $condition); DBA::update('contact', $fields, $condition);
} }
/** /**
* @brief Remove duplicated contacts * Remove duplicated contacts
* *
* @param string $nurl Normalised contact url * @param string $nurl Normalised contact url
* @param integer $uid User id * @param integer $uid User id
@ -2244,7 +2244,7 @@ class Contact
* $return['success'] boolean true if successful * $return['success'] boolean true if successful
* $return['message'] error text if success is false. * $return['message'] error text if success is false.
* *
* @brief Takes a $uid and a url/handle and adds a new contact * Takes a $uid and a url/handle and adds a new contact
* @param int $uid * @param int $uid
* @param string $url * @param string $url
* @param bool $interactive * @param bool $interactive
@ -2474,7 +2474,7 @@ class Contact
} }
/** /**
* @brief Updated contact's SSL policy * Updated contact's SSL policy
* *
* @param array $contact Contact array * @param array $contact Contact array
* @param string $new_policy New policy, valid: self,full * @param string $new_policy New policy, valid: self,full
@ -2677,7 +2677,7 @@ class Contact
} }
/** /**
* @brief Create a birthday event. * Create a birthday event.
* *
* Update the year and the birthday. * Update the year and the birthday.
*/ */
@ -2739,7 +2739,7 @@ class Contact
} }
/** /**
* @brief Returns a magic link to authenticate remote visitors * Returns a magic link to authenticate remote visitors
* *
* @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir
* *
@ -2768,7 +2768,7 @@ class Contact
} }
/** /**
* @brief Returns a magic link to authenticate remote visitors * Returns a magic link to authenticate remote visitors
* *
* @param integer $cid The contact id of the target contact profile * @param integer $cid The contact id of the target contact profile
* @param string $url An url that we will be redirected to after the authentication * @param string $url An url that we will be redirected to after the authentication
@ -2785,7 +2785,7 @@ class Contact
} }
/** /**
* @brief Returns a magic link to authenticate remote visitors * Returns a magic link to authenticate remote visitors
* *
* @param array $contact The contact array with "uid", "network" and "url" * @param array $contact The contact array with "uid", "network" and "url"
* @param string $url An url that we will be redirected to after the authentication * @param string $url An url that we will be redirected to after the authentication

2
src/Model/Conversation.php
View file

@ -31,7 +31,7 @@ class Conversation
} }
/** /**
* @brief Store the conversation data * Store the conversation data
* *
* @param array $arr Item array with conversation data * @param array $arr Item array with conversation data
* @return array Item array with removed conversation data * @return array Item array with removed conversation data

30
src/Model/Event.php
View file

@ -20,7 +20,7 @@ use Friendica\Util\Strings;
use Friendica\Util\XML; use Friendica\Util\XML;
/** /**
* @brief functions for interacting with the event database table * functions for interacting with the event database table
*/ */
class Event class Event
{ {
@ -110,7 +110,7 @@ class Event
} }
/** /**
* @brief Convert an array with event data to bbcode. * Convert an array with event data to bbcode.
* *
* @param array $event Array which contains the event data. * @param array $event Array which contains the event data.
* @return string The event as a bbcode formatted string. * @return string The event as a bbcode formatted string.
@ -147,7 +147,7 @@ class Event
} }
/** /**
* @brief Extract bbcode formatted event data from a string. * Extract bbcode formatted event data from a string.
* *
* @params: string $s The string which should be parsed for event data. * @params: string $s The string which should be parsed for event data.
* @param $text * @param $text
@ -211,7 +211,7 @@ class Event
} }
/** /**
* @brief Delete an event from the event table. * Delete an event from the event table.
* *
* Note: This function does only delete the event from the event table not its * Note: This function does only delete the event from the event table not its
* related entry in the item table. * related entry in the item table.
@ -231,7 +231,7 @@ class Event
} }
/** /**
* @brief Store the event. * Store the event.
* *
* Store the event in the event table and create an event item in the item table. * Store the event in the event table and create an event item in the item table.
* *
@ -370,7 +370,7 @@ class Event
} }
/** /**
* @brief Create an array with translation strings used for events. * Create an array with translation strings used for events.
* *
* @return array Array with translations strings. * @return array Array with translations strings.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -441,7 +441,7 @@ class Event
} }
/** /**
* @brief Removes duplicated birthday events. * Removes duplicated birthday events.
* *
* @param array $dates Array of possibly duplicated events. * @param array $dates Array of possibly duplicated events.
* @return array Cleaned events. * @return array Cleaned events.
@ -463,7 +463,7 @@ class Event
} }
/** /**
* @brief Get an event by its event ID. * Get an event by its event ID.
* *
* @param int $owner_uid The User ID of the owner of the event * @param int $owner_uid The User ID of the owner of the event
* @param int $event_id The ID of the event in the event table * @param int $event_id The ID of the event in the event table
@ -496,7 +496,7 @@ class Event
} }
/** /**
* @brief Get all events in a specific time frame. * Get all events in a specific time frame.
* *
* @param int $owner_uid The User ID of the owner of the events. * @param int $owner_uid The User ID of the owner of the events.
* @param array $event_params An associative array with * @param array $event_params An associative array with
@ -546,7 +546,7 @@ class Event
} }
/** /**
* @brief Convert an array query results in an array which could be used by the events template. * Convert an array query results in an array which could be used by the events template.
* *
* @param array $event_result Event query array. * @param array $event_result Event query array.
* @return array Event array for the template. * @return array Event array for the template.
@ -631,7 +631,7 @@ class Event
} }
/** /**
* @brief Format event to export format (ical/csv). * Format event to export format (ical/csv).
* *
* @param array $events Query result for events. * @param array $events Query result for events.
* @param string $format The output format (ical/csv). * @param string $format The output format (ical/csv).
@ -738,7 +738,7 @@ class Event
} }
/** /**
* @brief Get all events for a user ID. * Get all events for a user ID.
* *
* The query for events is done permission sensitive. * The query for events is done permission sensitive.
* If the user is the owner of the calendar they * If the user is the owner of the calendar they
@ -832,7 +832,7 @@ class Event
} }
/** /**
* @brief Format an item array with event data to HTML. * Format an item array with event data to HTML.
* *
* @param array $item Array with item and event data. * @param array $item Array with item and event data.
* @return string HTML output. * @return string HTML output.
@ -941,7 +941,7 @@ class Event
} }
/** /**
* @brief Format a string with map bbcode to an array with location data. * Format a string with map bbcode to an array with location data.
* *
* Note: The string must only contain location data. A string with no bbcode will be * Note: The string must only contain location data. A string with no bbcode will be
* handled as location name. * handled as location name.
@ -992,7 +992,7 @@ class Event
} }
/** /**
* @brief Add new birthday event for this person * Add new birthday event for this person
* *
* @param array $contact Contact array, expects: id, uid, url, name * @param array $contact Contact array, expects: id, uid, url, name
* @param string $birthday Birthday of the contact * @param string $birthday Birthday of the contact

18
src/Model/FileTag.php
View file

@ -10,7 +10,7 @@ use Friendica\Database\DBA;
use Friendica\DI; use Friendica\DI;
/** /**
* @brief This class handles FileTag related functions * This class handles FileTag related functions
* *
* post categories and "save to file" use the same item.file table for storage. * post categories and "save to file" use the same item.file table for storage.
* We will differentiate the different uses by wrapping categories in angle brackets * We will differentiate the different uses by wrapping categories in angle brackets
@ -20,7 +20,7 @@ use Friendica\DI;
class FileTag class FileTag
{ {
/** /**
* @brief URL encode <, >, left and right brackets * URL encode <, >, left and right brackets
* *
* @param string $s String to be URL encoded. * @param string $s String to be URL encoded.
* *
@ -32,7 +32,7 @@ class FileTag
} }
/** /**
* @brief URL decode <, >, left and right brackets * URL decode <, >, left and right brackets
* *
* @param string $s The URL encoded string to be decoded * @param string $s The URL encoded string to be decoded
* *
@ -44,7 +44,7 @@ class FileTag
} }
/** /**
* @brief Query files for tag * Query files for tag
* *
* @param string $table The table to be queired. * @param string $table The table to be queired.
* @param string $s The search term * @param string $s The search term
@ -124,7 +124,7 @@ class FileTag
} }
/** /**
* @brief Get file tags from list * Get file tags from list
* *
* ex. given music,video return <music><video> or [music][video] * ex. given music,video return <music><video> or [music][video]
* @param string $list A comma delimited list of tags. * @param string $list A comma delimited list of tags.
@ -141,7 +141,7 @@ class FileTag
} }
/** /**
* @brief Get list from file tags * Get list from file tags
* *
* ex. given <music><video>[friends], return music,video or friends * ex. given <music><video>[friends], return music,video or friends
* @param string $file File tags * @param string $file File tags
@ -156,7 +156,7 @@ class FileTag
} }
/** /**
* @brief Update file tags in PConfig * Update file tags in PConfig
* *
* @param int $uid Unique Identity. * @param int $uid Unique Identity.
* @param string $file_old Categories previously associated with an item * @param string $file_old Categories previously associated with an item
@ -234,7 +234,7 @@ class FileTag
} }
/** /**
* @brief Add tag to file * Add tag to file
* *
* @param int $uid Unique identity. * @param int $uid Unique identity.
* @param int $item_id Item identity. * @param int $item_id Item identity.
@ -269,7 +269,7 @@ class FileTag
} }
/** /**
* @brief Remove tag from file * Remove tag from file
* *
* @param int $uid Unique identity. * @param int $uid Unique identity.
* @param int $item_id Item identity. * @param int $item_id Item identity.

32
src/Model/GContact.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file src/Model/GlobalContact.php * @file src/Model/GlobalContact.php
* @brief This file includes the GlobalContact class with directory related functions * This file includes the GlobalContact class with directory related functions
*/ */
namespace Friendica\Model; namespace Friendica\Model;
@ -23,12 +23,12 @@ use Friendica\Util\Network;
use Friendica\Util\Strings; use Friendica\Util\Strings;
/** /**
* @brief This class handles GlobalContact related functions * This class handles GlobalContact related functions
*/ */
class GContact class GContact
{ {
/** /**
* @brief Search global contact table by nick or name * Search global contact table by nick or name
* *
* @param string $search Name or nick * @param string $search Name or nick
* @param string $mode Search mode (e.g. "community") * @param string $mode Search mode (e.g. "community")
@ -88,7 +88,7 @@ class GContact
} }
/** /**
* @brief Link the gcontact entry with user, contact and global contact * Link the gcontact entry with user, contact and global contact
* *
* @param integer $gcid Global contact ID * @param integer $gcid Global contact ID
* @param integer $uid User ID * @param integer $uid User ID
@ -108,7 +108,7 @@ class GContact
} }
/** /**
* @brief Sanitize the given gcontact data * Sanitize the given gcontact data
* *
* Generation: * Generation:
* 0: No definition * 0: No definition
@ -537,7 +537,7 @@ class GContact
} }
/** /**
* @brief Removes unwanted parts from a contact url * Removes unwanted parts from a contact url
* *
* @param string $url Contact url * @param string $url Contact url
* *
@ -570,7 +570,7 @@ class GContact
} }
/** /**
* @brief Fetch the gcontact id, add an entry if not existed * Fetch the gcontact id, add an entry if not existed
* *
* @param array $contact contact array * @param array $contact contact array
* *
@ -635,7 +635,7 @@ class GContact
} }
/** /**
* @brief Updates the gcontact table from a given array * Updates the gcontact table from a given array
* *
* @param array $contact contact array * @param array $contact contact array
* *
@ -947,7 +947,7 @@ class GContact
DBA::update('gcontact', $fields, ['nurl' => Strings::normaliseLink($data['url'])]); DBA::update('gcontact', $fields, ['nurl' => Strings::normaliseLink($data['url'])]);
} }
/** /**
* @brief Updates the gcontact entry from a given public contact id * Updates the gcontact entry from a given public contact id
* *
* @param integer $cid contact id * @param integer $cid contact id
* @return void * @return void
@ -960,7 +960,7 @@ class GContact
} }
/** /**
* @brief Updates the gcontact entry from a given public contact url * Updates the gcontact entry from a given public contact url
* *
* @param string $url contact url * @param string $url contact url
* @return integer gcontact id * @return integer gcontact id
@ -973,7 +973,7 @@ class GContact
} }
/** /**
* @brief Helper function for updateFromPublicContactID and updateFromPublicContactURL * Helper function for updateFromPublicContactID and updateFromPublicContactURL
* *
* @param array $condition contact condition * @param array $condition contact condition
* @return integer gcontact id * @return integer gcontact id
@ -1058,7 +1058,7 @@ class GContact
} }
/** /**
* @brief Updates the gcontact entry from probe * Updates the gcontact entry from probe
* *
* @param string $url profile link * @param string $url profile link
* @param boolean $force Optional forcing of network probing (otherwise we use the cached data) * @param boolean $force Optional forcing of network probing (otherwise we use the cached data)
@ -1090,7 +1090,7 @@ class GContact
} }
/** /**
* @brief Update the gcontact entry for a given user id * Update the gcontact entry for a given user id
* *
* @param int $uid User ID * @param int $uid User ID
* @return bool * @return bool
@ -1130,7 +1130,7 @@ class GContact
} }
/** /**
* @brief Get the basepath for a given contact link * Get the basepath for a given contact link
* *
* @param string $url The gcontact link * @param string $url The gcontact link
* @param boolean $dont_update Don't update the contact * @param boolean $dont_update Don't update the contact
@ -1162,7 +1162,7 @@ class GContact
} }
/** /**
* @brief Fetches users of given GNU Social server * Fetches users of given GNU Social server
* *
* If the "Statistics" addon is enabled (See http://gstools.org/ for details) we query user data with this. * If the "Statistics" addon is enabled (See http://gstools.org/ for details) we query user data with this.
* *
@ -1227,7 +1227,7 @@ class GContact
} }
/** /**
* @brief Asking GNU Social server on a regular base for their user data * Asking GNU Social server on a regular base for their user data
* @return void * @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException * @throws \ImagickException

26
src/Model/Group.php
View file

@ -13,7 +13,7 @@ use Friendica\Core\Renderer;
use Friendica\Database\DBA; use Friendica\Database\DBA;
/** /**
* @brief functions for interacting with the group database table * functions for interacting with the group database table
*/ */
class Group class Group
{ {
@ -50,7 +50,7 @@ class Group
} }
/** /**
* @brief Create a new contact group * Create a new contact group
* *
* Note: If we found a deleted group with the same name, we restore it * Note: If we found a deleted group with the same name, we restore it
* *
@ -101,7 +101,7 @@ class Group
} }
/** /**
* @brief Get a list of group ids a contact belongs to * Get a list of group ids a contact belongs to
* *
* @param int $cid * @param int $cid
* @return array * @return array
@ -121,7 +121,7 @@ class Group
} }
/** /**
* @brief count unread group items * count unread group items
* *
* Count unread items of each groups of the local user * Count unread items of each groups of the local user
* *
@ -152,7 +152,7 @@ class Group
} }
/** /**
* @brief Get the group id for a user/name couple * Get the group id for a user/name couple
* *
* Returns false if no group has been found. * Returns false if no group has been found.
* *
@ -176,7 +176,7 @@ class Group
} }
/** /**
* @brief Mark a group as deleted * Mark a group as deleted
* *
* @param int $gid * @param int $gid
* @return boolean * @return boolean
@ -226,7 +226,7 @@ class Group
} }
/** /**
* @brief Mark a group as deleted based on its name * Mark a group as deleted based on its name
* *
* @param int $uid * @param int $uid
* @param string $name * @param string $name
@ -248,7 +248,7 @@ class Group
} }
/** /**
* @brief Adds a contact to a group * Adds a contact to a group
* *
* @param int $gid * @param int $gid
* @param int $cid * @param int $cid
@ -273,7 +273,7 @@ class Group
} }
/** /**
* @brief Removes a contact from a group * Removes a contact from a group
* *
* @param int $gid * @param int $gid
* @param int $cid * @param int $cid
@ -292,7 +292,7 @@ class Group
} }
/** /**
* @brief Removes a contact from a group based on its name * Removes a contact from a group based on its name
* *
* @param int $uid * @param int $uid
* @param string $name * @param string $name
@ -312,7 +312,7 @@ class Group
} }
/** /**
* @brief Returns the combined list of contact ids from a group id list * Returns the combined list of contact ids from a group id list
* *
* @param int $uid * @param int $uid
* @param array $group_ids * @param array $group_ids
@ -391,7 +391,7 @@ class Group
} }
/** /**
* @brief Returns a templated group selection list * Returns a templated group selection list
* *
* @param int $uid * @param int $uid
* @param int $gid An optional pre-selected group * @param int $gid An optional pre-selected group
@ -433,7 +433,7 @@ class Group
} }
/** /**
* @brief Create group sidebar widget * Create group sidebar widget
* *
* @param string $every * @param string $every
* @param string $each * @param string $each

70
src/Model/Item.php
View file

@ -141,7 +141,7 @@ class Item
} }
/** /**
* @brief Select pinned rows from the item table for a given user * Select pinned rows from the item table for a given user
* *
* @param integer $uid User ID * @param integer $uid User ID
* @param array $selected Array of selected fields, empty for all * @param array $selected Array of selected fields, empty for all
@ -186,7 +186,7 @@ class Item
} }
/** /**
* @brief returns an activity index from an activity string * returns an activity index from an activity string
* *
* @param string $activity activity string * @param string $activity activity string
* @return integer Activity index * @return integer Activity index
@ -203,7 +203,7 @@ class Item
} }
/** /**
* @brief returns an activity string from an activity index * returns an activity string from an activity index
* *
* @param integer $index activity index * @param integer $index activity index
* @return string Activity string * @return string Activity string
@ -218,7 +218,7 @@ class Item
} }
/** /**
* @brief Fetch a single item row * Fetch a single item row
* *
* @param mixed $stmt statement object * @param mixed $stmt statement object
* @return array current row * @return array current row
@ -330,7 +330,7 @@ class Item
} }
/** /**
* @brief Fills an array with data from an item query * Fills an array with data from an item query
* *
* @param object $stmt statement object * @param object $stmt statement object
* @param bool $do_close * @param bool $do_close
@ -352,7 +352,7 @@ class Item
} }
/** /**
* @brief Check if item data exists * Check if item data exists
* *
* @param array $condition array of fields for condition * @param array $condition array of fields for condition
* *
@ -376,7 +376,6 @@ class Item
/** /**
* Retrieve a single record from the item table for a given user and returns it in an associative array * Retrieve a single record from the item table for a given user and returns it in an associative array
* *
* @brief Retrieve a single record from a table
* @param integer $uid User ID * @param integer $uid User ID
* @param array $selected * @param array $selected
* @param array $condition * @param array $condition
@ -397,7 +396,7 @@ class Item
} }
/** /**
* @brief Select rows from the item table for a given user * Select rows from the item table for a given user
* *
* @param integer $uid User ID * @param integer $uid User ID
* @param array $selected Array of selected fields, empty for all * @param array $selected Array of selected fields, empty for all
@ -421,7 +420,6 @@ class Item
/** /**
* Retrieve a single record from the item table and returns it in an associative array * Retrieve a single record from the item table and returns it in an associative array
* *
* @brief Retrieve a single record from a table
* @param array $fields * @param array $fields
* @param array $condition * @param array $condition
* @param array $params * @param array $params
@ -445,7 +443,7 @@ class Item
} }
/** /**
* @brief Select rows from the item table and returns them as an array * Select rows from the item table and returns them as an array
* *
* @param array $selected Array of selected fields, empty for all * @param array $selected Array of selected fields, empty for all
* @param array $condition Array of fields for condition * @param array $condition Array of fields for condition
@ -472,7 +470,7 @@ class Item
} }
/** /**
* @brief Select rows from the item table * Select rows from the item table
* *
* @param array $selected Array of selected fields, empty for all * @param array $selected Array of selected fields, empty for all
* @param array $condition Array of fields for condition * @param array $condition Array of fields for condition
@ -513,7 +511,7 @@ class Item
} }
/** /**
* @brief Select rows from the starting post in the item table * Select rows from the starting post in the item table
* *
* @param integer $uid User ID * @param integer $uid User ID
* @param array $selected * @param array $selected
@ -537,7 +535,6 @@ class Item
/** /**
* Retrieve a single record from the starting post in the item table and returns it in an associative array * Retrieve a single record from the starting post in the item table and returns it in an associative array
* *
* @brief Retrieve a single record from a table
* @param integer $uid User ID * @param integer $uid User ID
* @param array $selected * @param array $selected
* @param array $condition * @param array $condition
@ -560,7 +557,6 @@ class Item
/** /**
* Retrieve a single record from the starting post in the item table and returns it in an associative array * Retrieve a single record from the starting post in the item table and returns it in an associative array
* *
* @brief Retrieve a single record from a table
* @param array $fields * @param array $fields
* @param array $condition * @param array $condition
* @param array $params * @param array $params
@ -583,7 +579,7 @@ class Item
} }
/** /**
* @brief Select rows from the starting post in the item table * Select rows from the starting post in the item table
* *
* @param array $selected Array of selected fields, empty for all * @param array $selected Array of selected fields, empty for all
* @param array $condition Array of fields for condition * @param array $condition Array of fields for condition
@ -634,7 +630,7 @@ class Item
} }
/** /**
* @brief Returns a list of fields that are associated with the item table * Returns a list of fields that are associated with the item table
* *
* @param $usermode * @param $usermode
* @return array field list * @return array field list
@ -694,7 +690,7 @@ class Item
} }
/** /**
* @brief Returns SQL condition for the "select" functions * Returns SQL condition for the "select" functions
* *
* @param boolean $thread_mode Called for the items (false) or for the threads (true) * @param boolean $thread_mode Called for the items (false) or for the threads (true)
* *
@ -717,7 +713,7 @@ class Item
} }
/** /**
* @brief Returns all needed "JOIN" commands for the "select" functions * Returns all needed "JOIN" commands for the "select" functions
* *
* @param integer $uid User ID * @param integer $uid User ID
* @param string $sql_commands The parts of the built SQL commands in the "select" functions * @param string $sql_commands The parts of the built SQL commands in the "select" functions
@ -809,7 +805,7 @@ class Item
} }
/** /**
* @brief Add the field list for the "select" functions * Add the field list for the "select" functions
* *
* @param array $fields The field definition array * @param array $fields The field definition array
* @param array $selected The array with the selected fields from the "select" functions * @param array $selected The array with the selected fields from the "select" functions
@ -858,7 +854,7 @@ class Item
} }
/** /**
* @brief add table definition to fields in an SQL query * add table definition to fields in an SQL query
* *
* @param string $query SQL query * @param string $query SQL query
* @param array $fields The field definition array * @param array $fields The field definition array
@ -884,7 +880,7 @@ class Item
} }
/** /**
* @brief Update existing item entries * Update existing item entries
* *
* @param array $fields The fields that are to be changed * @param array $fields The fields that are to be changed
* @param array $condition The condition for finding the item entries * @param array $condition The condition for finding the item entries
@ -1047,7 +1043,7 @@ class Item
} }
/** /**
* @brief Delete an item and notify others about it - if it was ours * Delete an item and notify others about it - if it was ours
* *
* @param array $condition The condition for finding the item entries * @param array $condition The condition for finding the item entries
* @param integer $priority Priority for the notification * @param integer $priority Priority for the notification
@ -1063,7 +1059,7 @@ class Item
} }
/** /**
* @brief Delete an item for an user and notify others about it - if it was ours * Delete an item for an user and notify others about it - if it was ours
* *
* @param array $condition The condition for finding the item entries * @param array $condition The condition for finding the item entries
* @param integer $uid User who wants to delete this item * @param integer $uid User who wants to delete this item
@ -1093,7 +1089,7 @@ class Item
} }
/** /**
* @brief Delete an item and notify others about it - if it was ours * Delete an item and notify others about it - if it was ours
* *
* @param integer $item_id Item ID that should be delete * @param integer $item_id Item ID that should be delete
* @param integer $priority Priority for the notification * @param integer $priority Priority for the notification
@ -2036,7 +2032,7 @@ class Item
} }
/** /**
* @brief Insert a new item content entry * Insert a new item content entry
* *
* @param array $item The item fields that are to be inserted * @param array $item The item fields that are to be inserted
* @return bool * @return bool
@ -2084,7 +2080,7 @@ class Item
} }
/** /**
* @brief Insert a new item content entry * Insert a new item content entry
* *
* @param array $item The item fields that are to be inserted * @param array $item The item fields that are to be inserted
* @throws \Exception * @throws \Exception
@ -2124,7 +2120,7 @@ class Item
} }
/** /**
* @brief Update existing item content entries * Update existing item content entries
* *
* @param array $item The item fields that are to be changed * @param array $item The item fields that are to be changed
* @param array $condition The condition for finding the item content entries * @param array $condition The condition for finding the item content entries
@ -2152,7 +2148,7 @@ class Item
} }
/** /**
* @brief Update existing item content entries * Update existing item content entries
* *
* @param array $item The item fields that are to be changed * @param array $item The item fields that are to be changed
* @param array $condition The condition for finding the item content entries * @param array $condition The condition for finding the item content entries
@ -2180,7 +2176,7 @@ class Item
} }
/** /**
* @brief Distributes public items to the receivers * Distributes public items to the receivers
* *
* @param integer $itemid Item ID that should be added * @param integer $itemid Item ID that should be added
* @param string $signed_text Original text (for Diaspora signatures), JSON encoded. * @param string $signed_text Original text (for Diaspora signatures), JSON encoded.
@ -2276,7 +2272,7 @@ class Item
} }
/** /**
* @brief Store public items for the receivers * Store public items for the receivers
* *
* @param integer $itemid Item ID that should be added * @param integer $itemid Item ID that should be added
* @param array $item The item entry that will be stored * @param array $item The item entry that will be stored
@ -2322,7 +2318,7 @@ class Item
} }
/** /**
* @brief Add a shadow entry for a given item id that is a thread starter * Add a shadow entry for a given item id that is a thread starter
* *
* We store every public item entry additionally with the user id "0". * We store every public item entry additionally with the user id "0".
* This is used for the community page and for the search. * This is used for the community page and for the search.
@ -2386,7 +2382,7 @@ class Item
} }
/** /**
* @brief Add a shadow entry for a given item id that is a comment * Add a shadow entry for a given item id that is a comment
* *
* This function does the same like the function above - but for comments * This function does the same like the function above - but for comments
* *
@ -2469,7 +2465,7 @@ class Item
} }
/** /**
* @brief Creates an unique guid out of a given uri * Creates an unique guid out of a given uri
* *
* @param string $uri uri of an item entry * @param string $uri uri of an item entry
* @param string $host hostname for the GUID prefix * @param string $host hostname for the GUID prefix
@ -2515,7 +2511,7 @@ class Item
} }
/** /**
* @brief Set "success_update" and "last-item" to the date of the last time we heard from this contact * Set "success_update" and "last-item" to the date of the last time we heard from this contact
* *
* This can be used to filter for inactive contacts. * This can be used to filter for inactive contacts.
* Only do this for public postings to avoid privacy problems, since poco data is public. * Only do this for public postings to avoid privacy problems, since poco data is public.
@ -3096,7 +3092,7 @@ class Item
} }
/** /**
* @brief add/remove activity to an item * add/remove activity to an item
* *
* Toggle activities as like,dislike,attend of an item * Toggle activities as like,dislike,attend of an item
* *
@ -3463,7 +3459,7 @@ class Item
} }
/** /**
* @brief Find any non-embedded images in private items and add redir links to them * Find any non-embedded images in private items and add redir links to them
* *
* @param array &$item The field array of an item row * @param array &$item The field array of an item row
*/ */
@ -3488,7 +3484,7 @@ class Item
} }
/** /**
* @brief Given an item array, convert the body element from bbcode to html and add smilie icons. * Given an item array, convert the body element from bbcode to html and add smilie icons.
* If attach is true, also add icons for item attachments. * If attach is true, also add icons for item attachments.
* *
* @param array $item * @param array $item

2
src/Model/ItemContent.php
View file

@ -13,7 +13,7 @@ use Friendica\DI;
class ItemContent class ItemContent
{ {
/** /**
* @brief Convert a message into plaintext for connectors to other networks * Convert a message into plaintext for connectors to other networks
* *
* @param array $item The message array that is about to be posted * @param array $item The message array that is about to be posted
* @param int $limit The maximum number of characters when posting to that network * @param int $limit The maximum number of characters when posting to that network

4
src/Model/ItemURI.php
View file

@ -11,7 +11,7 @@ use Friendica\Database\DBA;
class ItemURI class ItemURI
{ {
/** /**
* @brief Insert an item-uri record and return its id * Insert an item-uri record and return its id
* *
* @param array $fields Item-uri fields * @param array $fields Item-uri fields
* *
@ -38,7 +38,7 @@ class ItemURI
} }
/** /**
* @brief Searched for an id of a given uri. Adds it, if not existing yet. * Searched for an id of a given uri. Adds it, if not existing yet.
* *
* @param string $uri * @param string $uri
* *

16
src/Model/Notify.php
View file

@ -22,7 +22,7 @@ use Psr\Log\LoggerInterface;
use Friendica\Network\HTTPException; use Friendica\Network\HTTPException;
/** /**
* @brief Methods for read and write notifications from/to database * Methods for read and write notifications from/to database
* or for formatting notifications * or for formatting notifications
*/ */
final class Notify final class Notify
@ -164,7 +164,7 @@ final class Notify
} }
/** /**
* @brief set seen state of $note of local_user() * set seen state of $note of local_user()
* *
* @param array $note note array * @param array $note note array
* @param bool $seen optional true or false, default true * @param bool $seen optional true or false, default true
@ -197,7 +197,7 @@ final class Notify
} }
/** /**
* @brief List of pages for the Notifications TabBar * List of pages for the Notifications TabBar
* *
* @return array with with notifications TabBar data * @return array with with notifications TabBar data
* @throws Exception * @throws Exception
@ -544,7 +544,7 @@ final class Notify
} }
/** /**
* @brief Get home notifications * Get home notifications
* *
* @param bool $seen False => only include notifications into the query * @param bool $seen False => only include notifications into the query
* which aren't marked as "seen" * which aren't marked as "seen"
@ -587,7 +587,7 @@ final class Notify
} }
/** /**
* @brief Get introductions * Get introductions
* *
* @param bool $all If false only include introductions into the query * @param bool $all If false only include introductions into the query
* which aren't marked as ignored * which aren't marked as ignored
@ -650,7 +650,7 @@ final class Notify
} }
/** /**
* @brief Format the notification query in an usable array * Format the notification query in an usable array
* *
* @param array $intros The array from the db query * @param array $intros The array from the db query
* *
@ -738,8 +738,8 @@ final class Notify
} }
/** /**
* @brief Check for missing contact data and try to fetch the data from * Check for missing contact data and try to fetch the data from
* from other sources * from other sources
* *
* @param array $intro The input array with the intro data * @param array $intro The input array with the intro data
* *

4
src/Model/PermissionSet.php
View file

@ -7,7 +7,7 @@ namespace Friendica\Model;
use Friendica\Database\DBA; use Friendica\Database\DBA;
/** /**
* @brief functions for interacting with the permission set of an object (item, photo, event, ...) * functions for interacting with the permission set of an object (item, photo, event, ...)
*/ */
class PermissionSet class PermissionSet
{ {
@ -62,7 +62,7 @@ class PermissionSet
} }
/** /**
* @brief Returns a permission set for a given contact * Returns a permission set for a given contact
* *
* @param integer $uid User id whom the items belong * @param integer $uid User id whom the items belong
* @param integer $contact_id Contact id of the visitor * @param integer $contact_id Contact id of the visitor

28
src/Model/Photo.php
View file

@ -2,7 +2,7 @@
/** /**
* @file src/Model/Photo.php * @file src/Model/Photo.php
* @brief This file contains the Photo class for database interface * This file contains the Photo class for database interface
*/ */
namespace Friendica\Model; namespace Friendica\Model;
@ -30,7 +30,7 @@ require_once "include/dba.php";
class Photo class Photo
{ {
/** /**
* @brief Select rows from the photo table and returns them as array * Select rows from the photo table and returns them as array
* *
* @param array $fields Array of selected fields, empty for all * @param array $fields Array of selected fields, empty for all
* @param array $conditions Array of fields for conditions * @param array $conditions Array of fields for conditions
@ -51,7 +51,7 @@ class Photo
} }
/** /**
* @brief Retrieve a single record from the photo table * Retrieve a single record from the photo table
* *
* @param array $fields Array of selected fields, empty for all * @param array $fields Array of selected fields, empty for all
* @param array $conditions Array of fields for conditions * @param array $conditions Array of fields for conditions
@ -72,7 +72,7 @@ class Photo
} }
/** /**
* @brief Get photos for user id * Get photos for user id
* *
* @param integer $uid User id * @param integer $uid User id
* @param string $resourceid Rescource ID of the photo * @param string $resourceid Rescource ID of the photo
@ -93,7 +93,7 @@ class Photo
} }
/** /**
* @brief Get a photo for user id * Get a photo for user id
* *
* @param integer $uid User id * @param integer $uid User id
* @param string $resourceid Rescource ID of the photo * @param string $resourceid Rescource ID of the photo
@ -116,7 +116,7 @@ class Photo
} }
/** /**
* @brief Get a single photo given resource id and scale * Get a single photo given resource id and scale
* *
* This method checks for permissions. Returns associative array * This method checks for permissions. Returns associative array
* on success, "no sign" image info, if user has no permission, * on success, "no sign" image info, if user has no permission,
@ -147,7 +147,7 @@ class Photo
} }
/** /**
* @brief Check if photo with given conditions exists * Check if photo with given conditions exists
* *
* @param array $conditions Array of extra conditions * @param array $conditions Array of extra conditions
* *
@ -161,7 +161,7 @@ class Photo
/** /**
* @brief Get Image object for given row id. null if row id does not exist * Get Image object for given row id. null if row id does not exist
* *
* @param array $photo Photo data. Needs at least 'id', 'type', 'backend-class', 'backend-ref' * @param array $photo Photo data. Needs at least 'id', 'type', 'backend-class', 'backend-ref'
* *
@ -192,7 +192,7 @@ class Photo
} }
/** /**
* @brief Return a list of fields that are associated with the photo table * Return a list of fields that are associated with the photo table
* *
* @return array field list * @return array field list
* @throws \Exception * @throws \Exception
@ -206,7 +206,7 @@ class Photo
} }
/** /**
* @brief Construct a photo array for a system resource image * Construct a photo array for a system resource image
* *
* @param string $filename Image file name relative to code root * @param string $filename Image file name relative to code root
* @param string $mimetype Image mime type. Defaults to "image/jpeg" * @param string $mimetype Image mime type. Defaults to "image/jpeg"
@ -230,7 +230,7 @@ class Photo
/** /**
* @brief store photo metadata in db and binary in default backend * store photo metadata in db and binary in default backend
* *
* @param Image $Image Image object with data * @param Image $Image Image object with data
* @param integer $uid User ID * @param integer $uid User ID
@ -320,7 +320,7 @@ class Photo
/** /**
* @brief Delete info from table and data from storage * Delete info from table and data from storage
* *
* @param array $conditions Field condition(s) * @param array $conditions Field condition(s)
* @param array $options Options array, Optional * @param array $options Options array, Optional
@ -346,7 +346,7 @@ class Photo
} }
/** /**
* @brief Update a photo * Update a photo
* *
* @param array $fields Contains the fields that are updated * @param array $fields Contains the fields that are updated
* @param array $conditions Condition array with the key values * @param array $conditions Condition array with the key values
@ -525,7 +525,7 @@ class Photo
} }
/** /**
* @brief Fetch the photo albums that are available for a viewer * Fetch the photo albums that are available for a viewer
* *
* The query in this function is cost intensive, so it is cached. * The query in this function is cost intensive, so it is cached.
* *

2
src/Model/Process.php
View file

@ -8,7 +8,7 @@ use Friendica\Database\DBA;
use Friendica\Util\DateTimeFormat; use Friendica\Util\DateTimeFormat;
/** /**
* @brief functions for interacting with a process * functions for interacting with a process
*/ */
class Process class Process
{ {

13
src/Model/Profile.php
View file

@ -32,7 +32,7 @@ use Friendica\Util\Temporal;
class Profile class Profile
{ {
/** /**
* @brief Returns default profile for a given user id * Returns default profile for a given user id
* *
* @param integer User ID * @param integer User ID
* *
@ -46,7 +46,7 @@ class Profile
} }
/** /**
* @brief Returns default profile for a given user ID and ID * Returns default profile for a given user ID and ID
* *
* @param int $uid The contact ID * @param int $uid The contact ID
* @param int $id The contact owner ID * @param int $id The contact owner ID
@ -61,7 +61,7 @@ class Profile
} }
/** /**
* @brief Returns profile data for the contact owner * Returns profile data for the contact owner
* *
* @param int $uid The User ID * @param int $uid The User ID
* @param array $fields The fields to retrieve * @param array $fields The fields to retrieve
@ -75,7 +75,7 @@ class Profile
} }
/** /**
* @brief Returns a formatted location string from the given profile array * Returns a formatted location string from the given profile array
* *
* @param array $profile Profile array (Generated from the "profile" table) * @param array $profile Profile array (Generated from the "profile" table)
* *
@ -109,7 +109,6 @@ class Profile
} }
/** /**
*
* Loads a profile into the page sidebar. * Loads a profile into the page sidebar.
* *
* The function requires a writeable copy of the main App structure, and the nickname * The function requires a writeable copy of the main App structure, and the nickname
@ -127,7 +126,6 @@ class Profile
* the theme is chosen before the _init() function of a theme is run, which will usually * the theme is chosen before the _init() function of a theme is run, which will usually
* load a lot of theme-specific content * load a lot of theme-specific content
* *
* @brief Loads a profile into the page sidebar.
* @param App $a * @param App $a
* @param string $nickname string * @param string $nickname string
* @param int $profile int * @param int $profile int
@ -238,7 +236,6 @@ class Profile
* *
* Includes all available profile data * Includes all available profile data
* *
* @brief Get all profile data of a local user
* @param string $nickname nick * @param string $nickname nick
* @param int $uid uid * @param int $uid uid
* @param int $profile_id ID of the profile * @param int $profile_id ID of the profile
@ -293,7 +290,6 @@ class Profile
* It is very difficult to templatise the HTML completely * It is very difficult to templatise the HTML completely
* because of all the conditional logic. * because of all the conditional logic.
* *
* @brief Formats a profile for display in the sidebar.
* @param array $profile * @param array $profile
* @param int $block * @param int $block
* @param boolean $show_connect Show connect link * @param boolean $show_connect Show connect link
@ -1208,7 +1204,6 @@ class Profile
* system pconfig, which means they don't want to see anybody else's theme * system pconfig, which means they don't want to see anybody else's theme
* settings except their own while on this site. * settings except their own while on this site.
* *
* @brief Get the user ID of the page owner
* @return int user ID * @return int user ID
* *
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException

10
src/Model/PushSubscriber.php
View file

@ -12,7 +12,7 @@ use Friendica\Util\DateTimeFormat;
class PushSubscriber class PushSubscriber
{ {
/** /**
* @brief Send subscription notifications for the given user * Send subscription notifications for the given user
* *
* @param integer $uid User ID * @param integer $uid User ID
* @param int $default_priority * @param int $default_priority
@ -27,7 +27,7 @@ class PushSubscriber
} }
/** /**
* @brief start workers to transmit the feed data * start workers to transmit the feed data
* *
* @param int $default_priority * @param int $default_priority
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -54,7 +54,7 @@ class PushSubscriber
} }
/** /**
* @brief Renew the feed subscription * Renew the feed subscription
* *
* @param integer $uid User ID * @param integer $uid User ID
* @param string $nick Priority for push workers * @param string $nick Priority for push workers
@ -98,7 +98,7 @@ class PushSubscriber
} }
/** /**
* @brief Delay the push subscriber * Delay the push subscriber
* *
* @param integer $id Subscriber ID * @param integer $id Subscriber ID
* @throws \Exception * @throws \Exception
@ -136,7 +136,7 @@ class PushSubscriber
} }
/** /**
* @brief Reset the push subscriber * Reset the push subscriber
* *
* @param integer $id Subscriber ID * @param integer $id Subscriber ID
* @param string $last_update Date of last transmitted item * @param string $last_update Date of last transmitted item

4
src/Model/Storage/Database.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file src/Model/Storage/Filesystem.php * @file src/Model/Storage/Filesystem.php
* @brief Storage backend system * Storage backend system
*/ */
namespace Friendica\Model\Storage; namespace Friendica\Model\Storage;
@ -11,7 +11,7 @@ use Psr\Log\LoggerInterface;
use Friendica\Database\Database as DBA; use Friendica\Database\Database as DBA;
/** /**
* @brief Database based storage system * Database based storage system
* *
* This class manage data stored in database table. * This class manage data stored in database table.
*/ */

8
src/Model/Storage/Filesystem.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file src/Model/Storage/Filesystem.php * @file src/Model/Storage/Filesystem.php
* @brief Storage backend system * Storage backend system
*/ */
namespace Friendica\Model\Storage; namespace Friendica\Model\Storage;
@ -12,7 +12,7 @@ use Friendica\Util\Strings;
use Psr\Log\LoggerInterface; use Psr\Log\LoggerInterface;
/** /**
* @brief Filesystem based storage backend * Filesystem based storage backend
* *
* This class manage data on filesystem. * This class manage data on filesystem.
* Base folder for storage is set in storage.filesystem_path. * Base folder for storage is set in storage.filesystem_path.
@ -52,7 +52,7 @@ class Filesystem extends AbstractStorage
} }
/** /**
* @brief Split data ref and return file path * Split data ref and return file path
* *
* @param string $reference Data reference * @param string $reference Data reference
* *
@ -69,7 +69,7 @@ class Filesystem extends AbstractStorage
/** /**
* @brief Create dirctory tree to store file, with .htaccess and index.html files * Create dirctory tree to store file, with .htaccess and index.html files
* *
* @param string $file Path and filename * @param string $file Path and filename
* *

14
src/Model/Storage/IStorage.php
View file

@ -1,18 +1,18 @@
<?php <?php
/** /**
* @file src/Model/Storage/IStorage.php * @file src/Model/Storage/IStorage.php
* @brief Storage backend system * Storage backend system
*/ */
namespace Friendica\Model\Storage; namespace Friendica\Model\Storage;
/** /**
* @brief Interface for storage backends * Interface for storage backends
*/ */
interface IStorage interface IStorage
{ {
/** /**
* @brief Get data from backend * Get data from backend
* *
* @param string $reference Data reference * @param string $reference Data reference
* *
@ -21,7 +21,7 @@ interface IStorage
public function get(string $reference); public function get(string $reference);
/** /**
* @brief Put data in backend as $ref. If $ref is not defined a new reference is created. * Put data in backend as $ref. If $ref is not defined a new reference is created.
* *
* @param string $data Data to save * @param string $data Data to save
* @param string $reference Data reference. Optional. * @param string $reference Data reference. Optional.
@ -31,7 +31,7 @@ interface IStorage
public function put(string $data, string $reference = ""); public function put(string $data, string $reference = "");
/** /**
* @brief Remove data from backend * Remove data from backend
* *
* @param string $reference Data reference * @param string $reference Data reference
* *
@ -40,7 +40,7 @@ interface IStorage
public function delete(string $reference); public function delete(string $reference);
/** /**
* @brief Get info about storage options * Get info about storage options
* *
* @return array * @return array
* *
@ -80,7 +80,7 @@ interface IStorage
public function getOptions(); public function getOptions();
/** /**
* @brief Validate and save options * Validate and save options
* *
* @param array $data Array [optionname => value] to be saved * @param array $data Array [optionname => value] to be saved
* *

4
src/Model/Storage/StorageException.php
View file

@ -1,13 +1,13 @@
<?php <?php
/** /**
* @file src/Model/Storage/StorageException.php * @file src/Model/Storage/StorageException.php
* @brief Storage backend system * Storage backend system
*/ */
namespace Friendica\Model\Storage; namespace Friendica\Model\Storage;
/** /**
* @brief Storage Exception * Storage Exception
*/ */
class StorageException extends \Exception class StorageException extends \Exception
{ {

4
src/Model/Storage/SystemResource.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file src/Model/Storage/SystemStorage.php * @file src/Model/Storage/SystemStorage.php
* @brief Storage backend system * Storage backend system
*/ */
namespace Friendica\Model\Storage; namespace Friendica\Model\Storage;
@ -9,7 +9,7 @@ namespace Friendica\Model\Storage;
use \BadMethodCallException; use \BadMethodCallException;
/** /**
* @brief System resource storage class * System resource storage class
* *
* This class is used to load system resources, like images. * This class is used to load system resources, like images.
* Is not intended to be selectable by admins as default storage class. * Is not intended to be selectable by admins as default storage class.

24
src/Model/User.php
View file

@ -2,7 +2,7 @@
/** /**
* @file src/Model/User.php * @file src/Model/User.php
* @brief This file includes the User class with user related database functions * This file includes the User class with user related database functions
*/ */
namespace Friendica\Model; namespace Friendica\Model;
@ -29,7 +29,7 @@ use Friendica\Worker\Delivery;
use LightOpenID; use LightOpenID;
/** /**
* @brief This class handles User related functions * This class handles User related functions
*/ */
class User class User
{ {
@ -138,7 +138,7 @@ class User
} }
/** /**
* @brief Returns the user id of a given profile URL * Returns the user id of a given profile URL
* *
* @param string $url * @param string $url
* *
@ -171,7 +171,7 @@ class User
} }
/** /**
* @brief Get owner data by user id * Get owner data by user id
* *
* @param int $uid * @param int $uid
* @param boolean $check_valid Test if data is invalid and correct it * @param boolean $check_valid Test if data is invalid and correct it
@ -243,7 +243,7 @@ class User
} }
/** /**
* @brief Get owner data by nick name * Get owner data by nick name
* *
* @param int $nick * @param int $nick
* @return boolean|array * @return boolean|array
@ -261,7 +261,7 @@ class User
} }
/** /**
* @brief Returns the default group for a given user and network * Returns the default group for a given user and network
* *
* @param int $uid User id * @param int $uid User id
* @param string $network network name * @param string $network network name
@ -294,7 +294,6 @@ class User
/** /**
* Authenticate a user with a clear text password * Authenticate a user with a clear text password
* *
* @brief Authenticate a user with a clear text password
* @param mixed $user_info * @param mixed $user_info
* @param string $password * @param string $password
* @param bool $third_party * @param bool $third_party
@ -312,9 +311,10 @@ class User
} }
/** /**
* Authenticate a user with a clear text password
*
* Returns the user id associated with a successful password authentication * Returns the user id associated with a successful password authentication
* *
* @brief Authenticate a user with a clear text password
* @param mixed $user_info * @param mixed $user_info
* @param string $password * @param string $password
* @param bool $third_party * @param bool $third_party
@ -536,7 +536,7 @@ class User
} }
/** /**
* @brief Checks if a nickname is in the list of the forbidden nicknames * Checks if a nickname is in the list of the forbidden nicknames
* *
* Check if a nickname is forbidden from registration on the node by the * Check if a nickname is forbidden from registration on the node by the
* admin. Forbidden nicknames (e.g. role namess) can be configured in the * admin. Forbidden nicknames (e.g. role namess) can be configured in the
@ -567,7 +567,7 @@ class User
} }
/** /**
* @brief Catch-all user creation function * Catch-all user creation function
* *
* Creates a user from the provided data array, either form fields or OpenID. * Creates a user from the provided data array, either form fields or OpenID.
* Required: { username, nickname, email } or { openid_url } * Required: { username, nickname, email } or { openid_url }
@ -872,7 +872,7 @@ class User
} }
/** /**
* @brief Sends pending registration confirmation email * Sends pending registration confirmation email
* *
* @param array $user User record array * @param array $user User record array
* @param string $sitename * @param string $sitename
@ -911,7 +911,7 @@ class User
} }
/** /**
* @brief Sends registration confirmation * Sends registration confirmation
* *
* It's here as a function because the mail is sent from different parts * It's here as a function because the mail is sent from different parts
* *

2
src/Module/Admin/Queue.php
View file

@ -11,7 +11,7 @@ use Friendica\Util\Arrays;
use Friendica\Util\DateTimeFormat; use Friendica\Util\DateTimeFormat;
/** /**
* @brief Admin Inspect Queue Page * Admin Inspect Queue Page
* *
* Generates a page for the admin to have a look into the current queue of * Generates a page for the admin to have a look into the current queue of
* worker jobs. Shown are the parameters for the job and its priority. * worker jobs. Shown are the parameters for the job and its priority.

4
src/Module/Attach.php
View file

@ -14,12 +14,12 @@ use Friendica\DI;
use Friendica\Model\Attach as MAttach; use Friendica\Model\Attach as MAttach;
/** /**
* @brief Attach Module * Attach Module
*/ */
class Attach extends BaseModule class Attach extends BaseModule
{ {
/** /**
* @brief Return to user an attached file given the id * Return to user an attached file given the id
*/ */
public static function rawContent(array $parameters = []) public static function rawContent(array $parameters = [])
{ {

5
src/Module/Base/Api.php
View file

@ -51,9 +51,8 @@ class Api extends BaseModule
/** /**
* Log in user via OAuth1 or Simple HTTP Auth. * 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 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
* *
* @return bool Was a user authenticated? * @return bool Was a user authenticated?
* @throws HTTPException\ForbiddenException * @throws HTTPException\ForbiddenException
@ -76,7 +75,7 @@ class Api extends BaseModule
} }
/** /**
* @brief Get user info array. * Get user info array.
* *
* @param int|string $contact_id Contact ID or URL * @param int|string $contact_id Contact ID or URL
* @return array|bool * @return array|bool

6
src/Module/Contact.php
View file

@ -27,8 +27,6 @@ use Friendica\Util\Strings;
/** /**
* Manages and show Contacts and their content * Manages and show Contacts and their content
*
* @brief manages contacts
*/ */
class Contact extends BaseModule class Contact extends BaseModule
{ {
@ -837,7 +835,7 @@ class Contact extends BaseModule
} }
/** /**
* @brief List of pages for the Contact TabBar * List of pages for the Contact TabBar
* *
* Available Pages are 'Status', 'Profile', 'Contacts' and 'Common Friends' * Available Pages are 'Status', 'Profile', 'Contacts' and 'Common Friends'
* *
@ -1049,7 +1047,7 @@ class Contact extends BaseModule
} }
/** /**
* @brief Gives a array with actions which can performed to a given contact * Gives a array with actions which can performed to a given contact
* *
* This includes actions like e.g. 'block', 'hide', 'archive', 'delete' and others * This includes actions like e.g. 'block', 'hide', 'archive', 'delete' and others
* *

2
src/Module/Feed.php
View file

@ -18,8 +18,6 @@ use Friendica\Protocol\OStatus;
* *
* The nocache GET parameter is provided mainly for debug purposes, requires auth * The nocache GET parameter is provided mainly for debug purposes, requires auth
* *
* @brief Provides public Atom feeds
*
* @author Hypolite Petovan <hypolite@mrpetovan.com> * @author Hypolite Petovan <hypolite@mrpetovan.com>
*/ */
class Feed extends BaseModule class Feed extends BaseModule

2
src/Module/Owa.php
View file

@ -14,7 +14,7 @@ use Friendica\Util\HTTPSignature;
use Friendica\Util\Strings; use Friendica\Util\Strings;
/** /**
* @brief OpenWebAuth verifier and token generator * OpenWebAuth verifier and token generator
* *
* See https://macgirvin.com/wiki/mike/OpenWebAuth/Home * See https://macgirvin.com/wiki/mike/OpenWebAuth/Home
* Requests to this endpoint should be signed using HTTP Signatures * Requests to this endpoint should be signed using HTTP Signatures

4
src/Module/Photo.php
View file

@ -14,12 +14,12 @@ use Friendica\Model\Photo as MPhoto;
use Friendica\Object\Image; use Friendica\Object\Image;
/** /**
* @brief Photo Module * Photo Module
*/ */
class Photo extends BaseModule class Photo extends BaseModule
{ {
/** /**
* @brief Module initializer * Module initializer
* *
* Fetch a photo or an avatar, in optional size, check for permissions and * Fetch a photo or an avatar, in optional size, check for permissions and
* return the image * return the image

16
src/Module/Proxy.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file src/Module/Proxy.php * @file src/Module/Proxy.php
* @brief Based upon "Privacy Image Cache" by Tobias Hößl <https://github.com/CatoTH/> * Based upon "Privacy Image Cache" by Tobias Hößl <https://github.com/CatoTH/>
*/ */
namespace Friendica\Module; namespace Friendica\Module;
@ -16,7 +16,7 @@ use Friendica\Util\HTTPSignature;
use Friendica\Util\Proxy as ProxyUtils; use Friendica\Util\Proxy as ProxyUtils;
/** /**
* @brief Module Proxy * Module Proxy
* *
* urls: * urls:
* /proxy/[sub1/[sub2/]]<base64url image url>[.ext][:size] * /proxy/[sub1/[sub2/]]<base64url image url>[.ext][:size]
@ -26,7 +26,7 @@ class Proxy extends BaseModule
{ {
/** /**
* @brief Initializer method for this class. * Initializer method for this class.
* *
* Sets application instance and checks if /proxy/ path is writable. * Sets application instance and checks if /proxy/ path is writable.
* *
@ -144,7 +144,7 @@ class Proxy extends BaseModule
/** /**
* @brief Build info about requested image to be proxied * Build info about requested image to be proxied
* *
* @return array * @return array
* [ * [
@ -224,7 +224,7 @@ class Proxy extends BaseModule
/** /**
* @brief setup ./proxy folder for direct cache * setup ./proxy folder for direct cache
* *
* @return bool False if direct cache can't be used. * @return bool False if direct cache can't be used.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -249,7 +249,7 @@ class Proxy extends BaseModule
/** /**
* @brief Try to reply with image in cachefile * Try to reply with image in cachefile
* *
* @param array $request Array from getRequestInfo * @param array $request Array from getRequestInfo
* *
@ -271,7 +271,7 @@ class Proxy extends BaseModule
} }
/** /**
* @brief Try to reply with image in database * Try to reply with image in database
* *
* @param array $request Array from getRequestInfo * @param array $request Array from getRequestInfo
* *
@ -301,7 +301,7 @@ class Proxy extends BaseModule
} }
/** /**
* @brief Output the image with cache headers * Output the image with cache headers
* *
* @param Image $img * @param Image $img
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException

Some files were not shown because too many files have changed in this diff Show more