mirror of
https://github.com/friendica/friendica
synced 2025-04-27 11:50:11 +00:00
Fix PHPDoc comments project-wide
This commit is contained in:
Hypolite Petovan
parent
6077aa5847
commit
3282ce5389
113 changed files with 1703 additions and 795 deletions
|
|
@ -36,6 +36,7 @@ class NotificationsManager extends BaseObject
|
|||
* - date_rel : relative date string
|
||||
* - msg_html: message as html string
|
||||
* - msg_plain: message as plain text string
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
private function _set_extra($notes)
|
||||
{
|
||||
|
|
@ -61,6 +62,7 @@ class NotificationsManager extends BaseObject
|
|||
* @param string $limit optional Query limits
|
||||
*
|
||||
* @return array of results or false on errors
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public function getAll($filter = [], $order = "-date", $limit = "")
|
||||
{
|
||||
|
|
@ -109,6 +111,7 @@ class NotificationsManager extends BaseObject
|
|||
*
|
||||
* @param int $id identity
|
||||
* @return array note values or null if not found
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public function getByID($id)
|
||||
{
|
||||
|
|
@ -161,6 +164,7 @@ class NotificationsManager extends BaseObject
|
|||
* @brief List of pages for the Notifications TabBar
|
||||
*
|
||||
* @return array with with notifications TabBar data
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function getTabs()
|
||||
{
|
||||
|
|
@ -213,14 +217,15 @@ class NotificationsManager extends BaseObject
|
|||
* @param array $notifs The array from the db query
|
||||
* @param string $ident The notifications identifier (e.g. network)
|
||||
* @return array
|
||||
* string 'label' => The type of the notification
|
||||
* string 'link' => URL to the source
|
||||
* string 'image' => The avatar image
|
||||
* string 'url' => The profile url of the contact
|
||||
* string 'text' => The notification text
|
||||
* string 'when' => The date of the notification
|
||||
* string 'ago' => T relative date of the notification
|
||||
* bool 'seen' => Is the notification marked as "seen"
|
||||
* string 'label' => The type of the notification
|
||||
* string 'link' => URL to the source
|
||||
* string 'image' => The avatar image
|
||||
* string 'url' => The profile url of the contact
|
||||
* string 'text' => The notification text
|
||||
* string 'when' => The date of the notification
|
||||
* string 'ago' => T relative date of the notification
|
||||
* bool 'seen' => Is the notification marked as "seen"
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
private function formatNotifs(array $notifs, $ident = "")
|
||||
{
|
||||
|
|
@ -398,14 +403,15 @@ class NotificationsManager extends BaseObject
|
|||
/**
|
||||
* @brief Get network notifications
|
||||
*
|
||||
* @param int|string $seen If 0 only include notifications into the query
|
||||
* which aren't marked as "seen"
|
||||
* @param int $start Start the query at this point
|
||||
* @param int $limit Maximum number of query results
|
||||
* @param int|string $seen If 0 only include notifications into the query
|
||||
* which aren't marked as "seen"
|
||||
* @param int $start Start the query at this point
|
||||
* @param int $limit Maximum number of query results
|
||||
*
|
||||
* @return array with
|
||||
* string 'ident' => Notification identifier
|
||||
* array 'notifications' => Network notifications
|
||||
* string 'ident' => Notification identifier
|
||||
* array 'notifications' => Network notifications
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public function networkNotifs($seen = 0, $start = 0, $limit = 80)
|
||||
{
|
||||
|
|
@ -439,14 +445,15 @@ class NotificationsManager extends BaseObject
|
|||
/**
|
||||
* @brief Get system notifications
|
||||
*
|
||||
* @param int|string $seen If 0 only include notifications into the query
|
||||
* which aren't marked as "seen"
|
||||
* @param int $start Start the query at this point
|
||||
* @param int $limit Maximum number of query results
|
||||
* @param int|string $seen If 0 only include notifications into the query
|
||||
* which aren't marked as "seen"
|
||||
* @param int $start Start the query at this point
|
||||
* @param int $limit Maximum number of query results
|
||||
*
|
||||
* @return array with
|
||||
* string 'ident' => Notification identifier
|
||||
* array 'notifications' => System notifications
|
||||
* string 'ident' => Notification identifier
|
||||
* array 'notifications' => System notifications
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public function systemNotifs($seen = 0, $start = 0, $limit = 80)
|
||||
{
|
||||
|
|
@ -481,14 +488,15 @@ class NotificationsManager extends BaseObject
|
|||
/**
|
||||
* @brief Get personal notifications
|
||||
*
|
||||
* @param int|string $seen If 0 only include notifications into the query
|
||||
* which aren't marked as "seen"
|
||||
* @param int $start Start the query at this point
|
||||
* @param int $limit Maximum number of query results
|
||||
* @param int|string $seen If 0 only include notifications into the query
|
||||
* which aren't marked as "seen"
|
||||
* @param int $start Start the query at this point
|
||||
* @param int $limit Maximum number of query results
|
||||
*
|
||||
* @return array with
|
||||
* string 'ident' => Notification identifier
|
||||
* array 'notifications' => Personal notifications
|
||||
* string 'ident' => Notification identifier
|
||||
* array 'notifications' => Personal notifications
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function personalNotifs($seen = 0, $start = 0, $limit = 80)
|
||||
{
|
||||
|
|
@ -526,14 +534,15 @@ class NotificationsManager extends BaseObject
|
|||
/**
|
||||
* @brief Get home notifications
|
||||
*
|
||||
* @param int|string $seen If 0 only include notifications into the query
|
||||
* which aren't marked as "seen"
|
||||
* @param int $start Start the query at this point
|
||||
* @param int $limit Maximum number of query results
|
||||
* @param int|string $seen If 0 only include notifications into the query
|
||||
* which aren't marked as "seen"
|
||||
* @param int $start Start the query at this point
|
||||
* @param int $limit Maximum number of query results
|
||||
*
|
||||
* @return array with
|
||||
* string 'ident' => Notification identifier
|
||||
* array 'notifications' => Home notifications
|
||||
* string 'ident' => Notification identifier
|
||||
* array 'notifications' => Home notifications
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public function homeNotifs($seen = 0, $start = 0, $limit = 80)
|
||||
{
|
||||
|
|
@ -566,14 +575,16 @@ class NotificationsManager extends BaseObject
|
|||
/**
|
||||
* @brief Get introductions
|
||||
*
|
||||
* @param bool $all If false only include introductions into the query
|
||||
* which aren't marked as ignored
|
||||
* @param int $start Start the query at this point
|
||||
* @param int $limit Maximum number of query results
|
||||
* @param bool $all If false only include introductions into the query
|
||||
* which aren't marked as ignored
|
||||
* @param int $start Start the query at this point
|
||||
* @param int $limit Maximum number of query results
|
||||
*
|
||||
* @return array with
|
||||
* string 'ident' => Notification identifier
|
||||
* array 'notifications' => Introductions
|
||||
* string 'ident' => Notification identifier
|
||||
* array 'notifications' => Introductions
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
* @throws \ImagickException
|
||||
*/
|
||||
public function introNotifs($all = false, $start = 0, $limit = 80)
|
||||
{
|
||||
|
|
@ -620,6 +631,8 @@ class NotificationsManager extends BaseObject
|
|||
*
|
||||
* @param array $intros The array from the db query
|
||||
* @return array with the introductions
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
* @throws \ImagickException
|
||||
*/
|
||||
private function formatIntros($intros)
|
||||
{
|
||||
|
|
@ -703,6 +716,7 @@ class NotificationsManager extends BaseObject
|
|||
* @param array $arr The input array with the intro data
|
||||
*
|
||||
* @return array The array with the intro data
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
private function getMissingIntroData($arr)
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue