" . bbcode($ev['desc']) . "
"; + $o .= "" . $event_start . "
"; @@ -49,31 +52,30 @@ function format_event_html($ev, $simple = false) { $o = '' . bbcode($ev['summary']) . '
' . "\r\n"; - - $o .= '' . bbcode($ev['desc']) . '
' . "\r\n"; - - $o .= '' . t('Starts:') . ' ' . t('Starts:') . ' '.$event_start - . '
' . "\r\n"; + . '' . t('Finishes:') . ' ' . t('Finishes:') . ' '.$event_end - . '
' . "\r\n"; + . '' . "\r\n"; } + $o .= ' ' . t('Location:') . ' '
+ $o .= '
+ * string 'start' => Start time of the timeframe.
+ * string 'finish' => Finish time of the timeframe.
+ * string 'adjust_start' =>
* string 'adjust_start' =>
*
- * @param string $sql_extra Additional sql conditions (e.g. permission request)
- * @return array Query results
+ * @param string $sql_extra Additional sql conditions (e.g. permission request).
+ *
+ * @return array Query results.
*/
function events_by_date($owner_uid = 0, $event_params, $sql_extra = '') {
- // Only allow events if there is a valid owner_id
+ // Only allow events if there is a valid owner_id.
if ($owner_uid == 0) {
return;
}
- // Query for the event by date
+ // Query for the event by date.
$r = q("SELECT `event`.*, `item`.`id` AS `itemid`,`item`.`plink`,
`item`.`author-name`, `item`.`author-avatar`, `item`.`author-link` FROM `event`
LEFT JOIN `item` ON `item`.`event-id` = `event`.`id` AND `item`.`uid` = `event`.`uid`
@@ -553,16 +591,16 @@ function events_by_date($owner_uid = 0, $event_params, $sql_extra = '') {
dbesc($event_params["adjust_finish"])
);
- if (dbm::is_result($r)) {
+ if (DBM::is_result($r)) {
return event_remove_duplicates($r);
}
}
/**
- * @brief Convert an array query results in an arry which could be used by the events template
+ * @brief Convert an array query results in an arry which could be used by the events template.
*
- * @param array $arr Event query array
- * @return array Event array for the template
+ * @param array $arr Event query array.
+ * @return array Event array for the template.
*/
function process_events($arr) {
$events=array();
@@ -571,7 +609,6 @@ function process_events($arr) {
$fmt = t('l, F j');
if (count($arr)) {
foreach ($arr as $rr) {
-
$j = (($rr['adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $rr['start'], 'j') : datetime_convert('UTC', 'UTC', $rr['start'], 'j'));
$d = (($rr['adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $rr['start'], $fmt) : datetime_convert('UTC', 'UTC', $rr['start'], $fmt));
$d = day_translate($d);
@@ -588,9 +625,10 @@ function process_events($arr) {
$last_date = $d;
// Show edit and drop actions only if the user is the owner of the event and the event
- // is a real event (no bithdays)
+ // is a real event (no bithdays).
if (local_user() && local_user() == $rr['uid'] && $rr['type'] == 'event') {
$edit = ((! $rr['cid']) ? array(System::baseUrl() . '/events/event/' . $rr['id'], t('Edit event'), '', '') : null);
+ $copy = ((! $rr['cid']) ? array(System::baseUrl() . '/events/copy/' . $rr['id'], t('Duplicate event'), '', '') : null);
$drop = array(System::baseUrl() . '/events/drop/' . $rr['id'], t('Delete event'), '', '');
}
@@ -614,6 +652,7 @@ function process_events($arr) {
'd' => $d,
'edit' => $edit,
'drop' => $drop,
+ 'copy' => $copy,
'is_first' => $is_first,
'item' => $rr,
'html' => $html,
@@ -626,13 +665,13 @@ function process_events($arr) {
}
/**
- * @brief Format event to export format (ical/csv)
+ * @brief Format event to export format (ical/csv).
*
- * @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)
+ * @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
+ * @return string Content according to selected export format.
*/
function event_format_export ($events, $format = 'ical', $timezone) {
if (! ((is_array($events)) && count($events))) {
@@ -640,7 +679,7 @@ function event_format_export ($events, $format = 'ical', $timezone) {
}
switch ($format) {
- // Format the exported data as a CSV file
+ // Format the exported data as a CSV file.
case "csv":
header("Content-type: text/csv");
$o = '"Subject", "Start Date", "Start Time", "Description", "End Date", "End Time", "Location"' . PHP_EOL;
@@ -661,7 +700,7 @@ function event_format_export ($events, $format = 'ical', $timezone) {
}
break;
- // Format the exported data as a ics file
+ // Format the exported data as a ics file.
case "ical":
header("Content-type: text/ics");
$o = 'BEGIN:VCALENDAR' . PHP_EOL
@@ -676,7 +715,6 @@ function event_format_export ($events, $format = 'ical', $timezone) {
// 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 {
@@ -729,32 +767,32 @@ function event_format_export ($events, $format = 'ical', $timezone) {
}
/**
- * @brief Get all events for a user ID
- *
- * The query for events is done permission sensitive
+ * @brief Get all events for a user ID.
+ *
+ * The query for events is done permission sensitive.
* If the user is the owner of the calendar he/she
* will get all of his/her available events.
* If the user is only a visitor only the public events will
- * be available
+ * be available.
*
- * @param int $uid The user ID
- * @param int $sql_extra Additional sql conditions for permission
+ * @param int $uid The user ID.
+ * @param int $sql_extra Additional sql conditions for permission.
*
- * @return array Query results
+ * @return array Query results.
*/
function events_by_uid($uid = 0, $sql_extra = '') {
if ($uid == 0) {
return;
}
- // The permission condition if no condition was transmitted
+ // The permission condition if no condition was transmitted.
if ($sql_extra == '') {
$sql_extra = " AND `allow_cid` = '' AND `allow_gid` = '' ";
}
// Does the user who requests happen to be the owner of the events
// requested? then show all of your events, otherwise only those that
- // don't have limitations set in allow_cid and allow_gid
+ // don't have limitations set in allow_cid and allow_gid.
if (local_user() == $uid) {
$r = q("SELECT `start`, `finish`, `adjust`, `summary`, `desc`, `location`, `nofinish`
FROM `event` WHERE `uid`= %d AND `cid` = 0 ",
@@ -767,49 +805,49 @@ function events_by_uid($uid = 0, $sql_extra = '') {
);
}
- if (dbm::is_result($r)) {
+ if (DBM::is_result($r)) {
return $r;
}
}
/**
*
- * @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
- * string 'format' => The output format
- * string 'extension' => The file extension of the output format
- * string 'content' => The formatted output content
+ * @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,
+ * string 'format' => The output format,
+ * string 'extension' => The file extension of the output format,
+ * string 'content' => The formatted output content.
*
- * @todo Respect authenticated users with events_by_uid()
+ * @todo Respect authenticated users with events_by_uid().
*/
function event_export($uid, $format = 'ical') {
$process = false;
- // We are allowed to show events
- // get the timezone the user is in
+ // We are allowed to show events.
+ // Get the timezone the user is in.
$r = q("SELECT `timezone` FROM `user` WHERE `uid` = %d LIMIT 1", intval($uid));
- if (dbm::is_result($r)) {
+ if (DBM::is_result($r)) {
$timezone = $r[0]['timezone'];
}
- // Get all events which are owned by a uid (respects permissions);
+ // Get all events which are owned by a uid (respects permissions).
$events = events_by_uid($uid);
- // We have the events that are available for the requestor
- // now format the output according to the requested format
+ // We have the events that are available for the requestor.
+ // Now format the output according to the requested format.
if (count($events)) {
$res = event_format_export($events, $format, $timezone);
}
- // If there are results the precess was successfull
+ // If there are results the precess was successfull.
if (x($res)) {
$process = true;
}
- // Get the file extension for the format
+ // Get the file extension for the format.
switch ($format) {
case "ical":
$file_ext = "ics";
@@ -834,43 +872,43 @@ function event_export($uid, $format = 'ical') {
}
/**
- * @brief Get the events widget
+ * @brief Get the events widget.
*
- * @return string Formated html of the evens widget
+ * @return string Formated html of the evens widget.
*/
function widget_events() {
$a = get_app();
$owner_uid = $a->data['user']['uid'];
// $a->data is only available if the profile page is visited. If the visited page is not part
- // of the profile page it should be the personal /events page. So we can use $a->user
+ // of the profile page it should be the personal /events page. So we can use $a->user.
$user = ($a->data['user']['nickname'] ? $a->data['user']['nickname'] : $a->user['nickname']);
- // The permission testing is a little bit tricky because we have to respect many cases
+ // The permission testing is a little bit tricky because we have to respect many cases.
- // It's not the private events page (we don't get the $owner_uid for /events)
+ // It's not the private events page (we don't get the $owner_uid for /events).
if (! local_user() && ! $owner_uid) {
return;
}
/*
- * Cal logged in user (test permission at foreign profile page)
- * If the $owner uid is available we know it is part of one of the profile pages (like /cal)
+ * Cal logged in user (test permission at foreign profile page).
+ * If the $owner uid is available we know it is part of one of the profile pages (like /cal).
* So we have to test if if it's the own profile page of the logged in user
* or a foreign one. For foreign profile pages we need to check if the feature
* for exporting the cal is enabled (otherwise the widget would appear for logged in users
- * on foreigen profile pages even if the widget is disabled)
+ * on foreigen profile pages even if the widget is disabled).
*/
- if (intval($owner_uid) && local_user() !== $owner_uid && ! feature_enabled($owner_uid, "export_calendar")) {
+ if (intval($owner_uid) && local_user() !== $owner_uid && ! Feature::isEnabled($owner_uid, "export_calendar")) {
return;
}
/*
* If it's a kind of profile page (intval($owner_uid)) return if the user not logged in and
- * export feature isn't enabled
+ * export feature isn't enabled.
*/
- if (intval($owner_uid) && ! local_user() && ! feature_enabled($owner_uid, "export_calendar")) {
+ if (intval($owner_uid) && ! local_user() && ! Feature::isEnabled($owner_uid, "export_calendar")) {
return;
}
@@ -881,3 +919,135 @@ function widget_events() {
'$user' => $user
));
}
+
+/**
+ * @brief Format an item array with event data to HTML.
+ *
+ * @param arr $item Array with item and event data.
+ * @return string HTML output.
+ */
+function format_event_item($item) {
+ $same_date = false;
+ $finish = false;
+
+ // Set the different time formats.
+ $dformat = t('l F d, Y \@ g:i A'); // Friday January 18, 2011 @ 8:01 AM.
+ $dformat_short = t('D g:i A'); // Fri 8:01 AM.
+ $tformat = t('g:i A'); // 8:01 AM.
+
+ // Convert the time to different formats.
+ $dtstart_dt = (($item['event-adjust']) ? day_translate(datetime_convert('UTC', date_default_timezone_get(), $item['event-start'], $dformat)) : day_translate(datetime_convert('UTC', 'UTC', $item['event-start'], $dformat)));
+ $dtstart_title = datetime_convert('UTC', 'UTC', $item['event-start'], (($item['event-adjust']) ? ATOM_TIME : 'Y-m-d\TH:i:s'));
+ // Format: Jan till Dec.
+ $month_short = (($item['event-adjust']) ? day_short_translate(datetime_convert('UTC', date_default_timezone_get(), $item['event-start'], 'M')) : day_short_translate(datetime_convert('UTC', 'UTC', $item['event-start'], 'M')));
+ // Format: 1 till 31.
+ $date_short = (($item['event-adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $item['event-start'], 'j') : datetime_convert('UTC', 'UTC', $item['event-start'], 'j'));
+ $start_time = (($item['event-adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $item['event-start'], $tformat) : datetime_convert('UTC', 'UTC', $item['event-start'], $tformat));
+ $start_short = (($item['event-adjust']) ? day_short_translate(datetime_convert('UTC', date_default_timezone_get(), $item['event-start'], $dformat_short)) : day_short_translate(datetime_convert('UTC', 'UTC', $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 = (($item['event-adjust']) ? day_translate(datetime_convert('UTC', date_default_timezone_get(), $item['event-finish'], $dformat)) : day_translate(datetime_convert('UTC', 'UTC', $item['event-finish'], $dformat)));
+ $dtend_title = datetime_convert('UTC', 'UTC', $item['event-finish'], (($item['event-adjust']) ? ATOM_TIME : 'Y-m-d\TH:i:s'));
+ $end_short = (($item['event-adjust']) ? day_short_translate(datetime_convert('UTC', date_default_timezone_get(), $item['event-finish'], $dformat_short)) : day_short_translate(datetime_convert('UTC', 'UTC', $item['event-finish'], $dformat_short)));
+ $end_time = (($item['event-adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $item['event-finish'], $tformat) : datetime_convert('UTC', 'UTC', $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;
+ }
+ }
+
+ // Format the event location.
+ $evloc = event_location2array($item['event-location']);
+ $location = array();
+
+ if (isset($evloc['name'])) {
+ $location['name'] = prepare_text($evloc['name']);
+ }
+ // Construct the map HTML.
+ if (isset($evloc['address'])) {
+ $location['map'] = '
+ * 'address' => The address of the location,
+ * 'coordinates' => Latitudeâ and longitudeâ (e.g. '48.864716,2.349014').
+ */
+function event_location2array($s = '') {
+ if ($s == '') {
+ return;
+ }
+
+ $location = array('name' => $s);
+
+ // Map tag with location name - e.g. [map]Paris[/map].
+ if (strpos($s, '[/map]') !== false) {
+ $found = preg_match("/\[map\](.*?)\[\/map\]/ism", $s, $match);
+ if (intval($found) > 0 && array_key_exists(1, $match)) {
+ $location['address'] = $match[1];
+ // Remove the map bbcode from the location name.
+ $location['name'] = str_replace($match[0], "", $s);
+ }
+ // Map tag with coordinates - e.g. [map=48.864716,2.349014].
+ } elseif (strpos($s, '[map=') !== false) {
+ $found = preg_match("/\[map=(.*?)\]/ism", $s, $match);
+ if (intval($found) > 0 && array_key_exists(1, $match)) {
+ $location['coordinates'] = $match[1];
+ // Remove the map bbcode from the location name.
+ $location['name'] = str_replace($match[0], "", $s);
+ }
+ }
+
+ return $location;
+}