SessionRepetitionCommand::copyEvaluationsAndCategories() - Code Metrics - Inspection of "Internal: Add session replication, reinscription l..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#5831)

unknown

created 2024-12-31 22:15 UTC

copyEvaluationsAndCategories() B

↳ Parent: SessionRepetitionCommand

Complexity

Conditions	7
Paths	34

Size

Total Lines	60
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	35
c	0
b	0
f	0
nc	34
nop	5
dl	0
loc	60
rs	8.4266

How to fix Long Method

<?php

declare(strict_types=1);

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

namespace Chamilo\CoreBundle\Command;

use Chamilo\CoreBundle\Entity\AccessUrl;
use Chamilo\CoreBundle\Entity\GradebookCategory;
use Chamilo\CoreBundle\Entity\GradebookEvaluation;
use Chamilo\CoreBundle\Entity\GradebookLink;
use Chamilo\CoreBundle\Entity\Session;
use Chamilo\CoreBundle\Repository\SessionRepository;
use Doctrine\ORM\EntityManagerInterface;
use Exception;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Mime\Email;
use Symfony\Contracts\Translation\TranslatorInterface;

class SessionRepetitionCommand extends Command
{
    protected static $defaultName = 'app:session-repetition';

    public function __construct(
        private readonly SessionRepository $sessionRepository,
        private readonly EntityManagerInterface $entityManager,
        private readonly MailerInterface $mailer,
        private readonly TranslatorInterface $translator
    ) {
        parent::__construct();
    }

    protected function configure(): void
    {
        $this
            ->setDescription('Automatically duplicates sessions that meet the repetition criteria.')
            ->addOption('debug', null, InputOption::VALUE_NONE, 'Enable debug mode');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $debug = $input->getOption('debug');

        // Find sessions that meet the repetition criteria
        $sessions = $this->sessionRepository->findSessionsWithoutChildAndReadyForRepetition();

        if ($debug) {
            $output->writeln(sprintf('Found %d session(s) ready for repetition.', count($sessions)));
        }

        foreach ($sessions as $session) {
            if ($debug) {
                $output->writeln(sprintf('Processing session: %d', $session->getId()));
            }

            // Duplicate session
            $newSession = $this->duplicateSession($session, $debug, $output);

            // Notify general coach of the new session
            $this->notifyGeneralCoach($newSession, $debug, $output);

            $output->writeln('Created new session: ' . $newSession->getId() . ' from session: ' . $session->getId());
        }

        return Command::SUCCESS;
    }

