136 lines
4.7 KiB
PHP
136 lines
4.7 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* This file is part of the TYPO3 CMS project.
|
|
*
|
|
* It is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU General Public License, either version 2
|
|
* of the License, or any later version.
|
|
*
|
|
* For the full copyright and license information, please read the
|
|
* LICENSE.txt file that was distributed with this source code.
|
|
*
|
|
* The TYPO3 project - inspiring people to share!
|
|
*/
|
|
|
|
namespace TYPO3\CMS\Backend\Backend\Avatar;
|
|
|
|
use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
|
|
use Symfony\Component\DependencyInjection\Attribute\Autowire;
|
|
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
|
|
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
|
|
use TYPO3\CMS\Core\Imaging\IconFactory;
|
|
use TYPO3\CMS\Core\Imaging\IconSize;
|
|
use TYPO3\CMS\Core\Service\DependencyOrderingService;
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
use TYPO3\CMS\Core\Utility\PathUtility;
|
|
|
|
/**
|
|
* Main class to render an avatar image of a certain Backend user, resolving any avatar provider
|
|
* that takes care of fetching the image.
|
|
*
|
|
* See render() and getImgTag() as main entry points
|
|
*/
|
|
#[Autoconfigure(public: true)]
|
|
readonly class Avatar
|
|
{
|
|
/**
|
|
* @param list<AvatarProviderInterface> $avatarProviders
|
|
*/
|
|
public function __construct(
|
|
#[Autowire(service: 'cache.runtime')]
|
|
protected FrontendInterface $cache,
|
|
protected DependencyOrderingService $dependencyOrderingService,
|
|
protected IconFactory $iconFactory,
|
|
protected array $avatarProviders = [],
|
|
) {
|
|
$this->validateAvatarProviders();
|
|
}
|
|
|
|
/**
|
|
* Renders an avatar based on a Fluid template which contains some base wrapper css classes.
|
|
* Has a simple caching functionality. Used in Avatar ViewHelper for instance.
|
|
* Renders avatar of a given backend user record, or of current logged-in backend user.
|
|
*/
|
|
public function render(?array $backendUser = null, int $size = 32, bool $showIcon = false): string
|
|
{
|
|
if (!is_array($backendUser)) {
|
|
/** @var array $backendUser */
|
|
$backendUser = $this->getBackendUser()->user;
|
|
}
|
|
$cacheId = 'avatar_' . sha1($backendUser['uid'] . $size . $showIcon);
|
|
$avatar = $this->cache->get($cacheId);
|
|
if (!$avatar) {
|
|
$icon = $showIcon ? $this->iconFactory->getIconForRecord('be_users', $backendUser, IconSize::SMALL)->render() : '';
|
|
$avatar
|
|
= '<span class="avatar" style="--avatar-size: ' . $size . 'px;">'
|
|
. '<span class="avatar-image">' . $this->getImgTag($backendUser, $size) . '</span>'
|
|
. ($showIcon ? '<span class="avatar-icon">' . $icon . '</span>' : '')
|
|
. '</span>';
|
|
$this->cache->set($cacheId, $avatar);
|
|
}
|
|
return $avatar;
|
|
}
|
|
|
|
/**
|
|
* Returns an HTML <img> tag of given backend users avatar.
|
|
*/
|
|
protected function getImgTag(array $backendUser, int $size = 32): string
|
|
{
|
|
$avatarImage = $this->getImage($backendUser, $size);
|
|
return '<img src="' . htmlspecialchars($avatarImage->getUrl()) . '" '
|
|
. 'width="' . (int)$avatarImage->getWidth() . '" '
|
|
. 'height="' . (int)$avatarImage->getHeight() . '" '
|
|
. 'alt="" '
|
|
. 'aria-hidden="true" '
|
|
. 'loading="lazy" />';
|
|
}
|
|
|
|
/**
|
|
* Get Image from first provider that returns one.
|
|
*/
|
|
protected function getImage(array $backendUser, int $size): Image
|
|
{
|
|
foreach ($this->avatarProviders as $provider) {
|
|
$avatarImage = $provider->getImage($backendUser, $size);
|
|
if (!empty($avatarImage)) {
|
|
return $avatarImage;
|
|
}
|
|
}
|
|
return GeneralUtility::makeInstance(
|
|
Image::class,
|
|
(string)PathUtility::getSystemResourceUri('EXT:core/Resources/Public/Icons/T3Icons/svgs/avatar/avatar-default.svg'),
|
|
$size,
|
|
$size
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Validates the registered avatar providers
|
|
*
|
|
* @throws \RuntimeException
|
|
*/
|
|
protected function validateAvatarProviders(): void
|
|
{
|
|
foreach ($this->avatarProviders as $provider) {
|
|
if (!($provider instanceof AvatarProviderInterface)) {
|
|
throw new \RuntimeException(
|
|
sprintf(
|
|
'Avatar provider must implement interface "%s", "%s" given.',
|
|
AvatarProviderInterface::class,
|
|
get_debug_type($provider),
|
|
),
|
|
1439317802,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
protected function getBackendUser(): BackendUserAuthentication
|
|
{
|
|
return $GLOBALS['BE_USER'];
|
|
}
|
|
}
|