CourseRelUserRepository::getCapacitySnapshot() - Code Metrics - Inspection of "Admin: Enforce hosting_limit_users_per_course w/o..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#7026)

unknown

created 2025-11-10 19:38 UTC

CourseRelUserRepository::getCapacitySnapshot() A

↳ Parent: CourseRelUserRepository

Complexity

Conditions	6
Paths	9

Size

Total Lines	28
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	15
nc	9
nop	2
dl	0
loc	28
rs	9.2222
c	0
b	0
f	0

<?php

declare(strict_types=1);

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

namespace Chamilo\CoreBundle\Repository;

use Chamilo\CoreBundle\Entity\CourseRelUser;
use Chamilo\CoreBundle\Entity\User;
use Chamilo\CourseBundle\Entity\CLp;
use Chamilo\CourseBundle\Entity\CLpView;
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
use Doctrine\Persistence\ManagerRegistry;

class CourseRelUserRepository extends ServiceEntityRepository
{
    public function __construct(ManagerRegistry $registry)
    {
        parent::__construct($registry, CourseRelUser::class);
    }

    /**
     * Retrieves users from a course and their LP progress (without session).
     */
    public function getCourseUsers(int $courseId, array $lpIds): array
    {
        $qb = $this->createQueryBuilder('cu')
            ->select('u.id AS userId, c.title AS courseTitle, lp.iid AS lpId, COALESCE(lpv.progress, 0) AS progress')
            ->innerJoin('cu.user', 'u')
            ->innerJoin('cu.course', 'c')
            ->leftJoin(CLpView::class, 'lpv', 'WITH', 'lpv.user = u.id AND lpv.course = cu.course AND lpv.lp IN (:lpIds)')
            ->leftJoin(CLp::class, 'lp', 'WITH', 'lp.iid IN (:lpIds)')
            ->innerJoin('lp.resourceNode', 'rn')
            ->where('cu.course = :courseId')
            ->andWhere('rn.parent = c.resourceNode')
            ->andWhere('(lpv.progress < 100 OR lpv.progress IS NULL)')
            ->setParameter('courseId', $courseId)
            ->setParameter('lpIds', $lpIds)
        ;

        return $qb->getQuery()->getResult();
    }

    /**
     * Count distinct courses where the given user is a teacher (status == TEACHER).
     */
    public function countTaughtCoursesForUser(User $user): int
    {
        return (int) $this->createQueryBuilder('cru')
            ->select('COUNT(DISTINCT c.id)')
            ->innerJoin('cru.course', 'c')
            ->andWhere('cru.user = :user')
            ->andWhere('cru.status = :teacher')
            ->setParameter('user', $user)
            ->setParameter('teacher', CourseRelUser::TEACHER)
            ->getQuery()
            ->getSingleScalarResult();
    }

    /**
     * Count all subscriptions (any status) for the given course ID.
     * Optionally exclude a specific relationType (e.g., RRHH).
     *
     * @param int        $courseId
     * @param int|null   $excludeRelationType If provided, rows with this relationType are excluded
     */
    public function countAllByCourseId(int $courseId, ?int $excludeRelationType = null): int
    {
        $qb = $this->createQueryBuilder('cru')
            ->select('COUNT(cru.id)')
            ->innerJoin('cru.course', 'c')
            ->andWhere('c.id = :cid')
            ->setParameter('cid', $courseId);

        if (null !== $excludeRelationType) {
            $qb->andWhere('cru.relationType <> :rt')
                ->setParameter('rt', $excludeRelationType);
        }

        return (int) $qb->getQuery()->getSingleScalarResult();
    }

    /**
     * Compute a capacity snapshot for UI (limit/used/left/is_full).
     * This only considers the global hosting limit and an optional per-course limit
     * already computed by caller. A limit of 0 means "no limit".
     *
     * @param int        $courseId
     * @param int|null   $perCourseLimit  Optional course-level limit (e.g., extra field). If provided, the effective
     *                                    limit will be min(global, per-course). If null, only global limit is used.
     *
     * @return array{limit:int, used:int, left:int|null, is_full:bool}
     */
    public function getCapacitySnapshot(int $courseId, ?int $perCourseLimit = null): array
    {
        // Read global limit (0 means unlimited)
        $global = (int) api_get_setting('hosting_limit_users_per_course');

        // Effective limit resolution rule:
        // - if per-course limit is provided and > 0, use min(global, per-course) when global > 0, else per-course
        // - else use global as-is (0 => unlimited)
        $limit = 0;
        if ($perCourseLimit && $perCourseLimit > 0) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $limit = $global > 0 ? min($global, $perCourseLimit) : $perCourseLimit;
        } else {
            $limit = $global;
        }

        if ($limit <= 0) {
            return ['limit' => 0, 'used' => 0, 'left' => null, 'is_full' => false];
        }

        // Exclude RRHH relation type if available (keeps legacy behavior)
        $exclude = \defined('COURSE_RELATION_TYPE_RRHH') ? COURSE_RELATION_TYPE_RRHH : null;
        $used = $this->countAllByCourseId($courseId, $exclude);