    /**
     * Duplicates a session and creates a new session with adjusted dates.
     * @throws Exception
     */
    private function duplicateSession(Session $session, bool $debug, OutputInterface $output): Session
    {
        // Calculate new session dates based on the duration of the original session
        $duration = $session->getAccessEndDate()->diff($session->getAccessStartDate())->days;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $newStartDate = (clone $session->getAccessEndDate())->modify('+1 day');
        $newEndDate = (clone $newStartDate)->modify("+{$duration} days");

        if ($debug) {
            $output->writeln(sprintf(
                'Duplicating session %d. New start date: %s, New end date: %s',
                $session->getId(),
                $newStartDate->format('Y-m-d H:i:s'),
                $newEndDate->format('Y-m-d H:i:s')
            ));
        }

        // Create a new session with the same details as the original session
        $newSession = new Session();
        $newSession
            ->setTitle($session->getTitle() . ' (Repetition ' . $session->getId() . ' - ' . time() . ')')
            ->setAccessStartDate($newStartDate)
            ->setAccessEndDate($newEndDate)
            ->setDisplayStartDate($newStartDate)
            ->setDisplayEndDate($newEndDate)
            ->setCoachAccessStartDate($newStartDate)
            ->setCoachAccessEndDate($newEndDate)
            ->setVisibility($session->getVisibility())
            ->setDuration(0)
            ->setDescription($session->getDescription() ?? '')
            ->setShowDescription($session->getShowDescription() ?? false)
            ->setCategory($session->getCategory())
            ->setPromotion($session->getPromotion())
            ->setDaysToReinscription($session->getDaysToReinscription())
            ->setDaysToNewRepetition($session->getDaysToNewRepetition())
            ->setParentId($session->getId())
            ->setLastRepetition(false);

        // Copy the AccessUrls from the original session
        foreach ($session->getUrls() as $accessUrl) {
            $newSession->addAccessUrl($accessUrl->getUrl());
        }

        // Save the new session
        $this->entityManager->persist($newSession);
        $this->entityManager->flush();

        if ($debug) {
            $output->writeln(sprintf('New session %d created successfully.', $newSession->getId()));
        }

        $courses = $session->getCourses()->toArray();

        if ($debug) {
            $output->writeln('Courses retrieved: ' . count($courses));
            foreach ($courses as $index => $sessionRelCourse) {
                $course = $sessionRelCourse->getCourse();
                $output->writeln(sprintf(
                    'Course #%d: %s (Course ID: %s)',
                    $index + 1,
                    $course ? $course->getTitle() : 'NULL',
                    $course ? $course->getId() : 'NULL'
                ));
            }
        }

        // Extract course IDs
        $courseList = array_map(function ($sessionRelCourse) {
            $course = $sessionRelCourse->getCourse();
            return $course?->getId();
        }, $courses);

        // Remove null values
        $courseList = array_filter($courseList);

        if ($debug) {
            $output->writeln(sprintf(
                'Extracted course IDs: %s',
                json_encode($courseList)
            ));
        }

        if (empty($courseList)) {
            $output->writeln(sprintf('Warning: No courses found in the original session %d.', $session->getId()));
        }

        // Add courses to the new session
        foreach ($courses as $sessionRelCourse) {
            $course = $sessionRelCourse->getCourse();
            if ($course) {
                $newSession->addCourse($course);

                if ($debug) {
                    $output->writeln(sprintf('Added course ID %d to session ID %d.', $course->getId(), $newSession->getId()));
                }

                $this->copyEvaluationsAndCategories($course->getId(), $session->getId(), $newSession->getId(), $debug, $output);
            }
        }

        $this->entityManager->flush();

        return $newSession;
    }

    /**
     * Notifies the general coach of the session about the new repetition.
     */
    private function notifyGeneralCoach(Session $newSession, bool $debug, OutputInterface $output): void
    {
        $generalCoach = $newSession->getGeneralCoaches()->first();
        if ($generalCoach) {
            $message = sprintf(
                'A new repetition of the session "%s" has been created. Please review the details: %s',
                $newSession->getTitle(),
                $this->generateSessionSummaryLink($newSession)
            );

            if ($debug) {
                $output->writeln(sprintf('Notifying coach (ID: %d) for session %d', $generalCoach->getId(), $newSession->getId()));
            }

            // Send message to the general coach
            $this->sendMessage($generalCoach->getEmail(), $message);

            if ($debug) {
                $output->writeln('Notification sent.');
            }
        } else {
            if ($debug) {
                $output->writeln('No general coach found for session ' . $newSession->getId());
            }
        }
    }

    /**
     * Sends an email message to a user.
     */
    private function sendMessage(string $recipientEmail, string $message): void
    {
        $subject = $this->translator->trans('New Session Repetition Created');

        $email = (new Email())
            ->from('[email protected]')
            ->to($recipientEmail)
            ->subject($subject)
            ->html('<p>' . $message . '</p>');

        $this->mailer->send($email);
    }

    /**
     * Generates a link to the session summary page.
     */
    private function generateSessionSummaryLink(Session $session): string
    {
        return '/main/session/resume_session.php?id_session=' . $session->getId();
    }

