Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2025-04-27 13:50:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix PHPDoc comments project-wide

Browse source
This commit is contained in:
Hypolite Petovan 2019-01-06 16:06:53 -05:00
parent 6077aa5847
commit 3282ce5389
113 changed files with 1703 additions and 795 deletions
Download patch file Download diff file Expand all files Collapse all files

22
src/Model/Event.php
View file

@ -148,6 +148,7 @@ class Event extends BaseObject
* @brief Extract bbcode formatted event data from a string.
*
* @params: string $s The string which should be parsed for event data.
* @param $text
* @return array The array with the event information.
*/
public static function fromBBCode($text)
@ -215,6 +216,7 @@ class Event extends BaseObject
*
* @param int $event_id Event ID.
* @return void
* @throws \Exception
*/
public static function delete($event_id)
{
@ -233,6 +235,7 @@ class Event extends BaseObject
*
* @param array $arr Array with event data.
* @return int The new event id.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function store($arr)
{
@ -371,6 +374,7 @@ class Event extends BaseObject
* @brief Create an array with translation strings used for events.
*
* @return array Array with translations strings.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function getStrings()
{
@ -546,6 +550,8 @@ class Event extends BaseObject
*
* @param array $event_result Event query array.
* @return array Event array for the template.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function prepareListForTemplate(array $event_result)
{
@ -629,7 +635,6 @@ class Event extends BaseObject
*
* @param array $events Query result for events.
* @param string $format The output format (ical/csv).
* @param string $timezone The timezone of the user (not implemented yet).
*
* @return string Content according to selected export format.
*
@ -741,6 +746,7 @@ class Event extends BaseObject
* @param int $uid The user ID.
*
* @return array Query results.
* @throws \Exception
*/
private static function getListByUserId($uid = 0)
{
@ -771,14 +777,15 @@ class Event extends BaseObject
/**
*
* @param int $uid The user ID.
* @param int $uid The user ID.
* @param string $format Output format (ical/csv).
* @return array With the results:
* bool 'success' => True if the processing was successful,<br>
* string 'format' => The output format,<br>
* string 'extension' => The file extension of the output format,<br>
* string 'content' => The formatted output content.<br>
* bool 'success' => True if the processing was successful,<br>
* string 'format' => The output format,<br>
* string 'extension' => The file extension of the output format,<br>
* string 'content' => The formatted output content.<br>
*
* @throws \Exception
* @todo Respect authenticated users with events_by_uid().
*/
public static function exportListByUserId($uid, $format = 'ical')
@ -831,6 +838,8 @@ class Event extends BaseObject
*
* @param array $item Array with item and event data.
* @return string HTML output.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function getItemHTML(array $item) {
$same_date = false;
@ -989,6 +998,7 @@ class Event extends BaseObject
* @param array $contact Contact array, expects: id, uid, url, name
* @param string $birthday Birthday of the contact
* @return bool
* @throws \Exception
*/
public static function createBirthday($contact, $birthday)
{