CToolProvider::provide() - Code Metrics - Inspection of "Refactoring tools visibility in course home - refs..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#5063)

by Angel Fernando Quiroz

created 2024-01-13 13:59 UTC

CToolProvider::provide() F

↳ Parent: CToolProvider

Complexity

Conditions	16
Paths	264

Size

Total Lines	55
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	16
eloc	27
c	1
b	0
f	0
nc	264
nop	3
dl	0
loc	55
rs	3.9333

How to fix Long Method Complexity

<?php

/* For licensing terms, see /license.txt */

declare(strict_types=1);

namespace Chamilo\CoreBundle\State;

use ApiPlatform\Doctrine\Orm\State\CollectionProvider;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\State\Pagination\PartialPaginatorInterface;
use ApiPlatform\State\ProviderInterface;
use Chamilo\CoreBundle\Entity\ResourceLink;
use Chamilo\CoreBundle\Entity\User;
use Chamilo\CoreBundle\Settings\SettingsManager;
use Chamilo\CoreBundle\Tool\ToolChain;
use Chamilo\CoreBundle\Traits\CourseFromRequestTrait;
use Chamilo\CourseBundle\Entity\CTool;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Security\Core\Security;

/**
 * @template-implements ProviderInterface<CTool>
 */
class CToolProvider implements ProviderInterface
{
    use CourseFromRequestTrait;

    public function __construct(
        private readonly CollectionProvider $provider,
        protected EntityManagerInterface $entityManager,
        private readonly SettingsManager $settingsManager,
        private readonly Security $security,
        private readonly ToolChain $toolChain,
        protected RequestStack $requestStack,
    ) {}

    public function provide(Operation $operation, array $uriVariables = [], array $context = []): array
    {
        /** @var PartialPaginatorInterface $result */
        $result = $this->provider->provide($operation, $uriVariables, $context);

        $request = $this->requestStack->getMainRequest();

        $studentView = $request ? $request->getSession()->get('studentview') : 'studentview';

        /** @var User|null $user */
        $user = $this->security->getUser();

        $isAllowToEdit = $user && ($user->hasRole('ROLE_ADMIN') || $user->hasRole('ROLE_CURRENT_COURSE_TEACHER'));
        $isAllowToSessionEdit = $user && ($user->hasRole('ROLE_ADMIN') || $user->hasRole('ROLE_CURRENT_COURSE_TEACHER') || $user->hasRole('ROLE_CURRENT_COURSE_SESSION_TEACHER'));

        $allowVisibilityInSession = $this->settingsManager->getSetting('course.allow_edit_tool_visibility_in_session');
        $session = $this->getSession();

        $results = [];

        /** @var CTool $cTool */
        foreach ($result as $cTool) {
            $toolModel = $this->toolChain->getToolFromName(
                $cTool->getTool()->getName()
            );

            if (!$isAllowToEdit && 'admin' === $toolModel->getCategory()) {
                continue;
            }

            $resourceLinks = $cTool->getResourceNode()->getResourceLinks();

            if ($session && $allowVisibilityInSession) {
                $sessionLink = $resourceLinks->findFirst(
                    fn (int $key, ResourceLink $resourceLink): bool => $resourceLink->getSession()?->getId() === $session->getId()
                );

                if ($sessionLink) {
                    $resourceLinks->clear();
                    $resourceLinks->add($sessionLink);
                }
            }

            if (!$isAllowToSessionEdit || 'studentview' === $studentView) {
                $notPublishedLink = ResourceLink::VISIBILITY_PUBLISHED !== $resourceLinks->first()->getVisibility();

                if ($notPublishedLink) {
                    continue;
                }
            }

            $results[] = $cTool;
        }

        return $results;
    }
}


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			declare(strict_types=1);
6
7			namespace Chamilo\CoreBundle\State;
8
9			use ApiPlatform\Doctrine\Orm\State\CollectionProvider;
10			use ApiPlatform\Metadata\Operation;
11			use ApiPlatform\State\Pagination\PartialPaginatorInterface;
12			use ApiPlatform\State\ProviderInterface;
13			use Chamilo\CoreBundle\Entity\ResourceLink;
14			use Chamilo\CoreBundle\Entity\User;
15			use Chamilo\CoreBundle\Settings\SettingsManager;
16			use Chamilo\CoreBundle\Tool\ToolChain;
17			use Chamilo\CoreBundle\Traits\CourseFromRequestTrait;
18			use Chamilo\CourseBundle\Entity\CTool;
19			use Doctrine\ORM\EntityManagerInterface;
20			use Symfony\Component\HttpFoundation\RequestStack;
21			use Symfony\Component\Security\Core\Security;
22
23			/**
24			* @template-implements ProviderInterface<CTool>
25			*/
26			class CToolProvider implements ProviderInterface
27			{
28			use CourseFromRequestTrait;
29
30			public function __construct(
31			private readonly CollectionProvider $provider,
32			protected EntityManagerInterface $entityManager,
33			private readonly SettingsManager $settingsManager,
34			private readonly Security $security,
35			private readonly ToolChain $toolChain,
36			protected RequestStack $requestStack,
37			) {}
38
39			public function provide(Operation $operation, array $uriVariables = [], array $context = []): array
40			{
41			/** @var PartialPaginatorInterface $result */
42			$result = $this->provider->provide($operation, $uriVariables, $context);
43
44			$request = $this->requestStack->getMainRequest();
45
46			$studentView = $request ? $request->getSession()->get('studentview') : 'studentview';
47
48			/** @var User\|null $user */
49			$user = $this->security->getUser();
50
51			$isAllowToEdit = $user && ($user->hasRole('ROLE_ADMIN') \|\| $user->hasRole('ROLE_CURRENT_COURSE_TEACHER'));
52			$isAllowToSessionEdit = $user && ($user->hasRole('ROLE_ADMIN') \|\| $user->hasRole('ROLE_CURRENT_COURSE_TEACHER') \|\| $user->hasRole('ROLE_CURRENT_COURSE_SESSION_TEACHER'));
53
54			$allowVisibilityInSession = $this->settingsManager->getSetting('course.allow_edit_tool_visibility_in_session');
55			$session = $this->getSession();
56
57			$results = [];
58
59			/** @var CTool $cTool */
60			foreach ($result as $cTool) {
61			$toolModel = $this->toolChain->getToolFromName(
62			$cTool->getTool()->getName()
63			);
64
65			if (!$isAllowToEdit && 'admin' === $toolModel->getCategory()) {
66			continue;
67			}
68
69			$resourceLinks = $cTool->getResourceNode()->getResourceLinks();
70
71			if ($session && $allowVisibilityInSession) {
72			$sessionLink = $resourceLinks->findFirst(
73			fn (int $key, ResourceLink $resourceLink): bool => $resourceLink->getSession()?->getId() === $session->getId()
74			);
75
76			if ($sessionLink) {
77			$resourceLinks->clear();
78			$resourceLinks->add($sessionLink);
79			}
80			}
81
82			if (!$isAllowToSessionEdit \|\| 'studentview' === $studentView) {
83			$notPublishedLink = ResourceLink::VISIBILITY_PUBLISHED !== $resourceLinks->first()->getVisibility();
84
85			if ($notPublishedLink) {
86			continue;
87			}
88			}
89
90			$results[] = $cTool;
91			}
92
93			return $results;
94			}
95			}
96

chamilo / chamilo-lms

Pull Request — master (#5063)

CToolProvider::provide() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like