Zikula\UsersModule\Twig\Runtime\ProfileRuntime

Complexity

Total Complexity

19

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
C	determineProfileLink()	0	48	12
A	getUserAvatar()	0	3	1
A	__construct()	0	8	1
A	profileLinkByUserId()	0	12	3
A	profileLinkByUserName()	0	12	2

<?php

declare(strict_types=1);

/*
 * This file is part of the Zikula package.
 *
 * Copyright Zikula - https://ziku.la/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zikula\UsersModule\Twig\Runtime;

use InvalidArgumentException;
use function Symfony\Component\String\s;
use Symfony\Contracts\Translation\TranslatorInterface;
use Twig\Extension\RuntimeExtensionInterface;
use Zikula\UsersModule\Collector\ProfileModuleCollector;
use Zikula\UsersModule\Entity\RepositoryInterface\UserRepositoryInterface;
use Zikula\UsersModule\Entity\UserEntity;

class ProfileRuntime implements RuntimeExtensionInterface
{
    /**
     * @var UserRepositoryInterface
     */
    private $userRepository;

    /**
     * @var ProfileModuleCollector
     */
    private $profileModuleCollector;

    /**
     * @var TranslatorInterface
     */
    private $translator;

    public function __construct(
        UserRepositoryInterface $userRepository,
        ProfileModuleCollector $profileModuleCollector,
        TranslatorInterface $translator
    ) {
        $this->userRepository = $userRepository;
        $this->profileModuleCollector = $profileModuleCollector;
        $this->translator = $translator;
    }

    /**
     * Displays the avatar of a given user.
     *
     * @param int|string $userId The user's id or name
     */
    public function getUserAvatar($userId = 0, array $parameters = []): string
    {
        return $this->profileModuleCollector->getSelected()->getAvatar($userId, $parameters);
    }

    /**
     * Create a link to a users profile from the UID.
     *
     * Examples
     *
     *   Simple version, shows the username
     *   {{ uid|profileLinkByUserId() }}
     *   Simple version, shows username, using class="classname"
     *   {{ uid|profileLinkByUserId(class='classname') }}
     *   Using profile.gif instead of username, no class
     *   {{ uid|profileLinkByUserId(image='images/profile.gif') }}
     */
    public function profileLinkByUserId(
        int $userId,
        string $class = '',
        string $image = '',
        int $maxLength = 0,
        string $title = ''
    ): string {
        if (empty($userId) || 1 > $userId) {
            return (string) $userId;
        }

        return $this->determineProfileLink($userId, null, $class, $image, $maxLength, $title);
    }

    /**
     * Create a link to a users profile from the username.
     *
     * Examples
     *
     *   Simple version, shows the username
     *   {{ username|profileLinkByUserName() }}
     *   Simple version, shows username, using class="classname"
     *   {{ username|profileLinkByUserName(class='classname') }}
     *   Using profile.gif instead of username, no class
     *   {{ username|profileLinkByUserName('image'='images/profile.gif') }}
     */
    public function profileLinkByUserName(
        string $userName,
        string $class = '',
        string $image = '',
        int $maxLength = 0,
        string $title = ''
    ): string {
        if (empty($userName)) {
            return $userName;
        }

        return $this->determineProfileLink(null, $userName, $class, $image, $maxLength, $title);
    }

    /**
     * Internal function used by profileLinkByUserId() and profileLinkByUserName().
     */
    private function determineProfileLink(
        int $userId = null,
        string $userName = null,
        string $class = '',
        string $imagePath = '',
        int $maxLength = 0,
        string $title = ''
    ): string {
        if (!isset($userId) && !isset($userName)) {
            throw new InvalidArgumentException();
        }
        /** @var UserEntity $user */
        if (null !== $userId) {
            $user = $this->userRepository->find($userId);
        } else {
            $user = $this->userRepository->findOneBy(['uname' => $userName]);
        }
        if (!$user) {
            return $userId . $userName; // one or the other is empty
        }

        $userDisplayName = $this->profileModuleCollector->getSelected()->getDisplayName($user->getUid());
        if (!$userDisplayName) {
            $userDisplayName = $user->getUname();
        }

        $class = !empty($class) ? ' class="' . htmlspecialchars($class, ENT_QUOTES) . '"' : '';

        if (!empty($imagePath)) {
            $show = '<img src="' . htmlspecialchars($imagePath, ENT_QUOTES) . '" alt="' . htmlspecialchars($userDisplayName, ENT_QUOTES) . '" />';
        } elseif (0 < $maxLength) {
            // truncate the user name to $maxLength chars
            $length = mb_strlen($userDisplayName);
            $truncEnd = ($maxLength > $length) ? $length : $maxLength;
            $show = htmlspecialchars(s($userDisplayName)->slice(0, $truncEnd)->toString(), ENT_QUOTES);
        } else {
            $show = htmlspecialchars($userDisplayName, ENT_QUOTES);
        }
        $href = $this->profileModuleCollector->getSelected()->getProfileUrl($user->getUid());
        if ('#' === $href) {
            return $userDisplayName;
        }

        if (empty($title)) {
            $title = $this->translator->trans('Profile') . ': ' . $userDisplayName;
        }

        return '<a' . $class . ' title="' . htmlspecialchars($title, ENT_QUOTES) . '" href="' . $href . '">' . $show . '</a>';
    }
}