. * * @category Action * @package StatusNet * @author Sarven Capadisli * @author Evan Prodromou * @copyright 2010 StatusNet, Inc. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } /** * Abstract superclass for advertising plugins * * Plugins for showing ads should derive from this plugin. * * Outputs the following ad types (based on UAP): * * Medium Rectangle 300x250 * Rectangle 180x150 * Leaderboard 728x90 * Wide Skyscraper 160x600 * * @category Plugin * @package StatusNet * @author Sarven Capadisli * @author Evan Prodromou * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ abstract class UAPPlugin extends Plugin { public $MediumRectangle = null; public $Rectangle = null; public $Leaderboard = null; public $WideSkyscraper = null; /** * Output our dedicated stylesheet * * @param Action $action Action being shown * * @return boolean hook flag */ function onEndShowStatusNetStyles($action) { // XXX: allow override by theme $action->cssLink('css/uap.css', 'base', 'screen, projection, tv'); return true; } /** * Add a medium rectangle ad at the beginning of sidebar * * @param Action $action Action being shown * * @return boolean hook flag */ function onStartShowAside($action) { if (!is_null($this->mediumRectangle)) { $action->elementStart('div', array('id' => 'ad_medium-rectangle', 'class' => 'ad')); $this->showMediumRectangle($action); $action->elementEnd('div'); } return true; } /** * Add a leaderboard in the header * * @param Action $action Action being shown * * @return boolean hook flag */ function onEndShowHeader($action) { if (!is_null($this->leaderboard)) { $action->elementStart('div', array('id' => 'ad_leaderboard', 'class' => 'ad')); $this->showLeaderboard($action); $action->elementEnd('div'); } return true; } /** * Add a rectangle before aside sections * * @param Action $action Action being shown * * @return boolean hook flag */ function onStartShowSections($action) { if (!is_null($this->rectangle)) { $action->elementStart('div', array('id' => 'ad_rectangle', 'class' => 'ad')); $this->showRectangle($action); $action->elementEnd('div'); } return true; } /** * Add a wide skyscraper after the aside * * @param Action $action Action being shown * * @return boolean hook flag */ function onEndShowAside($action) { if (!is_null($this->wideSkyscraper)) { $action->elementStart('div', array('id' => 'ad_wide-skyscraper', 'class' => 'ad')); $this->showWideSkyscraper($action); $action->elementEnd('div'); } return true; } /** * Show a medium rectangle ad * * @param Action $action Action being shown * * @return void */ abstract protected function showMediumRectangle($action); /** * Show a rectangle ad * * @param Action $action Action being shown * * @return void */ abstract protected function showRectangle($action); /** * Show a wide skyscraper ad * * @param Action $action Action being shown * * @return void */ abstract protected function showWideSkyscraper($action); /** * Show a leaderboard ad * * @param Action $action Action being shown * * @return void */ abstract protected function showLeaderboard($action); }