mirror of
https://github.com/friendica/friendica
synced 2025-05-01 23:04:24 +02:00
Update more PHPDoc, including in include/
This commit is contained in:
parent
af9067a381
commit
070aa016e0
17 changed files with 99 additions and 30 deletions
|
@ -1054,6 +1054,7 @@ class Contact extends BaseObject
|
|||
*
|
||||
* @param int $uid uid
|
||||
* @return array
|
||||
* @throws \Exception
|
||||
*/
|
||||
public static function getUngroupedList($uid)
|
||||
{
|
||||
|
|
|
@ -471,6 +471,7 @@ class Event extends BaseObject
|
|||
* @param int $event_id The ID of the event in the event table
|
||||
* @param string $sql_extra
|
||||
* @return array Query result
|
||||
* @throws \Exception
|
||||
*/
|
||||
public static function getListById($owner_uid, $event_id, $sql_extra = '')
|
||||
{
|
||||
|
@ -499,17 +500,18 @@ class Event extends BaseObject
|
|||
/**
|
||||
* @brief Get all events in a specific time frame.
|
||||
*
|
||||
* @param int $owner_uid The User ID of the owner of the events.
|
||||
* @param array $event_params An associative array with
|
||||
* int 'ignore' =>
|
||||
* string 'start' => Start time of the timeframe.
|
||||
* string 'finish' => Finish time of the timeframe.
|
||||
* string 'adjust_start' =>
|
||||
* string 'adjust_finish' =>
|
||||
* @param int $owner_uid The User ID of the owner of the events.
|
||||
* @param array $event_params An associative array with
|
||||
* int 'ignore' =>
|
||||
* string 'start' => Start time of the timeframe.
|
||||
* string 'finish' => Finish time of the timeframe.
|
||||
* string 'adjust_start' =>
|
||||
* string 'adjust_finish' =>
|
||||
*
|
||||
* @param string $sql_extra Additional sql conditions (e.g. permission request).
|
||||
* @param string $sql_extra Additional sql conditions (e.g. permission request).
|
||||
*
|
||||
* @return array Query results.
|
||||
* @throws \Exception
|
||||
*/
|
||||
public static function getListByDate($owner_uid, $event_params, $sql_extra = '')
|
||||
{
|
||||
|
@ -633,12 +635,13 @@ class Event extends BaseObject
|
|||
/**
|
||||
* @brief Format event to export format (ical/csv).
|
||||
*
|
||||
* @param array $events Query result for events.
|
||||
* @param string $format The output format (ical/csv).
|
||||
* @param array $events Query result for events.
|
||||
* @param string $format The output format (ical/csv).
|
||||
*
|
||||
* @param $timezone
|
||||
* @return string Content according to selected export format.
|
||||
*
|
||||
* @todo Implement timezone support
|
||||
* @todo Implement timezone support
|
||||
*/
|
||||
private static function formatListForExport(array $events, $format, $timezone)
|
||||
{
|
||||
|
@ -954,6 +957,7 @@ class Event extends BaseObject
|
|||
* 'name' => The name of the location,<br>
|
||||
* 'address' => The address of the location,<br>
|
||||
* 'coordinates' => Latitude and longitude (e.g. '48.864716,2.349014').<br>
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
private static function locationToArray($s = '') {
|
||||
if ($s == '') {
|
||||
|
|
|
@ -242,6 +242,7 @@ class GContact
|
|||
* @param integer $uid id
|
||||
* @param integer $cid id
|
||||
* @return integer
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function countCommonFriends($uid, $cid)
|
||||
{
|
||||
|
@ -269,6 +270,7 @@ class GContact
|
|||
* @param integer $uid id
|
||||
* @param integer $zcid zcid
|
||||
* @return integer
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function countCommonFriendsZcid($uid, $zcid)
|
||||
{
|
||||
|
@ -295,6 +297,7 @@ class GContact
|
|||
* @param integer $limit optional, default 9999
|
||||
* @param boolean $shuffle optional, default false
|
||||
* @return object
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function commonFriends($uid, $cid, $start = 0, $limit = 9999, $shuffle = false)
|
||||
{
|
||||
|
@ -333,6 +336,7 @@ class GContact
|
|||
* @param integer $limit optional, default 9999
|
||||
* @param boolean $shuffle optional, default false
|
||||
* @return object
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function commonFriendsZcid($uid, $zcid, $start = 0, $limit = 9999, $shuffle = false)
|
||||
{
|
||||
|
@ -362,6 +366,7 @@ class GContact
|
|||
* @param integer $uid user
|
||||
* @param integer $cid cid
|
||||
* @return integer
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function countAllFriends($uid, $cid)
|
||||
{
|
||||
|
@ -387,6 +392,7 @@ class GContact
|
|||
* @param integer $start optional, default 0
|
||||
* @param integer $limit optional, default 80
|
||||
* @return array
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function allFriends($uid, $cid, $start = 0, $limit = 80)
|
||||
{
|
||||
|
@ -1053,6 +1059,7 @@ class GContact
|
|||
|
||||
/**
|
||||
* @return string
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function getRandomUrl()
|
||||
{
|
||||
|
|
|
@ -52,6 +52,7 @@ class Queue
|
|||
* @param int $cid Contact id
|
||||
*
|
||||
* @return bool The communication with this contact has currently problems
|
||||
* @throws \Exception
|
||||
*/
|
||||
public static function wasDelayed($cid)
|
||||
{
|
||||
|
|
|
@ -729,6 +729,7 @@ class User
|
|||
* @param string $siteurl
|
||||
* @param string $password Plaintext password
|
||||
* @return NULL|boolean from notification() and email() inherited
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
|
||||
{
|
||||
|
@ -764,6 +765,7 @@ class User
|
|||
* @param string $siteurl
|
||||
* @param string $password Plaintext password
|
||||
* @return NULL|boolean from notification() and email() inherited
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public static function sendRegisterOpenEmail($user, $sitename, $siteurl, $password)
|
||||
{
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue