plugins/InfiniteScroll/InfiniteScrollPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to enable Infinite Scrolling
   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  Plugin
  23  * @package   StatusNet
  24  * @author    Craig Andrews <candrews@integralblue.com>
  25  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  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 class InfiniteScrollPlugin extends Plugin
  35 {
  36
  37     public $on_next_only = false;
  38
  39     function __construct()
  40     {
  41         parent::__construct();
  42     }
  43
  44     function onEndShowScripts(Action $action)
  45     {
  46         $action->inlineScript('var infinite_scroll_on_next_only = ' . ($this->on_next_only?'true':'false') . ';');
  47         $action->inlineScript('var ajax_loader_url = "' . ($this->path('ajax-loader.gif')) . '";');
  48         $action->script($this->path('jquery.infinitescroll.js'));
  49         $action->script($this->path('infinitescroll.js'));
  50     }
  51
  52     function onPluginVersion(array &$versions)
  53     {
  54         $versions[] = array('name' => 'InfiniteScroll',
  55                             'version' => GNUSOCIAL_VERSION,
  56                             'author' => 'Craig Andrews',
  57                             'homepage' => 'http://status.net/wiki/Plugin:InfiniteScroll',
  58                             'rawdescription' =>
  59                             // TRANS: Plugin dscription.
  60                             _m('Infinite Scroll adds the following functionality to your StatusNet installation: When a user scrolls towards the bottom of the page, the next page of notices is automatically retrieved and appended. This means they never need to click "Next Page", which dramatically increases stickiness.'));
  61         return true;
  62     }
  63 }