CAttendance::getResults() - Code Metrics - Inspection of "Merge pull request #6281 from christianbeeznest/fi..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d0aec4...3a1c32 )

unknown

created 2025-05-09 22:58 UTC

CAttendance::getResults() A

↳ Parent: CAttendance

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

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\Delete;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use Chamilo\CoreBundle\Entity\AbstractResource;
use Chamilo\CoreBundle\Entity\ResourceInterface;
use Chamilo\CoreBundle\Filter\SidFilter;
use Chamilo\CoreBundle\State\CAttendanceStateProcessor;
use Chamilo\CourseBundle\Repository\CAttendanceRepository;
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\Serializer\Annotation\MaxDepth;
use Symfony\Component\Validator\Constraints as Assert;

#[ApiResource(
    shortName: 'Attendances',
    operations: [
        new Put(
            uriTemplate: '/attendances/{iid}/toggle_visibility',
            openapiContext: [
                'summary' => 'Toggle visibility of the attendance\'s associated ResourceLink',
            ],
            security: "is_granted('EDIT', object.resourceNode)",
            name: 'toggle_visibility',
            processor: CAttendanceStateProcessor::class
        ),
        new Put(
            uriTemplate: '/attendances/{iid}/soft_delete',
            openapiContext: [
                'summary' => 'Soft delete the attendance',
            ],
            security: "is_granted('EDIT', object.resourceNode)",
            name: 'soft_delete',
            processor: CAttendanceStateProcessor::class
        ),
        new Delete(security: "is_granted('ROLE_TEACHER')"),
        new Post(
            uriTemplate: '/attendances/{iid}/calendars',
            openapiContext: ['summary' => 'Add a calendar to an attendance.'],
            denormalizationContext: ['groups' => ['attendance:write']],
            name: 'calendar_add',
            processor: CAttendanceStateProcessor::class
        ),
        new GetCollection(
            openapiContext: [
                'parameters' => [
                    [
                        'name' => 'resourceNode.parent',
                        'in' => 'query',
                        'required' => true,
                        'description' => 'Resource node Parent',
                        'schema' => ['type' => 'integer'],
                    ],
                ],
            ],
        ),
        new Get(security: "is_granted('ROLE_USER')"),
        new Post(
            denormalizationContext: ['groups' => ['attendance:write']],
            security: "is_granted('ROLE_TEACHER')",
            validationContext: ['groups' => ['Default']]
        ),
        new Put(
            denormalizationContext: ['groups' => ['attendance:write']],
            security: "is_granted('ROLE_TEACHER')"
        ),
    ],
    normalizationContext: [
        'groups' => ['attendance:read', 'resource_node:read', 'resource_link:read'],
        'enable_max_depth' => true
    ],
    denormalizationContext: ['groups' => ['attendance:write']],
    paginationEnabled: true,
)]
#[ApiFilter(SearchFilter::class, properties: ['active' => 'exact', 'title' => 'partial', 'resourceNode.parent' => 'exact'])]
#[ApiFilter(filterClass: SidFilter::class)]
#[ORM\Table(name: 'c_attendance')]
#[ORM\Index(columns: ['active'], name: 'active')]
#[ORM\Entity(repositoryClass: CAttendanceRepository::class)]
class CAttendance extends AbstractResource implements ResourceInterface, Stringable
{
    #[ORM\Column(name: 'iid', type: 'integer')]
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[Groups(['attendance:read'])]
    protected ?int $iid = null;

    #[Assert\NotBlank]
    #[ORM\Column(name: 'title', type: 'text', nullable: false)]
    #[Groups(['attendance:read', 'attendance:write'])]
    protected string $title;

    #[ORM\Column(name: 'description', type: 'text', nullable: true)]
    #[Groups(['attendance:read', 'attendance:write'])]
    protected ?string $description = null;

    #[Assert\NotBlank]
    #[ORM\Column(name: 'active', type: 'integer', nullable: false)]
    #[Groups(['attendance:read', 'attendance:write'])]
    protected int $active = 1;

