CourseRepository::getSubscribedStudents() - Code Metrics - Inspection of "Merge branch 'master' of github.com:chamilo/chamil..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 769c74...60f6e4 )

by Yannick

created 2024-02-29 01:06 UTC

CourseRepository::getSubscribedStudents() A

↳ Parent: CourseRepository

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	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

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

namespace Chamilo\CoreBundle\Repository\Node;

use Chamilo\CoreBundle\Component\Utils\ChamiloApi;
use Chamilo\CoreBundle\Entity\AccessUrl;
use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Entity\CourseRelUser;
use Chamilo\CoreBundle\Entity\ResourceNode;
use Chamilo\CoreBundle\Entity\User;
use Chamilo\CoreBundle\Repository\ResourceRepository;
use Doctrine\Common\Collections\Criteria;
use Doctrine\ORM\Query\Expr\Join;
use Doctrine\ORM\QueryBuilder;
use Doctrine\Persistence\ManagerRegistry;

/**
 * Class CourseRepository.
 *
 * The functions inside this class should return an instance of QueryBuilder.
 */
class CourseRepository extends ResourceRepository
{
    public function __construct(ManagerRegistry $registry)
    {
        parent::__construct($registry, Course::class);
    }

    public function deleteCourse(Course $course): void
    {
        $em = $this->getEntityManager();

        // Deleting all nodes connected to the course:
        // $node = $course->getResourceNode();
        // $children = $node->getChildren();
        // /* var ResourceNode $child
        /*foreach ($children as $child) {
            var_dump($child->getId().'-'.$child->getTitle().'<br />');
            var_dump(get_class($child));
            $em->remove($child);
        }*/

        $em->remove($course);
        $em->flush();
        $em->clear();
    }

    public function findOneByCode(string $code): ?Course
    {
        return $this->findOneBy([
            'code' => $code,
        ]);
    }

    /**
     * Get course user relationship based in the course_rel_user table.
     *
     * @return CourseRelUser[]
     */
    public function getCoursesByUser(User $user, AccessUrl $url)
    {
        $qb = $this->getEntityManager()->createQueryBuilder();

        $qb
            ->select('courseRelUser')
            ->from(Course::class, 'c')
            ->innerJoin(CourseRelUser::class, 'courseRelUser')
            // ->innerJoin('c.users', 'courseRelUser')
            ->innerJoin('c.urls', 'accessUrlRelCourse')
            ->where('courseRelUser.user = :user')
            ->andWhere('accessUrlRelCourse.url = :url')
            ->setParameters([
                'user' => $user,
                'url' => $url,
            ])
        ;

        $query = $qb->getQuery();

        return $query->getResult();
    }

    /**
     * Get info from courses where the user has the given role.
     * @param User $user
     * @param AccessUrl $url
     * @param int $status
     * @param string $keyword
     * @return Course[]
     */
    public function getCoursesInfoByUser(User $user, AccessUrl $url, int $status, string $keyword = ''): array
    {
        $qb = $this->getEntityManager()->createQueryBuilder();

        $qb
            ->select('DISTINCT c.id')
            ->from(Course::class, 'c')
            ->innerJoin(CourseRelUser::class, 'courseRelUser')
            ->innerJoin('c.urls', 'accessUrlRelCourse')
            ->where('accessUrlRelCourse.url = :url')
            ->andWhere('courseRelUser.user = :user')
            ->andWhere('courseRelUser.status = :status')
            ->setParameters([
                'user' => $user,
                'url' => $url,
                'status' => $status
            ])
        ;
        if (!empty($keyword)) {
            $qb
                ->andWhere('c.title like = :keyword OR c.code like = :keyword')
                ->setParameter('keyword', $keyword)
            ;
        }

        $query = $qb->getQuery();

        return $query->getResult();
    }

