Merge branch 'nightly' into 'nightly'

[quix0rs-gnu-social.git] / actions / featured.php

diff --git a/actions/featured.php b/actions/featured.php
index 0356226914d1c3845f78d473ee14422ae4bcc55a..394cfe6a8b9ef456325179533a3e5c00dbb48cc5 100644 (file)
--- a/actions/featured.php
+++ b/actions/featured.php
@@ -1,67 +1,104 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * StatusNet, the distributed open-source microblogging tool
  *
- * This program is free software: you can redistribute it and/or modify
+ * List of featured users
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Affero General Public License for more details.
  *
  * You should have received a copy of the GNU Affero General Public License
- * along with this program.     If not, see <http://www.gnu.org/licenses/>.
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Public
+ * @package   StatusNet
+ * @author    Zach Copley <zach@status.net>
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2008-2009 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/stream.php');
-require_once(INSTALLDIR.'/lib/profilelist.php');
+require_once INSTALLDIR.'/lib/profilelist.php';
+require_once INSTALLDIR.'/lib/publicgroupnav.php';
 
-class FeaturedAction extends StreamAction
+/**
+ * List of featured users
+ *
+ * @category Public
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
+ * @author   Evan Prodromou <evan@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ */
+class FeaturedAction extends Action
 {
+    var $page = null;
 
-    function handle($args)
+    function isReadOnly($args)
     {
-        parent::handle($args);
+        return true;
+    }
 
-        $page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
+    function prepare($args)
+    {
+        parent::prepare($args);
+        $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
+
+        return true;
+    }
 
-        common_show_header(_('Featured users'),
-                           array($this, 'show_header'), null,
-                           array($this, 'show_top'));
+    function title()
+    {
+        if ($this->page == 1) {
+            // TRANS: Page title for first page of featured users.
+            return _('Featured users');
+        } else {
+            // TRANS: Page title for all but first page of featured users.
+            // TRANS: %d is the page number being displayed.
+            return sprintf(_('Featured users, page %d'), $this->page);
+        }
+    }
 
-        $this->show_notices($page);
+    function handle($args)
+    {
+        parent::handle($args);
 
-        common_show_footer();
+        $this->showPage();
     }
 
-    function show_top()
+    function showPageNotice()
     {
-        $instr = $this->get_instructions();
+        $instr = $this->getInstructions();
         $output = common_markup_to_html($instr);
         $this->elementStart('div', 'instructions');
         $this->raw($output);
         $this->elementEnd('div');
-        $this->public_views_menu();
     }
 
-    function show_header()
+    function getInstructions()
     {
+        // TRANS: Description on page displaying featured users.
+        return sprintf(_('A selection of some great users on %s.'),
+                       common_config('site', 'name'));
     }
 
-    function get_instructions()
+    function showContent()
     {
-        return _('Featured users');
-    }
-
-    function show_notices($page)
-    {
-
         // XXX: Note I'm doing it this two-stage way because a raw query
         // with a JOIN was *not* working. --Zach
 
@@ -77,8 +114,8 @@ class FeaturedAction extends StreamAction
 
             $user = new User;
             $user->whereAdd(sprintf('nickname IN (%s)', implode(',', $quoted)));
-            $user->limit(($page - 1) * PROFILES_PER_PAGE, PROFILES_PER_PAGE + 1);
-            $user->orderBy('user.nickname ASC');
+            $user->limit(($this->page - 1) * PROFILES_PER_PAGE, PROFILES_PER_PAGE + 1);
+            $user->orderBy(common_database_tablename('user') .'.nickname ASC');
 
             $user->find();
 
@@ -95,14 +132,14 @@ class FeaturedAction extends StreamAction
             $cnt = $profile->find();
 
             if ($cnt > 0) {
-                $featured = new ProfileList($profile);
-                $featured->show_list();
+                $featured = new ProfileList($profile, $this);
+                $featured->show();
             }
 
             $profile->free();
 
-            common_pagination($page > 1, $cnt > PROFILES_PER_PAGE, $page, 'featured');
+            $this->pagination($this->page > 1, $cnt > PROFILES_PER_PAGE,
+                              $this->page, 'featured');
         }
     }
-
-}
\ No newline at end of file
+}