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

ProfileHelper::findUser() A
last analyzed 2025-02-11 12:26 UTC

↳ Parent: ProfileHelper
Complexity

Conditions	4
Paths	4
Size

Total Lines	17
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	4
eloc	8
nc	4
nop	1
dl	0
loc	17
rs	10
c	0
b	0
f	0
<?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\Helper;

use Symfony\Bundle\SecurityBundle\Security;
use Symfony\Component\DependencyInjection\Attribute\Autowire;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\RouterInterface;
use Zikula\UsersBundle\Entity\User;
use Zikula\UsersBundle\ProfileConstant;
use Zikula\UsersBundle\Repository\UserRepositoryInterface;
use function Symfony\Component\String\s;

class ProfileHelper
{
    public function __construct(
        private readonly RouterInterface $router,
        private readonly RequestStack $requestStack,
        private readonly Security $security,
        private readonly UserRepositoryInterface $userRepository,
        private readonly GravatarHelper $gravatarHelper,
        #[Autowire(param: 'kernel.project_dir')]
        private readonly string $projectDir,
        #[Autowire(param: 'profile_property_prefix')]
        private readonly string $prefix,
        private readonly string $avatarImagePath,
        private readonly string $avatarDefaultImage,
        private readonly bool $gravatarEnabled
    ) {
    }

    public function getDisplayName($userId = null): string
    {
        $userEntity = $this->findUser($userId);
        if (!$userEntity) {

            throw new \InvalidArgumentException('Invalid userId provided');
        }

        $key = $this->prefix . ':' . ProfileConstant::ATTRIBUTE_NAME_DISPLAY_NAME;
        if ($userEntity->getAttributes()->containsKey($key)) {
            return $userEntity->getAttributes()->get($key)->getValue();
        }

        return $userEntity->getUsername();
    }

    public function getFullName($userId = null): string
    {
        $userEntity = $this->findUser($userId);
        if (!$userEntity) {

            throw new \InvalidArgumentException('Invalid userId provided');
        }

        $key1 = $this->prefix . ':' . ProfileConstant::ATTRIBUTE_NAME_FIRST_NAME;
        $key2 = $this->prefix . ':' . ProfileConstant::ATTRIBUTE_NAME_LAST_NAME;
        $attributes = $userEntity->getAttributes();
        if ($attributes->containsKey($key1) && $attributes->containsKey($key2)) {
            return $attributes->get($key1)->getValue() . ' ' . $attributes->get($key2)->getValue();
        }

        return $userEntity->getUsername();
    }

    public function getProfileUrl($userId = null): string
    {
        $userEntity = $this->findUser($userId);
        if (!$userEntity) {

            throw new \InvalidArgumentException('Invalid userId provided');
        }

        return $this->router->generate('zikulaprofilebundle_profile_display', ['userId' => $userEntity->getId()]);
    }

    public function getAvatar($userId = null, array $parameters = []): string
    {
        $userEntity = $this->findUser($userId);
        if (!$userEntity) {

            throw new \InvalidArgumentException('Invalid userId provided');
        }

        $avatarPath = $this->avatarImagePath;
        $userAttributes = $userEntity->getAttributes();
        $key = $this->prefix . ':avatar';
        $avatar = $userAttributes[$key] ? $userAttributes[$key]->getValue() : $this->avatarDefaultImage;

        $avatarUrl = '';
        if (!in_array($avatar, ['blank.gif', 'blank.jpg'], true)) {
            if (isset($avatar) && !empty($avatar) && $avatar !== $this->avatarDefaultImage && file_exists($this->projectDir . '/' . $avatarPath . '/' . $avatar)) {
                $request = $this->requestStack->getCurrentRequest();
                if (null !== $request) {
                    $avatarPath = s($avatarPath)->after('public/')->toString();
                    $avatarUrl = $request->getSchemeAndHttpHost() . $request->getBasePath() . '/' . $avatarPath . '/' . $avatar;
                }
            } elseif (true === $this->gravatarEnabled) {
                $parameters = $this->squareSize($parameters);
                $avatarUrl = $this->gravatarHelper->getGravatarUrl($userEntity->getEmail(), $parameters);
            }
        }

        if (empty($avatarUrl)) {
            // e.g. blank.gif or empty avatars
            return '';
        }

        if (!isset($parameters['class'])) {
            $parameters['class'] = 'img-fluid img-thumbnail';
        }
        $attributes = ' class="' . str_replace('"', '', htmlspecialchars($parameters['class'])) . '"';
        $attributes .= isset($parameters['width']) ? ' width="' . (int) $parameters['width'] . '"' : '';
        $attributes .= isset($parameters['height']) ? ' height="' . (int) $parameters['height'] . '"' : '';

        $result = '<img src="' . str_replace('"', '', htmlspecialchars($avatarUrl)) . '" title="' . str_replace('"', '', htmlspecialchars($userEntity->getUsername())) . '" alt="' . str_replace('"', '', htmlspecialchars($userEntity->getUsername())) . '"' . $attributes . ' />';

        return $result;
    }

    /**
     * Finds a certain user based on either it's id or it's name.
     *
     * @param int|string $userId The user's id or name
     */
    private function findUser($userId = null): ?User
    {
        if (empty($userId)) {
            return $this->security->getUser();

        }

        if (is_numeric($userId)) {
            return $this->userRepository->find($userId);
        }

        // select user id by user name
        $results = $this->userRepository->searchActiveUser(['operator' => '=', 'operand' => $userId], 1);
        $results = $this->userRepository->searchActiveUser(['operator' => '=', 'operand' => $userId], 1);
        if (!count($results)) {
            return null;
        }

        return $results[0];
    }

    /**
     * Checks and updates the avatar image size parameters.
     */
    private function squareSize(array $parameters = []): array
    {
        if (!isset($parameters['size'])) {
            if (isset($parameters['width']) || isset($parameters['height'])) {
                $hasWidth = isset($parameters['width']);
                $hasHeight = isset($parameters['height']);
                if (($hasWidth && !$hasHeight) || ($hasWidth && $hasHeight && $parameters['width'] < $parameters['height'])) {
                    $parameters['size'] = $parameters['width'];
                } elseif ((!$hasWidth && $hasHeight) || ($hasWidth && $hasHeight && $parameters['width'] > $parameters['height'])) {
                    $parameters['size'] = $parameters['height'];
                } else {
                    $parameters['size'] = 80;
                }
            } else {
                $parameters['size'] = 80;
            }
        }
        $parameters['width'] = $parameters['size'];
        $parameters['height'] = $parameters['size'];

        return $parameters;
    }
}

zikula / core

ProfileHelper::findUser() A last analyzed 2025-02-11 12:26 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ProfileHelper::findUser() A
last analyzed 2025-02-11 12:26 UTC
