tag cloud: add doxygen docu

[friendica.git] / include / tags.php

diff --git a/include/tags.php b/include/tags.php
index de716edef0b5d6052af6844c81a7b0284fc20d63..6c13b82962f9e0b6103b5a8628f667d2e63432ed 100644 (file)
--- a/include/tags.php
+++ b/include/tags.php
@@ -1,9 +1,12 @@
 <?php
 
 use Friendica\App;
+use Friendica\Core\System;
+use Friendica\Database\DBM;
+use Friendica\Object\Contact;
 
 function create_tags_from_item($itemid) {
-       $profile_base = App::get_baseurl();
+       $profile_base = System::baseUrl();
        $profile_data = parse_url($profile_base);
        $profile_base_friendica = $profile_data['host'].$profile_data['path']."/profile/";
        $profile_base_diaspora = $profile_data['host'].$profile_data['path']."/u/";
@@ -147,3 +150,166 @@ function update_items() {
 
        dba::close($messages);
 }
+
+/**
+ * @brief Get alphabetical sorted array of used tags/terms of an user including
+ * a weighting by frequency of use.
+ * 
+ * @param int $uid      The user ID.
+ * @param int $count    Max number of displayed tags/terms.
+ * @param int $owner_id The contact id of the owner of the tagged items.
+ * @param string $flags Special item flags.
+ * @param int $type     The tag/term type.
+ * 
+ * @return arr          Alphabetical sorted array of used tags of an user.
+ */
+function tagadelic($uid, $count = 0, $owner_id = 0, $flags = '', $type = TERM_HASHTAG) {
+       require_once('include/security.php');
+
+       $item_condition = item_condition();
+       $sql_options = item_permissions_sql($uid);
+       $count = intval($count);
+       if ($flags) {
+               if ($flags === 'wall') {
+                       $sql_options .= " AND `item`.`wall` ";
+               }
+       }
+
+       if ($owner_id) {
+               $sql_options .= " AND `item`.`owner-id` = ".intval($owner_id)." ";
+       }
+
+       // Fetch tags
+       $r = q("SELECT `term`, COUNT(`term`) AS `total` FROM `term`
+               LEFT JOIN `item` ON `term`.`oid` = `item`.`id`
+               WHERE `term`.`uid` = %d AND `term`.`type` = %d
+               AND `term`.`otype` = %d
+               AND $item_condition $sql_options
+               GROUP BY `term` ORDER BY `total` DESC %s",
+               intval($uid),
+               intval($type),
+               intval(TERM_OBJ_POST),
+               ((intval($count)) ? "LIMIT $count" : '')
+       );
+       if(!DBM::is_result($r)) {
+               return array();
+       }
+               
+       return tag_calc($r);
+}
+
+/**
+ * @brief Construct a tag/term cloud block for an user.
+ * 
+ * @param int $uid      The user ID.
+ * @param int $count    Max number of displayed tags/terms.
+ * @param int $owner_id The contact ID of the owner of the tagged items.
+ * @param string $flags Special item flags.
+ * @param int $type     The tag/term type.
+ * 
+ * @return string       HTML formatted output.
+ */
+function wtagblock($uid, $count = 0,$owner_id = 0, $flags = '', $type = TERM_HASHTAG) {
+       $o = '';
+       $r = tagadelic($uid, $count, $owner_id, $flags, $type);
+       if (count($r)) {
+               $contact = dba::select(
+                       "contact",
+                       array("url"),
+                       array("id" => $uid),
+                       array("limit" => 1)
+               );
+               $url = System::removedBaseUrl($contact['url']);
+
+               foreach ($r as $rr) {
+                       $tag['level'] = $rr[2];
+                       $tag['url'] = $url."?tag=".urlencode($rr[0]);
+                       $tag['name'] = $rr[0];
+
+                       $tags[] = $tag;
+               }
+
+               $tpl = get_markup_template("tagblock_widget.tpl");
+               $o = replace_macros($tpl, array(
+                       '$title' => t('Tags'),
+                       '$tags'  => $tags
+               ));
+
+       }
+       return $o;
+}
+
+/**
+ * @brief Calculate weighting of tags according to the frequency of use.
+ * 
+ * @param array $arr Array of tags/terms with tag/term name and total count of use.
+ * @return array     Alphabetical sorted array of used tags/terms of an user.
+ */
+function tag_calc($arr) {
+       $tags = array();
+       $min = 1e9;
+       $max = -1e9;
+       $x = 0;
+
+       if (!$arr) {
+               return array();
+       }
+
+       foreach ($arr as $rr) {
+               $tags[$x][0] = $rr['term'];
+               $tags[$x][1] = log($rr['total']);
+               $tags[$x][2] = 0;
+               $min = min($min, $tags[$x][1]);
+               $max = max($max, $tags[$x][1]);
+               $x ++;
+       }
+
+       usort($tags, 'tags_sort');
+       $range = max(.01, $max - $min) * 1.0001;
+
+       for ($x = 0; $x < count($tags); $x ++) {
+               $tags[$x][2] = 1 + floor(9 * ($tags[$x][1] - $min) / $range);
+       }
+
+       return $tags;
+}
+
+/**
+ * @brief Compare function to sort tags/terms alphabetically.
+ * 
+ * @param type $a
+ * @param type $b
+ * 
+ * @return int
+ */
+function tags_sort($a, $b) {
+       if (strtolower($a[0]) == strtolower($b[0])) {
+               return 0;
+       }
+       return ((strtolower($a[0]) < strtolower($b[0])) ? -1 : 1);
+}
+
+/**
+ * @brief Insert a tag cloud widget for the present profile.
+ * 
+ * @param int     $limit Max number of displayed tags.
+ * @return string HTML formattat output.
+ */
+function tagcloud_wall_widget($limit = 50) {
+       $a = get_app();
+
+       if(!$a->profile['profile_uid'] || !$a->profile['url']) {
+               return "";
+       }
+
+       if(feature_enabled($a->profile['profile_uid'], 'tagadelic')) {
+               $owner_id = Contact::getIdForURL($a->profile['url']);
+
+               if(!$owner_id) {
+                       return "";
+               }
+               return wtagblock($a->profile['profile_uid'], $limit, $owner_id, 'wall');
+       }
+
+       return "";
+}