| Current Path : /var/www/surf/TYPO3/vendor/typo3/cms-backend/Classes/ViewHelpers/ |
| Current File : /var/www/surf/TYPO3/vendor/typo3/cms-backend/Classes/ViewHelpers/AvatarViewHelper.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\ViewHelpers;
use TYPO3\CMS\Backend\Backend\Avatar\Avatar;
use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
/**
* Render the avatar markup, including the :html:`<img>` tag, for a given backend user.
*
* Examples
* ========
*
* Default
* -------
*
* ::
*
* <be:avatar backendUser="{user.uid}" size="32" showIcon="true" />
*
* Output::
*
* <span class="avatar">
* <span class="avatar-image">
* <img src="/typo3/sysext/core/Resources/Public/Icons/T3Icons/avatar/svgs/avatar-default.svg" width="32" height="32" />
* </span>
* </span>
*
* If the given backend user hasn't added a custom avatar yet, a default one is used.
*
* Inline notation
* ---------------
*
* ::
*
* {be:avatar(backendUser: user.id, size: 32, showIcon: 'true')}
*
* Output::
*
* <span class="avatar">
* <span class="avatar-image">
* <img src="/fileadmin/_processed_/7/9/csm_custom-avatar_4ea4a18f58.jpg" width="32" height="32" />
* </span>
* </span>
*/
final class AvatarViewHelper extends AbstractViewHelper
{
use CompileWithRenderStatic;
/**
* As this ViewHelper renders HTML, the output must not be escaped.
*
* @var bool
*/
protected $escapeOutput = false;
public function initializeArguments(): void
{
$this->registerArgument('backendUser', 'int', 'uid of the backend user', false, 0);
$this->registerArgument('size', 'int', 'width and height of the image', false, 32);
$this->registerArgument('showIcon', 'bool', 'show the record icon as well', false, false);
}
/**
* Resolve user avatar from a given backend user id.
*
* @param array{backendUser: int, size: int, showIcon: bool} $arguments
*/
public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext): string
{
if ($arguments['backendUser'] > 0) {
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('be_users');
$queryBuilder->getRestrictions()->removeAll();
$backendUser = $queryBuilder
->select('*')
->from('be_users')
->where(
$queryBuilder->expr()->eq(
'uid',
$queryBuilder->createNamedParameter($arguments['backendUser'], Connection::PARAM_INT)
)
)
->executeQuery()
->fetchAssociative();
} else {
$backendUser = $GLOBALS['BE_USER']->user;
}
if ($backendUser === false) {
// no BE user can be retrieved from DB, probably deleted
return '';
}
$avatar = GeneralUtility::makeInstance(Avatar::class);
return $avatar->render($backendUser, $arguments['size'], $arguments['showIcon']);
}
}