    /**
     * Copies gradebook categories, evaluations, and links from the old session to the new session.
     */
    private function copyEvaluationsAndCategories(
        int $courseId,
        int $oldSessionId,
        int $newSessionId,
        bool $debug,
        OutputInterface $output
    ): void {
        // Get existing categories of the original course and session
        $categories = $this->entityManager->getRepository(GradebookCategory::class)
            ->findBy(['course' => $courseId, 'session' => $oldSessionId]);

        if ($debug) {
            $output->writeln(sprintf('Found %d category(ies) for course ID %d in session ID %d.', count($categories), $courseId, $oldSessionId));
        }

        foreach ($categories as $category) {
            // Create new category for the new session
            $newCategory = new GradebookCategory();
            $newCategory->setTitle($category->getTitle())
                ->setDescription($category->getDescription())
                ->setWeight($category->getWeight())
                ->setVisible($category->getVisible())
                ->setCertifMinScore($category->getCertifMinScore())
                ->setGenerateCertificates($category->getGenerateCertificates())
                ->setIsRequirement($category->getIsRequirement())
                ->setCourse($category->getCourse())
                ->setSession($this->entityManager->getReference(Session::class, $newSessionId))
                ->setParent($category->getParent());

            $this->entityManager->persist($newCategory);
            $this->entityManager->flush();

            if ($debug) {
                $output->writeln(sprintf('Created new category ID %d for session ID %d.', $newCategory->getId(), $newSessionId));
            }

            // Copy links
            $links = $this->entityManager->getRepository(GradebookLink::class)
                ->findBy(['category' => $category->getId()]);

            foreach ($links as $link) {
                $newLink = clone $link;
                $newLink->setCategory($newCategory);
                $this->entityManager->persist($newLink);
            }

            // Copy evaluations
            $evaluations = $this->entityManager->getRepository(GradebookEvaluation::class)
                ->findBy(['category' => $category->getId()]);

            foreach ($evaluations as $evaluation) {
                $newEvaluation = clone $evaluation;
                $newEvaluation->setCategory($newCategory);
                $this->entityManager->persist($newEvaluation);
            }

            $this->entityManager->flush();

            if ($debug) {
                $output->writeln(sprintf('Copied links and evaluations for category ID %d to new category ID %d.', $category->getId(), $newCategory->getId()));
            }
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\CoreBundle\Command;
8
9			use Chamilo\CoreBundle\Entity\AccessUrl;
10			use Chamilo\CoreBundle\Entity\GradebookCategory;
11			use Chamilo\CoreBundle\Entity\GradebookEvaluation;
12			use Chamilo\CoreBundle\Entity\GradebookLink;
13			use Chamilo\CoreBundle\Entity\Session;
14			use Chamilo\CoreBundle\Repository\SessionRepository;
15			use Doctrine\ORM\EntityManagerInterface;
16			use Exception;
17			use Symfony\Component\Console\Command\Command;
18			use Symfony\Component\Console\Input\InputInterface;
19			use Symfony\Component\Console\Output\OutputInterface;
20			use Symfony\Component\Console\Input\InputOption;
21			use Symfony\Component\Mailer\MailerInterface;
22			use Symfony\Component\Mime\Email;
23			use Symfony\Contracts\Translation\TranslatorInterface;
24
25			class SessionRepetitionCommand extends Command
26			{
27			protected static $defaultName = 'app:session-repetition';
28
29			public function __construct(
30			private readonly SessionRepository $sessionRepository,
31			private readonly EntityManagerInterface $entityManager,
32			private readonly MailerInterface $mailer,
33			private readonly TranslatorInterface $translator
34			) {
35			parent::__construct();
36			}
37
38			protected function configure(): void
39			{
40			$this
41			->setDescription('Automatically duplicates sessions that meet the repetition criteria.')
42			->addOption('debug', null, InputOption::VALUE_NONE, 'Enable debug mode');
43			}
44
45			protected function execute(InputInterface $input, OutputInterface $output): int
46			{
47			$debug = $input->getOption('debug');
48
49			// Find sessions that meet the repetition criteria
50			$sessions = $this->sessionRepository->findSessionsWithoutChildAndReadyForRepetition();
51
52			if ($debug) {
53			$output->writeln(sprintf('Found %d session(s) ready for repetition.', count($sessions)));
54			}
55
56			foreach ($sessions as $session) {
57			if ($debug) {
58			$output->writeln(sprintf('Processing session: %d', $session->getId()));
59			}
60
61			// Duplicate session
62			$newSession = $this->duplicateSession($session, $debug, $output);
63
64			// Notify general coach of the new session
65			$this->notifyGeneralCoach($newSession, $debug, $output);
66
67			$output->writeln('Created new session: ' . $newSession->getId() . ' from session: ' . $session->getId());
68			}
69
70			return Command::SUCCESS;
71			}
72
73			/**
74			* Duplicates a session and creates a new session with adjusted dates.
75			* @throws Exception
76			*/
77			private function duplicateSession(Session $session, bool $debug, OutputInterface $output): Session
78			{
79			// Calculate new session dates based on the duration of the original session
80			$duration = $session->getAccessEndDate()->diff($session->getAccessStartDate())->days;
			0 ignored issues – show Documentation Bug introduced 2024-11-29 22:57 UTC by Report Bug Copy Issue Report It seems like `$session->getAccessEndDa...ccessStartDate())->days` can also be of type `boolean`. However, the property `$days` is declared as type `false\|integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
81			$newStartDate = (clone $session->getAccessEndDate())->modify('+1 day');
82			$newEndDate = (clone $newStartDate)->modify("+{$duration} days");
83
84			if ($debug) {
85			$output->writeln(sprintf(
86			'Duplicating session %d. New start date: %s, New end date: %s',
87			$session->getId(),
88			$newStartDate->format('Y-m-d H:i:s'),
89			$newEndDate->format('Y-m-d H:i:s')
90			));
91			}
92
93			// Create a new session with the same details as the original session
94			$newSession = new Session();
95			$newSession
96			->setTitle($session->getTitle() . ' (Repetition ' . $session->getId() . ' - ' . time() . ')')
97			->setAccessStartDate($newStartDate)
98			->setAccessEndDate($newEndDate)
99			->setDisplayStartDate($newStartDate)
100			->setDisplayEndDate($newEndDate)
101			->setCoachAccessStartDate($newStartDate)
102			->setCoachAccessEndDate($newEndDate)
103			->setVisibility($session->getVisibility())
104			->setDuration(0)
105			->setDescription($session->getDescription() ?? '')
106			->setShowDescription($session->getShowDescription() ?? false)
107			->setCategory($session->getCategory())
108			->setPromotion($session->getPromotion())
109			->setDaysToReinscription($session->getDaysToReinscription())
110			->setDaysToNewRepetition($session->getDaysToNewRepetition())
111			->setParentId($session->getId())
112			->setLastRepetition(false);
113
114			// Copy the AccessUrls from the original session
115			foreach ($session->getUrls() as $accessUrl) {
116			$newSession->addAccessUrl($accessUrl->getUrl());
117			}
118
119			// Save the new session
120			$this->entityManager->persist($newSession);
121			$this->entityManager->flush();
122
123			if ($debug) {
124			$output->writeln(sprintf('New session %d created successfully.', $newSession->getId()));
125			}
126
127			$courses = $session->getCourses()->toArray();
128
129			if ($debug) {
130			$output->writeln('Courses retrieved: ' . count($courses));
131			foreach ($courses as $index => $sessionRelCourse) {
132			$course = $sessionRelCourse->getCourse();
133			$output->writeln(sprintf(
134			'Course #%d: %s (Course ID: %s)',
135			$index + 1,
136			$course ? $course->getTitle() : 'NULL',
137			$course ? $course->getId() : 'NULL'
138			));
139			}
140			}
141
142			// Extract course IDs
143			$courseList = array_map(function ($sessionRelCourse) {
144			$course = $sessionRelCourse->getCourse();
145			return $course?->getId();
146			}, $courses);
147
148			// Remove null values
149			$courseList = array_filter($courseList);
150
151			if ($debug) {
152			$output->writeln(sprintf(
153			'Extracted course IDs: %s',
154			json_encode($courseList)
155			));
156			}
157
158			if (empty($courseList)) {
159			$output->writeln(sprintf('Warning: No courses found in the original session %d.', $session->getId()));
160			}
161
162			// Add courses to the new session
163			foreach ($courses as $sessionRelCourse) {
164			$course = $sessionRelCourse->getCourse();
165			if ($course) {
166			$newSession->addCourse($course);
167
168			if ($debug) {
169			$output->writeln(sprintf('Added course ID %d to session ID %d.', $course->getId(), $newSession->getId()));
170			}
171
172			$this->copyEvaluationsAndCategories($course->getId(), $session->getId(), $newSession->getId(), $debug, $output);
173			}
174			}
175
176			$this->entityManager->flush();
177
178			return $newSession;
179			}
180
181			/**
182			* Notifies the general coach of the session about the new repetition.
183			*/
184			private function notifyGeneralCoach(Session $newSession, bool $debug, OutputInterface $output): void
185			{
186			$generalCoach = $newSession->getGeneralCoaches()->first();
187			if ($generalCoach) {
188			$message = sprintf(
189			'A new repetition of the session "%s" has been created. Please review the details: %s',
190			$newSession->getTitle(),
191			$this->generateSessionSummaryLink($newSession)
192			);
193
194			if ($debug) {
195			$output->writeln(sprintf('Notifying coach (ID: %d) for session %d', $generalCoach->getId(), $newSession->getId()));
196			}
197
198			// Send message to the general coach
199			$this->sendMessage($generalCoach->getEmail(), $message);
200
201			if ($debug) {
202			$output->writeln('Notification sent.');
203			}
204			} else {
205			if ($debug) {
206			$output->writeln('No general coach found for session ' . $newSession->getId());
207			}
208			}
209			}
210
211			/**
212			* Sends an email message to a user.
213			*/
214			private function sendMessage(string $recipientEmail, string $message): void
215			{
216			$subject = $this->translator->trans('New Session Repetition Created');
217
218			$email = (new Email())
219			->from('[email protected]')
220			->to($recipientEmail)
221			->subject($subject)
222			->html('<p>' . $message . '</p>');
223
224			$this->mailer->send($email);
225			}
226
227			/**
228			* Generates a link to the session summary page.
229			*/
230			private function generateSessionSummaryLink(Session $session): string
231			{
232			return '/main/session/resume_session.php?id_session=' . $session->getId();
233			}
234
235			/**
236			* Copies gradebook categories, evaluations, and links from the old session to the new session.
237			*/
238			private function copyEvaluationsAndCategories(
239			int $courseId,
240			int $oldSessionId,
241			int $newSessionId,
242			bool $debug,
243			OutputInterface $output
244			): void {
245			// Get existing categories of the original course and session
246			$categories = $this->entityManager->getRepository(GradebookCategory::class)
247			->findBy(['course' => $courseId, 'session' => $oldSessionId]);
248
249			if ($debug) {
250			$output->writeln(sprintf('Found %d category(ies) for course ID %d in session ID %d.', count($categories), $courseId, $oldSessionId));
251			}
252
253			foreach ($categories as $category) {
254			// Create new category for the new session
255			$newCategory = new GradebookCategory();
256			$newCategory->setTitle($category->getTitle())
257			->setDescription($category->getDescription())
258			->setWeight($category->getWeight())
259			->setVisible($category->getVisible())
260			->setCertifMinScore($category->getCertifMinScore())
261			->setGenerateCertificates($category->getGenerateCertificates())
262			->setIsRequirement($category->getIsRequirement())
263			->setCourse($category->getCourse())
264			->setSession($this->entityManager->getReference(Session::class, $newSessionId))
265			->setParent($category->getParent());
266
267			$this->entityManager->persist($newCategory);
268			$this->entityManager->flush();
269
270			if ($debug) {
271			$output->writeln(sprintf('Created new category ID %d for session ID %d.', $newCategory->getId(), $newSessionId));
272			}
273
274			// Copy links
275			$links = $this->entityManager->getRepository(GradebookLink::class)
276			->findBy(['category' => $category->getId()]);
277
278			foreach ($links as $link) {
279			$newLink = clone $link;
280			$newLink->setCategory($newCategory);
281			$this->entityManager->persist($newLink);
282			}
283
284			// Copy evaluations
285			$evaluations = $this->entityManager->getRepository(GradebookEvaluation::class)
286			->findBy(['category' => $category->getId()]);
287
288			foreach ($evaluations as $evaluation) {
289			$newEvaluation = clone $evaluation;
290			$newEvaluation->setCategory($newCategory);
291			$this->entityManager->persist($newEvaluation);
292			}
293
294			$this->entityManager->flush();
295
296			if ($debug) {
297			$output->writeln(sprintf('Copied links and evaluations for category ID %d to new category ID %d.', $category->getId(), $newCategory->getId()));
298			}
299			}
300			}
301			}
302

chamilo / chamilo-lms

Pull Request — master (#5831)

copyEvaluationsAndCategories() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like