CGroup::setDescription() - Code Metrics - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

CGroup::setDescription() A
last analyzed 2025-12-14 00:14 UTC

↳ Parent: CGroup

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	5
rs	10

<?php

declare(strict_types=1);

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

namespace Chamilo\CourseBundle\Entity;

use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
use ApiPlatform\Metadata\ApiFilter;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\OpenApi\Model\Operation;
use ApiPlatform\OpenApi\Model\Parameter;
use Chamilo\CoreBundle\Entity\AbstractResource;
use Chamilo\CoreBundle\Entity\ResourceInterface;
use Chamilo\CoreBundle\Entity\User;
use Chamilo\CourseBundle\Repository\CGroupRepository;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Stringable;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Uid\Uuid;
use Symfony\Component\Validator\Constraints as Assert;

#[ApiResource(
    shortName: 'Group',
    operations: [
        new GetCollection(
            uriTemplate: '/groups',
            openapi: new Operation(
                parameters: [
                    new Parameter(
                        name: 'resourceNode.parent',
                        in: 'query',
                        required: true,
                        description: 'Filter groups by the parent resource node (course)',
                        schema: ['type' => 'integer'],
                    ),
                ],
            )
        ),
        new Get(security: "is_granted('VIEW', object.resourceNode)"),
    ],
    normalizationContext: ['groups' => ['group:read']],
    denormalizationContext: ['groups' => ['group:write']],
    paginationEnabled: true
)]
#[ApiFilter(SearchFilter::class, properties: ['resourceNode.parent' => 'exact'])]
#[ORM\Table(name: 'c_group_info')]
#[ORM\Entity(repositoryClass: CGroupRepository::class)]
class CGroup extends AbstractResource implements ResourceInterface, Stringable
{
    public const TOOL_NOT_AVAILABLE = 0;
    public const TOOL_PUBLIC = 1;
    public const TOOL_PRIVATE = 2;
    public const TOOL_PRIVATE_BETWEEN_USERS = 3;
    #[ORM\Column(name: 'iid', type: 'integer')]
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[Groups(['group:read', 'group:write'])]
    protected ?int $iid = null;
    #[Assert\NotBlank]
    #[ORM\Column(name: 'title', type: 'string', length: 100, nullable: false)]
    #[Groups(['group:read', 'group:write'])]
    protected string $title;
    #[Assert\NotNull]
    #[ORM\Column(name: 'status', type: 'boolean', nullable: false)]
    #[Groups(['group:read', 'group:write'])]
    protected bool $status;
    #[ORM\ManyToOne(targetEntity: CGroupCategory::class, cascade: ['persist'])]
    #[ORM\JoinColumn(name: 'category_id', referencedColumnName: 'iid', onDelete: 'CASCADE')]
    protected ?CGroupCategory $category = null;
    #[ORM\Column(name: 'description', type: 'text', nullable: true)]
    #[Groups(['group:read', 'group:write'])]
    protected ?string $description = null;
    #[Assert\NotBlank]
    #[ORM\Column(name: 'max_student', type: 'integer')]
    protected int $maxStudent;
    #[ORM\Column(name: 'doc_state', type: 'integer')]
    protected int $docState;
    #[ORM\Column(name: 'calendar_state', type: 'integer')]
    protected int $calendarState;
    #[ORM\Column(name: 'work_state', type: 'integer')]
    protected int $workState;
    #[ORM\Column(name: 'announcements_state', type: 'integer')]
    protected int $announcementsState;
    #[ORM\Column(name: 'forum_state', type: 'integer')]
    protected int $forumState;
    #[ORM\Column(name: 'wiki_state', type: 'integer')]
    protected int $wikiState;
    #[ORM\Column(name: 'chat_state', type: 'integer')]
    protected int $chatState;
    #[ORM\Column(name: 'self_registration_allowed', type: 'boolean')]
    protected bool $selfRegistrationAllowed;
    #[ORM\Column(name: 'self_unregistration_allowed', type: 'boolean')]
    protected bool $selfUnregistrationAllowed;
    #[ORM\Column(name: 'document_access', type: 'integer', options: ['default' => 0])]
    protected int $documentAccess;

    /**
     * @var Collection<int, CGroupRelUser>
     */
    #[ORM\OneToMany(mappedBy: 'group', targetEntity: CGroupRelUser::class)]
    protected Collection $members;