    #[ORM\Column(name: 'attendance_qualify_title', type: 'string', length: 255, nullable: true)]
    #[Groups(['attendance:read', 'attendance:write'])]
    protected ?string $attendanceQualifyTitle = null;

    #[Assert\NotNull]
    #[ORM\Column(name: 'attendance_qualify_max', type: 'integer', nullable: false)]
    protected int $attendanceQualifyMax;

    #[Assert\NotNull]
    #[ORM\Column(name: 'attendance_weight', type: 'float', precision: 6, scale: 2, nullable: false)]
    #[Groups(['attendance:read', 'attendance:write'])]
    protected float $attendanceWeight = 0.0;

    #[Assert\NotNull]
    #[ORM\Column(name: 'locked', type: 'integer', nullable: false)]
    protected int $locked;

    /**
     * @var Collection|CAttendanceCalendar[]
     */
    #[ORM\OneToMany(mappedBy: 'attendance', targetEntity: CAttendanceCalendar::class, cascade: ['persist', 'remove'])]
    #[Groups(['attendance:read'])]
    #[MaxDepth(1)]
    protected Collection $calendars;

    /**
     * @var Collection|CAttendanceResult[]
     */
    #[ORM\OneToMany(mappedBy: 'attendance', targetEntity: CAttendanceResult::class, cascade: ['persist', 'remove'])]
    protected Collection $results;

    /**
     * @var Collection|CAttendanceSheetLog[]
     */
    #[ORM\OneToMany(mappedBy: 'attendance', targetEntity: CAttendanceSheetLog::class, cascade: ['persist', 'remove'])]
    protected Collection $logs;

    #[Groups(['attendance:read'])]
    private ?int $doneCalendars = null;

    public function __construct()
    {
        $this->description = '';
        $this->active = 1;
        $this->attendanceQualifyMax = 0;
        $this->locked = 0;
        $this->calendars = new ArrayCollection();
        $this->results = new ArrayCollection();
        $this->logs = new ArrayCollection();
    }

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

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

        return $this;
    }

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

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

        return $this;
    }

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

    public function setActive(int $active): self
    {
        $this->active = $active;

        return $this;
    }

    public function getActive(): int
    {
        return $this->active;
    }

    public function setAttendanceQualifyTitle(string $attendanceQualifyTitle): self
    {
        $this->attendanceQualifyTitle = $attendanceQualifyTitle;

        return $this;
    }

    public function getAttendanceQualifyTitle(): ?string
    {
        return $this->attendanceQualifyTitle;
    }

    public function setAttendanceQualifyMax(int $attendanceQualifyMax): self
    {
        $this->attendanceQualifyMax = $attendanceQualifyMax;

        return $this;
    }

    /**
     * Get attendanceQualifyMax.
     */
    public function getAttendanceQualifyMax(): int
    {
        return $this->attendanceQualifyMax;
    }

    public function setAttendanceWeight(float $attendanceWeight): self
    {
        $this->attendanceWeight = $attendanceWeight;

        return $this;
    }

    /**
     * Get attendanceWeight.
     */
    public function getAttendanceWeight(): float
    {
        return $this->attendanceWeight;
    }

    public function setLocked(int $locked): self
    {
        $this->locked = $locked;

        return $this;
    }

    /**
     * Get locked.
     */
    public function getLocked(): int
    {
        return $this->locked;
    }

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

    public function getCalendars(): Collection
    {
        return $this->calendars;
    }

    public function setCalendars(Collection $calendars): self
    {
        $this->calendars = $calendars;

        return $this;
    }

    public function addCalendar(CAttendanceCalendar $calendar): self
    {
        if (!$this->calendars->contains($calendar)) {
            $this->calendars->add($calendar);
            $calendar->setAttendance($this);
        }

        return $this;
    }

    /**
     * @return CAttendanceSheetLog[]|Collection
     */
    public function getLogs(): array|Collection
    {
        return $this->logs;
    }

    public function getDoneCalendars(): int
    {
        return $this->calendars
            ->filter(fn (CAttendanceCalendar $calendar) => $calendar->getDoneAttendance())
            ->count();
    }

    public function setDoneCalendars(?int $count): self
    {
        $this->doneCalendars = $count;
        return $this;
    }

    /**
     * @param CAttendanceSheetLog[]|Collection $logs
     */
    public function setLogs(array|Collection $logs): self
    {
        $this->logs = $logs;

        return $this;
    }

    /**
     * @return CAttendanceResult[]|Collection
     */
    public function getResults(): array|Collection
    {
        return $this->results;
    }

    public function setResults(Collection $results): self
    {
        $this->results = $results;

        return $this;
    }

    public function getResourceIdentifier(): int
    {
        return $this->getIid();

    }

    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\Delete;