    /**
     * Get all users that are registered in the course. No matter the status.
     *
     * @return QueryBuilder
     */
    public function getSubscribedUsers(Course $course)
    {
        // Course builder
        $queryBuilder = $this->createQueryBuilder('c');

        // Selecting user info.
        $queryBuilder->select('DISTINCT user');

        // Selecting courses for users.
        $queryBuilder->innerJoin('c.users', 'subscriptions');
        $queryBuilder->innerJoin(
            User::class,
            'user',
            Join::WITH,
            'subscriptions.user = user.id'
        );

        if (api_is_western_name_order()) {
            $queryBuilder->orderBy('user.firstname', Criteria::ASC);
        } else {
            $queryBuilder->orderBy('user.lastname', Criteria::ASC);
        }

        $wherePart = $queryBuilder->expr()->andx();

        // Get only users subscribed to this course
        $wherePart->add($queryBuilder->expr()->eq('c.id', $course->getId()));

        // $wherePart->add($queryBuilder->expr()->eq('c.status', $status));

        $queryBuilder->where($wherePart);

        return $queryBuilder;
    }

    /**
     * Gets students subscribed in the course.
     *
     * @return QueryBuilder
     */
    public function getSubscribedStudents(Course $course)
    {
        return $this->getSubscribedUsersByStatus($course, STUDENT);
    }

    /**
     * Gets the students subscribed in the course.
     *
     * @return QueryBuilder
     */
    public function getSubscribedCoaches(Course $course)
    {
        return $this->getSubscribedUsers($course);
    }

    /**
     * Gets the teachers subscribed in the course.
     *
     * @return QueryBuilder
     */
    public function getSubscribedTeachers(Course $course)
    {
        return $this->getSubscribedUsersByStatus($course, ChamiloApi::COURSE_MANAGER);
    }

