lib/uapplugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * UAP (Universal Ad Package) plugin
   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  Action
  23  * @package   StatusNet
  24  * @author    Sarven Capadisli <csarven@status.net>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Abstract superclass for advertising plugins
  37  *
  38  * Plugins for showing ads should derive from this plugin.
  39  *
  40  * Outputs the following ad types (based on UAP):
  41  *
  42  * Medium Rectangle 300x250
  43  * Rectangle        180x150
  44  * Leaderboard      728x90
  45  * Wide Skyscraper  160x600
  46  *
  47  * @category Plugin
  48  * @package  StatusNet
  49  * @author   Sarven Capadisli <csarven@status.net>
  50  * @author   Evan Prodromou <evan@status.net>
  51  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  52  * @link     http://status.net/
  53  */
  54
  55 abstract class UAPPlugin extends Plugin
  56 {
  57     public $mediumRectangle = null;
  58     public $rectangle       = null;
  59     public $leaderboard     = null;
  60     public $wideSkyscraper  = null;
  61
  62     /**
  63      * Output our dedicated stylesheet
  64      *
  65      * @param Action $action Action being shown
  66      *
  67      * @return boolean hook flag
  68      */
  69
  70     function onEndShowStatusNetStyles($action)
  71     {
  72         // XXX: allow override by theme
  73         $action->cssLink('css/uap.css', 'base', 'screen, projection, tv');
  74         return true;
  75     }
  76
  77     /**
  78      * Add a medium rectangle ad at the beginning of sidebar
  79      *
  80      * @param Action $action Action being shown
  81      *
  82      * @return boolean hook flag
  83      */
  84
  85     function onStartShowAside($action)
  86     {
  87         if (!is_null($this->mediumRectangle)) {
  88
  89             $action->elementStart('div',
  90                                   array('id' => 'ad_medium-rectangle',
  91                                         'class' => 'ad'));
  92
  93             $this->showMediumRectangle($action);
  94
  95             $action->elementEnd('div');
  96         }
  97
  98         return true;
  99     }
 100
 101     /**
 102      * Add a leaderboard in the header
 103      *
 104      * @param Action $action Action being shown
 105      *
 106      * @return boolean hook flag
 107      */
 108
 109     function onEndShowHeader($action)
 110     {
 111         if (!is_null($this->leaderboard)) {
 112             $action->elementStart('div',
 113                                   array('id' => 'ad_leaderboard',
 114                                         'class' => 'ad'));
 115             $this->showLeaderboard($action);
 116             $action->elementEnd('div');
 117         }
 118
 119         return true;
 120     }
 121
 122     /**
 123      * Add a rectangle before aside sections
 124      *
 125      * @param Action $action Action being shown
 126      *
 127      * @return boolean hook flag
 128      */
 129
 130     function onStartShowSections($action)
 131     {
 132         if (!is_null($this->rectangle)) {
 133             $action->elementStart('div',
 134                                   array('id' => 'ad_rectangle',
 135                                         'class' => 'ad'));
 136             $this->showRectangle($action);
 137             $action->elementEnd('div');
 138         }
 139
 140         return true;
 141     }
 142
 143     /**
 144      * Add a wide skyscraper after the aside
 145      *
 146      * @param Action $action Action being shown
 147      *
 148      * @return boolean hook flag
 149      */
 150
 151     function onEndShowAside($action)
 152     {
 153         if (!is_null($this->wideSkyscraper)) {
 154             $action->elementStart('div',
 155                                   array('id' => 'ad_wide-skyscraper',
 156                                         'class' => 'ad'));
 157
 158             $this->showWideSkyscraper($action);
 159
 160             $action->elementEnd('div');
 161         }
 162         return true;
 163     }
 164
 165     /**
 166      * Show a medium rectangle ad
 167      *
 168      * @param Action $action Action being shown
 169      *
 170      * @return void
 171      */
 172
 173     abstract protected function showMediumRectangle($action);
 174
 175     /**
 176      * Show a rectangle ad
 177      *
 178      * @param Action $action Action being shown
 179      *
 180      * @return void
 181      */
 182
 183     abstract protected function showRectangle($action);
 184
 185     /**
 186      * Show a wide skyscraper ad
 187      *
 188      * @param Action $action Action being shown
 189      *
 190      * @return void
 191      */
 192
 193     abstract protected function showWideSkyscraper($action);
 194
 195     /**
 196      * Show a leaderboard ad
 197      *
 198      * @param Action $action Action being shown
 199      *
 200      * @return void
 201      */
 202
 203     abstract protected function showLeaderboard($action);
 204 }