gnu-social/lib/uapplugin.php

214 lines
5.7 KiB
PHP
Raw Normal View History

<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* UAP (Universal Ad Package) plugin
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Action
* @package StatusNet
* @author Sarven Capadisli <csarven@status.net>
2010-01-27 12:19:36 +00:00
* @author Evan Prodromou <evan@status.net>
* @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')) {
exit(1);
}
/**
2010-01-27 12:19:36 +00:00
* Abstract superclass for advertising plugins
*
* Plugins for showing ads should derive from this plugin.
*
* Outputs the following ad types (based on UAP):
2010-01-27 12:19:36 +00:00
*
* Medium Rectangle 300x250
* Rectangle 180x150
* Leaderboard 728x90
* Wide Skyscraper 160x600
*
* @category Plugin
* @package StatusNet
* @author Sarven Capadisli <csarven@status.net>
2010-01-27 12:19:36 +00:00
* @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
2010-01-27 12:19:36 +00:00
abstract class UAPPlugin extends Plugin
{
2010-01-27 15:45:44 +00:00
public $mediumRectangle = null;
public $rectangle = null;
public $leaderboard = null;
public $wideSkyscraper = null;
2010-01-27 12:19:36 +00:00
/**
* Output our dedicated stylesheet
*
* @param Action $action Action being shown
*
* @return boolean hook flag
*/
public function onEndShowStylesheets(Action $action)
{
2010-01-27 12:19:36 +00:00
// XXX: allow override by theme
$action->cssLink('css/uap.css', 'base', 'screen, projection, tv');
return true;
}
2010-01-27 12:19:36 +00:00
/**
* Add a medium rectangle ad at the beginning of sidebar
*
* @param Action $action Action being shown
*
* @return boolean hook flag
*/
function onStartShowAside(Action $action)
{
2010-01-27 12:19:36 +00:00
if (!is_null($this->mediumRectangle)) {
2010-01-27 12:19:36 +00:00
$action->elementStart('div',
2010-01-27 13:13:24 +00:00
array('id' => 'ad_medium-rectangle',
'class' => 'ad'));
2010-01-27 12:19:36 +00:00
$this->showMediumRectangle($action);
2010-01-27 12:19:36 +00:00
$action->elementEnd('div');
}
// XXX: Hack to force ads to show on single-notice pages
if (!is_null($this->rectangle) &&
$action->trimmed('action') == 'shownotice') {
$action->elementStart('div', array('id' => 'aside_primary',
'class' => 'aside'));
if (Event::handle('StartShowSections', array($action))) {
$action->showSections();
Event::handle('EndShowSections', array($action));
}
$action->elementEnd('div');
return false;
}
return true;
}
2010-01-27 12:19:36 +00:00
/**
* Add a leaderboard in the header
2010-01-27 12:19:36 +00:00
*
* @param Action $action Action being shown
*
* @return boolean hook flag
*/
2010-01-27 15:44:49 +00:00
function onEndShowHeader($action)
{
2010-01-27 12:19:36 +00:00
if (!is_null($this->leaderboard)) {
$action->elementStart('div',
2010-01-27 13:13:24 +00:00
array('id' => 'ad_leaderboard',
'class' => 'ad'));
2010-01-27 12:19:36 +00:00
$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 $action)
{
2010-01-27 12:19:36 +00:00
if (!is_null($this->rectangle)) {
$action->elementStart('div',
2010-01-27 13:13:24 +00:00
array('id' => 'ad_rectangle',
'class' => 'ad'));
2010-01-27 12:19:36 +00:00
$this->showRectangle($action);
$action->elementEnd('div');
}
return true;
}
2010-01-27 12:19:36 +00:00
/**
* Add a wide skyscraper after the aside
*
* @param Action $action Action being shown
*
* @return boolean hook flag
*/
function onEndShowAside(Action $action)
{
2010-01-27 12:19:36 +00:00
if (!is_null($this->wideSkyscraper)) {
$action->elementStart('div',
2010-01-27 13:13:24 +00:00
array('id' => 'ad_wide-skyscraper',
'class' => 'ad'));
2010-01-27 12:19:36 +00:00
$this->showWideSkyscraper($action);
2010-01-27 12:19:36 +00:00
$action->elementEnd('div');
}
return true;
}
2010-01-27 12:19:36 +00:00
/**
* 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);
}