    /**
     * @param int $status use legacy chamilo constants COURSEMANAGER|STUDENT
     *
     * @return QueryBuilder
     */
    public function getSubscribedUsersByStatus(Course $course, int $status)
    {
        $queryBuilder = $this->getSubscribedUsers($course);
        $queryBuilder
            ->andWhere(
                $queryBuilder->expr()->eq('subscriptions.status', $status)
            )
        ;

        return $queryBuilder;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\CoreBundle\Repository\Node;
8
9			use Chamilo\CoreBundle\Component\Utils\ChamiloApi;
10			use Chamilo\CoreBundle\Entity\AccessUrl;
11			use Chamilo\CoreBundle\Entity\Course;
12			use Chamilo\CoreBundle\Entity\CourseRelUser;
13			use Chamilo\CoreBundle\Entity\ResourceNode;
14			use Chamilo\CoreBundle\Entity\User;
15			use Chamilo\CoreBundle\Repository\ResourceRepository;
16			use Doctrine\Common\Collections\Criteria;
17			use Doctrine\ORM\Query\Expr\Join;
18			use Doctrine\ORM\QueryBuilder;
19			use Doctrine\Persistence\ManagerRegistry;
20
21			/**
22			* Class CourseRepository.
23			*
24			* The functions inside this class should return an instance of QueryBuilder.
25			*/
26			class CourseRepository extends ResourceRepository
27			{
28			public function __construct(ManagerRegistry $registry)
29			{
30			parent::__construct($registry, Course::class);
31			}
32
33			public function deleteCourse(Course $course): void
34			{
35			$em = $this->getEntityManager();
36
37			// Deleting all nodes connected to the course:
38			// $node = $course->getResourceNode();
39			// $children = $node->getChildren();
40			// /* var ResourceNode $child
41			/*foreach ($children as $child) {
42			var_dump($child->getId().'-'.$child->getTitle().'<br />');
43			var_dump(get_class($child));
44			$em->remove($child);
45			}*/
46
47			$em->remove($course);
48			$em->flush();
49			$em->clear();
50			}
51
52			public function findOneByCode(string $code): ?Course
53			{
54			return $this->findOneBy([
55			'code' => $code,
56			]);
57			}
58
59			/**
60			* Get course user relationship based in the course_rel_user table.
61			*
62			* @return CourseRelUser[]
63			*/
64			public function getCoursesByUser(User $user, AccessUrl $url)
65			{
66			$qb = $this->getEntityManager()->createQueryBuilder();
67
68			$qb
69			->select('courseRelUser')
70			->from(Course::class, 'c')
71			->innerJoin(CourseRelUser::class, 'courseRelUser')
72			// ->innerJoin('c.users', 'courseRelUser')
73			->innerJoin('c.urls', 'accessUrlRelCourse')
74			->where('courseRelUser.user = :user')
75			->andWhere('accessUrlRelCourse.url = :url')
76			->setParameters([
77			'user' => $user,
78			'url' => $url,
79			])
80			;
81
82			$query = $qb->getQuery();
83
84			return $query->getResult();
85			}
86
87			/**
88			* Get info from courses where the user has the given role.
89			* @param User $user
90			* @param AccessUrl $url
91			* @param int $status
92			* @param string $keyword
93			* @return Course[]
94			*/
95			public function getCoursesInfoByUser(User $user, AccessUrl $url, int $status, string $keyword = ''): array
96			{
97			$qb = $this->getEntityManager()->createQueryBuilder();
98
99			$qb
100			->select('DISTINCT c.id')
101			->from(Course::class, 'c')
102			->innerJoin(CourseRelUser::class, 'courseRelUser')
103			->innerJoin('c.urls', 'accessUrlRelCourse')
104			->where('accessUrlRelCourse.url = :url')
105			->andWhere('courseRelUser.user = :user')
106			->andWhere('courseRelUser.status = :status')
107			->setParameters([
108			'user' => $user,
109			'url' => $url,
110			'status' => $status
111			])
112			;
113			if (!empty($keyword)) {
114			$qb
115			->andWhere('c.title like = :keyword OR c.code like = :keyword')
116			->setParameter('keyword', $keyword)
117			;
118			}
119
120			$query = $qb->getQuery();
121
122			return $query->getResult();
123			}
124
125			/**
126			* Get all users that are registered in the course. No matter the status.
127			*
128			* @return QueryBuilder
129			*/
130			public function getSubscribedUsers(Course $course)
131			{
132			// Course builder
133			$queryBuilder = $this->createQueryBuilder('c');
134
135			// Selecting user info.
136			$queryBuilder->select('DISTINCT user');
137
138			// Selecting courses for users.
139			$queryBuilder->innerJoin('c.users', 'subscriptions');
140			$queryBuilder->innerJoin(
141			User::class,
142			'user',
143			Join::WITH,
144			'subscriptions.user = user.id'
145			);
146
147			if (api_is_western_name_order()) {
148			$queryBuilder->orderBy('user.firstname', Criteria::ASC);
149			} else {
150			$queryBuilder->orderBy('user.lastname', Criteria::ASC);
151			}
152
153			$wherePart = $queryBuilder->expr()->andx();
154
155			// Get only users subscribed to this course
156			$wherePart->add($queryBuilder->expr()->eq('c.id', $course->getId()));
157
158			// $wherePart->add($queryBuilder->expr()->eq('c.status', $status));
159
160			$queryBuilder->where($wherePart);
161
162			return $queryBuilder;
163			}
164
165			/**
166			* Gets students subscribed in the course.
167			*
168			* @return QueryBuilder
169			*/
170			public function getSubscribedStudents(Course $course)
171			{
172			return $this->getSubscribedUsersByStatus($course, STUDENT);
173			}
174
175			/**
176			* Gets the students subscribed in the course.
177			*
178			* @return QueryBuilder
179			*/
180			public function getSubscribedCoaches(Course $course)
181			{
182			return $this->getSubscribedUsers($course);
183			}
184
185			/**
186			* Gets the teachers subscribed in the course.
187			*
188			* @return QueryBuilder
189			*/
190			public function getSubscribedTeachers(Course $course)
191			{
192			return $this->getSubscribedUsersByStatus($course, ChamiloApi::COURSE_MANAGER);
193			}
194
195			/**
196			* @param int $status use legacy chamilo constants COURSEMANAGER\|STUDENT
197			*
198			* @return QueryBuilder
199			*/
200			public function getSubscribedUsersByStatus(Course $course, int $status)
201			{
202			$queryBuilder = $this->getSubscribedUsers($course);
203			$queryBuilder
204			->andWhere(
205			$queryBuilder->expr()->eq('subscriptions.status', $status)
206			)
207			;
208
209			return $queryBuilder;
210			}
211			}
212

chamilo / chamilo-lms

Push — master ( 769c74...60f6e4 )

CourseRepository::getSubscribedStudents() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like