<?php
/**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
class Event
{
- public static function getHTML(array $event, $simple = false, $uriid = 0)
+ public static function getHTML(array $event, bool $simple = false, int $uriid = 0): string
{
if (empty($event)) {
return '';
$uriid = $event['uri-id'] ?? $uriid;
- $bd_format = DI::l10n()->t('l F d, Y \@ g:i A'); // Friday January 18, 2011 @ 8 AM.
+ $bd_format = DI::l10n()->t('l F d, Y \@ g:i A \G\M\TP (e)'); // Friday October 29, 2021 @ 9:15 AM GMT-04:00 (America/New_York)
- $event_start = DI::l10n()->getDay(
- !empty($event['adjust']) ?
- DateTimeFormat::local($event['start'], $bd_format) : DateTimeFormat::utc($event['start'], $bd_format)
- );
+ $event_start = DI::l10n()->getDay(DateTimeFormat::local($event['start'], $bd_format));
if (!empty($event['finish'])) {
- $event_end = DI::l10n()->getDay(
- !empty($event['adjust']) ?
- DateTimeFormat::local($event['finish'], $bd_format) : DateTimeFormat::utc($event['finish'], $bd_format)
- );
+ $event_end = DI::l10n()->getDay(DateTimeFormat::local($event['finish'], $bd_format));
} else {
$event_end = '';
}
$o .= '<div class="summary event-summary">' . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['summary']), $simple) . '</div>' . "\r\n";
$o .= '<div class="event-start"><span class="event-label">' . DI::l10n()->t('Starts:') . '</span> <span class="dtstart" title="'
- . DateTimeFormat::utc($event['start'], (!empty($event['adjust']) ? DateTimeFormat::ATOM : 'Y-m-d\TH:i:s'))
+ . DateTimeFormat::local($event['start'], DateTimeFormat::ATOM)
. '" >' . $event_start
. '</span></div>' . "\r\n";
if (!$event['nofinish']) {
$o .= '<div class="event-end" ><span class="event-label">' . DI::l10n()->t('Finishes:') . '</span> <span class="dtend" title="'
- . DateTimeFormat::utc($event['finish'], (!empty($event['adjust']) ? DateTimeFormat::ATOM : 'Y-m-d\TH:i:s'))
+ . DateTimeFormat::local($event['finish'], DateTimeFormat::ATOM)
. '" >' . $event_end
. '</span></div>' . "\r\n";
}
* @param array $event Array which contains the event data.
* @return string The event as a bbcode formatted string.
*/
- private static function getBBCode(array $event)
+ private static function getBBCode(array $event): string
{
$o = '';
$o .= '[event-location]' . $event['location'] . '[/event-location]';
}
- if ($event['adjust']) {
- $o .= '[event-adjust]' . $event['adjust'] . '[/event-adjust]';
- }
-
return $o;
}
/**
* Extract bbcode formatted event data from a string.
*
- * @params: string $s The string which should be parsed for event data.
- * @param $text
+ * @param string $text The string which should be parsed for event data.
* @return array The array with the event information.
*/
- public static function fromBBCode($text)
+ public static function fromBBCode(string $text): array
{
$ev = [];
$ev['location'] = $match[1];
}
- $match = [];
- if (preg_match("/\[event\-adjust\](.*?)\[\/event\-adjust\]/is", $text, $match)) {
- $ev['adjust'] = $match[1];
- }
-
$ev['nofinish'] = !empty($ev['start']) && empty($ev['finish']) ? 1 : 0;
return $ev;
}
- public static function sortByDate($event_list)
+ public static function sortByDate(array $event_list): array
{
usort($event_list, ['self', 'compareDatesCallback']);
return $event_list;
}
- private static function compareDatesCallback($event_a, $event_b)
+ private static function compareDatesCallback(array $event_a, array $event_b)
{
- $date_a = (($event_a['adjust']) ? DateTimeFormat::local($event_a['start']) : $event_a['start']);
- $date_b = (($event_b['adjust']) ? DateTimeFormat::local($event_b['start']) : $event_b['start']);
+ $date_a = DateTimeFormat::local($event_a['start']);
+ $date_b = DateTimeFormat::local($event_b['start']);
if ($date_a === $date_b) {
return strcasecmp($event_a['desc'], $event_b['desc']);
* @return void
* @throws \Exception
*/
- public static function delete($event_id)
+ public static function delete(int $event_id)
{
if ($event_id == 0) {
return;
}
DBA::delete('event', ['id' => $event_id]);
- Logger::log("Deleted event ".$event_id, Logger::DEBUG);
+ Logger::info("Deleted event", ['id' => $event_id]);
}
/**
* @return int The new event id.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function store($arr)
+ public static function store(array $arr): int
{
- $event = [];
- $event['id'] = intval($arr['id'] ?? 0);
- $event['uid'] = intval($arr['uid'] ?? 0);
- $event['cid'] = intval($arr['cid'] ?? 0);
- $event['guid'] = ($arr['guid'] ?? '') ?: System::createUUID();
- $event['uri'] = ($arr['uri'] ?? '') ?: Item::newURI($event['uid'], $event['guid']);
- $event['uri-id'] = ItemURI::insert(['uri' => $event['uri'], 'guid' => $event['guid']]);
- $event['type'] = ($arr['type'] ?? '') ?: 'event';
- $event['summary'] = $arr['summary'] ?? '';
- $event['desc'] = $arr['desc'] ?? '';
- $event['location'] = $arr['location'] ?? '';
- $event['allow_cid'] = $arr['allow_cid'] ?? '';
- $event['allow_gid'] = $arr['allow_gid'] ?? '';
- $event['deny_cid'] = $arr['deny_cid'] ?? '';
- $event['deny_gid'] = $arr['deny_gid'] ?? '';
- $event['adjust'] = intval($arr['adjust'] ?? 0);
- $event['nofinish'] = intval($arr['nofinish'] ?? (!empty($event['start']) && empty($event['finish'])));
-
- $event['created'] = DateTimeFormat::utc(($arr['created'] ?? '') ?: 'now');
- $event['edited'] = DateTimeFormat::utc(($arr['edited'] ?? '') ?: 'now');
- $event['start'] = DateTimeFormat::utc(($arr['start'] ?? '') ?: DBA::NULL_DATETIME);
- $event['finish'] = DateTimeFormat::utc(($arr['finish'] ?? '') ?: DBA::NULL_DATETIME);
+ $guid = $arr['guid'] ?? '' ?: System::createUUID();
+ $uri = $arr['uri'] ?? '' ?: Item::newURI($guid);
+ $event = [
+ 'id' => intval($arr['id'] ?? 0),
+ 'uid' => intval($arr['uid'] ?? 0),
+ 'cid' => intval($arr['cid'] ?? 0),
+ 'guid' => $guid,
+ 'uri' => $uri,
+ 'uri-id' => ItemURI::insert(['uri' => $uri, 'guid' => $guid]),
+ 'type' => ($arr['type'] ?? '') ?: 'event',
+ 'summary' => $arr['summary'] ?? '',
+ 'desc' => $arr['desc'] ?? '',
+ 'location' => $arr['location'] ?? '',
+ 'allow_cid' => $arr['allow_cid'] ?? '',
+ 'allow_gid' => $arr['allow_gid'] ?? '',
+ 'deny_cid' => $arr['deny_cid'] ?? '',
+ 'deny_gid' => $arr['deny_gid'] ?? '',
+ 'nofinish' => intval($arr['nofinish'] ?? (!empty($arr['start']) && empty($arr['finish']))),
+ 'created' => DateTimeFormat::utc(($arr['created'] ?? '') ?: 'now'),
+ 'edited' => DateTimeFormat::utc(($arr['edited'] ?? '') ?: 'now'),
+ 'start' => DateTimeFormat::utc(($arr['start'] ?? '') ?: DBA::NULL_DATETIME),
+ 'finish' => DateTimeFormat::utc(($arr['finish'] ?? '') ?: DBA::NULL_DATETIME),
+ ];
+
+
if ($event['finish'] < DBA::NULL_DATETIME) {
$event['finish'] = DBA::NULL_DATETIME;
}
'desc' => $event['desc'],
'location' => $event['location'],
'type' => $event['type'],
- 'adjust' => $event['adjust'],
'nofinish' => $event['nofinish'],
];
return $event['id'];
}
- public static function getItemArrayForId(int $event_id, array $item = []):array
+ public static function getItemArrayForId(int $event_id, array $item = []): array
{
if (empty($event_id)) {
return $item;
return $item;
}
- public static function getItemArrayForImportedId(int $event_id, array $item = []):array
+ public static function getItemArrayForImportedId(int $event_id, array $item = []): array
{
if (empty($event_id)) {
return $item;
* @return array Array with translations strings.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function getStrings()
+ public static function getStrings(): array
{
// First day of the week (0 = Sunday).
$firstDay = DI::pConfig()->get(local_user(), 'system', 'first_day_of_week', 0);
*
* @todo We should replace this with a separate update function if there is some time left.
*/
- private static function removeDuplicates(array $dates)
+ private static function removeDuplicates(array $dates): array
{
$dates2 = [];
* @return array Query result
* @throws \Exception
*/
- public static function getListById($owner_uid, $event_id, $sql_extra = '')
+ public static function getListById(int $owner_uid, int $event_id, string $sql_extra = ''): array
{
$return = [];
* 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).
*
* @return array Query results.
* @throws \Exception
*/
- public static function getListByDate($owner_uid, $event_params, $sql_extra = '')
+ public static function getListByDate(int $owner_uid, array $event_params, string $sql_extra = ''): array
{
$return = [];
$events = DBA::toArray(DBA::p("SELECT `event`.*, `post-user`.`id` AS `itemid` FROM `event`
LEFT JOIN `post-user` ON `post-user`.`event-id` = `event`.`id` AND `post-user`.`uid` = `event`.`uid`
WHERE `event`.`uid` = ? AND `event`.`ignore` = ?
- AND ((NOT `adjust` AND (`finish` >= ? OR (`nofinish` AND `start` >= ?)) AND `start` <= ?)
- OR (`adjust` AND (`finish` >= ? OR (`nofinish` AND `start` >= ?)) AND `start` <= ?))" . $sql_extra,
- $owner_uid, $event_params["ignore"],
- $event_params["start"], $event_params["start"], $event_params["finish"],
- $event_params["adjust_start"], $event_params["adjust_start"], $event_params["adjust_finish"]));
+ AND (`finish` >= ? OR (`nofinish` AND `start` >= ?)) AND `start` <= ?
+ " . $sql_extra,
+ $owner_uid, $event_params['ignore'],
+ $event_params['start'], $event_params['start'], $event_params['finish']
+ ));
if (DBA::isResult($events)) {
$return = self::removeDuplicates($events);
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- public static function prepareListForTemplate(array $event_result)
+ public static function prepareListForTemplate(array $event_result): array
{
$event_list = [];
$event = array_merge($event, $item);
- $start = $event['adjust'] ? DateTimeFormat::local($event['start'], 'c') : DateTimeFormat::utc($event['start'], 'c');
- $j = $event['adjust'] ? DateTimeFormat::local($event['start'], 'j') : DateTimeFormat::utc($event['start'], 'j');
- $day = $event['adjust'] ? DateTimeFormat::local($event['start'], $fmt) : DateTimeFormat::utc($event['start'], $fmt);
+ $start = DateTimeFormat::local($event['start'], 'c');
+ $j = DateTimeFormat::local($event['start'], 'j');
+ $day = DateTimeFormat::local($event['start'], $fmt);
$day = DI::l10n()->getDay($day);
if ($event['nofinish']) {
$end = null;
} else {
- $end = $event['adjust'] ? DateTimeFormat::local($event['finish'], 'c') : DateTimeFormat::utc($event['finish'], 'c');
+ $end = DateTimeFormat::local($event['finish'], 'c');
}
$is_first = ($day !== $last_date);
* @param array $events Query result for events.
* @param string $format The output format (ical/csv).
*
- * @param $timezone
+ * @param string $timezone Timezone (missing parameter!)
* @return string Content according to selected export format.
*
* @todo Implement timezone support
*/
- private static function formatListForExport(array $events, $format)
+ private static function formatListForExport(array $events, string $format): string
{
$o = '';
// but test your solution against http://icalvalid.cloudapp.net/
// also long lines SHOULD be split at 75 characters length
foreach ($events as $event) {
- if ($event['adjust'] == 1) {
- $UTC = 'Z';
- } else {
- $UTC = '';
- }
$o .= 'BEGIN:VEVENT' . PHP_EOL;
if ($event['start']) {
- $tmp = strtotime($event['start']);
- $dtformat = "%Y%m%dT%H%M%S" . $UTC;
- $o .= 'DTSTART:' . strftime($dtformat, $tmp) . PHP_EOL;
+ $o .= 'DTSTART:' . DateTimeFormat::utc($event['start'], 'Ymd\THis\Z') . PHP_EOL;
}
if (!$event['nofinish']) {
- $tmp = strtotime($event['finish']);
- $dtformat = "%Y%m%dT%H%M%S" . $UTC;
- $o .= 'DTEND:' . strftime($dtformat, $tmp) . PHP_EOL;
+ $o .= 'DTEND:' . DateTimeFormat::utc($event['finish'], 'Ymd\THis\Z') . PHP_EOL;
}
if ($event['summary']) {
* @return array Query results.
* @throws \Exception
*/
- private static function getListByUserId($uid = 0)
+ private static function getListByUserId(int $uid = 0): array
{
$return = [];
return $return;
}
- $fields = ['start', 'finish', 'adjust', 'summary', 'desc', 'location', 'nofinish'];
+ $fields = ['start', 'finish', 'summary', 'desc', 'location', 'nofinish'];
$conditions = ['uid' => $uid, 'cid' => 0];
* @throws \Exception
* @todo Respect authenticated users with events_by_uid().
*/
- public static function exportListByUserId($uid, $format = 'ical')
+ public static function exportListByUserId(int $uid, string $format = 'ical'): array
{
$process = false;
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- public static function getItemHTML(array $item) {
+ public static function getItemHTML(array $item): string
+ {
$same_date = false;
$finish = false;
$tformat = DI::l10n()->t('g:i A'); // 8:01 AM.
// Convert the time to different formats.
- $dtstart_dt = DI::l10n()->getDay(
- $item['event-adjust'] ?
- DateTimeFormat::local($item['event-start'], $dformat)
- : DateTimeFormat::utc($item['event-start'], $dformat)
- );
- $dtstart_title = DateTimeFormat::utc($item['event-start'], $item['event-adjust'] ? DateTimeFormat::ATOM : 'Y-m-d\TH:i:s');
+ $dtstart_dt = DI::l10n()->getDay(DateTimeFormat::local($item['event-start'], $dformat));
+ $dtstart_title = DateTimeFormat::utc($item['event-start'], DateTimeFormat::ATOM);
// Format: Jan till Dec.
- $month_short = DI::l10n()->getDayShort(
- $item['event-adjust'] ?
- DateTimeFormat::local($item['event-start'], 'M')
- : DateTimeFormat::utc($item['event-start'], 'M')
- );
+ $month_short = DI::l10n()->getDayShort(DateTimeFormat::local($item['event-start'], 'M'));
// Format: 1 till 31.
- $date_short = $item['event-adjust'] ?
- DateTimeFormat::local($item['event-start'], 'j')
- : DateTimeFormat::utc($item['event-start'], 'j');
- $start_time = $item['event-adjust'] ?
- DateTimeFormat::local($item['event-start'], $tformat)
- : DateTimeFormat::utc($item['event-start'], $tformat);
- $start_short = DI::l10n()->getDayShort(
- $item['event-adjust'] ?
- DateTimeFormat::local($item['event-start'], $dformat_short)
- : DateTimeFormat::utc($item['event-start'], $dformat_short)
- );
+ $date_short = DateTimeFormat::local($item['event-start'], 'j');
+ $start_time = DateTimeFormat::local($item['event-start'], $tformat);
+ $start_short = DI::l10n()->getDayShort(DateTimeFormat::local($item['event-start'], $dformat_short));
// If the option 'nofinisch' isn't set, we need to format the finish date/time.
if (!$item['event-nofinish']) {
$finish = true;
- $dtend_dt = DI::l10n()->getDay(
- $item['event-adjust'] ?
- DateTimeFormat::local($item['event-finish'], $dformat)
- : DateTimeFormat::utc($item['event-finish'], $dformat)
- );
- $dtend_title = DateTimeFormat::utc($item['event-finish'], $item['event-adjust'] ? DateTimeFormat::ATOM : 'Y-m-d\TH:i:s');
- $end_short = DI::l10n()->getDayShort(
- $item['event-adjust'] ?
- DateTimeFormat::local($item['event-finish'], $dformat_short)
- : DateTimeFormat::utc($item['event-finish'], $dformat_short)
- );
- $end_time = $item['event-adjust'] ?
- DateTimeFormat::local($item['event-finish'], $tformat)
- : DateTimeFormat::utc($item['event-finish'], $tformat);
+ $dtend_dt = DI::l10n()->getDay(DateTimeFormat::local($item['event-finish'], $dformat));
+ $dtend_title = DateTimeFormat::utc($item['event-finish'], DateTimeFormat::ATOM);
+ $end_short = DI::l10n()->getDayShort(DateTimeFormat::utc($item['event-finish'], $dformat_short));
+ $end_time = DateTimeFormat::local($item['event-finish'], $tformat);
// Check if start and finish time is at the same day.
if (substr($dtstart_title, 0, 10) === substr($dtend_title, 0, 10)) {
$same_date = true;
* @return array The array with the location data.
* '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>
+ * 'coordinates' => Latitude and longitude (e.g. '48.864716,2.349014').<br>
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private static function locationToArray($s = '') {
+ private static function locationToArray(string $s = ''): array
+ {
if ($s == '') {
return [];
}
* @return bool
* @throws \Exception
*/
- public static function createBirthday($contact, $birthday)
+ public static function createBirthday(array $contact, string $birthday): bool
{
// Check for duplicates
$condition = [
'summary' => DI::l10n()->t('%s\'s birthday', $contact['name']),
'desc' => DI::l10n()->t('Happy Birthday %s', ' [url=' . $contact['url'] . ']' . $contact['name'] . '[/url]'),
'type' => 'birthday',
- 'adjust' => 0
];
- self::store($values);
-
- return true;
+ // Check if self::store() was success
+ return (self::store($values) > 0);
}
}