mirror of
https://github.com/friendica/friendica
synced 2025-05-04 19:44:11 +02:00
@brief is removed completely
This commit is contained in:
Michael
parent
fd1f1999f0
commit
0a4119adaf
170 changed files with 901 additions and 962 deletions
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @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;
|
||||
|
||||
|
|
@ -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
|
||||
* @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 $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 $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
|
||||
*
|
||||
|
|
@ -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
|
||||
*
|
||||
|
|
@ -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
|
||||
*
|
||||
|
|
@ -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'
|
||||
*
|
||||
|
|
@ -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 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 $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 $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 $options Options array, Optional
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ use Friendica\Util\Network;
|
|||
use Friendica\Util\Strings;
|
||||
|
||||
/**
|
||||
* @brief functions for interacting with a contact
|
||||
* functions for interacting with a 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 $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 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 $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 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 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 $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 $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 $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 $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 $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 $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 $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
|
||||
* @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
|
||||
* @return int
|
||||
|
|
@ -807,7 +807,7 @@ class Contact
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Marks a contact for removal
|
||||
* Marks a contact for removal
|
||||
*
|
||||
* @param int $id contact id
|
||||
* @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 $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.
|
||||
* 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()
|
||||
*
|
||||
|
|
@ -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
|
||||
* 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
|
||||
*
|
||||
|
|
@ -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 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
|
||||
* 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`,
|
||||
* `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
|
||||
*
|
||||
|
|
@ -1706,7 +1706,7 @@ class Contact
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Checks if the contact is blocked
|
||||
* Checks if the contact is blocked
|
||||
*
|
||||
* @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
|
||||
*
|
||||
|
|
@ -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
|
||||
*
|
||||
|
|
@ -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
|
||||
*
|
||||
|
|
@ -1871,7 +1871,7 @@ class Contact
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Blocks a contact
|
||||
* Blocks a contact
|
||||
*
|
||||
* @param int $cid
|
||||
* @return bool
|
||||
|
|
@ -1885,7 +1885,7 @@ class Contact
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Unblocks a contact
|
||||
* Unblocks a contact
|
||||
*
|
||||
* @param int $cid
|
||||
* @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 int $uid User id of contact owner
|
||||
|
|
@ -1949,8 +1949,8 @@ class Contact
|
|||
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 $uid user id
|
||||
|
|
@ -2008,8 +2008,8 @@ class Contact
|
|||
DBA::update('contact', $fields, $condition);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Remove duplicated contacts
|
||||
/**
|
||||
* Remove duplicated contacts
|
||||
*
|
||||
* @param string $nurl Normalised contact url
|
||||
* @param integer $uid User id
|
||||
|
|
@ -2244,7 +2244,7 @@ class Contact
|
|||
* $return['success'] boolean true if successful
|
||||
* $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 string $url
|
||||
* @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 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.
|
||||
*/
|
||||
|
|
@ -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
|
||||
*
|
||||
|
|
@ -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 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 string $url An url that we will be redirected to after the authentication
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ class Conversation
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Store the conversation data
|
||||
* Store the conversation data
|
||||
*
|
||||
* @param array $arr Item array with conversation data
|
||||
* @return array Item array with removed conversation data
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ use Friendica\Util\Strings;
|
|||
use Friendica\Util\XML;
|
||||
|
||||
/**
|
||||
* @brief functions for interacting with the event database table
|
||||
* functions for interacting with the event database table
|
||||
*/
|
||||
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.
|
||||
* @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.
|
||||
* @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
|
||||
* 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.
|
||||
*
|
||||
|
|
@ -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.
|
||||
* @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.
|
||||
* @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 $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 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.
|
||||
* @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 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.
|
||||
* 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.
|
||||
* @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
|
||||
* 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 string $birthday Birthday of the contact
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ use Friendica\Database\DBA;
|
|||
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.
|
||||
* We will differentiate the different uses by wrapping categories in angle brackets
|
||||
|
|
@ -20,7 +20,7 @@ use Friendica\DI;
|
|||
class FileTag
|
||||
{
|
||||
/**
|
||||
* @brief URL encode <, >, left and right brackets
|
||||
* URL encode <, >, left and right brackets
|
||||
*
|
||||
* @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
|
||||
*
|
||||
|
|
@ -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 $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]
|
||||
* @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
|
||||
* @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 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 $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 $item_id Item identity.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?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;
|
||||
|
||||
|
|
@ -23,12 +23,12 @@ use Friendica\Util\Network;
|
|||
use Friendica\Util\Strings;
|
||||
|
||||
/**
|
||||
* @brief This class handles GlobalContact related functions
|
||||
* This class handles GlobalContact related functions
|
||||
*/
|
||||
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 $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 $uid User ID
|
||||
|
|
@ -108,7 +108,7 @@ class GContact
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Sanitize the given gcontact data
|
||||
* Sanitize the given gcontact data
|
||||
*
|
||||
* Generation:
|
||||
* 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
|
||||
*
|
||||
|
|
@ -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
|
||||
*
|
||||
|
|
@ -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
|
||||
*
|
||||
|
|
@ -947,7 +947,7 @@ class GContact
|
|||
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
|
||||
* @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
|
||||
* @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
|
||||
* @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 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
|
||||
* @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 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.
|
||||
*
|
||||
|
|
@ -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
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
* @throws \ImagickException
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ use Friendica\Core\Renderer;
|
|||
use Friendica\Database\DBA;
|
||||
|
||||
/**
|
||||
* @brief functions for interacting with the group database table
|
||||
* functions for interacting with the group database table
|
||||
*/
|
||||
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
|
||||
*
|
||||
|
|
@ -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
|
||||
* @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
|
||||
*
|
||||
|
|
@ -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.
|
||||
*
|
||||
|
|
@ -176,7 +176,7 @@ class Group
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Mark a group as deleted
|
||||
* Mark a group as deleted
|
||||
*
|
||||
* @param int $gid
|
||||
* @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 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 $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 $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 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 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 $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 $each
|
||||
|
|
|
|||
|
|
@ -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 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
|
||||
* @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
|
||||
* @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
|
||||
* @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 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
|
||||
*
|
||||
|
|
@ -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
|
||||
*
|
||||
* @brief Retrieve a single record from a table
|
||||
* @param integer $uid User ID
|
||||
* @param array $selected
|
||||
* @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 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
|
||||
*
|
||||
* @brief Retrieve a single record from a table
|
||||
* @param array $fields
|
||||
* @param array $condition
|
||||
* @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 $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 $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 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
|
||||
*
|
||||
* @brief Retrieve a single record from a table
|
||||
* @param integer $uid User ID
|
||||
* @param array $selected
|
||||
* @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
|
||||
*
|
||||
* @brief Retrieve a single record from a table
|
||||
* @param array $fields
|
||||
* @param array $condition
|
||||
* @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 $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
|
||||
* @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)
|
||||
*
|
||||
|
|
@ -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 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 $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 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 $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 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 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 $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
|
||||
* @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
|
||||
* @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 $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 $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 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 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".
|
||||
* 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
|
||||
*
|
||||
|
|
@ -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 $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.
|
||||
* 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
|
||||
*
|
||||
|
|
@ -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
|
||||
*/
|
||||
|
|
@ -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.
|
||||
*
|
||||
* @param array $item
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ use Friendica\DI;
|
|||
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 int $limit The maximum number of characters when posting to that network
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ use Friendica\Database\DBA;
|
|||
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
|
||||
*
|
||||
|
|
@ -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
|
||||
*
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ use Psr\Log\LoggerInterface;
|
|||
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
|
||||
*/
|
||||
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 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
|
||||
* @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
|
||||
* 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
|
||||
* 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
|
||||
*
|
||||
|
|
@ -738,8 +738,8 @@ final class Notify
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Check for missing contact data and try to fetch the data from
|
||||
* from other sources
|
||||
* Check for missing contact data and try to fetch the data from
|
||||
* from other sources
|
||||
*
|
||||
* @param array $intro The input array with the intro data
|
||||
*
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ namespace Friendica\Model;
|
|||
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
|
||||
{
|
||||
|
|
@ -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 $contact_id Contact id of the visitor
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @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;
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ require_once "include/dba.php";
|
|||
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 $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 $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 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 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
|
||||
* 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
|
||||
*
|
||||
|
|
@ -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'
|
||||
*
|
||||
|
|
@ -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
|
||||
* @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 $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 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 $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 $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.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ use Friendica\Database\DBA;
|
|||
use Friendica\Util\DateTimeFormat;
|
||||
|
||||
/**
|
||||
* @brief functions for interacting with a process
|
||||
* functions for interacting with a process
|
||||
*/
|
||||
class Process
|
||||
{
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ use Friendica\Util\Temporal;
|
|||
class Profile
|
||||
{
|
||||
/**
|
||||
* @brief Returns default profile for a given user id
|
||||
* Returns default profile for a given 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 $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 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)
|
||||
*
|
||||
|
|
@ -109,7 +109,6 @@ class Profile
|
|||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Loads a profile into the page sidebar.
|
||||
*
|
||||
* 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
|
||||
* load a lot of theme-specific content
|
||||
*
|
||||
* @brief Loads a profile into the page sidebar.
|
||||
* @param App $a
|
||||
* @param string $nickname string
|
||||
* @param int $profile int
|
||||
|
|
@ -238,7 +236,6 @@ class Profile
|
|||
*
|
||||
* Includes all available profile data
|
||||
*
|
||||
* @brief Get all profile data of a local user
|
||||
* @param string $nickname nick
|
||||
* @param int $uid uid
|
||||
* @param int $profile_id ID of the profile
|
||||
|
|
@ -293,7 +290,6 @@ class Profile
|
|||
* It is very difficult to templatise the HTML completely
|
||||
* because of all the conditional logic.
|
||||
*
|
||||
* @brief Formats a profile for display in the sidebar.
|
||||
* @param array $profile
|
||||
* @param int $block
|
||||
* @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
|
||||
* settings except their own while on this site.
|
||||
*
|
||||
* @brief Get the user ID of the page owner
|
||||
* @return int user ID
|
||||
*
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ use Friendica\Util\DateTimeFormat;
|
|||
class PushSubscriber
|
||||
{
|
||||
/**
|
||||
* @brief Send subscription notifications for the given user
|
||||
* Send subscription notifications for the given user
|
||||
*
|
||||
* @param integer $uid User ID
|
||||
* @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
|
||||
* @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 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
|
||||
* @throws \Exception
|
||||
|
|
@ -136,7 +136,7 @@ class PushSubscriber
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Reset the push subscriber
|
||||
* Reset the push subscriber
|
||||
*
|
||||
* @param integer $id Subscriber ID
|
||||
* @param string $last_update Date of last transmitted item
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @file src/Model/Storage/Filesystem.php
|
||||
* @brief Storage backend system
|
||||
* Storage backend system
|
||||
*/
|
||||
|
||||
namespace Friendica\Model\Storage;
|
||||
|
|
@ -11,7 +11,7 @@ use Psr\Log\LoggerInterface;
|
|||
use Friendica\Database\Database as DBA;
|
||||
|
||||
/**
|
||||
* @brief Database based storage system
|
||||
* Database based storage system
|
||||
*
|
||||
* This class manage data stored in database table.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @file src/Model/Storage/Filesystem.php
|
||||
* @brief Storage backend system
|
||||
* Storage backend system
|
||||
*/
|
||||
|
||||
namespace Friendica\Model\Storage;
|
||||
|
|
@ -12,7 +12,7 @@ use Friendica\Util\Strings;
|
|||
use Psr\Log\LoggerInterface;
|
||||
|
||||
/**
|
||||
* @brief Filesystem based storage backend
|
||||
* Filesystem based storage backend
|
||||
*
|
||||
* This class manage data on filesystem.
|
||||
* 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
|
||||
*
|
||||
|
|
@ -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
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1,18 +1,18 @@
|
|||
<?php
|
||||
/**
|
||||
* @file src/Model/Storage/IStorage.php
|
||||
* @brief Storage backend system
|
||||
* Storage backend system
|
||||
*/
|
||||
|
||||
namespace Friendica\Model\Storage;
|
||||
|
||||
/**
|
||||
* @brief Interface for storage backends
|
||||
* Interface for storage backends
|
||||
*/
|
||||
interface IStorage
|
||||
{
|
||||
/**
|
||||
* @brief Get data from backend
|
||||
* Get data from backend
|
||||
*
|
||||
* @param string $reference Data reference
|
||||
*
|
||||
|
|
@ -21,7 +21,7 @@ interface IStorage
|
|||
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 $reference Data reference. Optional.
|
||||
|
|
@ -31,7 +31,7 @@ interface IStorage
|
|||
public function put(string $data, string $reference = "");
|
||||
|
||||
/**
|
||||
* @brief Remove data from backend
|
||||
* Remove data from backend
|
||||
*
|
||||
* @param string $reference Data reference
|
||||
*
|
||||
|
|
@ -40,7 +40,7 @@ interface IStorage
|
|||
public function delete(string $reference);
|
||||
|
||||
/**
|
||||
* @brief Get info about storage options
|
||||
* Get info about storage options
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
|
|
@ -80,7 +80,7 @@ interface IStorage
|
|||
public function getOptions();
|
||||
|
||||
/**
|
||||
* @brief Validate and save options
|
||||
* Validate and save options
|
||||
*
|
||||
* @param array $data Array [optionname => value] to be saved
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
<?php
|
||||
/**
|
||||
* @file src/Model/Storage/StorageException.php
|
||||
* @brief Storage backend system
|
||||
* Storage backend system
|
||||
*/
|
||||
|
||||
namespace Friendica\Model\Storage;
|
||||
|
||||
/**
|
||||
* @brief Storage Exception
|
||||
* Storage Exception
|
||||
*/
|
||||
class StorageException extends \Exception
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @file src/Model/Storage/SystemStorage.php
|
||||
* @brief Storage backend system
|
||||
* Storage backend system
|
||||
*/
|
||||
|
||||
namespace Friendica\Model\Storage;
|
||||
|
|
@ -9,7 +9,7 @@ namespace Friendica\Model\Storage;
|
|||
use \BadMethodCallException;
|
||||
|
||||
/**
|
||||
* @brief System resource storage class
|
||||
* System resource storage class
|
||||
*
|
||||
* This class is used to load system resources, like images.
|
||||
* Is not intended to be selectable by admins as default storage class.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @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;
|
||||
|
|
@ -29,7 +29,7 @@ use Friendica\Worker\Delivery;
|
|||
use LightOpenID;
|
||||
|
||||
/**
|
||||
* @brief This class handles User related functions
|
||||
* This class handles User related functions
|
||||
*/
|
||||
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
|
||||
*
|
||||
|
|
@ -171,7 +171,7 @@ class User
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Get owner data by user id
|
||||
* Get owner data by user id
|
||||
*
|
||||
* @param int $uid
|
||||
* @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
|
||||
* @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 string $network network name
|
||||
|
|
@ -294,7 +294,6 @@ class User
|
|||
/**
|
||||
* Authenticate a user with a clear text password
|
||||
*
|
||||
* @brief Authenticate a user with a clear text password
|
||||
* @param mixed $user_info
|
||||
* @param string $password
|
||||
* @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
|
||||
*
|
||||
* @brief Authenticate a user with a clear text password
|
||||
* @param mixed $user_info
|
||||
* @param string $password
|
||||
* @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
|
||||
* 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.
|
||||
* 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 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
|
||||
*
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue