Skill::__toString() - Code Metrics - Inspection of "Skill: Remove legacy methods to translate title an..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 979a1d...b582f4 )

by Angel Fernando Quiroz

created 2024-11-12 00:02 UTC

Skill::__toString() A

↳ Parent: Skill

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

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

declare(strict_types=1);

namespace Chamilo\CoreBundle\Entity;

use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
use ApiPlatform\Metadata\ApiFilter;
use ApiPlatform\Metadata\ApiResource;
use Chamilo\CoreBundle\Component\Utils\ChamiloApi;
use Chamilo\CoreBundle\Repository\SkillRepository;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
use Gedmo\Translatable\Translatable;
use Stringable;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

#[ApiResource(normalizationContext: ['groups' => ['skill:read']], security: 'is_granted(\'ROLE_ADMIN\')')]
#[ApiFilter(SearchFilter::class, properties: ['issuedSkills.user' => 'exact'])]
#[ORM\Table(name: 'skill')]
#[ORM\Entity(repositoryClass: SkillRepository::class)]
class Skill implements Stringable, Translatable
{
    public const STATUS_DISABLED = 0;
    public const STATUS_ENABLED = 1;

    #[Groups(['skill:read'])]
    #[ORM\Column(name: 'id', type: 'integer')]
    #[ORM\Id]
    #[ORM\GeneratedValue]
    protected ?int $id = null;

    #[ORM\ManyToOne(targetEntity: Profile::class, inversedBy: 'skills')]
    #[ORM\JoinColumn(name: 'profile_id', referencedColumnName: 'id')]
    protected ?Profile $profile = null;

    /**
     * @var Collection<int, SkillRelUser>
     */
    #[Groups(['skill:read'])]
    #[ORM\OneToMany(mappedBy: 'skill', targetEntity: SkillRelUser::class, cascade: ['persist'])]
    protected Collection $issuedSkills;

    /**
     * @var Collection<int, SkillRelItem>
     */
    #[ORM\OneToMany(mappedBy: 'skill', targetEntity: SkillRelItem::class, cascade: ['persist'])]
    protected Collection $items;

    /**
     * @var Collection<int, SkillRelSkill>
     */
    #[ORM\OneToMany(mappedBy: 'skill', targetEntity: SkillRelSkill::class, cascade: ['persist'])]
    protected Collection $skills;

    /**
     * @var Collection<int, SkillRelCourse>
     */
    #[ORM\OneToMany(mappedBy: 'skill', targetEntity: SkillRelCourse::class, cascade: ['persist'])]
    protected Collection $courses;

    /**
     * @var Collection<int, SkillRelGradebook>
     */
    #[ORM\OneToMany(mappedBy: 'skill', targetEntity: SkillRelGradebook::class, cascade: ['persist'])]
    protected Collection $gradeBookCategories;

    #[Gedmo\Translatable]
    #[Assert\NotBlank]
    #[Groups(['skill:read', 'skill:write', 'skill_rel_user:read'])]
    #[ORM\Column(name: 'title', type: 'string', length: 255, nullable: false)]
    protected string $title;

    #[Gedmo\Translatable]
    #[Assert\NotBlank]
    #[Groups(['skill:read', 'skill:write'])]
    #[ORM\Column(name: 'short_code', type: 'string', length: 100, nullable: false)]
    protected string $shortCode;

    #[Groups(['skill:read', 'skill:write'])]
    #[ORM\Column(name: 'description', type: 'text', nullable: false)]
    protected string $description;

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

    #[Groups(['skill:read', 'skill_rel_user:read'])]
    #[ORM\Column(name: 'icon', type: 'string', length: 255, nullable: false)]
    protected string $icon;

    #[ORM\ManyToOne(targetEntity: Asset::class, cascade: ['persist', 'remove'])]
    #[ORM\JoinColumn(name: 'asset_id', referencedColumnName: 'id')]
    protected ?Asset $asset = null;

    #[ORM\Column(name: 'criteria', type: 'text', nullable: true)]
    protected ?string $criteria = null;

    #[ORM\Column(name: 'status', type: 'integer', nullable: false, options: ['default' => 1])]
    protected int $status;

    #[Gedmo\Timestampable(on: 'update')]
    #[ORM\Column(name: 'updated_at', type: 'datetime', nullable: false)]
    protected DateTime $updatedAt;

    #[Gedmo\Locale]
    private ?string $locale = null;

    public function __construct()
    {
        $this->issuedSkills = new ArrayCollection();
        $this->items = new ArrayCollection();
        $this->courses = new ArrayCollection();
        $this->gradeBookCategories = new ArrayCollection();
        $this->skills = new ArrayCollection();
        $this->icon = '';
        $this->description = '';
        $this->status = self::STATUS_ENABLED;
    }

    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 getShortCode(): string
    {
        return $this->shortCode;
    }

    public function setShortCode(string $shortCode): self
    {
        $this->shortCode = $shortCode;

        return $this;
    }

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

        return $this;
    }

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

    public function setAccessUrlId(int $accessUrlId): static
    {
        $this->accessUrlId = $accessUrlId;

        return $this;
    }

    public function getAccessUrlId(): int
    {
        return $this->accessUrlId;
    }

    public function setIcon(string $icon): self
    {
        $this->icon = $icon;

        return $this;
    }

    public function getIcon(): string
    {
        return $this->icon;
    }

    public function setCriteria(string $criteria): self
    {
        $this->criteria = $criteria;

        return $this;
    }

    public function getCriteria(): ?string
    {
        return $this->criteria;
    }

    public function setStatus(int $status): self
    {
        $this->status = $status;

        return $this;
    }

    public function getStatus(): int
    {
        return $this->status;
    }

    public function setUpdatedAt(DateTime $updatedAt): static
    {
        $this->updatedAt = $updatedAt;

        return $this;
    }

    public function getUpdatedAt(): DateTime
    {
        return $this->updatedAt;
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getProfile(): ?Profile
    {
        return $this->profile;
    }

    public function setProfile(Profile $profile): self
    {
        $this->profile = $profile;

        return $this;
    }

    /**
     * @return Collection<int, SkillRelUser>
     */
    public function getIssuedSkills(): Collection
    {
        return $this->issuedSkills;
    }

    /**
     * @return Collection<int, SkillRelItem>
     */
    public function getItems(): Collection
    {
        return $this->items;
    }

    public function setItems(ArrayCollection $items): self
    {
        $this->items = $items;

        return $this;
    }

    public function hasItem(int $typeId, int $itemId): bool
    {
        if (0 !== $this->getItems()->count()) {
            $found = false;

            /** @var SkillRelItem $item */
            foreach ($this->getItems() as $item) {
                if ($item->getItemId() === $itemId && $item->getItemType() === $typeId) {
                    $found = true;

                    break;
                }
            }

            return $found;
        }

        return false;
    }

    public function addItem(SkillRelItem $skillRelItem): void
    {
        $skillRelItem->setSkill($this);
        $this->items[] = $skillRelItem;
    }

    public function getCourses(): Collection
    {
        return $this->courses;
    }

    public function setCourses(ArrayCollection $courses): self
    {
        $this->courses = $courses;

        return $this;
    }

    /**
     * @return Collection<int, SkillRelSkill>
     */
    public function getSkills(): Collection
    {
        return $this->skills;
    }

    /**
     * @param Collection<int, SkillRelSkill> $skills
     */
    public function setSkills(Collection $skills): self
    {
        $this->skills = $skills;

        return $this;
    }

    /**
     * @return Collection<int, SkillRelGradebook>
     */
    public function getGradeBookCategories(): Collection
    {
        return $this->gradeBookCategories;
    }

    /**
     * @param Collection<int, SkillRelGradebook> $gradeBookCategories
     */
    public function setGradeBookCategories(Collection $gradeBookCategories): self
    {
        $this->gradeBookCategories = $gradeBookCategories;

        return $this;
    }

    public function hasAsset(): bool
    {
        return null !== $this->asset;
    }

    public function getAsset(): ?Asset
    {
        return $this->asset;
    }

    public function setAsset(?Asset $asset): self
    {
        $this->asset = $asset;

        return $this;
    }

    public function hasCourseAndSession(SkillRelCourse $searchItem): bool
    {
        if (0 !== $this->getCourses()->count()) {
            $found = false;

            /** @var SkillRelCourse $item */
            foreach ($this->getCourses() as $item) {
                $sessionPassFilter = false;
                $session = $item->getSession();
                $sessionId = empty($session) ? 0 : $session->getId();
                $searchSessionId = empty($searchItem->getSession()) ? 0 : $searchItem->getSession()->getId();
                if ($sessionId === $searchSessionId) {
                    $sessionPassFilter = true;
                }
                if ($item->getCourse()->getId() === $searchItem->getCourse()->getId() && $sessionPassFilter) {
                    $found = true;

                    break;
                }
            }

            return $found;
        }

        return false;
    }

    public function addToCourse(SkillRelCourse $item): void
    {
        $item->setSkill($this);
        $this->courses[] = $item;
    }

    public function getLocale(): string
    {
        return $this->locale;

    }

    public function setLocale(string $locale): Skill
    {
        $this->locale = $locale;

        return $this;
    }
}


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 ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
10			use ApiPlatform\Metadata\ApiFilter;
11			use ApiPlatform\Metadata\ApiResource;
12			use Chamilo\CoreBundle\Component\Utils\ChamiloApi;
13			use Chamilo\CoreBundle\Repository\SkillRepository;
14			use DateTime;
15			use Doctrine\Common\Collections\ArrayCollection;
16			use Doctrine\Common\Collections\Collection;
17			use Doctrine\ORM\Mapping as ORM;
18			use Gedmo\Mapping\Annotation as Gedmo;
19			use Gedmo\Translatable\Translatable;
20			use Stringable;
21			use Symfony\Component\Serializer\Annotation\Groups;
22			use Symfony\Component\Validator\Constraints as Assert;
23
24			#[ApiResource(normalizationContext: ['groups' => ['skill:read']], security: 'is_granted(\'ROLE_ADMIN\')')]
25			#[ApiFilter(SearchFilter::class, properties: ['issuedSkills.user' => 'exact'])]
26			#[ORM\Table(name: 'skill')]
27			#[ORM\Entity(repositoryClass: SkillRepository::class)]
28			class Skill implements Stringable, Translatable
29			{
30			public const STATUS_DISABLED = 0;
31			public const STATUS_ENABLED = 1;
32
33			#[Groups(['skill:read'])]
34			#[ORM\Column(name: 'id', type: 'integer')]
35			#[ORM\Id]
36			#[ORM\GeneratedValue]
37			protected ?int $id = null;
38
39			#[ORM\ManyToOne(targetEntity: Profile::class, inversedBy: 'skills')]
40			#[ORM\JoinColumn(name: 'profile_id', referencedColumnName: 'id')]
41			protected ?Profile $profile = null;
42
43			/**
44			* @var Collection<int, SkillRelUser>
45			*/
46			#[Groups(['skill:read'])]
47			#[ORM\OneToMany(mappedBy: 'skill', targetEntity: SkillRelUser::class, cascade: ['persist'])]
48			protected Collection $issuedSkills;
49
50			/**
51			* @var Collection<int, SkillRelItem>
52			*/
53			#[ORM\OneToMany(mappedBy: 'skill', targetEntity: SkillRelItem::class, cascade: ['persist'])]
54			protected Collection $items;
55
56			/**
57			* @var Collection<int, SkillRelSkill>
58			*/
59			#[ORM\OneToMany(mappedBy: 'skill', targetEntity: SkillRelSkill::class, cascade: ['persist'])]
60			protected Collection $skills;
61
62			/**
63			* @var Collection<int, SkillRelCourse>
64			*/
65			#[ORM\OneToMany(mappedBy: 'skill', targetEntity: SkillRelCourse::class, cascade: ['persist'])]
66			protected Collection $courses;
67
68			/**
69			* @var Collection<int, SkillRelGradebook>
70			*/
71			#[ORM\OneToMany(mappedBy: 'skill', targetEntity: SkillRelGradebook::class, cascade: ['persist'])]
72			protected Collection $gradeBookCategories;
73
74			#[Gedmo\Translatable]
75			#[Assert\NotBlank]
76			#[Groups(['skill:read', 'skill:write', 'skill_rel_user:read'])]
77			#[ORM\Column(name: 'title', type: 'string', length: 255, nullable: false)]
78			protected string $title;
79
80			#[Gedmo\Translatable]
81			#[Assert\NotBlank]
82			#[Groups(['skill:read', 'skill:write'])]
83			#[ORM\Column(name: 'short_code', type: 'string', length: 100, nullable: false)]
84			protected string $shortCode;
85
86			#[Groups(['skill:read', 'skill:write'])]
87			#[ORM\Column(name: 'description', type: 'text', nullable: false)]
88			protected string $description;
89
90			#[Assert\NotNull]
91			#[ORM\Column(name: 'access_url_id', type: 'integer', nullable: false)]
92			protected int $accessUrlId;
93
94			#[Groups(['skill:read', 'skill_rel_user:read'])]
95			#[ORM\Column(name: 'icon', type: 'string', length: 255, nullable: false)]
96			protected string $icon;
97
98			#[ORM\ManyToOne(targetEntity: Asset::class, cascade: ['persist', 'remove'])]
99			#[ORM\JoinColumn(name: 'asset_id', referencedColumnName: 'id')]
100			protected ?Asset $asset = null;
101
102			#[ORM\Column(name: 'criteria', type: 'text', nullable: true)]
103			protected ?string $criteria = null;
104
105			#[ORM\Column(name: 'status', type: 'integer', nullable: false, options: ['default' => 1])]
106			protected int $status;
107
108			#[Gedmo\Timestampable(on: 'update')]
109			#[ORM\Column(name: 'updated_at', type: 'datetime', nullable: false)]
110			protected DateTime $updatedAt;
111
112			#[Gedmo\Locale]
113			private ?string $locale = null;
114
115			public function __construct()
116			{
117			$this->issuedSkills = new ArrayCollection();
118			$this->items = new ArrayCollection();
119			$this->courses = new ArrayCollection();
120			$this->gradeBookCategories = new ArrayCollection();
121			$this->skills = new ArrayCollection();
122			$this->icon = '';
123			$this->description = '';
124			$this->status = self::STATUS_ENABLED;
125			}
126
127			public function __toString(): string
128			{
129			return $this->getTitle();
130			}
131
132			public function setTitle(string $title): self
133			{
134			$this->title = $title;
135
136			return $this;
137			}
138
139			public function getTitle(): string
140			{
141			return $this->title;
142			}
143
144			public function getShortCode(): string
145			{
146			return $this->shortCode;
147			}
148
149			public function setShortCode(string $shortCode): self
150			{
151			$this->shortCode = $shortCode;
152
153			return $this;
154			}
155
156			public function setDescription(string $description): self
157			{
158			$this->description = $description;
159
160			return $this;
161			}
162
163			public function getDescription(): string
164			{
165			return $this->description;
166			}
167
168			public function setAccessUrlId(int $accessUrlId): static
169			{
170			$this->accessUrlId = $accessUrlId;
171
172			return $this;
173			}
174
175			public function getAccessUrlId(): int
176			{
177			return $this->accessUrlId;
178			}
179
180			public function setIcon(string $icon): self
181			{
182			$this->icon = $icon;
183
184			return $this;
185			}
186
187			public function getIcon(): string
188			{
189			return $this->icon;
190			}
191
192			public function setCriteria(string $criteria): self
193			{
194			$this->criteria = $criteria;
195
196			return $this;
197			}
198
199			public function getCriteria(): ?string
200			{
201			return $this->criteria;
202			}
203
204			public function setStatus(int $status): self
205			{
206			$this->status = $status;
207
208			return $this;
209			}
210
211			public function getStatus(): int
212			{
213			return $this->status;
214			}
215
216			public function setUpdatedAt(DateTime $updatedAt): static
217			{
218			$this->updatedAt = $updatedAt;
219
220			return $this;
221			}
222
223			public function getUpdatedAt(): DateTime
224			{
225			return $this->updatedAt;
226			}
227
228			public function getId(): ?int
229			{
230			return $this->id;
231			}
232
233			public function getProfile(): ?Profile
234			{
235			return $this->profile;
236			}
237
238			public function setProfile(Profile $profile): self
239			{
240			$this->profile = $profile;
241
242			return $this;
243			}
244
245			/**
246			* @return Collection<int, SkillRelUser>
247			*/
248			public function getIssuedSkills(): Collection
249			{
250			return $this->issuedSkills;
251			}
252
253			/**
254			* @return Collection<int, SkillRelItem>
255			*/
256			public function getItems(): Collection
257			{
258			return $this->items;
259			}
260
261			public function setItems(ArrayCollection $items): self
262			{
263			$this->items = $items;
264
265			return $this;
266			}
267
268			public function hasItem(int $typeId, int $itemId): bool
269			{
270			if (0 !== $this->getItems()->count()) {
271			$found = false;
272
273			/** @var SkillRelItem $item */
274			foreach ($this->getItems() as $item) {
275			if ($item->getItemId() === $itemId && $item->getItemType() === $typeId) {
276			$found = true;
277
278			break;
279			}
280			}
281
282			return $found;
283			}
284
285			return false;
286			}
287
288			public function addItem(SkillRelItem $skillRelItem): void
289			{
290			$skillRelItem->setSkill($this);
291			$this->items[] = $skillRelItem;
292			}
293
294			public function getCourses(): Collection
295			{
296			return $this->courses;
297			}
298
299			public function setCourses(ArrayCollection $courses): self
300			{
301			$this->courses = $courses;
302
303			return $this;
304			}
305
306			/**
307			* @return Collection<int, SkillRelSkill>
308			*/
309			public function getSkills(): Collection
310			{
311			return $this->skills;
312			}
313
314			/**
315			* @param Collection<int, SkillRelSkill> $skills
316			*/
317			public function setSkills(Collection $skills): self
318			{
319			$this->skills = $skills;
320
321			return $this;
322			}
323
324			/**
325			* @return Collection<int, SkillRelGradebook>
326			*/
327			public function getGradeBookCategories(): Collection
328			{
329			return $this->gradeBookCategories;
330			}
331
332			/**
333			* @param Collection<int, SkillRelGradebook> $gradeBookCategories
334			*/
335			public function setGradeBookCategories(Collection $gradeBookCategories): self
336			{
337			$this->gradeBookCategories = $gradeBookCategories;
338
339			return $this;
340			}
341
342			public function hasAsset(): bool
343			{
344			return null !== $this->asset;
345			}
346
347			public function getAsset(): ?Asset
348			{
349			return $this->asset;
350			}
351
352			public function setAsset(?Asset $asset): self
353			{
354			$this->asset = $asset;
355
356			return $this;
357			}
358
359			public function hasCourseAndSession(SkillRelCourse $searchItem): bool
360			{
361			if (0 !== $this->getCourses()->count()) {
362			$found = false;
363
364			/** @var SkillRelCourse $item */
365			foreach ($this->getCourses() as $item) {
366			$sessionPassFilter = false;
367			$session = $item->getSession();
368			$sessionId = empty($session) ? 0 : $session->getId();
369			$searchSessionId = empty($searchItem->getSession()) ? 0 : $searchItem->getSession()->getId();
370			if ($sessionId === $searchSessionId) {
371			$sessionPassFilter = true;
372			}
373			if ($item->getCourse()->getId() === $searchItem->getCourse()->getId() && $sessionPassFilter) {
374			$found = true;
375
376			break;
377			}
378			}
379
380			return $found;
381			}
382
383			return false;
384			}
385
386			public function addToCourse(SkillRelCourse $item): void
387			{
388			$item->setSkill($this);
389			$this->courses[] = $item;
390			}
391
392			public function getLocale(): string
393			{
394			return $this->locale;
			0 ignored issues – show Bug Best Practice introduced 2024-11-12 00:19 UTC by Report Bug Copy Issue Report The expression `return $this->locale` could return the type `null` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
395			}
396
397			public function setLocale(string $locale): Skill
398			{
399			$this->locale = $locale;
400
401			return $this;
402			}
403			}
404

chamilo / chamilo-lms

Push — master ( 979a1d...b582f4 )

Skill::__toString() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like