gnu-social/DOCUMENTATION/DEVELOPERS/Plugins/Sample Plugins/Awesomeness/includes/AwesomenessPlugin.php

91 lines
3.0 KiB
PHP
Raw Normal View History

2010-11-20 14:14:12 +00:00
<?php
2019-08-04 12:01:49 +01:00
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
2010-11-20 14:14:12 +00:00
2019-08-04 12:01:49 +01:00
defined('GNUSOCIAL') || die();
2010-11-20 14:14:12 +00:00
/**
* Fun sample plugin: tweaks input data and adds a 'Cornify' widget to sidebar.
2010-11-20 14:14:12 +00:00
*
* @category Plugin
2019-08-04 12:01:49 +01:00
* @package GNUsocial
2010-11-20 14:14:12 +00:00
* @author Jeroen De Dauw <jeroendedauw@gmail.com>
2019-08-04 12:01:49 +01:00
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2010-11-20 14:14:12 +00:00
*/
class AwesomenessPlugin extends Plugin
{
2019-08-04 12:01:49 +01:00
const PLUGIN_VERSION = '13.37.42';
public function onPluginVersion(array &$versions): bool
2010-11-20 14:14:12 +00:00
{
2019-08-04 12:01:49 +01:00
$versions[] = [
2010-11-20 14:14:12 +00:00
'name' => 'Awesomeness',
'version' => self::PLUGIN_VERSION,
2010-11-20 14:14:12 +00:00
'author' => 'Jeroen De Dauw',
'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/Awesomeness',
// TRANS: Plugin description for a sample plugin.
2011-06-05 10:12:34 +01:00
'rawdescription' => _m('The Awesomeness plugin adds additional awesomeness ' .
2019-08-04 12:01:49 +01:00
'to a GNU social installation.')
];
2010-11-20 14:14:12 +00:00
return true;
}
2010-11-20 14:14:12 +00:00
/**
* Add the conrnify button
*
* @param Action $action the current action
*
* @return void
*/
2019-08-04 12:01:49 +01:00
public function onEndShowSections(Action $action)
{
2019-08-04 12:01:49 +01:00
$action->elementStart('div', ['id' => 'cornify_section',
'class' => 'section']);
2011-04-06 14:12:56 +01:00
$action->raw(
2019-08-04 12:01:49 +01:00
<<<EOT
<a href="https://www.cornify.com" onclick="cornify_add();return false;">
<img src="https://www.cornify.com/assets/cornify.gif" width="61" height="16" border="0" alt="Cornify" />
2011-04-06 14:12:56 +01:00
</a>
2010-11-20 14:14:12 +00:00
EOT
2011-04-06 14:12:56 +01:00
);
2011-04-06 14:12:56 +01:00
$action->elementEnd('div');
2010-11-20 14:14:12 +00:00
}
2019-08-04 12:01:49 +01:00
public function onEndShowScripts(Action $action)
{
$action->script($this->path('js/cornify.js'));
}
2010-11-20 14:14:12 +00:00
/**
* Hook for new-notice form processing to take our HTML goodies;
* won't affect API posting etc.
*
2010-11-20 14:14:12 +00:00
* @param NewNoticeAction $action
* @param User $user
* @param string $content
* @param array $options
2019-08-04 12:01:49 +01:00
* @return bool hook return
2010-11-20 14:14:12 +00:00
*/
2019-08-04 12:01:49 +01:00
public function onStartSaveNewNoticeWeb($action, $user, &$content, &$options)
2010-11-20 14:14:12 +00:00
{
2011-04-06 14:12:56 +01:00
$content = htmlspecialchars($content);
$options['rendered'] = preg_replace("/(^|\s|-)((?:awesome|awesomeness)[\?!\.\,]?)(\s|$)/i", " <b>$2</b> ", $content);
2010-11-20 14:14:12 +00:00
}
}