Code standards in api_get_user

[friendica.git] / include / tags.php

diff --git a/include/tags.php b/include/tags.php
index 8a6b3ba7468a8ef5efc908f81e71c79477cd2337..8d8fb765595ddd9f90f84325c94500db2abd0bc2 100644 (file)
--- a/include/tags.php
+++ b/include/tags.php
@@ -1,9 +1,12 @@
 <?php
-
+/**
+ * @file include/tags.php
+ */
 use Friendica\App;
+use Friendica\Content\Feature;
 use Friendica\Core\System;
 use Friendica\Database\DBM;
-use Friendica\Object\Contact;
+use Friendica\Model\Contact;
 
 function create_tags_from_item($itemid) {
        $profile_base = System::baseUrl();
@@ -151,12 +154,25 @@ function update_items() {
        dba::close($messages);
 }
 
-function tagadelic($uid, $count = 0, $owner_id = 0, $flags = 0, $type = TERM_HASHTAG) {
+/**
+ * @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);
+       $limit = $count ? sprintf("LIMIT %d", intval($count)) : "";
+
        if ($flags) {
                if ($flags === 'wall') {
                        $sql_options .= " AND `item`.`wall` ";
@@ -168,32 +184,42 @@ function tagadelic($uid, $count = 0, $owner_id = 0, $flags = 0, $type = TERM_HAS
        }
 
        // Fetch tags
-       $r = q("SELECT `term`, COUNT(`term`) AS `total` FROM `term`
+       $r = dba::p("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`.`private` = 0
-               $sql_options AND $item_condition
-               GROUP BY `term` ORDER BY `total` DESC %s",
-               intval($uid),
-               intval($type),
-               intval(TERM_OBJ_POST),
-               ((intval($count)) ? "LIMIT $count" : '')
+               WHERE `term`.`uid` = ? AND `term`.`type` = ?
+               AND `term`.`otype` = ?
+               AND $item_condition $sql_options
+               GROUP BY `term` ORDER BY `total` DESC $limit",
+               $uid,
+               $type,
+               TERM_OBJ_POST
        );
        if(!DBM::is_result($r)) {
                return array();
        }
-               
+
        return tag_calc($r);
 }
 
-function wtagblock($uid, $count = 0,$owner_id = 0, $flags = 0, $type = TERM_HASHTAG) {
+/**
+ * @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($r && $owner_id) {
+       if (count($r)) {
                $contact = dba::select(
                        "contact",
                        array("url"),
-                       array("id" => $owner_id),
+                       array("id" => $uid),
                        array("limit" => 1)
                );
                $url = System::removedBaseUrl($contact['url']);
@@ -216,6 +242,12 @@ function wtagblock($uid, $count = 0,$owner_id = 0, $flags = 0, $type = TERM_HASH
        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;
@@ -245,24 +277,35 @@ function tag_calc($arr) {
        return $tags;
 }
 
-function tags_sort($a,$b) {
+/**
+ * @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);
+       return ((strtolower($a[0]) < strtolower($b[0])) ? -1 : 1);
 }
 
-
-function tagcloud_wall_widget($arr = array()) {
+/**
+ * @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 "";
        }
 
-       $limit = ((array_key_exists('limit', $arr)) ? intval($arr['limit']) : 50);
-
-       if(feature_enabled($a->profile['profile_uid'], 'tagadelic')) {
+       if(Feature::isEnabled($a->profile['profile_uid'], 'tagadelic')) {
                $owner_id = Contact::getIdForURL($a->profile['url']);
 
                if(!$owner_id) {