13			use ApiPlatform\Metadata\Get;
14			use ApiPlatform\Metadata\GetCollection;
15			use ApiPlatform\Metadata\Post;
16			use ApiPlatform\Metadata\Put;
17			use Chamilo\CoreBundle\Entity\AbstractResource;
18			use Chamilo\CoreBundle\Entity\ResourceInterface;
19			use Chamilo\CoreBundle\Filter\SidFilter;
20			use Chamilo\CoreBundle\State\CAttendanceStateProcessor;
21			use Chamilo\CourseBundle\Repository\CAttendanceRepository;
22			use Doctrine\Common\Collections\ArrayCollection;
23			use Doctrine\Common\Collections\Collection;
24			use Doctrine\ORM\Mapping as ORM;
25			use Stringable;
26			use Symfony\Component\Serializer\Annotation\Groups;
27			use Symfony\Component\Serializer\Annotation\MaxDepth;
28			use Symfony\Component\Validator\Constraints as Assert;
29
30			#[ApiResource(
31			shortName: 'Attendances',
32			operations: [
33			new Put(
34			uriTemplate: '/attendances/{iid}/toggle_visibility',
35			openapiContext: [
36			'summary' => 'Toggle visibility of the attendance\'s associated ResourceLink',
37			],
38			security: "is_granted('EDIT', object.resourceNode)",
39			name: 'toggle_visibility',
40			processor: CAttendanceStateProcessor::class
41			),
42			new Put(
43			uriTemplate: '/attendances/{iid}/soft_delete',
44			openapiContext: [
45			'summary' => 'Soft delete the attendance',
46			],
47			security: "is_granted('EDIT', object.resourceNode)",
48			name: 'soft_delete',
49			processor: CAttendanceStateProcessor::class
50			),
51			new Delete(security: "is_granted('ROLE_TEACHER')"),
52			new Post(
53			uriTemplate: '/attendances/{iid}/calendars',
54			openapiContext: ['summary' => 'Add a calendar to an attendance.'],
55			denormalizationContext: ['groups' => ['attendance:write']],
56			name: 'calendar_add',
57			processor: CAttendanceStateProcessor::class
58			),
59			new GetCollection(
60			openapiContext: [
61			'parameters' => [
62			[
63			'name' => 'resourceNode.parent',
64			'in' => 'query',
65			'required' => true,
66			'description' => 'Resource node Parent',
67			'schema' => ['type' => 'integer'],
68			],
69			],
70			],
71			),
72			new Get(security: "is_granted('ROLE_USER')"),
73			new Post(
74			denormalizationContext: ['groups' => ['attendance:write']],
75			security: "is_granted('ROLE_TEACHER')",
76			validationContext: ['groups' => ['Default']]
77			),
78			new Put(
79			denormalizationContext: ['groups' => ['attendance:write']],
80			security: "is_granted('ROLE_TEACHER')"
81			),
82			],
83			normalizationContext: [
84			'groups' => ['attendance:read', 'resource_node:read', 'resource_link:read'],
85			'enable_max_depth' => true
86			],
87			denormalizationContext: ['groups' => ['attendance:write']],
88			paginationEnabled: true,
89			)]
90			#[ApiFilter(SearchFilter::class, properties: ['active' => 'exact', 'title' => 'partial', 'resourceNode.parent' => 'exact'])]
91			#[ApiFilter(filterClass: SidFilter::class)]
92			#[ORM\Table(name: 'c_attendance')]
93			#[ORM\Index(columns: ['active'], name: 'active')]
94			#[ORM\Entity(repositoryClass: CAttendanceRepository::class)]
95			class CAttendance extends AbstractResource implements ResourceInterface, Stringable
96			{
97			#[ORM\Column(name: 'iid', type: 'integer')]
98			#[ORM\Id]
99			#[ORM\GeneratedValue]
100			#[Groups(['attendance:read'])]
101			protected ?int $iid = null;
102
103			#[Assert\NotBlank]
104			#[ORM\Column(name: 'title', type: 'text', nullable: false)]
105			#[Groups(['attendance:read', 'attendance:write'])]
106			protected string $title;
107
108			#[ORM\Column(name: 'description', type: 'text', nullable: true)]
109			#[Groups(['attendance:read', 'attendance:write'])]
110			protected ?string $description = null;
111
112			#[Assert\NotBlank]
113			#[ORM\Column(name: 'active', type: 'integer', nullable: false)]
114			#[Groups(['attendance:read', 'attendance:write'])]
115			protected int $active = 1;
116
117			#[ORM\Column(name: 'attendance_qualify_title', type: 'string', length: 255, nullable: true)]
118			#[Groups(['attendance:read', 'attendance:write'])]
119			protected ?string $attendanceQualifyTitle = null;
120
121			#[Assert\NotNull]
122			#[ORM\Column(name: 'attendance_qualify_max', type: 'integer', nullable: false)]
123			protected int $attendanceQualifyMax;
124
125			#[Assert\NotNull]
126			#[ORM\Column(name: 'attendance_weight', type: 'float', precision: 6, scale: 2, nullable: false)]
127			#[Groups(['attendance:read', 'attendance:write'])]
128			protected float $attendanceWeight = 0.0;
129
130			#[Assert\NotNull]
131			#[ORM\Column(name: 'locked', type: 'integer', nullable: false)]
132			protected int $locked;
133
134			/**
135			* @var Collection\|CAttendanceCalendar[]
136			*/
137			#[ORM\OneToMany(mappedBy: 'attendance', targetEntity: CAttendanceCalendar::class, cascade: ['persist', 'remove'])]
138			#[Groups(['attendance:read'])]
139			#[MaxDepth(1)]
140			protected Collection $calendars;
141
142			/**
143			* @var Collection\|CAttendanceResult[]
144			*/
145			#[ORM\OneToMany(mappedBy: 'attendance', targetEntity: CAttendanceResult::class, cascade: ['persist', 'remove'])]
146			protected Collection $results;
147
148			/**
149			* @var Collection\|CAttendanceSheetLog[]
150			*/
151			#[ORM\OneToMany(mappedBy: 'attendance', targetEntity: CAttendanceSheetLog::class, cascade: ['persist', 'remove'])]
152			protected Collection $logs;
153
154			#[Groups(['attendance:read'])]
155			private ?int $doneCalendars = null;
156
157			public function __construct()
158			{
159			$this->description = '';
160			$this->active = 1;
161			$this->attendanceQualifyMax = 0;
162			$this->locked = 0;
163			$this->calendars = new ArrayCollection();
164			$this->results = new ArrayCollection();
165			$this->logs = new ArrayCollection();
166			}
167
168			public function __toString(): string
169			{
170			return $this->getTitle();
171			}
172
173			public function setTitle(string $title): self
174			{
175			$this->title = $title;
176
177			return $this;
178			}
179
180			public function getTitle(): string
181			{
182			return $this->title;
183			}
184
185			public function setDescription(string $description): self
186			{
187			$this->description = $description;
188
189			return $this;
190			}
191
192			public function getDescription(): ?string
193			{
194			return $this->description;
195			}
196
197			public function setActive(int $active): self
198			{
199			$this->active = $active;
200
201			return $this;
202			}
203
204			public function getActive(): int
205			{
206			return $this->active;
207			}
208
209			public function setAttendanceQualifyTitle(string $attendanceQualifyTitle): self
210			{
211			$this->attendanceQualifyTitle = $attendanceQualifyTitle;
212
213			return $this;
214			}
215
216			public function getAttendanceQualifyTitle(): ?string
217			{
218			return $this->attendanceQualifyTitle;
219			}
220
221			public function setAttendanceQualifyMax(int $attendanceQualifyMax): self
222			{
223			$this->attendanceQualifyMax = $attendanceQualifyMax;
224
225			return $this;
226			}
227
228			/**
229			* Get attendanceQualifyMax.
230			*/
231			public function getAttendanceQualifyMax(): int
232			{
233			return $this->attendanceQualifyMax;
234			}
235
236			public function setAttendanceWeight(float $attendanceWeight): self
237			{
238			$this->attendanceWeight = $attendanceWeight;
239
240			return $this;
241			}
242
243			/**
244			* Get attendanceWeight.
245			*/
246			public function getAttendanceWeight(): float
247			{
248			return $this->attendanceWeight;
249			}
250
251			public function setLocked(int $locked): self
252			{
253			$this->locked = $locked;
254
255			return $this;
256			}
257
258			/**
259			* Get locked.
260			*/
261			public function getLocked(): int
262			{
263			return $this->locked;
264			}
265
266			public function getIid(): ?int
267			{
268			return $this->iid;
269			}
270
271			public function getCalendars(): Collection
272			{
273			return $this->calendars;
274			}
275
276			public function setCalendars(Collection $calendars): self
277			{
278			$this->calendars = $calendars;
279
280			return $this;
281			}
282
283			public function addCalendar(CAttendanceCalendar $calendar): self
284			{
285			if (!$this->calendars->contains($calendar)) {
286			$this->calendars->add($calendar);
287			$calendar->setAttendance($this);
288			}
289
290			return $this;
291			}
292
293			/**
294			* @return CAttendanceSheetLog[]\|Collection
295			*/
296			public function getLogs(): array\|Collection
297			{
298			return $this->logs;
299			}
300
301			public function getDoneCalendars(): int
302			{
303			return $this->calendars
304			->filter(fn (CAttendanceCalendar $calendar) => $calendar->getDoneAttendance())
305			->count();
306			}
307
308			public function setDoneCalendars(?int $count): self
309			{
310			$this->doneCalendars = $count;
311			return $this;
312			}
313
314			/**
315			* @param CAttendanceSheetLog[]\|Collection $logs
316			*/
317			public function setLogs(array\|Collection $logs): self
318			{
319			$this->logs = $logs;
320
321			return $this;
322			}
323
324			/**
325			* @return CAttendanceResult[]\|Collection
326			*/
327			public function getResults(): array\|Collection
328			{
329			return $this->results;
330			}
331
332			public function setResults(Collection $results): self
333			{
334			$this->results = $results;
335
336			return $this;
337			}
338
339			public function getResourceIdentifier(): int
340			{
341			return $this->getIid();
			0 ignored issues – show Bug Best Practice introduced 2023-12-31 00:18 UTC by Report Bug Copy Issue Report The expression `return $this->getIid()` could return the type `null` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
342			}
343
344			public function getResourceName(): string
345			{
346			return $this->getTitle();
347			}
348
349			public function setResourceName(string $name): self
350			{
351			return $this->setTitle($name);
352			}
353			}
354

chamilo / chamilo-lms

Push — master ( d0aec4...3a1c32 )

CAttendance::getResults() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like