plugins/BlankAd/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 images with one red pixel stretched to the
  39  * right size. It's 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 true (or anything non-null). For example, to make a leaderboard:
  43  *
  44  *     addPlugin('BlankAd', array('leaderboard' => true));
  45  *
  46  * @category Plugin
  47  * @package  StatusNet
  48  * @author   Evan Prodromou <evan@status.net>
  49  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  50  * @link     http://status.net/
  51  *
  52  * @seeAlso  Location
  53  */
  54
  55 class BlankAdPlugin extends UAPPlugin
  56 {
  57     /**
  58      * Show a medium rectangle 'ad'
  59      *
  60      * @param Action $action Action being shown
  61      *
  62      * @return void
  63      */
  64
  65     protected function showMediumRectangle($action)
  66     {
  67         $action->element('img',
  68                          array('width' => 300,
  69                                'height' => 250,
  70                                'src' => common_path('plugins/BlankAd/redpixel.png')),
  71                          '');
  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         $action->element('img',
  85                          array('width' => 180,
  86                                'height' => 150,
  87                                'src' => common_path('plugins/BlankAd/redpixel.png')),
  88                          '');
  89     }
  90
  91     /**
  92      * Show a wide skyscraper ad
  93      *
  94      * @param Action $action Action being shown
  95      *
  96      * @return void
  97      */
  98
  99     protected function showWideSkyscraper($action)
 100     {
 101         $action->element('img',
 102                          array('width' => 160,
 103                                'height' => 600,
 104                                'src' => common_path('plugins/BlankAd/redpixel.png')),
 105                          '');
 106     }
 107
 108     /**
 109      * Show a leaderboard ad
 110      *
 111      * @param Action $action Action being shown
 112      *
 113      * @return void
 114      */
 115
 116     protected function showLeaderboard($action)
 117     {
 118         $action->element('img',
 119                          array('width' => 728,
 120                                'height' => 90,
 121                                'src' => common_path('plugins/BlankAd/redpixel.png')),
 122                          '');
 123     }
 124 }