Session::getDisplayEndDate() - Code Metrics - Inspection of "Session: show remaining days (or duration for coac..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#7168)

unknown
created 2025-12-14 22:49 UTC
Session::getDisplayEndDate() A

↳ Parent: Session
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php

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

declare(strict_types=1);

namespace Chamilo\CoreBundle\Entity;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Delete;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Link;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use Chamilo\CoreBundle\Controller\Api\CreateSessionWithUsersAndCoursesAction;
use Chamilo\CoreBundle\Dto\CreateSessionWithUsersAndCoursesInput;
use Chamilo\CoreBundle\Entity\Listener\SessionListener;
use Chamilo\CoreBundle\Repository\SessionRepository;
use Chamilo\CoreBundle\State\UserSessionSubscriptionsStateProvider;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\Common\Collections\Criteria;
use Doctrine\Common\Collections\ReadableCollection;
use Doctrine\ORM\Mapping as ORM;
use LogicException;
use Stringable;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

#[ApiResource(
    operations: [
        new Get(
            uriTemplate: '/sessions/{id}',
            normalizationContext: [
                'groups' => ['session:basic'],
            ],
            security: "is_granted('ROLE_ADMIN') or is_granted('VIEW', object)"
        ),
        new Put(security: "is_granted('ROLE_ADMIN')"),
        new GetCollection(
            security: "is_granted('ROLE_ADMIN')",
            filters: [
                'session.search_filter',
                'session.property_filter',
                'session.order_filter',
                'session.group_filter',
            ]
        ),
        new GetCollection(
            uriTemplate: '/users/{id}/session_subscriptions/past.{_format}',
            uriVariables: [
                'id' => new Link(
                    fromClass: User::class,
                    description: 'User identifier',
                ),
            ],
            paginationEnabled: false,
            normalizationContext: [
                'groups' => [
                    'user_subscriptions:sessions',
                ],
            ],
            security: "is_granted('ROLE_USER')",
            name: 'user_session_subscriptions_past',
            provider: UserSessionSubscriptionsStateProvider::class,
        ),
        new GetCollection(
            uriTemplate: '/users/{id}/session_subscriptions/current.{_format}',
            uriVariables: [
                'id' => new Link(
                    fromClass: User::class,
                    description: 'User identifier',
                ),
            ],
            normalizationContext: [
                'groups' => [
                    'user_subscriptions:sessions',
                ],
            ],
            security: "is_granted('ROLE_USER')",
            name: 'user_session_subscriptions_current',
            provider: UserSessionSubscriptionsStateProvider::class,
        ),
        new GetCollection(
            uriTemplate: '/users/{id}/session_subscriptions/upcoming.{_format}',
            uriVariables: [
                'id' => new Link(
                    fromClass: User::class,
                    description: 'User identifier',
                ),
            ],
            normalizationContext: [
                'groups' => [
                    'user_subscriptions:sessions',
                ],
            ],
            security: "is_granted('ROLE_USER')",
            name: 'user_session_subscriptions_upcoming',
            provider: UserSessionSubscriptionsStateProvider::class,
        ),
        new Post(security: "is_granted('ROLE_ADMIN')"),
        new Post(
            uriTemplate: '/advanced/create-session-with-courses-and-users',
            controller: CreateSessionWithUsersAndCoursesAction::class,
            denormalizationContext: ['groups' => ['write']],
            security: "is_granted('ROLE_ADMIN') or is_granted('ROLE_SESSION_MANAGER')",
            input: CreateSessionWithUsersAndCoursesInput::class,
            output: Session::class,
            deserialize: true,
            name: 'create_session_with_courses_and_assign_users'
        ),
        new Delete(security: "is_granted('DELETE', object)"),
    ],
    normalizationContext: ['groups' => ['session:basic']],
    denormalizationContext: ['groups' => ['session:write']],
    security: "is_granted('ROLE_ADMIN')"
)]
#[ORM\Table(name: 'session')]
#[ORM\UniqueConstraint(name: 'title', columns: ['title'])]
#[ORM\EntityListeners([SessionListener::class])]
#[ORM\Entity(repositoryClass: SessionRepository::class)]
#[UniqueEntity('title')]
class Session implements ResourceWithAccessUrlInterface, Stringable
{
    public const READ_ONLY = 1;
    public const VISIBLE = 2;
    public const INVISIBLE = 3;
    public const AVAILABLE = 4;
    public const LIST_ONLY = 5;

    public const STUDENT = 0;
    public const DRH = 1;
    public const COURSE_COACH = 2;
    public const GENERAL_COACH = 3;
    public const SESSION_ADMIN = 4;

    public const STATUS_PLANNED = 1;
    public const STATUS_PROGRESS = 2;
    public const STATUS_FINISHED = 3;
    public const STATUS_CANCELLED = 4;
    public const STATUS_UNKNOWN = 0;

