lib/tagcloudsection.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for sections showing tag clouds
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Widget
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 define('TAGS_PER_SECTION', 10);
  35
  36 /**
  37  * Base class for sections
  38  *
  39  * These are the widgets that show interesting data about a person
  40  * group, or site.
  41  *
  42  * @category Widget
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46  * @link     http://status.net/
  47  */
  48 class TagCloudSection extends Section
  49 {
  50     function showContent()
  51     {
  52         $tags = $this->getTags();
  53         //* NOISY-DEBUG: */ common_debug('[' . __METHOD__ . ':' . __LINE__ . '] tags[]=' . gettype($tags));
  54
  55         if (!$tags) {
  56             // TRANS: Content displayed in a tag cloud section if there are no tags.
  57             $this->out->element('p', null, _m('NOTAGS','None'));
  58             return false;
  59         }
  60
  61         $cnt = 0;
  62
  63         $tw = array();
  64         $sum = 0;
  65
  66         while ($tags->fetch() && ++$cnt <= TAGS_PER_SECTION) {
  67             // Check scope of tag to current profile (including guests)
  68             if ($tags->isCurrentProfileInScope()) {
  69                 $tw[$tags->tag] = $tags->weight;
  70                 $sum += $tags->weight;
  71             }
  72         }
  73
  74         if ($cnt == 0) {
  75             // TRANS: Content displayed in a tag cloud section if there are no tags.
  76             $this->out->element('p', null, _m('NOTAGS','None'));
  77             return false;
  78         }
  79
  80         ksort($tw);
  81
  82         $this->out->elementStart('ul', 'tags xoxo tag-cloud');
  83         foreach ($tw as $tag => $weight) {
  84             $this->showTag($tag, $weight, ($sum == 0) ? 0 : $weight/$sum);
  85         }
  86         $this->out->elementEnd('ul');
  87
  88         return ($cnt > TAGS_PER_SECTION);
  89     }
  90
  91     function getTags()
  92     {
  93         return null;
  94     }
  95
  96     function showTag($tag, $weight, $relative)
  97     {
  98         if ($relative > 0.1) {
  99             $rel =  'tag-cloud-7';
 100         } else if ($relative > 0.05) {
 101             $rel = 'tag-cloud-6';
 102         } else if ($relative > 0.02) {
 103             $rel = 'tag-cloud-5';
 104         } else if ($relative > 0.01) {
 105             $rel = 'tag-cloud-4';
 106         } else if ($relative > 0.005) {
 107             $rel = 'tag-cloud-3';
 108         } else if ($relative > 0.002) {
 109             $rel = 'tag-cloud-2';
 110         } else {
 111             $rel = 'tag-cloud-1';
 112         }
 113
 114         $this->out->elementStart('li', $rel);
 115         $this->out->element('a', array('href' => $this->tagUrl($tag)),
 116                        $tag);
 117         $this->out->elementEnd('li');
 118     }
 119
 120     function tagUrl($tag)
 121     {
 122         if ($this->out instanceof ShowstreamAction) {
 123             return common_local_url('showstream', array('nickname' => $this->out->getTarget()->getNickname(), 'tag' => $tag));
 124         }
 125         return common_local_url('tag', array('tag' => $tag));
 126     }
 127
 128     function divId()
 129     {
 130         return 'tagcloud';
 131     }
 132 }