ProfileRuntime::determineProfileLink() - Code Metrics - zikula/core - Measure and Improve Code Quality continuously with Scrutinizer

ProfileRuntime::determineProfileLink() C
last analyzed 2025-02-11 12:26 UTC

↳ Parent: ProfileRuntime

Complexity

Conditions	12
Paths	99

Size

Total Lines	48
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	26
dl	0
loc	48
rs	6.9666
c	0
b	0
f	0
cc	12
nc	99
nop	6

How to fix Complexity

<?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\UsersBundle\Twig\Runtime;

use InvalidArgumentException;
use Symfony\Contracts\Translation\TranslatorInterface;
use Twig\Extension\RuntimeExtensionInterface;
use Zikula\UsersBundle\Entity\User;
use Zikula\UsersBundle\Helper\ProfileHelper;
use Zikula\UsersBundle\Repository\UserRepositoryInterface;
use function Symfony\Component\String\s;

class ProfileRuntime implements RuntimeExtensionInterface
{
    public function __construct(
        private readonly ProfileHelper $profileHelper,
        private readonly UserRepositoryInterface $userRepository,
        private readonly TranslatorInterface $translator,
        private readonly bool $displayRegistrationDate = false
    ) {
    }

    /**
     * Whether to show the users registration date or not.
     */
    public function displayRegistrationDate(): bool
    {
        return $this->displayRegistrationDate;
    }

    /**
     * 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->profileHelper->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 User $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->profileHelper->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->profileHelper->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>';
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Zikula package.
7			*
8			* Copyright Zikula - https://ziku.la/
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Zikula\UsersBundle\Twig\Runtime;
15
16			use InvalidArgumentException;
17			use Symfony\Contracts\Translation\TranslatorInterface;
18			use Twig\Extension\RuntimeExtensionInterface;
19			use Zikula\UsersBundle\Entity\User;
20			use Zikula\UsersBundle\Helper\ProfileHelper;
21			use Zikula\UsersBundle\Repository\UserRepositoryInterface;
22			use function Symfony\Component\String\s;
23
24			class ProfileRuntime implements RuntimeExtensionInterface
25			{
26			public function __construct(
27			private readonly ProfileHelper $profileHelper,
28			private readonly UserRepositoryInterface $userRepository,
29			private readonly TranslatorInterface $translator,
30			private readonly bool $displayRegistrationDate = false
31			) {
32			}
33
34			/**
35			* Whether to show the users registration date or not.
36			*/
37			public function displayRegistrationDate(): bool
38			{
39			return $this->displayRegistrationDate;
40			}
41
42			/**
43			* Displays the avatar of a given user.
44			*
45			* @param int\|string $userId The user's id or name
46			*/
47			public function getUserAvatar($userId = 0, array $parameters = []): string
48			{
49			return $this->profileHelper->getAvatar($userId, $parameters);
50			}
51
52			/**
53			* Create a link to a users profile from the UID.
54			*
55			* Examples
56			*
57			* Simple version, shows the username
58			* {{ uid\|profileLinkByUserId() }}
59			* Simple version, shows username, using class="classname"
60			* {{ uid\|profileLinkByUserId(class='classname') }}
61			* Using profile.gif instead of username, no class
62			* {{ uid\|profileLinkByUserId(image='images/profile.gif') }}
63			*/
64			public function profileLinkByUserId(
65			int $userId,
66			string $class = '',
67			string $image = '',
68			int $maxLength = 0,
69			string $title = ''
70			): string {
71			if (empty($userId) \|\| 1 > $userId) {
72			return (string) $userId;
73			}
74
75			return $this->determineProfileLink($userId, null, $class, $image, $maxLength, $title);
76			}
77
78			/**
79			* Create a link to a users profile from the username.
80			*
81			* Examples
82			*
83			* Simple version, shows the username
84			* {{ username\|profileLinkByUserName() }}
85			* Simple version, shows username, using class="classname"
86			* {{ username\|profileLinkByUserName(class='classname') }}
87			* Using profile.gif instead of username, no class
88			* {{ username\|profileLinkByUserName('image'='images/profile.gif') }}
89			*/
90			public function profileLinkByUserName(
91			string $userName,
92			string $class = '',
93			string $image = '',
94			int $maxLength = 0,
95			string $title = ''
96			): string {
97			if (empty($userName)) {
98			return $userName;
99			}
100
101			return $this->determineProfileLink(null, $userName, $class, $image, $maxLength, $title);
102			}
103
104			/**
105			* Internal function used by profileLinkByUserId() and profileLinkByUserName().
106			*/
107			private function determineProfileLink(
108			int $userId = null,
109			string $userName = null,
110			string $class = '',
111			string $imagePath = '',
112			int $maxLength = 0,
113			string $title = ''
114			): string {
115			if (!isset($userId) && !isset($userName)) {
116			throw new InvalidArgumentException();
117			}
118			/** @var User $user */
119			if (null !== $userId) {
120			$user = $this->userRepository->find($userId);
121			} else {
122			$user = $this->userRepository->findOneBy(['uname' => $userName]);
123			}
124			if (!$user) {
125			return $userId . $userName; // one or the other is empty
126			}
127
128			$userDisplayName = $this->profileHelper->getDisplayName($user->getUid());
129			if (!$userDisplayName) {
130			$userDisplayName = $user->getUname();
131			}
132
133			$class = !empty($class) ? ' class="' . htmlspecialchars($class, ENT_QUOTES) . '"' : '';
134
135			if (!empty($imagePath)) {
136			$show = '<img src="' . htmlspecialchars($imagePath, ENT_QUOTES) . '" alt="' . htmlspecialchars($userDisplayName, ENT_QUOTES) . '" />';
137			} elseif (0 < $maxLength) {
138			// truncate the user name to $maxLength chars
139			$length = mb_strlen($userDisplayName);
140			$truncEnd = ($maxLength > $length) ? $length : $maxLength;
141			$show = htmlspecialchars(s($userDisplayName)->slice(0, $truncEnd)->toString(), ENT_QUOTES);
142			} else {
143			$show = htmlspecialchars($userDisplayName, ENT_QUOTES);
144			}
145			$href = $this->profileHelper->getProfileUrl($user->getUid());
146			if ('#' === $href) {
147			return $userDisplayName;
148			}
149
150			if (empty($title)) {
151			$title = $this->translator->trans('Profile') . ': ' . $userDisplayName;
152			}
153
154			return '<a' . $class . ' title="' . htmlspecialchars($title, ENT_QUOTES) . '" href="' . $href . '">' . $show . '</a>';
155			}
156			}
157

zikula / core

ProfileRuntime::determineProfileLink() C last analyzed 2025-02-11 12:26 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

ProfileRuntime::determineProfileLink() C
last analyzed 2025-02-11 12:26 UTC