Skip to content

Commit ec327ab

Browse files
christianbeeznestchristianbeeznest
authored
Internal: Add catalogue filters and toggle icon for courses - refs #6154
Author: @christianbeeznest
1 parent 4e1f533 commit ec327ab

13 files changed

+658
-6
lines changed

‎assets/vue/composables/catalogue/catalogueCourseList.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export function useCatalogueCourseList() {
2929
isLoading.value = true
3030

3131
try {
32-
const { items } = await courseService.listAll()
32+
const items = await courseService.listCatalogueCourses()
3333

3434
courses.value = items.map((course) => ({
3535
...course,

‎assets/vue/services/courseService.js

+8
Original file line numberDiff line numberDiff line change
@@ -170,4 +170,12 @@ export default {
170170
return null
171171
}
172172
},
173+
/**
174+
* Loads public catalogue courses filtered by access_url and usergroup rules.
175+
* @returns {Promise<{items: Array}>}
176+
*/
177+
listCatalogueCourses: async () => {
178+
const response = await api.get("/catalogue/courses-list")
179+
return response.data
180+
},
173181
}

‎assets/vue/views/course/CatalogueCourses.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ const platformConfigStore = usePlatformConfig()
190190
const showCourseDuration = "true" === platformConfigStore.getSetting("course.show_course_duration")
191191
192192
const isUserInCourse = (course) => {
193-
return course.users.some((user) => user.user.id === securityStore.user.id)
193+
return Array.isArray(course.users) && course.users.some((user) => user.user.id === securityStore.user.id)
194194
}
195195
196196
load()

‎assets/vue/views/course/CatalogueSessions.vue

+4-4
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115
class="p-button-sm"
116116
>
117117
<BaseIcon icon="link-external" />
118-
{{ t("Go to the session") }}
118+
{{ $t("Go to the session") }}
119119
</BaseAppLink>
120120
</template>
121121
</Column>
@@ -183,7 +183,7 @@
183183
class="p-button-sm"
184184
icon="link-external"
185185
/>
186-
{{ t("Go to the course") }}
186+
{{ $t("Go to the course") }}
187187
</BaseAppLink>
188188
</template>
189189
</Column>
@@ -232,14 +232,14 @@ export default {
232232
load: function () {
233233
this.status = true
234234
axios
235-
.get(ENTRYPOINT + "sessions.json")
235+
.get("/catalogue/sessions-list")
236236
.then((response) => {
237237
this.status = false
238238
if (Array.isArray(response.data)) {
239239
this.sessions = response.data
240240
}
241241
})
242-
.catch(function (error) {
242+
.catch((error) => {
243243
console.log(error)
244244
})
245245
},

‎public/main/admin/course_list.php

+66
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@
1212
use Chamilo\CoreBundle\Component\Utils\ActionIcon;
1313
use Chamilo\CoreBundle\Component\Utils\StateIcon;
1414
use Chamilo\CoreBundle\Component\Utils\ToolIcon;
15+
use Chamilo\CoreBundle\Entity\AccessUrl;
16+
use Chamilo\CoreBundle\Entity\CatalogueCourseRelAccessUrlRelUsergroup;
1517
use Chamilo\CoreBundle\Framework\Container;
18+
use Chamilo\CoreBundle\Repository\CatalogueCourseRelAccessUrlRelUsergroupRepository;
1619

1720
$cidReset = true;
1821

@@ -257,6 +260,35 @@ function get_course_data(
257260
]
258261
);
259262

263+
$em = Database::getManager();
264+
/** @var CatalogueCourseRelAccessUrlRelUsergroupRepository $repo */
265+
$repo = $em->getRepository(CatalogueCourseRelAccessUrlRelUsergroup::class);
266+
$record = $repo->findOneBy([
267+
'course' => $courseId,
268+
'accessUrl' => api_get_current_access_url_id(),
269+
'usergroup' => null,
270+
]);
271+
272+
$isInCatalogue = null !== $record;
273+
$catalogueUrl = api_get_self().'?toggle_catalogue='.$course['id'].'&sec_token='.Security::getTokenFromSession();
274+
275+
$actions[] = Display::url(
276+
Display::getMdiIcon(
277+
$isInCatalogue ? StateIcon::CATALOGUE_OFF : StateIcon::CATALOGUE_ON,
278+
'ch-tool-icon',
279+
null,
280+
ICON_SIZE_SMALL,
281+
$isInCatalogue ? get_lang('Remove from catalogue') : get_lang('Add to catalogue'),
282+
[
283+
'class' => $isInCatalogue ? 'text-warning' : 'text-muted',
284+
]
285+
),
286+
$catalogueUrl,
287+
[
288+
'title' => $isInCatalogue ? get_lang('Remove from catalogue') : get_lang('Add to catalogue'),
289+
]
290+
);
291+
260292
$courseItem = [
261293
$course['col0'],
262294
$course['col1'],
@@ -340,6 +372,40 @@ function get_course_visibility_icon(int $visibility): string
340372
api_location(api_get_self());
341373
}
342374
}
375+
376+
if (isset($_GET['toggle_catalogue']) && Security::check_token('get')) {
377+
$courseId = (int) $_GET['toggle_catalogue'];
378+
$accessUrlId = api_get_current_access_url_id();
379+
$em = Database::getManager();
380+
$repo = $em->getRepository(CatalogueCourseRelAccessUrlRelUsergroup::class);
381+
$course = api_get_course_entity($courseId);
382+
$accessUrl = $em->getRepository(AccessUrl::class)->find($accessUrlId);
383+
384+
if ($course && $accessUrl) {
385+
$record = $repo->findOneBy([
386+
'course' => $course,
387+
'accessUrl' => $accessUrl,
388+
'usergroup' => null,
389+
]);
390+
391+
if ($record) {
392+
$em->remove($record);
393+
Display::addFlash(Display::return_message(get_lang('Removed from catalogue')));
394+
} else {
395+
$newRel = new CatalogueCourseRelAccessUrlRelUsergroup();
396+
$newRel->setCourse($course);
397+
$newRel->setAccessUrl($accessUrl);
398+
$newRel->setUsergroup(null);
399+
400+
$em->persist($newRel);
401+
Display::addFlash(Display::return_message(get_lang('Added to catalogue'), 'success'));
402+
}
403+
404+
$em->flush();
405+
}
406+
407+
api_location(api_get_self());
408+
}
343409
$content = '';
344410
$message = '';
345411
$actions = '';

‎src/CoreBundle/Component/Utils/StateIcon.php

+4
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,8 @@ enum StateIcon: string
6262
case OFFLINE = 'account-off';
6363
// Soft deleted (for a user)
6464
case REJECT = 'cancel';
65+
// Item is visible in the catalogue
66+
case CATALOGUE_ON = 'book-plus';
67+
// Item is hidden from the catalogue
68+
case CATALOGUE_OFF = 'book-minus-outline';
6569
}

‎src/CoreBundle/Controller/CatalogueController.php

+125
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
<?php
2+
3+
/* For licensing terms, see /license.txt */
4+
5+
declare(strict_types=1);
6+
7+
namespace Chamilo\CoreBundle\Controller;
8+
9+
use Chamilo\CoreBundle\Entity\CatalogueCourseRelAccessUrlRelUsergroup;
10+
use Chamilo\CoreBundle\Entity\CatalogueSessionRelAccessUrlRelUsergroup;
11+
use Chamilo\CoreBundle\Entity\Course;
12+
use Chamilo\CoreBundle\Entity\Session;
13+
use Chamilo\CoreBundle\Entity\UsergroupRelUser;
14+
use Chamilo\CoreBundle\Repository\Node\CourseRepository;
15+
use Chamilo\CoreBundle\Repository\SessionRepository;
16+
use Chamilo\CoreBundle\ServiceHelper\AccessUrlHelper;
17+
use Chamilo\CoreBundle\ServiceHelper\UserHelper;
18+
use Doctrine\ORM\EntityManagerInterface;
19+
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
20+
use Symfony\Component\HttpFoundation\JsonResponse;
21+
use Symfony\Component\Routing\Annotation\Route;
22+
23+
#[Route('/catalogue')]
24+
class CatalogueController extends AbstractController
25+
{
26+
public function __construct(
27+
private readonly EntityManagerInterface $em,
28+
private readonly UserHelper $userHelper,
29+
private readonly AccessUrlHelper $accessUrlHelper,
30+
private readonly CourseRepository $courseRepository,
31+
private readonly SessionRepository $sessionRepository
32+
) {}
33+
34+
#[Route('/courses-list', name: 'chamilo_core_catalogue_courses_list', methods: ['GET'])]
35+
public function listCourses(): JsonResponse
36+
{
37+
$user = $this->userHelper->getCurrent();
38+
$accessUrl = $this->accessUrlHelper->getCurrent();
39+
40+
$relRepo = $this->em->getRepository(CatalogueCourseRelAccessUrlRelUsergroup::class);
41+
$userGroupRepo = $this->em->getRepository(UsergroupRelUser::class);
42+
43+
$relations = $relRepo->findBy(['accessUrl' => $accessUrl]);
44+
45+
if (empty($relations)) {
46+
$courses = $this->courseRepository->findAll();
47+
} else {
48+
$userGroups = $userGroupRepo->findBy(['user' => $user]);
49+
$userGroupIds = array_map(fn($ug) => $ug->getUsergroup()->getId(), $userGroups);
50+
51+
$visibleCourses = [];
52+
53+
foreach ($relations as $rel) {
54+
$course = $rel->getCourse();
55+
$usergroup = $rel->getUsergroup();
56+
57+
if ($usergroup === null || in_array($usergroup->getId(), $userGroupIds)) {
58+
$visibleCourses[$course->getId()] = $course;
59+
}
60+
}
61+
62+
$courses = array_values($visibleCourses);
63+
}
64+
65+
$data = array_map(function (Course $course) {
66+
return [
67+
'id' => $course->getId(),
68+
'code' => $course->getCode(),
69+
'title' => $course->getTitle(),
70+
'description' => $course->getDescription(),
71+
'visibility' => $course->getVisibility(),
72+
];
73+
}, $courses);
74+
75+
return $this->json($data);
76+
}
77+
78+
#[Route('/sessions-list', name: 'chamilo_core_catalogue_sessions_list', methods: ['GET'])]
79+
public function listSessions(): JsonResponse
80+
{
81+
$user = $this->userHelper->getCurrent();
82+
$accessUrl = $this->accessUrlHelper->getCurrent();
83+
84+
$relRepo = $this->em->getRepository(CatalogueSessionRelAccessUrlRelUsergroup::class);
85+
$userGroupRepo = $this->em->getRepository(UsergroupRelUser::class);
86+
87+
$relations = $relRepo->findBy(['accessUrl' => $accessUrl]);
88+
89+
if (empty($relations)) {
90+
$sessions = $this->sessionRepository->findAll();
91+
} else {
92+
$userGroups = $userGroupRepo->findBy(['user' => $user]);
93+
$userGroupIds = array_map(fn($ug) => $ug->getUsergroup()->getId(), $userGroups);
94+
95+
$visibleSessions = [];
96+
97+
foreach ($relations as $rel) {
98+
$session = $rel->getSession();
99+
$usergroup = $rel->getUsergroup();
100+
101+
if ($usergroup === null || in_array($usergroup->getId(), $userGroupIds)) {
102+
$visibleSessions[$session->getId()] = $session;
103+
}
104+
}
105+
106+
$sessions = array_values($visibleSessions);
107+
}
108+
109+
$data = array_map(function (Session $session) {
110+
return [
111+
'id' => $session->getId(),
112+
'title' => $session->getTitle(),
113+
'description' => $session->getDescription(),
114+
'imageUrl' => $session->getImageUrl(),
115+
'visibility' => $session->getVisibility(),
116+
'nbrUsers' => $session->getNbrUsers(),
117+
'nbrCourses' => $session->getNbrCourses(),
118+
'startDate' => $session->getAccessStartDate()?->format('Y-m-d'),
119+
'endDate' => $session->getAccessEndDate()?->format('Y-m-d'),
120+
];
121+
}, $sessions);
122+
123+
return $this->json($data);
124+
}
125+
}

‎src/CoreBundle/Entity/CatalogueCourseRelAccessUrlRelUsergroup.php

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<?php
2+
3+
/* For licensing terms, see /license.txt */
4+
5+
declare(strict_types=1);
6+
7+
namespace Chamilo\CoreBundle\Entity;
8+
9+
use Chamilo\CoreBundle\Repository\CatalogueCourseRelAccessUrlRelUsergroupRepository;
10+
use Doctrine\ORM\Mapping as ORM;
11+
12+
#[ORM\Table(name: 'catalogue_course_rel_access_url_rel_usergroup')]
13+
#[ORM\Entity(repositoryClass: CatalogueCourseRelAccessUrlRelUsergroupRepository::class)]
14+
class CatalogueCourseRelAccessUrlRelUsergroup
15+
{
16+
#[ORM\Id]
17+
#[ORM\GeneratedValue]
18+
#[ORM\Column(type: 'integer')]
19+
private ?int $id = null;
20+
21+
#[ORM\ManyToOne(targetEntity: Course::class)]
22+
#[ORM\JoinColumn(name: 'course_id', referencedColumnName: 'id', onDelete: 'CASCADE')]
23+
private Course $course;
24+
25+
#[ORM\ManyToOne(targetEntity: AccessUrl::class)]
26+
#[ORM\JoinColumn(name: 'access_url_id', referencedColumnName: 'id', onDelete: 'CASCADE')]
27+
private AccessUrl $accessUrl;
28+
29+
#[ORM\ManyToOne(targetEntity: Usergroup::class)]
30+
#[ORM\JoinColumn(name: 'usergroup_id', referencedColumnName: 'id', nullable: true, onDelete: 'SET NULL')]
31+
private ?Usergroup $usergroup = null;
32+
33+
34+
public function getId(): ?int
35+
{
36+
return $this->id;
37+
}
38+
39+
public function getCourse(): Course
40+
{
41+
return $this->course;
42+
}
43+
44+
public function setCourse(Course $course): self
45+
{
46+
$this->course = $course;
47+
48+
return $this;
49+
}
50+
51+
public function getAccessUrl(): AccessUrl
52+
{
53+
return $this->accessUrl;
54+
}
55+
56+
public function setAccessUrl(AccessUrl $accessUrl): self
57+
{
58+
$this->accessUrl = $accessUrl;
59+
60+
return $this;
61+
}
62+
63+
public function getUsergroup(): ?Usergroup
64+
{
65+
return $this->usergroup;
66+
}
67+
68+
public function setUsergroup(?Usergroup $usergroup): self
69+
{
70+
$this->usergroup = $usergroup;
71+
72+
return $this;
73+
}
74+
}

0 commit comments

Comments
 (0)