plugins/BlankAdPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin for testing ad layout
   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  Ads
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2010 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')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Plugin for testing ad layout
  36  *
  37  * This plugin uses the UAPPlugin framework to output ad content. However,
  38  * its ad content is just paragraphs with defined background colors. It's
  39  * mostly useful for debugging theme layout.
  40  *
  41  * To use this plugin, set the parameter for the ad size you want to use
  42  * to the background you want to use. For example, to make a leaderboard
  43  * that's red:
  44  *
  45  *     addPlugin('BlankAd', array('leaderboard' => 'red'));
  46  *
  47  * @category Plugin
  48  * @package  StatusNet
  49  * @author   Evan Prodromou <evan@status.net>
  50  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  51  * @link     http://status.net/
  52  *
  53  * @seeAlso  Location
  54  */
  55
  56 class BlankAdPlugin extends UAPPlugin
  57 {
  58     /**
  59      * Show a medium rectangle 'ad'
  60      *
  61      * @param Action $action Action being shown
  62      *
  63      * @return void
  64      */
  65
  66     protected function showMediumRectangle($action)
  67     {
  68         $style = 'width: 300px; height: 250px; background-color: ' .
  69           $this->mediumRectangle;
  70
  71         $action->element('p', array('style' => $style), '');
  72     }
  73
  74     /**
  75      * Show a rectangle 'ad'
  76      *
  77      * @param Action $action Action being shown
  78      *
  79      * @return void
  80      */
  81
  82     protected function showRectangle($action)
  83     {
  84         $style = 'width: 180px; height: 150px; background-color: ' .
  85           $this->rectangle;
  86
  87         $action->element('p', array('style' => $style), '');
  88     }
  89
  90     /**
  91      * Show a wide skyscraper ad
  92      *
  93      * @param Action $action Action being shown
  94      *
  95      * @return void
  96      */
  97
  98     protected function showWideSkyscraper($action)
  99     {
 100         $style = 'width: 160px; height: 600px; background-color: ' .
 101           $this->wideSkyscraper;
 102
 103         $action->element('p', array('style' => $style), '');
 104     }
 105
 106     /**
 107      * Show a leaderboard ad
 108      *
 109      * @param Action $action Action being shown
 110      *
 111      * @return void
 112      */
 113
 114     protected function showLeaderboard($action)
 115     {
 116         $style = 'width: 728px; height: 90px; background-color: ' .
 117           $this->leaderboard;
 118
 119         $action->element('p', array('style' => $style), '');
 120     }
 121 }