plugins/SiteNoticeInSidebar/SiteNoticeInSidebarPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Plugin to put the site notice in the sidebar
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Plugin
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Put the site notice in the sidebar
  39  *
  40  * @category  General
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class SiteNoticeInSidebarPlugin extends Plugin
  49 {
  50     /**
  51      * Function comment
  52      *
  53      * @param
  54      *
  55      * @return
  56      */
  57
  58     function onStartShowSiteNotice($action)
  59     {
  60         return false;
  61     }
  62
  63     function onStartShowSections(Action $action)
  64     {
  65         $text = common_config('site', 'notice');
  66         if (!empty($text)) {
  67             $sns = new SiteNoticeSection($action, $text);
  68             $sns->show();
  69         }
  70         return true;
  71     }
  72
  73     function onEndShowStyles($action)
  74     {
  75         $action->element('style', null, '#site_notice { width: 100% }');
  76         return true;
  77     }
  78 }