    #[Groups([
        'session:basic',
        'session:read',
        'session_rel_user:read',
        'session_rel_course_rel_user:read',
        'course:read',
        'track_e_exercise:read',
        'user_subscriptions:sessions',
    ])]
    #[ORM\Column(name: 'id', type: 'integer')]
    #[ORM\Id]
    #[ORM\GeneratedValue]
    protected ?int $id = null;

    /**
     * @var Collection<int, SessionRelCourse>
     */
    #[Groups([
        'session:read',
        'session_rel_user:read',
        'session_rel_course_rel_user:read',
        'user_subscriptions:sessions',
    ])]
    #[ORM\OrderBy(['position' => 'ASC'])]
    #[ORM\OneToMany(
        mappedBy: 'session',
        targetEntity: SessionRelCourse::class,
        cascade: ['persist'],
        fetch: 'EXTRA_LAZY',
        orphanRemoval: true
    )]
    protected Collection $courses;

    /**
     * @var Collection<int, SessionRelUser>
     */
    #[Groups([
        'session:read',
    ])]
    #[ORM\OneToMany(
        mappedBy: 'session',
        targetEntity: SessionRelUser::class,
        cascade: ['persist', 'remove'],
        fetch: 'EXTRA_LAZY',
        orphanRemoval: true
    )]
    protected Collection $users;

    /**
     * @var Collection<int, SessionRelCourseRelUser>
     */
    #[Groups([
        'session:read',
        'session_rel_course_rel_user:read',
    ])]
    #[ORM\OneToMany(
        mappedBy: 'session',
        targetEntity: SessionRelCourseRelUser::class,
        cascade: ['persist'],
        orphanRemoval: true
    )]
    protected Collection $sessionRelCourseRelUsers;

    /**
     * @var Collection<int, SkillRelCourse>
     */
    #[ORM\OneToMany(
        mappedBy: 'session',
        targetEntity: SkillRelCourse::class,
        cascade: ['persist', 'remove']
    )]
    protected Collection $skills;

    /**
     * @var Collection<int, SkillRelUser>
     */
    #[ORM\OneToMany(mappedBy: 'session', targetEntity: SkillRelUser::class, cascade: ['persist'])]
    protected Collection $issuedSkills;

    /**
     * @var Collection<int, EntityAccessUrlInterface>
     */
    #[ORM\OneToMany(
        mappedBy: 'session',
        targetEntity: AccessUrlRelSession::class,
        cascade: ['persist'],
        orphanRemoval: true
    )]
    protected Collection $urls;

    /**
     * @var Collection<int, ResourceLink>
     */
    #[ORM\OneToMany(mappedBy: 'session', targetEntity: ResourceLink::class, cascade: ['remove'], orphanRemoval: true)]
    protected Collection $resourceLinks;

    protected AccessUrl $currentUrl;

    protected ?Course $currentCourse = null;

    #[Assert\NotBlank]
    #[Groups([
        'session:basic',
        'session:read',
        'session:write',
        'session_rel_course_rel_user:read',
        'document:read',
        'session_rel_user:read',
        'course:read',
        'track_e_exercise:read',
        'calendar_event:read',
        'user_subscriptions:sessions',
    ])]
    #[ORM\Column(name: 'title', type: 'string', length: 150)]
    protected string $title;

    #[Groups([
        'session:basic',
        'session:read',
        'session:write',
    ])]
    #[ORM\Column(name: 'description', type: 'text', unique: false, nullable: true)]
    protected ?string $description;

    #[Groups([
        'session:read',
        'session:write',
    ])]
    #[ORM\Column(name: 'show_description', type: 'boolean', nullable: true)]
    protected ?bool $showDescription = false;

    #[Groups(['session:read', 'session:write', 'user_subscriptions:sessions'])]
    #[ORM\Column(name: 'duration', type: 'integer', nullable: true)]
    protected ?int $duration = null;

    #[Groups(['session:basic', 'session:read', 'session:write'])]
    #[ORM\Column(name: 'nbr_courses', type: 'integer', unique: false, nullable: false)]
    protected int $nbrCourses;

    #[Groups(['session:basic', 'session:read', 'session:write'])]
    #[ORM\Column(name: 'nbr_users', type: 'integer', unique: false, nullable: false)]
    protected int $nbrUsers;

    #[Groups(['session:read'])]
    #[ORM\Column(name: 'nbr_classes', type: 'integer', unique: false, nullable: false)]
    protected int $nbrClasses;

    #[Groups([
        'session:basic',
        'session:read',
        'session:write',
    ])]
    #[ORM\Column(name: 'visibility', type: 'integer')]
    protected int $visibility;

    #[ORM\ManyToOne(targetEntity: Promotion::class, cascade: ['persist'], inversedBy: 'sessions')]
    #[ORM\JoinColumn(name: 'promotion_id', referencedColumnName: 'id', onDelete: 'CASCADE')]
    protected ?Promotion $promotion = null;

    #[Groups([
        'session:read',
        'session:write',
        'session_rel_user:read',
        'session_rel_course_rel_user:read',
        'user_subscriptions:sessions',
    ])]
    #[ORM\Column(name: 'display_start_date', type: 'datetime', unique: false, nullable: true)]
    protected ?DateTime $displayStartDate = null;

    #[Groups([
        'session:read',
        'session:write',
        'session_rel_user:read',
        'session_rel_course_rel_user:read',
        'user_subscriptions:sessions',
    ])]
    #[ORM\Column(name: 'display_end_date', type: 'datetime', unique: false, nullable: true)]
    protected ?DateTime $displayEndDate = null;

    #[Groups([
        'session:read',
        'session:write',
        'session_rel_user:read',
        'session_rel_course_rel_user:read',
    ])]
    #[ORM\Column(name: 'access_start_date', type: 'datetime', unique: false, nullable: true)]
    protected ?DateTime $accessStartDate = null;

    #[Groups([
        'session:read',
        'session:write',
        'session_rel_user:read',
        'session_rel_course_rel_user:read',
    ])]
    #[ORM\Column(name: 'access_end_date', type: 'datetime', unique: false, nullable: true)]
    protected ?DateTime $accessEndDate = null;

    #[Groups([
        'session:read',
        'session:write',
        'session_rel_user:read',
        'session_rel_course_rel_user:read',
    ])]
    #[ORM\Column(name: 'coach_access_start_date', type: 'datetime', unique: false, nullable: true)]
    protected ?DateTime $coachAccessStartDate = null;

    #[Groups([
        'session:read',
        'session:write',
        'session_rel_user:read',
        'session_rel_course_rel_user:read',
    ])]
    #[ORM\Column(name: 'coach_access_end_date', type: 'datetime', unique: false, nullable: true)]
    protected ?DateTime $coachAccessEndDate = null;

    #[ORM\Column(name: 'position', type: 'integer', nullable: false, options: ['default' => 0])]
    protected int $position;

    #[Groups(['session:read'])]
    #[ORM\Column(name: 'status', type: 'integer', nullable: false)]
    protected int $status;

    #[Groups(['session:read', 'session:write', 'session_rel_user:read', 'user_subscriptions:sessions'])]
    #[ORM\ManyToOne(targetEntity: SessionCategory::class, inversedBy: 'sessions')]
    #[ORM\JoinColumn(name: 'session_category_id', referencedColumnName: 'id')]
    protected ?SessionCategory $category = null;

    #[ORM\Column(
        name: 'send_subscription_notification',
        type: 'boolean',
        nullable: false,
        options: ['default' => false]
    )]
    protected bool $sendSubscriptionNotification;

    /**
     * Image illustrating the session (was extra field 'image' in 1.11).
     */
    #[Groups(['user_subscriptions:sessions'])]
    #[ORM\ManyToOne(targetEntity: Asset::class, cascade: ['persist', 'remove'])]
    #[ORM\JoinColumn(name: 'image_id', referencedColumnName: 'id', onDelete: 'SET NULL')]
    protected ?Asset $image = null;

    #[Groups(['session:basic'])]
    private ?string $imageUrl = null;

    #[Groups(['user_subscriptions:sessions', 'session:read', 'session:item:read'])]
    private int $accessVisibility = 0;

    #[ORM\Column(name: 'parent_id', type: 'integer', nullable: true)]
    protected ?int $parentId = null;

    #[ORM\Column(name: 'days_to_reinscription', type: 'integer', nullable: true)]
    protected ?int $daysToReinscription = null;

    #[ORM\Column(name: 'last_repetition', type: 'boolean', nullable: false, options: ['default' => false])]
    protected bool $lastRepetition = false;

    #[ORM\Column(name: 'days_to_new_repetition', type: 'integer', nullable: true)]
    protected ?int $daysToNewRepetition = null;

    #[ORM\Column(name: 'notify_boss', type: 'boolean', options: ['default' => false])]
    protected bool $notifyBoss = false;

    #[Groups(['session:basic', 'session:read', 'session:write'])]
    #[ORM\Column(name: 'validity_in_days', type: 'integer', nullable: true)]
    protected ?int $validityInDays = null;

    #[Groups(['user_subscriptions:sessions'])]
    private ?int $daysLeft = null;

    public function __construct()
    {
        $this->skills = new ArrayCollection();
        $this->issuedSkills = new ArrayCollection();
        $this->resourceLinks = new ArrayCollection();
        $this->courses = new ArrayCollection();
        $this->users = new ArrayCollection();
        $this->sessionRelCourseRelUsers = new ArrayCollection();
        $this->urls = new ArrayCollection();
        $this->duration = 0;
        $this->description = '';
        $this->nbrClasses = 0;
        $this->nbrUsers = 0;
        $this->nbrCourses = 0;
        $this->sendSubscriptionNotification = false;
        $now = new DateTime();
        $this->displayStartDate = $now;
        $this->displayEndDate = $now;
        $this->accessStartDate = $now;
        $this->accessEndDate = $now;
        $this->coachAccessStartDate = $now;
        $this->coachAccessEndDate = $now;
        $this->visibility = 1;
        $this->showDescription = false;
        $this->category = null;
        $this->status = 0;
        $this->position = 0;
    }

    public function __toString(): string
    {
        return $this->getTitle();
    }

    public static function getRelationTypeList(): array
    {
        return [self::STUDENT, self::DRH, self::COURSE_COACH, self::GENERAL_COACH, self::SESSION_ADMIN];
    }

    public static function getStatusList(): array
    {
        return [
            self::READ_ONLY => 'status_read_only',
            self::VISIBLE => 'status_visible',
            self::INVISIBLE => 'status_invisible',
            self::AVAILABLE => 'status_available',
        ];
    }

    public function getDuration(): ?int
    {
        return $this->duration;
    }

    public function setDuration(int $duration): self
    {
        $this->duration = $duration;

        return $this;
    }

    public function getShowDescription(): bool
    {
        return $this->showDescription ?? false;
    }

    public function setShowDescription(bool $showDescription): self
    {
        $this->showDescription = $showDescription;

        return $this;
    }

    /**
     * @return Collection<int, SessionRelUser>
     */
    public function getUsers(): Collection
    {
        return $this->users;
    }

    public function setUsers(Collection $users): self
    {
        $this->users = new ArrayCollection();
        foreach ($users as $user) {
            $this->addUserSubscription($user);
        }

        return $this;
    }

    public function addUserSubscription(SessionRelUser $subscription): void
    {
        $subscription->setSession($this);
        if (!$this->hasUser($subscription)) {
            $this->users->add($subscription);
            $this->nbrUsers++;
        }
    }

    public function hasUser(SessionRelUser $subscription): bool
    {
        if (0 !== $this->getUsers()->count()) {
            $criteria = Criteria::create()
                ->where(
                    Criteria::expr()->eq('user', $subscription->getUser())
                )
                ->andWhere(
                    Criteria::expr()->eq('session', $subscription->getSession())
                )
                ->andWhere(
                    Criteria::expr()->eq('relationType', $subscription->getRelationType())
                )
            ;
            $relation = $this->getUsers()->matching($criteria);

            return $relation->count() > 0;
        }

        return false;
    }

    public function hasCourse(Course $course): bool
    {
        if (0 !== $this->getCourses()->count()) {
            $criteria = Criteria::create()->where(Criteria::expr()->eq('course', $course));
            $relation = $this->getCourses()->matching($criteria);

            return $relation->count() > 0;
        }

        return false;
    }

    /**
     * @return Collection<int, SessionRelCourse>
     */
    public function getCourses(): Collection
    {
        return $this->courses;
    }

    public function setCourses(ArrayCollection $courses): void
    {
        $this->courses = new ArrayCollection();
        foreach ($courses as $course) {
            $this->addCourses($course);
        }
    }

    public function addCourses(SessionRelCourse $course): void
    {
        $course->setSession($this);
        $this->courses->add($course);
    }

    public function removeCourses(SessionRelCourse $course): void
    {
        foreach ($this->courses as $key => $value) {
            if ($value->getId() === $course->getId()) {
                unset($this->courses[$key]);
            }
        }
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    /**
     * Remove course subscription for a user.
     * If user status in session is student, then decrease number of course users.
     */
    public function removeUserCourseSubscription(User $user, Course $course): void
    {
        foreach ($this->sessionRelCourseRelUsers as $i => $sessionRelUser) {
            if ($sessionRelUser->getCourse()->getId() === $course->getId()
                && $sessionRelUser->getUser()->getId() === $user->getId()
            ) {
                if (self::STUDENT === $this->sessionRelCourseRelUsers[$i]->getStatus()) {
                    $sessionCourse = $this->getCourseSubscription($course);
                    $sessionCourse->setNbrUsers($sessionCourse->getNbrUsers() - 1);
                }

                unset($this->sessionRelCourseRelUsers[$i]);
            }
        }
    }

    public function getStatus(): int
    {
        return $this->status;
    }

    public function setStatus(int $status): self
    {
        $this->status = $status;

        return $this;
    }

    public function setTitle(string $title): self
    {
        $this->title = $title;

        return $this;
    }

    public function getCourseSubscription(Course $course): ?SessionRelCourse
    {
        $criteria = Criteria::create()->where(Criteria::expr()->eq('course', $course));

        return $this->courses->matching($criteria)->current();
    }

    public function getTitle(): string
    {
        return $this->title;
    }

    public function getNbrUsers(): int
    {
        return $this->nbrUsers;
    }

    public function setNbrUsers(int $nbrUsers): self
    {
        $this->nbrUsers = $nbrUsers;

        return $this;
    }

    /**
     * @return Collection<int, SessionRelCourseRelUser>
     */
    public function getAllUsersFromCourse(int $status): Collection
    {
        $criteria = Criteria::create()->where(Criteria::expr()->eq('status', $status));

        return $this->getSessionRelCourseRelUsers()->matching($criteria);
    }

    public function getSessionRelCourseRelUsers(): Collection
    {
        return $this->sessionRelCourseRelUsers;
    }

    public function setSessionRelCourseRelUsers(Collection $sessionRelCourseRelUsers): self
    {
        $this->sessionRelCourseRelUsers = new ArrayCollection();
        foreach ($sessionRelCourseRelUsers as $item) {
            $this->addSessionRelCourseRelUser($item);
        }

        return $this;
    }

    public function addSessionRelCourseRelUser(SessionRelCourseRelUser $sessionRelCourseRelUser): void
    {
        $sessionRelCourseRelUser->setSession($this);
        if (!$this->hasUserCourseSubscription($sessionRelCourseRelUser)) {
            $this->sessionRelCourseRelUsers->add($sessionRelCourseRelUser);
        }
    }

    public function hasUserCourseSubscription(SessionRelCourseRelUser $subscription): bool
    {
        if (0 !== $this->getSessionRelCourseRelUsers()->count()) {
            $criteria = Criteria::create()
                ->where(
                    Criteria::expr()->eq('user', $subscription->getUser())
                )
                ->andWhere(
                    Criteria::expr()->eq('course', $subscription->getCourse())
                )
                ->andWhere(
                    Criteria::expr()->eq('session', $subscription->getSession())
                )
            ;
            $relation = $this->getSessionRelCourseRelUsers()->matching($criteria);

            return $relation->count() > 0;
        }

        return false;
    }

    /**
     * @return Collection<int, SessionRelCourseRelUser>
     */
    public function getSessionRelCourseByUser(User $user, ?int $status = null): Collection
    {
        $criteria = Criteria::create()->where(Criteria::expr()->eq('user', $user));
        if (null !== $status) {
            $criteria->andWhere(Criteria::expr()->eq('status', $status));
        }

        return $this->sessionRelCourseRelUsers->matching($criteria);
    }

    public function getDescription(): ?string
    {
        return $this->description;
    }

    public function setDescription(string $description): self
    {
        $this->description = $description;

        return $this;
    }

    public function getNbrCourses(): int
    {
        return $this->nbrCourses;
    }

    public function setNbrCourses(int $nbrCourses): self
    {
        $this->nbrCourses = $nbrCourses;

        return $this;
    }

    public function getNbrClasses(): int
    {
        return $this->nbrClasses;
    }

    public function setNbrClasses(int $nbrClasses): self
    {
        $this->nbrClasses = $nbrClasses;

        return $this;
    }

    public function getVisibility(): int
    {
        return $this->visibility;
    }

    public function setVisibility(int $visibility): self
    {
        $this->visibility = $visibility;

        return $this;
    }

    public function getPromotion(): ?Promotion
    {
        return $this->promotion;
    }

    public function setPromotion(?Promotion $promotion): self
    {
        $this->promotion = $promotion;

        return $this;
    }

    public function getDisplayStartDate(): ?DateTime
    {
        return $this->displayStartDate;
    }

    public function setDisplayStartDate(?DateTime $displayStartDate): self
    {
        $this->displayStartDate = $displayStartDate;

        return $this;
    }

    public function getDisplayEndDate(): ?DateTime
    {
        return $this->displayEndDate;
    }

    public function setDisplayEndDate(?DateTime $displayEndDate): self
    {
        $this->displayEndDate = $displayEndDate;

        return $this;
    }

    /**
     * @return Collection<int, User>
     */
    public function getGeneralCoaches(): Collection
    {
        return $this->getGeneralCoachesSubscriptions()
            ->map(fn (SessionRelUser $subscription) => $subscription->getUser())
        ;
    }

    /**
     * @return Collection<int, SessionRelUser>
     */
    public function getCoachesSubscriptions(bool $includeSessionAdmin = false): Collection
    {
        $relationTypes = [
            self::COURSE_COACH,
            self::GENERAL_COACH,
        ];

        if ($includeSessionAdmin) {
            $relationTypes[] = self::SESSION_ADMIN;
        }

        $criteria = Criteria::create()->where(Criteria::expr()->in('relationType', $relationTypes));

        return $this->users->matching($criteria);
    }

    /**
     * @return Collection<int, SessionRelUser>
     */
    public function getStudentSubscriptions(): Collection
    {
        $criteria = Criteria::create()->where(Criteria::expr()->eq('relationType', self::STUDENT));

        return $this->users->matching($criteria);
    }

    /**
     * @return Collection<int, SessionRelUser>
     */
    #[Groups(['session:basic', 'user_subscriptions:sessions'])]
    public function getGeneralCoachesSubscriptions(): Collection
    {
        $criteria = Criteria::create()->where(Criteria::expr()->eq('relationType', self::GENERAL_COACH));

        return $this->users->matching($criteria);
    }

    public function hasUserAsGeneralCoach(User $user): bool
    {
        $criteria = Criteria::create()
            ->where(
                Criteria::expr()->eq('relationType', self::GENERAL_COACH)
            )
            ->andWhere(
                Criteria::expr()->eq('user', $user)
            )
        ;

        return $this->users->matching($criteria)->count() > 0;
    }

    public function hasUserInSession(User $user, int $relationType): bool
    {
        $criteria = Criteria::create()
            ->where(Criteria::expr()->eq('user', $user))
            ->andWhere(Criteria::expr()->eq('relationType', $relationType))
        ;

        return $this->users->matching($criteria)->count() > 0;
    }

    public function addGeneralCoach(User $coach): self
    {
        return $this->addUserInSession(self::GENERAL_COACH, $coach);
    }

    public function addUserInSession(int $relationType, User $user): self
    {
        foreach ($this->getUsers() as $existingSubscription) {
            if (
                $existingSubscription->getUser()->getId() === $user->getId()
                && $existingSubscription->getRelationType() === $relationType
            ) {
                return $this;
            }
        }

        $sessionRelUser = (new SessionRelUser())
            ->setUser($user)
            ->setRelationType($relationType)
        ;

        $this->addUserSubscription($sessionRelUser);

        if ($this->duration <= 0) {
            $isCoach = \in_array($relationType, [self::COURSE_COACH, self::GENERAL_COACH, self::SESSION_ADMIN]);

            $sessionRelUser
                ->setAccessStartDate(
                    $isCoach && $this->coachAccessStartDate ? $this->coachAccessStartDate : $this->accessStartDate
                )
                ->setAccessEndDate(
                    $isCoach && $this->coachAccessEndDate ? $this->coachAccessEndDate : $this->accessEndDate
                )
            ;
        }

        return $this;
    }

    public function removeGeneralCoach(User $user): self
    {
        $this->removeUserInSession(self::GENERAL_COACH, $user);

        return $this;
    }

    public function removeUserInSession(int $relationType, User $user): self
    {
        $criteria = Criteria::create()
            ->where(
                Criteria::expr()->eq('relationType', $relationType)
            )
            ->andWhere(
                Criteria::expr()->eq('user', $user)
            )
        ;
        $subscriptions = $this->users->matching($criteria);

        foreach ($subscriptions as $subscription) {
            $this->removeUserSubscription($subscription);
        }

        return $this;
    }

    public function removeUserSubscription(SessionRelUser $subscription): self
    {
        if ($this->hasUser($subscription)) {
            $subscription->setSession(null);
            $this->users->removeElement($subscription);
            $this->nbrUsers--;
        }

        return $this;
    }

    public function getCategory(): ?SessionCategory
    {
        return $this->category;
    }

    public function setCategory(?SessionCategory $category): self
    {
        $this->category = $category;

        return $this;
    }

    /**
     * Check if session is visible.
     */
    public function isActive(): bool
    {
        $now = new DateTime('now');

        return $now > $this->getAccessStartDate();
    }

    public function getAccessStartDate(): ?DateTime
    {
        return $this->accessStartDate;
    }

    public function setAccessStartDate(?DateTime $accessStartDate, bool $updateCoachesDates = false): self
    {
        $this->accessStartDate = $accessStartDate;

        if ($updateCoachesDates) {
            foreach ($this->getStudentSubscriptions() as $studentSubscription) {
                $studentSubscription->setAccessStartDate($this->accessStartDate);
            }
        }

        return $this;
    }

    public function isActiveForStudent(): bool
    {
        $start = $this->getAccessStartDate();
        $end = $this->getAccessEndDate();

        return $this->compareDates($start, $end);
    }

    public function getAccessEndDate(): ?DateTime
    {
        return $this->accessEndDate;
    }

    public function setAccessEndDate(?DateTime $accessEndDate, bool $updateCoachesDates = false): self
    {
        $this->accessEndDate = $accessEndDate;

        if ($updateCoachesDates) {
            foreach ($this->getStudentSubscriptions() as $studentSubscription) {
                $studentSubscription->setAccessEndDate($this->accessEndDate);
            }
        }

        return $this;
    }

    public function isActiveForCoach(): bool
    {
        $start = $this->getCoachAccessStartDate();
        $end = $this->getCoachAccessEndDate();

        return $this->compareDates($start, $end);
    }

    public function getCoachAccessStartDate(): ?DateTime
    {
        return $this->coachAccessStartDate;
    }

    public function setCoachAccessStartDate(
        ?DateTime $coachAccessStartDate,
        bool $updateCoachesDates = false,
        bool $updateAdminDates = false,
    ): self {
        $this->coachAccessStartDate = $coachAccessStartDate;

        if ($updateCoachesDates) {
            foreach ($this->getCoachesSubscriptions($updateAdminDates) as $coachSubscription) {
                $coachSubscription->setAccessStartDate($this->coachAccessStartDate ?: $this->accessStartDate);
            }
        }

        return $this;
    }

    public function getCoachAccessEndDate(): ?DateTime
    {
        return $this->coachAccessEndDate;
    }

    public function setCoachAccessEndDate(
        ?DateTime $coachAccessEndDate,
        bool $updateCoachesDates = false,
        bool $updateAdminDates = false,
    ): self {
        $this->coachAccessEndDate = $coachAccessEndDate;

        if ($updateCoachesDates) {
            foreach ($this->getCoachesSubscriptions($updateAdminDates) as $coachSubscription) {
                $coachSubscription->setAccessEndDate($this->coachAccessEndDate ?: $this->accessEndDate);
            }
        }

        return $this;
    }

    /**
     * Compare the current date with start and end access dates.
     * Either missing date is interpreted as no limit.
     *
     * @return bool whether now is between the session access start and end dates
     */
    public function isCurrentlyAccessible(): bool
    {
        $now = new DateTime();

        return (!$this->accessStartDate || $now >= $this->accessStartDate) && (!$this->accessEndDate || $now <= $this->accessEndDate);
    }

    public function addCourse(Course $course): self
    {
        $sessionRelCourse = (new SessionRelCourse())->setCourse($course);
        $this->addCourses($sessionRelCourse);

        return $this;
    }

    /**
     * Removes a course from this session.
     *
     * @param Course $course the course to remove from this session
     *
     * @return bool whether the course was actually found in this session and removed from it
     */
    public function removeCourse(Course $course): bool
    {
        $relCourse = $this->getCourseSubscription($course);
        if (null !== $relCourse) {
            $this->courses->removeElement($relCourse);
            $this->setNbrCourses(\count($this->courses));

            return true;
        }

        return false;
    }

    /**
     * Add a user course subscription.
     * If user status in session is student, then increase number of course users.
     * Status example: Session::STUDENT.
     */
    public function addUserInCourse(int $status, User $user, Course $course): ?SessionRelCourseRelUser
    {
        if ($this->hasUserInCourse($user, $course, $status)) {
            return null;
        }

        $userRelCourseRelSession = (new SessionRelCourseRelUser())
            ->setCourse($course)
            ->setUser($user)
            ->setSession($this)
            ->setStatus($status)
        ;

        $this->addSessionRelCourseRelUser($userRelCourseRelSession);

        if (self::STUDENT === $status) {
            $sessionCourse = $this->getCourseSubscription($course);
            if ($sessionCourse) {
                $sessionCourse->setNbrUsers($sessionCourse->getNbrUsers() + 1);
            }
        }

        return $userRelCourseRelSession;
    }

    /**
     * currentCourse is set in CidReqListener.
     */
    public function getCurrentCourse(): ?Course
    {
        return $this->currentCourse;
    }

    /**
     * currentCourse is set in CidReqListener.
     */
    public function setCurrentCourse(Course $course): self
    {
        // If the session is registered in the course session list.
        $exists = $this->getCourses()
            ->exists(
                fn ($key, $element) => $course->getId() === $element->getCourse()->getId()
            )
        ;

        if ($exists) {
            $this->currentCourse = $course;
        }

        return $this;
    }

    public function getSendSubscriptionNotification(): bool
    {
        return $this->sendSubscriptionNotification;
    }

    public function setSendSubscriptionNotification(bool $sendNotification): self
    {
        $this->sendSubscriptionNotification = $sendNotification;

        return $this;
    }

    /**
     * Get user from course by status.
     *
     * @return Collection<int, SessionRelCourseRelUser>
     */
    public function getSessionRelCourseRelUsersByStatus(Course $course, int $status): Collection
    {
        $criteria = Criteria::create()
            ->where(
                Criteria::expr()->eq('course', $course)
            )
            ->andWhere(
                Criteria::expr()->eq('status', $status)
            )
        ;

        return $this->sessionRelCourseRelUsers->matching($criteria);
    }

    public function getSessionRelCourseRelUserInCourse(Course $course): Collection
    {
        $criteria = Criteria::create()
            ->where(
                Criteria::expr()->eq('course', $course)
            )
        ;

        return $this->sessionRelCourseRelUsers->matching($criteria);
    }

    public function getIssuedSkills(): Collection
    {
        return $this->issuedSkills;
    }

    public function getCurrentUrl(): AccessUrl
    {
        return $this->currentUrl;
    }

    public function setCurrentUrl(AccessUrl $url): self
    {
        $urlList = $this->getUrls();
        foreach ($urlList as $item) {
            if ($item->getUrl()->getId() === $url->getId()) {
                $this->currentUrl = $url;

                break;
            }
        }

        return $this;
    }

    /**
     * @return Collection<int, EntityAccessUrlInterface>
     */
    public function getUrls(): Collection
    {
        return $this->urls;
    }

    public function setUrls(Collection $urls): self
    {
        $this->urls = new ArrayCollection();
        foreach ($urls as $url) {
            $this->addUrls($url);
        }

        return $this;
    }

    public function addUrls(AccessUrlRelSession $url): self
    {
        $url->setSession($this);
        $this->urls->add($url);

        return $this;
    }

    public function addAccessUrl(?AccessUrl $url): self
    {
        $accessUrlRelSession = new AccessUrlRelSession();
        $accessUrlRelSession->setUrl($url);
        $accessUrlRelSession->setSession($this);
        $this->addUrls($accessUrlRelSession);

        return $this;
    }

    public function getPosition(): int
    {
        return $this->position;
    }

    public function setPosition(int $position): self
    {
        $this->position = $position;

        return $this;
    }

    public function getSessionAdmins(): ReadableCollection
    {
        return $this->getGeneralAdminsSubscriptions()
            ->map(fn (SessionRelUser $subscription) => $subscription->getUser())
        ;
    }

    public function getGeneralAdminsSubscriptions(): Collection
    {
        $criteria = Criteria::create()->where(Criteria::expr()->eq('relationType', self::SESSION_ADMIN));

        return $this->users->matching($criteria);
    }

    public function hasUserAsSessionAdmin(User $user): bool
    {
        $criteria = Criteria::create()
            ->where(
                Criteria::expr()->eq('relationType', self::SESSION_ADMIN)
            )
            ->andWhere(
                Criteria::expr()->eq('user', $user)
            )
        ;

        return $this->users->matching($criteria)->count() > 0;
    }

    public function addSessionAdmin(User $sessionAdmin): self
    {
        return $this->addUserInSession(self::SESSION_ADMIN, $sessionAdmin);
    }

    public function getSkills(): Collection
    {
        return $this->skills;
    }

    public function getResourceLinks(): Collection
    {
        return $this->resourceLinks;
    }

    public function getImage(): ?Asset
    {
        return $this->image;
    }

    public function setImage(?Asset $asset): self
    {
        $this->image = $asset;

        return $this;
    }

    public function hasImage(): bool
    {
        return null !== $this->image;
    }

    public function setImageUrl(?string $imageUrl): self
    {
        $this->imageUrl = $imageUrl;

        return $this;
    }

    public function getImageUrl(): ?string
    {
        $image = $this->getImage();

        if ($image instanceof Asset) {
            $category = $image->getCategory();
            $filename = $image->getTitle();

            return \sprintf('/assets/%s/%s/%s', $category, $filename, $filename);
        }

        return null;
    }

    /**
     * Check if $user is course coach in any course.
     */
    public function hasCoachInCourseList(User $user): bool
    {
        foreach ($this->courses as $sessionCourse) {
            if ($this->hasCourseCoachInCourse($user, $sessionCourse->getCourse())) {
                return true;
            }
        }

        return false;
    }

    public function hasCourseCoachInCourse(User $user, ?Course $course = null): bool
    {
        if (null === $course) {
            return false;
        }

        return $this->hasUserInCourse($user, $course, self::COURSE_COACH);
    }

    /**
     * @param int $status if not set it will check if the user is registered
     *                    with any status
     */
    public function hasUserInCourse(User $user, Course $course, ?int $status = null): bool
    {
        $relation = $this->getUserInCourse($user, $course, $status);

        return $relation->count() > 0;
    }

    public function getUserInCourse(User $user, Course $course, ?int $status = null): Collection
    {
        $criteria = Criteria::create()
            ->where(
                Criteria::expr()->eq('course', $course)
            )
            ->andWhere(
                Criteria::expr()->eq('user', $user)
            )
        ;

        if (null !== $status) {
            $criteria->andWhere(Criteria::expr()->eq('status', $status));
        }

        return $this->getSessionRelCourseRelUsers()->matching($criteria);
    }

    /**
     * Check if $user is student in any course.
     */
    public function hasStudentInCourseList(User $user): bool
    {
        foreach ($this->courses as $sessionCourse) {
            if ($this->hasStudentInCourse($user, $sessionCourse->getCourse())) {
                return true;
            }
        }

        return false;
    }

    public function hasStudentInCourse(User $user, Course $course): bool
    {
        return $this->hasUserInCourse($user, $course, self::STUDENT);
    }

    protected function compareDates(?DateTime $start, ?DateTime $end = null): bool
    {
        $now = new DateTime('now');

        if (!empty($start) && !empty($end)) {
            return $now >= $start && $now <= $end;
        }

        if (!empty($start)) {
            return $now >= $start;
        }

        return !empty($end) && $now <= $end;
    }

    /**
     * @return Collection<int, User>
     */
    public function getCourseCoaches(): Collection
    {
        return $this->getCourseCoachesSubscriptions()
            ->map(fn (SessionRelCourseRelUser $subscription) => $subscription->getUser())
        ;
    }

    /**
     * @return Collection<int, SessionRelCourseRelUser>
     */
    #[Groups(['session:basic', 'user_subscriptions:sessions'])]
    public function getCourseCoachesSubscriptions(): Collection
    {
        return $this->getAllUsersFromCourse(self::COURSE_COACH);
    }

    public function isAvailableByDurationForUser(User $user): bool
    {
        $duration = $this->duration * 24 * 60 * 60;

        if (0 === $user->getTrackECourseAccess()->count()) {
            return true;
        }

        $trackECourseAccess = $user->getFirstAccessToSession($this);

        $firstAccess = $trackECourseAccess
            ? $trackECourseAccess->getLoginCourseDate()->getTimestamp()
            : 0;

        $userDurationData = $user->getSubscriptionToSession($this);

        $userDuration = $userDurationData
            ? ($userDurationData->getDuration() * 24 * 60 * 60)
            : 0;

        $totalDuration = $firstAccess + $duration + $userDuration;
        $currentTime = time();

        return $totalDuration > $currentTime;
    }

    public function getDaysLeftByUser(User $user): int
    {
        $userSessionSubscription = $user->getSubscriptionToSession($this);

        $duration = $this->duration;

        if ($userSessionSubscription) {
            $duration += $userSessionSubscription->getDuration();
        }

        $courseAccess = $user->getFirstAccessToSession($this);

        if (!$courseAccess) {
            return $duration;

        }

        $endDateInSeconds = $courseAccess->getLoginCourseDate()->getTimestamp() + $duration * 24 * 60 * 60;
        $currentTime = time();

        return (int) round(($endDateInSeconds - $currentTime) / 60 / 60 / 24);
    }

    private function getAccessVisibilityByDuration(User $user): int
    {
        // Session duration per student.
        if ($this->getDuration() > 0) {
            if ($this->hasCoach($user)) {
                return self::AVAILABLE;
            }

            $duration = $this->getDuration() * 24 * 60 * 60;
            $courseAccess = $user->getFirstAccessToSession($this);

            // If there is a session duration but there is no previous
            // access by the user, then the session is still available
            if (!$courseAccess) {
                return self::AVAILABLE;
            }

            $currentTime = time();
            $firstAccess = $courseAccess->getLoginCourseDate()->getTimestamp();
            $userSessionSubscription = $user->getSubscriptionToSession($this);
            $userDuration = $userSessionSubscription
                ? $userSessionSubscription->getDuration() * 24 * 60 * 60
                : 0;

            $totalDuration = $firstAccess + $duration + $userDuration;

            return $totalDuration > $currentTime ? self::AVAILABLE : $this->visibility;
        }

        return self::AVAILABLE;
    }

    /**
     * Checks whether the user is a course or session coach.
     */
    public function hasCoach(User $user): bool
    {
        return $this->hasUserAsGeneralCoach($user) || $this->hasCoachInCourseList($user);
    }

    private function getAcessVisibilityByDates(User $user): int
    {
        $now = new DateTime();

        $userIsCoach = $this->hasCoach($user);

        $sessionEndDate = $userIsCoach && $this->coachAccessEndDate
            ? $this->coachAccessEndDate
            : $this->accessEndDate;

        if (!$userIsCoach && $this->accessStartDate && $now < $this->accessStartDate) {
            return self::LIST_ONLY;
        }

        if ($sessionEndDate) {
            return $now <= $sessionEndDate ? self::AVAILABLE : $this->visibility;
        }

        return self::AVAILABLE;
    }

    public function setAccessVisibilityByUser(User $user, bool $ignoreVisibilityForAdmins = true): int
    {
        if (($user->isAdmin() || $user->isSuperAdmin()) && $ignoreVisibilityForAdmins) {
            $this->accessVisibility = self::AVAILABLE;
        } elseif (!$this->getAccessStartDate() && !$this->getAccessEndDate()) {
            // I don't care the session visibility.
            $this->accessVisibility = $this->getAccessVisibilityByDuration($user);
        } else {
            $this->accessVisibility = $this->getAcessVisibilityByDates($user);
        }

        return $this->accessVisibility;
    }

    public function getAccessVisibility(): int
    {
        if (0 === $this->accessVisibility) {
            throw new LogicException('Access visibility by user is not set');
        }

        return $this->accessVisibility;
    }

    public function getClosedOrHiddenCourses(): Collection
    {
        $closedVisibilities = [
            Course::CLOSED,
            Course::HIDDEN,
        ];

        return $this->courses->filter(fn (SessionRelCourse $sessionRelCourse) => \in_array(
            $sessionRelCourse->getCourse()->getVisibility(),
            $closedVisibilities
        ));
    }

    public function getParentId(): ?int
    {
        return $this->parentId;
    }

    public function setParentId(?int $parentId): self
    {
        $this->parentId = $parentId;

        return $this;
    }

    public function getDaysToReinscription(): ?int
    {
        return $this->daysToReinscription;
    }

    public function setDaysToReinscription(?int $daysToReinscription): self
    {
        $this->daysToReinscription = $daysToReinscription ?: null;

        return $this;
    }

    public function getLastRepetition(): bool
    {
        return $this->lastRepetition;
    }

    public function setLastRepetition(bool $lastRepetition): self
    {
        $this->lastRepetition = $lastRepetition;

        return $this;
    }

    public function getDaysToNewRepetition(): ?int
    {
        return $this->daysToNewRepetition;
    }

    public function setDaysToNewRepetition(?int $daysToNewRepetition): self
    {
        $this->daysToNewRepetition = $daysToNewRepetition ?: null;

        return $this;
    }

    public function getNotifyBoss(): bool
    {
        return $this->notifyBoss;
    }

    public function setNotifyBoss(bool $notifyBoss): self
    {
        $this->notifyBoss = $notifyBoss;

        return $this;
    }

    public function getValidityInDays(): ?int
    {
        return $this->validityInDays;
    }

    public function setValidityInDays(?int $validityInDays): self
    {
        $this->validityInDays = $validityInDays ?: null;

        return $this;
    }

    public function getDaysLeft(): ?int
    {
        return $this->daysLeft;
    }

    public function setDaysLeft(?int $daysLeft): self
    {
        $this->daysLeft = $daysLeft;

        return $this;
    }
}

chamilo / chamilo-lms

Pull Request — master (#7168)

Session::getDisplayEndDate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
