gnu-social/plugins/ProfileColor/ProfileColor.php

95 lines
3.1 KiB
PHP
Raw Permalink Normal View History

<?php
declare(strict_types = 1);
// {{{ License
// 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/>.
// }}}
namespace Plugin\ProfileColor;
2021-12-12 17:02:55 +00:00
use App\Core\Cache;
2020-12-18 19:45:45 +00:00
use App\Core\DB\DB;
use App\Core\Event;
use App\Core\Modules\Plugin;
use App\Core\Router\RouteLoader;
use App\Util\Exception\RedirectException;
use App\Util\Exception\ServerException;
use App\Util\Formatting;
use Plugin\ProfileColor\Controller as C;
use Symfony\Component\HttpFoundation\Request;
/**
* Profile Color plugin main class
*
* @package GNUsocial
* @category ProfileColor
*
* @author Daniel Brandao <up201705812@fe.up.pt>
* @author Eliseu Amaro <mail@eliseuama.ro>
* @copyright 2020 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class ProfileColor extends Plugin
{
/**
* Map URLs to actions
*
* @return bool hook value; true means continue processing, false means stop
*/
public function onAddRoute(RouteLoader $r): bool
{
$r->connect('settings_profile_color', 'settings/color', [Controller\ProfileColor::class, 'profileColorSettings']);
return Event::next;
}
/**
* @throws RedirectException
* @throws ServerException
*/
public function onPopulateSettingsTabs(Request $request, string $section, array &$tabs): bool
{
if ($section === 'colours') {
$tabs[] = [
'title' => 'Profile Colour',
'desc' => 'Change your profile colour.',
'id' => 'settings-profile-colour-details',
'controller' => C\ProfileColor::profileColorSettings($request),
];
}
return Event::next;
}
/**
* Renders profileColorView, which changes the background color of that profile.
*/
public function onAppendCardProfile(array $vars, array &$res): bool
{
$actor = $vars['actor'];
if ($actor !== null) {
$actor_id = $actor->getId();
$profile_color = Cache::get("profile-color-{$actor_id}", fn () => DB::findOneBy('profile_color', ['actor_id' => $actor_id], return_null: true));
if (!\is_null($profile_color)) {
$res[] = Formatting::twigRenderFile('/profileColor/profileColorView.html.twig', ['profile_color' => $profile_color, 'actor' => $actor_id]);
}
}
return Event::next;
}
}