    /**
     * @var Collection<int, CGroupRelTutor>
     */
    #[ORM\OneToMany(mappedBy: 'group', targetEntity: CGroupRelTutor::class)]
    protected Collection $tutors;
    public function __construct()
    {
        $this->status = true;
        $this->members = new ArrayCollection();
        $this->tutors = new ArrayCollection();
        // Default values
        $defaultVisibility = self::TOOL_PRIVATE;
        $this->docState = $defaultVisibility;
        $this->calendarState = $defaultVisibility;
        $this->workState = $defaultVisibility;
        $this->announcementsState = $defaultVisibility;
        $this->forumState = $defaultVisibility;
        $this->wikiState = $defaultVisibility;
        $this->chatState = $defaultVisibility;
        $this->documentAccess = $defaultVisibility;
        $this->selfRegistrationAllowed = false;
        $this->selfUnregistrationAllowed = false;
    }
    public function __toString(): string
    {
        return $this->getTitle();
    }

    public function getIid(): ?int
    {
        return $this->iid;
    }

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

        return $this;
    }

    public function getTitle(): string
    {
        return $this->title;
    }
    public function setStatus(bool $status): self
    {
        $this->status = $status;

        return $this;
    }
    public function getStatus(): bool
    {
        return $this->status;
    }
    public function setDescription(string $description): self
    {
        $this->description = $description;

        return $this;
    }
    public function getDescription(): ?string
    {
        return $this->description;
    }
    public function setMaxStudent(int $maxStudent): self
    {
        $this->maxStudent = $maxStudent;

        return $this;
    }
    public function getMaxStudent(): int
    {
        return $this->maxStudent;
    }
    public function setDocState(int $docState): self
    {
        $this->docState = $docState;

        return $this;
    }

    public function getDocState(): int
    {
        return $this->docState;
    }
    public function setCalendarState(int $calendarState): self
    {
        $this->calendarState = $calendarState;

        return $this;
    }

    public function getCalendarState(): int
    {
        return $this->calendarState;
    }
    public function setWorkState(int $workState): self
    {
        $this->workState = $workState;

        return $this;
    }

    public function getWorkState(): int
    {
        return $this->workState;
    }
    public function setAnnouncementsState(int $announcementsState): self
    {
        $this->announcementsState = $announcementsState;

        return $this;
    }

    public function getAnnouncementsState(): int
    {
        return $this->announcementsState;
    }
    public function setForumState(int $forumState): self
    {
        $this->forumState = $forumState;

        return $this;
    }
    public function getForumState(): int
    {
        return $this->forumState;
    }
    public function setWikiState(int $wikiState): self
    {
        $this->wikiState = $wikiState;

        return $this;
    }

    public function getWikiState(): int
    {
        return $this->wikiState;
    }
    public function setChatState(int $chatState): self
    {
        $this->chatState = $chatState;

        return $this;
    }

    public function getChatState(): int
    {
        return $this->chatState;
    }
    public function setSelfRegistrationAllowed(bool $selfRegistrationAllowed): self
    {
        $this->selfRegistrationAllowed = $selfRegistrationAllowed;

        return $this;
    }

    public function getSelfRegistrationAllowed(): bool
    {
        return $this->selfRegistrationAllowed;
    }
    public function setSelfUnregistrationAllowed(bool $selfUnregistrationAllowed): self
    {
        $this->selfUnregistrationAllowed = $selfUnregistrationAllowed;

        return $this;
    }

    public function getSelfUnregistrationAllowed(): bool
    {
        return $this->selfUnregistrationAllowed;
    }
    public function getDocumentAccess(): int
    {
        return $this->documentAccess;
    }
    public function setDocumentAccess(int $documentAccess): self
    {
        $this->documentAccess = $documentAccess;

        return $this;
    }

    /**
     * @return Collection<int, CGroupRelUser>
     */
    public function getMembers(): Collection
    {
        return $this->members;
    }

    public function setMembers(Collection $members): self
    {
        $this->members = $members;

        return $this;
    }
    public function hasMembers(): bool
    {
        return $this->members->count() > 0;
    }
    public function hasMember(User $user): bool
    {
        if (!$this->hasMembers()) {
            return false;
        }
        $list = $this->members->filter(fn (CGroupRelUser $member) => $member->getUser()->getId() === $user->getId());

        return $list->count() > 0;
    }
    public function hasTutor(User $user): bool
    {
        if (!$this->hasTutors()) {
            return false;
        }
        $list = $this->tutors->filter(fn (CGroupRelTutor $tutor) => $tutor->getUser()->getId() === $user->getId());

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

    /**
     * @return Collection<int, CGroupRelTutor>
     */
    public function getTutors(): Collection
    {
        return $this->tutors;
    }

    public function setTutors(Collection $tutors): self
    {
        $this->tutors = $tutors;

        return $this;
    }
    public function hasTutors(): bool
    {
        return $this->tutors->count() > 0;
    }
    public function getCategory(): ?CGroupCategory
    {
        return $this->category;
    }
    public function setCategory(?CGroupCategory $category = null): self
    {
        $this->category = $category;

        return $this;
    }

    public function getResourceIdentifier(): int|Uuid
    {
        return $this->iid;

    }
    public function getResourceName(): string
    {
        return $this->getTitle();
    }
    public function setResourceName(string $name): self
    {
        return $this->setTitle($name);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\CourseBundle\Entity;
8
9			use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
10			use ApiPlatform\Metadata\ApiFilter;
11			use ApiPlatform\Metadata\ApiResource;
12			use ApiPlatform\Metadata\Get;
13			use ApiPlatform\Metadata\GetCollection;
14			use ApiPlatform\OpenApi\Model\Operation;
15			use ApiPlatform\OpenApi\Model\Parameter;
16			use Chamilo\CoreBundle\Entity\AbstractResource;
17			use Chamilo\CoreBundle\Entity\ResourceInterface;
18			use Chamilo\CoreBundle\Entity\User;
19			use Chamilo\CourseBundle\Repository\CGroupRepository;
20			use Doctrine\Common\Collections\ArrayCollection;
21			use Doctrine\Common\Collections\Collection;
22			use Doctrine\ORM\Mapping as ORM;
23			use Stringable;
24			use Symfony\Component\Serializer\Annotation\Groups;
25			use Symfony\Component\Uid\Uuid;
26			use Symfony\Component\Validator\Constraints as Assert;
27
28			#[ApiResource(
29			shortName: 'Group',
30			operations: [
31			new GetCollection(
32			uriTemplate: '/groups',
33			openapi: new Operation(
34			parameters: [
35			new Parameter(
36			name: 'resourceNode.parent',
37			in: 'query',
38			required: true,
39			description: 'Filter groups by the parent resource node (course)',
40			schema: ['type' => 'integer'],
41			),
42			],
43			)
44			),
45			new Get(security: "is_granted('VIEW', object.resourceNode)"),
46			],
47			normalizationContext: ['groups' => ['group:read']],
48			denormalizationContext: ['groups' => ['group:write']],
49			paginationEnabled: true
50			)]
51			#[ApiFilter(SearchFilter::class, properties: ['resourceNode.parent' => 'exact'])]
52			#[ORM\Table(name: 'c_group_info')]
53			#[ORM\Entity(repositoryClass: CGroupRepository::class)]
54			class CGroup extends AbstractResource implements ResourceInterface, Stringable
55			{
56			public const TOOL_NOT_AVAILABLE = 0;
57			public const TOOL_PUBLIC = 1;
58			public const TOOL_PRIVATE = 2;
59			public const TOOL_PRIVATE_BETWEEN_USERS = 3;
60			#[ORM\Column(name: 'iid', type: 'integer')]
61			#[ORM\Id]
62			#[ORM\GeneratedValue]
63			#[Groups(['group:read', 'group:write'])]
64			protected ?int $iid = null;
65			#[Assert\NotBlank]
66			#[ORM\Column(name: 'title', type: 'string', length: 100, nullable: false)]
67			#[Groups(['group:read', 'group:write'])]
68			protected string $title;
69			#[Assert\NotNull]
70			#[ORM\Column(name: 'status', type: 'boolean', nullable: false)]
71			#[Groups(['group:read', 'group:write'])]
72			protected bool $status;
73			#[ORM\ManyToOne(targetEntity: CGroupCategory::class, cascade: ['persist'])]
74			#[ORM\JoinColumn(name: 'category_id', referencedColumnName: 'iid', onDelete: 'CASCADE')]
75			protected ?CGroupCategory $category = null;
76			#[ORM\Column(name: 'description', type: 'text', nullable: true)]
77			#[Groups(['group:read', 'group:write'])]
78			protected ?string $description = null;
79			#[Assert\NotBlank]
80			#[ORM\Column(name: 'max_student', type: 'integer')]
81			protected int $maxStudent;
82			#[ORM\Column(name: 'doc_state', type: 'integer')]
83			protected int $docState;
84			#[ORM\Column(name: 'calendar_state', type: 'integer')]
85			protected int $calendarState;
86			#[ORM\Column(name: 'work_state', type: 'integer')]
87			protected int $workState;
88			#[ORM\Column(name: 'announcements_state', type: 'integer')]
89			protected int $announcementsState;
90			#[ORM\Column(name: 'forum_state', type: 'integer')]
91			protected int $forumState;
92			#[ORM\Column(name: 'wiki_state', type: 'integer')]
93			protected int $wikiState;
94			#[ORM\Column(name: 'chat_state', type: 'integer')]
95			protected int $chatState;
96			#[ORM\Column(name: 'self_registration_allowed', type: 'boolean')]
97			protected bool $selfRegistrationAllowed;
98			#[ORM\Column(name: 'self_unregistration_allowed', type: 'boolean')]
99			protected bool $selfUnregistrationAllowed;
100			#[ORM\Column(name: 'document_access', type: 'integer', options: ['default' => 0])]
101			protected int $documentAccess;
102
103			/**
104			* @var Collection<int, CGroupRelUser>
105			*/
106			#[ORM\OneToMany(mappedBy: 'group', targetEntity: CGroupRelUser::class)]
107			protected Collection $members;
108
109			/**
110			* @var Collection<int, CGroupRelTutor>
111			*/
112			#[ORM\OneToMany(mappedBy: 'group', targetEntity: CGroupRelTutor::class)]
113			protected Collection $tutors;
114			public function __construct()
115			{
116			$this->status = true;
117			$this->members = new ArrayCollection();
118			$this->tutors = new ArrayCollection();
119			// Default values
120			$defaultVisibility = self::TOOL_PRIVATE;
121			$this->docState = $defaultVisibility;
122			$this->calendarState = $defaultVisibility;
123			$this->workState = $defaultVisibility;
124			$this->announcementsState = $defaultVisibility;
125			$this->forumState = $defaultVisibility;
126			$this->wikiState = $defaultVisibility;
127			$this->chatState = $defaultVisibility;
128			$this->documentAccess = $defaultVisibility;
129			$this->selfRegistrationAllowed = false;
130			$this->selfUnregistrationAllowed = false;
131			}
132			public function __toString(): string
133			{
134			return $this->getTitle();
135			}
136
137			public function getIid(): ?int
138			{
139			return $this->iid;
140			}
141
142			public function setTitle(string $title): self
143			{
144			$this->title = $title;
145
146			return $this;
147			}
148
149			public function getTitle(): string
150			{
151			return $this->title;
152			}
153			public function setStatus(bool $status): self
154			{
155			$this->status = $status;
156
157			return $this;
158			}
159			public function getStatus(): bool
160			{
161			return $this->status;
162			}
163			public function setDescription(string $description): self
164			{
165			$this->description = $description;
166
167			return $this;
168			}
169			public function getDescription(): ?string
170			{
171			return $this->description;
172			}
173			public function setMaxStudent(int $maxStudent): self
174			{
175			$this->maxStudent = $maxStudent;
176
177			return $this;
178			}
179			public function getMaxStudent(): int
180			{
181			return $this->maxStudent;
182			}
183			public function setDocState(int $docState): self
184			{
185			$this->docState = $docState;
186
187			return $this;
188			}
189
190			public function getDocState(): int
191			{
192			return $this->docState;
193			}
194			public function setCalendarState(int $calendarState): self
195			{
196			$this->calendarState = $calendarState;
197
198			return $this;
199			}
200
201			public function getCalendarState(): int
202			{
203			return $this->calendarState;
204			}
205			public function setWorkState(int $workState): self
206			{
207			$this->workState = $workState;
208
209			return $this;
210			}
211
212			public function getWorkState(): int
213			{
214			return $this->workState;
215			}
216			public function setAnnouncementsState(int $announcementsState): self
217			{
218			$this->announcementsState = $announcementsState;
219
220			return $this;
221			}
222
223			public function getAnnouncementsState(): int
224			{
225			return $this->announcementsState;
226			}
227			public function setForumState(int $forumState): self
228			{
229			$this->forumState = $forumState;
230
231			return $this;
232			}
233			public function getForumState(): int
234			{
235			return $this->forumState;
236			}
237			public function setWikiState(int $wikiState): self
238			{
239			$this->wikiState = $wikiState;
240
241			return $this;
242			}
243
244			public function getWikiState(): int
245			{
246			return $this->wikiState;
247			}
248			public function setChatState(int $chatState): self
249			{
250			$this->chatState = $chatState;
251
252			return $this;
253			}
254
255			public function getChatState(): int
256			{
257			return $this->chatState;
258			}
259			public function setSelfRegistrationAllowed(bool $selfRegistrationAllowed): self
260			{
261			$this->selfRegistrationAllowed = $selfRegistrationAllowed;
262
263			return $this;
264			}
265
266			public function getSelfRegistrationAllowed(): bool
267			{
268			return $this->selfRegistrationAllowed;
269			}
270			public function setSelfUnregistrationAllowed(bool $selfUnregistrationAllowed): self
271			{
272			$this->selfUnregistrationAllowed = $selfUnregistrationAllowed;
273
274			return $this;
275			}
276
277			public function getSelfUnregistrationAllowed(): bool
278			{
279			return $this->selfUnregistrationAllowed;
280			}
281			public function getDocumentAccess(): int
282			{
283			return $this->documentAccess;
284			}
285			public function setDocumentAccess(int $documentAccess): self
286			{
287			$this->documentAccess = $documentAccess;
288
289			return $this;
290			}
291
292			/**
293			* @return Collection<int, CGroupRelUser>
294			*/
295			public function getMembers(): Collection
296			{
297			return $this->members;
298			}
299
300			public function setMembers(Collection $members): self
301			{
302			$this->members = $members;
303
304			return $this;
305			}
306			public function hasMembers(): bool
307			{
308			return $this->members->count() > 0;
309			}
310			public function hasMember(User $user): bool
311			{
312			if (!$this->hasMembers()) {
313			return false;
314			}
315			$list = $this->members->filter(fn (CGroupRelUser $member) => $member->getUser()->getId() === $user->getId());
316
317			return $list->count() > 0;
318			}
319			public function hasTutor(User $user): bool
320			{
321			if (!$this->hasTutors()) {
322			return false;
323			}
324			$list = $this->tutors->filter(fn (CGroupRelTutor $tutor) => $tutor->getUser()->getId() === $user->getId());
325
326			return $list->count() > 0;
327			}
328
329			/**
330			* @return Collection<int, CGroupRelTutor>
331			*/
332			public function getTutors(): Collection
333			{
334			return $this->tutors;
335			}
336
337			public function setTutors(Collection $tutors): self
338			{
339			$this->tutors = $tutors;
340
341			return $this;
342			}
343			public function hasTutors(): bool
344			{
345			return $this->tutors->count() > 0;
346			}
347			public function getCategory(): ?CGroupCategory
348			{
349			return $this->category;
350			}
351			public function setCategory(?CGroupCategory $category = null): self
352			{
353			$this->category = $category;
354
355			return $this;
356			}
357
358			public function getResourceIdentifier(): int\|Uuid
359			{
360			return $this->iid;
			0 ignored issues – show Bug Best Practice introduced 2023-12-31 00:18 UTC by Report Bug Copy Issue Report The expression `return $this->iid` could return the type `null` which is incompatible with the type-hinted return `Symfony\Component\Uid\Uuid\|integer`. Consider adding an additional type-check to rule them out. Loading history...
361			}
362			public function getResourceName(): string
363			{
364			return $this->getTitle();
365			}
366			public function setResourceName(string $name): self
367			{
368			return $this->setTitle($name);
369			}
370			}
371

chamilo / chamilo-lms

CGroup::setDescription() A last analyzed 2025-12-14 00:14 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CGroup::setDescription() A
last analyzed 2025-12-14 00:14 UTC