        return [
            'limit'   => $limit,
            'used'    => $used,
            'left'    => max(0, $limit - $used),
            'is_full' => $used >= $limit,
        ];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\CoreBundle\Repository;
8
9			use Chamilo\CoreBundle\Entity\CourseRelUser;
10			use Chamilo\CoreBundle\Entity\User;
11			use Chamilo\CourseBundle\Entity\CLp;
12			use Chamilo\CourseBundle\Entity\CLpView;
13			use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
14			use Doctrine\Persistence\ManagerRegistry;
15
16			class CourseRelUserRepository extends ServiceEntityRepository
17			{
18			public function __construct(ManagerRegistry $registry)
19			{
20			parent::__construct($registry, CourseRelUser::class);
21			}
22
23			/**
24			* Retrieves users from a course and their LP progress (without session).
25			*/
26			public function getCourseUsers(int $courseId, array $lpIds): array
27			{
28			$qb = $this->createQueryBuilder('cu')
29			->select('u.id AS userId, c.title AS courseTitle, lp.iid AS lpId, COALESCE(lpv.progress, 0) AS progress')
30			->innerJoin('cu.user', 'u')
31			->innerJoin('cu.course', 'c')
32			->leftJoin(CLpView::class, 'lpv', 'WITH', 'lpv.user = u.id AND lpv.course = cu.course AND lpv.lp IN (:lpIds)')
33			->leftJoin(CLp::class, 'lp', 'WITH', 'lp.iid IN (:lpIds)')
34			->innerJoin('lp.resourceNode', 'rn')
35			->where('cu.course = :courseId')
36			->andWhere('rn.parent = c.resourceNode')
37			->andWhere('(lpv.progress < 100 OR lpv.progress IS NULL)')
38			->setParameter('courseId', $courseId)
39			->setParameter('lpIds', $lpIds)
40			;
41
42			return $qb->getQuery()->getResult();
43			}
44
45			/**
46			* Count distinct courses where the given user is a teacher (status == TEACHER).
47			*/
48			public function countTaughtCoursesForUser(User $user): int
49			{
50			return (int) $this->createQueryBuilder('cru')
51			->select('COUNT(DISTINCT c.id)')
52			->innerJoin('cru.course', 'c')
53			->andWhere('cru.user = :user')
54			->andWhere('cru.status = :teacher')
55			->setParameter('user', $user)
56			->setParameter('teacher', CourseRelUser::TEACHER)
57			->getQuery()
58			->getSingleScalarResult();
59			}
60
61			/**
62			* Count all subscriptions (any status) for the given course ID.
63			* Optionally exclude a specific relationType (e.g., RRHH).
64			*
65			* @param int $courseId
66			* @param int\|null $excludeRelationType If provided, rows with this relationType are excluded
67			*/
68			public function countAllByCourseId(int $courseId, ?int $excludeRelationType = null): int
69			{
70			$qb = $this->createQueryBuilder('cru')
71			->select('COUNT(cru.id)')
72			->innerJoin('cru.course', 'c')
73			->andWhere('c.id = :cid')
74			->setParameter('cid', $courseId);
75
76			if (null !== $excludeRelationType) {
77			$qb->andWhere('cru.relationType <> :rt')
78			->setParameter('rt', $excludeRelationType);
79			}
80
81			return (int) $qb->getQuery()->getSingleScalarResult();
82			}
83
84			/**
85			* Compute a capacity snapshot for UI (limit/used/left/is_full).
86			* This only considers the global hosting limit and an optional per-course limit
87			* already computed by caller. A limit of 0 means "no limit".
88			*
89			* @param int $courseId
90			* @param int\|null $perCourseLimit Optional course-level limit (e.g., extra field). If provided, the effective
91			* limit will be min(global, per-course). If null, only global limit is used.
92			*
93			* @return array{limit:int, used:int, left:int\|null, is_full:bool}
94			*/
95			public function getCapacitySnapshot(int $courseId, ?int $perCourseLimit = null): array
96			{
97			// Read global limit (0 means unlimited)
98			$global = (int) api_get_setting('hosting_limit_users_per_course');
99
100			// Effective limit resolution rule:
101			// - if per-course limit is provided and > 0, use min(global, per-course) when global > 0, else per-course
102			// - else use global as-is (0 => unlimited)
103			$limit = 0;
104			if ($perCourseLimit && $perCourseLimit > 0) {
			0 ignored issues – show Bug Best Practice introduced 2025-11-10 19:47 UTC by Report Bug Copy Issue Report The expression `$perCourseLimit` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be 0. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
105			$limit = $global > 0 ? min($global, $perCourseLimit) : $perCourseLimit;
106			} else {
107			$limit = $global;
108			}
109
110			if ($limit <= 0) {
111			return ['limit' => 0, 'used' => 0, 'left' => null, 'is_full' => false];
112			}
113
114			// Exclude RRHH relation type if available (keeps legacy behavior)
115			$exclude = \defined('COURSE_RELATION_TYPE_RRHH') ? COURSE_RELATION_TYPE_RRHH : null;
116			$used = $this->countAllByCourseId($courseId, $exclude);
117
118			return [
119			'limit' => $limit,
120			'used' => $used,
121			'left' => max(0, $limit - $used),
122			'is_full' => $used >= $limit,
123			];
124			}
125			}
126

chamilo / chamilo-lms

Pull Request — master (#7026)

CourseRelUserRepository::getCapacitySnapshot() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like