]> git.mxchange.org Git - friendica.git/blobdiff - include/event.php
Transfer all item shadow functions to the item class
[friendica.git] / include / event.php
index 4795867b129dde88fde5a377f34a7ff000cc113b..76044cf981936d89353aaa96a40e163167c6f591 100644 (file)
@@ -9,11 +9,12 @@ use Friendica\Content\Feature;
 use Friendica\Core\PConfig;
 use Friendica\Core\System;
 use Friendica\Database\DBM;
+use Friendica\Model\Profile;
+use Friendica\Util\Map;
 
 require_once 'include/bbcode.php';
-require_once 'include/map.php';
 require_once 'include/datetime.php';
-require_once "include/conversation.php";
+require_once 'include/conversation.php';
 
 function format_event_html($ev, $simple = false) {
        if (! ((is_array($ev)) && count($ev))) {
@@ -75,7 +76,7 @@ function format_event_html($ev, $simple = false) {
 
                // Include a map of the location if the [map] BBCode is used.
                if (strpos($ev['location'], "[map") !== false) {
-                       $map = generate_named_map($ev['location']);
+                       $map = Map::byLocation($ev['location']);
                        if ($map !== $ev['location']) {
                                $o.= $map;
                        }
@@ -88,7 +89,7 @@ function format_event_html($ev, $simple = false) {
 
 /**
  * @brief Convert an array with event data to bbcode.
- * 
+ *
  * @param array $ev Array which conains the event data.
  * @return string The event as a bbcode formatted string.
  */
@@ -126,7 +127,7 @@ function format_event_bbcode($ev) {
 /**
  * @brief Extract bbcode formatted event data from a string
  *     and convert it to html.
- * 
+ *
  * @params: string $s The string which should be parsed for event data.
  * @return string The html output.
  */
@@ -143,13 +144,13 @@ function bbtovcal($s) {
 
 /**
  * @brief Extract bbcode formatted event data from a string.
- * 
+ *
  * @params: string $s The string which should be parsed for event data.
  * @return array The array with the event information.
  */
 function bbtoevent($s) {
 
-       $ev = array();
+       $ev = [];
 
        $match = '';
        if (preg_match("/\[event\-summary\](.*?)\[\/event\-summary\]/is", $s, $match)) {
@@ -206,10 +207,10 @@ function ev_compare($a,$b) {
 
 /**
  * @brief 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.
- * 
+ *
  * @param int $event_id Event ID.
  * @return void
  */
@@ -218,15 +219,15 @@ function event_delete($event_id) {
                return;
        }
 
-       dba::delete('event', array('id' => $event_id));
+       dba::delete('event', ['id' => $event_id]);
        logger("Deleted event ".$event_id, LOGGER_DEBUG);
 }
 
 /**
  * @brief Store the event.
- * 
+ *
  * Store the event in the event table and create an event item in the item table.
- * 
+ *
  * @param array $arr Array with event data.
  * @return int The event id.
  */
@@ -261,13 +262,10 @@ function event_store($arr) {
                $contact = $c[0];
        }
 
-
        // Existing event being modified.
-
        if ($arr['id']) {
 
                // has the event actually changed?
-
                $r = q("SELECT * FROM `event` WHERE `id` = %d AND `uid` = %d LIMIT 1",
                        intval($arr['id']),
                        intval($arr['uid'])
@@ -275,7 +273,6 @@ function event_store($arr) {
                if ((! DBM::is_result($r)) || ($r[0]['edited'] === $arr['edited'])) {
 
                        // Nothing has changed. Grab the item id to return.
-
                        $r = q("SELECT * FROM `item` WHERE `event-id` = %d AND `uid` = %d LIMIT 1",
                                intval($arr['id']),
                                intval($arr['uid'])
@@ -284,8 +281,7 @@ function event_store($arr) {
                }
 
                // The event changed. Update it.
-
-               $r = q("UPDATE `event` SET
+               q("UPDATE `event` SET
                        `edited` = '%s',
                        `start` = '%s',
                        `finish` = '%s',
@@ -309,6 +305,7 @@ function event_store($arr) {
                        intval($arr['id']),
                        intval($arr['uid'])
                );
+
                $r = q("SELECT * FROM `item` WHERE `event-id` = %d AND `uid` = %d LIMIT 1",
                        intval($arr['id']),
                        intval($arr['uid'])
@@ -336,8 +333,7 @@ function event_store($arr) {
                return $item_id;
        } else {
                // New event. Store it.
-
-               $r = q("INSERT INTO `event` (`uid`,`cid`,`guid`,`uri`,`created`,`edited`,`start`,`finish`,`summary`, `desc`,`location`,`type`,
+               q("INSERT INTO `event` (`uid`,`cid`,`guid`,`uri`,`created`,`edited`,`start`,`finish`,`summary`, `desc`,`location`,`type`,
                        `adjust`,`nofinish`,`allow_cid`,`allow_gid`,`deny_cid`,`deny_gid`)
                        VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, '%s', '%s', '%s', '%s' ) ",
                        intval($arr['uid']),
@@ -368,7 +364,7 @@ function event_store($arr) {
                        $event = $r[0];
                }
 
-               $item_arr = array();
+               $item_arr = [];
 
                $item_arr['uid']           = $arr['uid'];
                $item_arr['contact-id']    = $arr['cid'];
@@ -403,21 +399,7 @@ function event_store($arr) {
                $item_arr['object'] .= '</object>' . "\n";
 
                $item_id = item_store($item_arr);
-
-               $r = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1",
-                       intval($arr['uid'])
-               );
-               //if (DBM::is_result($r))
-               //      $plink = System::baseUrl() . '/display/' . $r[0]['nickname'] . '/' . $item_id;
-
-
                if ($item_id) {
-                       //q("UPDATE `item` SET `plink` = '%s', `event-id` = %d  WHERE `uid` = %d AND `id` = %d",
-                       //      dbesc($plink),
-                       //      intval($event['id']),
-                       //      intval($arr['uid']),
-                       //      intval($item_id)
-                       //);
                        q("UPDATE `item` SET `event-id` = %d  WHERE `uid` = %d AND `id` = %d",
                                intval($event['id']),
                                intval($arr['uid']),
@@ -433,7 +415,7 @@ function event_store($arr) {
 
 /**
  * @brief Create an array with translation strings used for events.
- * 
+ *
  * @return array Array with translations strings.
  */
 function get_event_strings() {
@@ -441,7 +423,7 @@ function get_event_strings() {
        // First day of the week (0 = Sunday).
        $firstDay = PConfig::get(local_user(), 'system', 'first_day_of_week', 0);
 
-       $i18n = array(
+       $i18n = [
                        "firstDay" => $firstDay,
                        "allday"   => t("all-day"),
 
@@ -497,7 +479,7 @@ function get_event_strings() {
                        "dtstart_label"  => t("Starts:"),
                        "dtend_label"    => t("Finishes:"),
                        "location_label" => t("Location:")
-               );
+               ];
 
        return $i18n;
 }
@@ -511,7 +493,7 @@ function get_event_strings() {
  * @todo We should replace this with a separate update function if there is some time left.
  */
 function event_remove_duplicates($dates) {
-       $dates2 = array();
+       $dates2 = [];
 
        foreach ($dates as $date) {
                if ($date['type'] == 'birthday') {
@@ -526,10 +508,10 @@ function event_remove_duplicates($dates) {
 /**
  * @brief Get an event by its event ID.
  *
- * @param type $owner_uid The User ID of the owner of the event
- * @param type $event_params An assoziative array with
- *     int 'event_id' => The ID of the event in the event table
- * @param type $sql_extra
+ * @param int    $owner_uid    The User ID of the owner of the event
+ * @param array  $event_params An assoziative array with
+ *                                int 'event_id' => The ID of the event in the event table
+ * @param string $sql_extra
  * @return array Query result
  */
 function event_by_id($owner_uid = 0, $event_params, $sql_extra = '') {
@@ -564,7 +546,7 @@ function event_by_id($owner_uid = 0, $event_params, $sql_extra = '') {
  *     string 'adjust_start' =>
  *
  * @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 = '') {
@@ -603,7 +585,7 @@ function events_by_date($owner_uid = 0, $event_params, $sql_extra = '') {
  * @return array Event array for the template.
  */
 function process_events($arr) {
-       $events=array();
+       $events=[];
 
        $last_date = '';
        $fmt = t('l, F j');
@@ -626,10 +608,13 @@ function process_events($arr) {
 
                        // Show edit and drop actions only if the user is the owner of the event and the event
                        // is a real event (no bithdays).
+                       $edit = null;
+                       $copy = null;
+                       $drop = null;
                        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'), '', '');
+                               $edit = ((! $rr['cid']) ? [System::baseUrl() . '/events/event/' . $rr['id'], t('Edit event'), '', ''] : null);
+                               $copy = ((! $rr['cid']) ? [System::baseUrl() . '/events/copy/' . $rr['id'], t('Duplicate event'), '', ''] : null);
+                               $drop = [System::baseUrl() . '/events/drop/' . $rr['id'], t('Delete event'), '', ''];
                        }
 
                        $title = strip_tags(html_entity_decode(bbcode($rr['summary']), ENT_QUOTES, 'UTF-8'));
@@ -641,7 +626,7 @@ function process_events($arr) {
                        $html = format_event_html($rr);
                        $rr['desc'] = bbcode($rr['desc']);
                        $rr['location'] = bbcode($rr['location']);
-                       $events[] = array(
+                       $events[] = [
                                'id'     => $rr['id'],
                                'start'  => $start,
                                'end'    => $end,
@@ -656,8 +641,8 @@ function process_events($arr) {
                                'is_first' => $is_first,
                                'item'     => $rr,
                                'html'     => $html,
-                               'plink'    => array($rr['plink'], t('link to source'), '', ''),
-                       );
+                               'plink'    => [$rr['plink'], t('link to source'), '', ''],
+                       ];
                }
        }
 
@@ -672,9 +657,12 @@ function process_events($arr) {
  * @param string $timezone The timezone of the user (not implemented yet).
  *
  * @return string Content according to selected export format.
+ *
+ * @todo Implement timezone support
  */
-function event_format_export ($events, $format = 'ical', $timezone) {
-       if (! ((is_array($events)) && count($events))) {
+function event_format_export($events, $format = 'ical', $timezone)
+{
+       if (!((is_array($events)) && count($events))) {
                return;
        }
 
@@ -768,7 +756,7 @@ function event_format_export ($events, $format = 'ical', $timezone) {
 
 /**
  * @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.
@@ -861,12 +849,12 @@ function event_export($uid, $format = 'ical') {
                        $file_ext = "";
        }
 
-       $arr = array(
+       $arr = [
                'success'   => $process,
                'format'    => $format,
                'extension' => $file_ext,
                'content'   => $res,
-       );
+       ];
 
        return $arr;
 }
@@ -912,17 +900,17 @@ function widget_events() {
                return;
        }
 
-       return replace_macros(get_markup_template("events_aside.tpl"), array(
+       return replace_macros(get_markup_template("events_aside.tpl"), [
                '$etitle' => t("Export"),
                '$export_ical' => t("Export calendar as ical"),
                '$export_csv' => t("Export calendar as csv"),
                '$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.
  */
@@ -960,16 +948,16 @@ function format_event_item($item) {
 
        // Format the event location.
        $evloc = event_location2array($item['event-location']);
-       $location = array();
+       $location = [];
 
        if (isset($evloc['name'])) {
                $location['name'] = prepare_text($evloc['name']);
        }
        // Construct the map HTML.
        if (isset($evloc['address'])) {
-               $location['map'] = '<div class="map">' . generate_named_map($evloc['address']) . '</div>';
+               $location['map'] = '<div class="map">' . Map::byLocation($evloc['address']) . '</div>';
        } elseif (isset($evloc['coordinates'])) {
-               $location['map'] = '<div class="map">' . generate_map(str_replace('/', ' ', $evloc['coordinates'])) . '</div>';
+               $location['map'] = '<div class="map">' . Map::byCoordinates(str_replace('/', ' ', $evloc['coordinates'])) . '</div>';
        }
 
        // Construct the profile link (magic-auth).
@@ -977,10 +965,10 @@ function format_event_item($item) {
        $profile_link = best_link_url($item, $sp);
 
        if (!$sp) {
-               $profile_link = zrl($profile_link);
+               $profile_link = Profile::zrl($profile_link);
        }
 
-       $event = replace_macros(get_markup_template('event_stream_item.tpl'), array(
+       $event = replace_macros(get_markup_template('event_stream_item.tpl'), [
                '$id'             => $item['event-id'],
                '$title'          => prepare_text($item['event-summary']),
                '$dtstart_label'  => t('Starts:'),
@@ -1006,19 +994,19 @@ function format_event_item($item) {
                '$hide_map_label' => t('Hide map'),
                '$map_btn_label'  => t('Show map'),
                '$location'       => $location
-       ));
+       ]);
 
        return $event;
 }
 
 /**
  * @brief 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.
- * 
+ *
  * @param string $s The string with the bbcode formatted location data.
- * 
+ *
  * @return array The array with the location data.
  *  'name' => The name of the location,<br>
  * 'address' => The address of the location,<br>
@@ -1029,7 +1017,7 @@ function event_location2array($s = '') {
                return;
        }
 
-       $location = array('name' => $s);
+       $location = ['name' => $s];
 
        // Map tag with location name - e.g. [map]Paris[/map].
        if (strpos($s, '[/map]') !== false) {