chamilo/chamilo-lms

<?php

declare(strict_types=1);

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

namespace Chamilo\CoreBundle\Entity;

use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;
use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
use ApiPlatform\Metadata\ApiFilter;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Link;
use ApiPlatform\Serializer\Filter\PropertyFilter;
use Chamilo\CoreBundle\Repository\CourseCategoryRepository;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\Common\Collections\Criteria;
use Doctrine\ORM\Mapping as ORM;
use Stringable;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

#[ApiResource(
    normalizationContext: [
        'groups' => ['course_category:read', 'course:read'],
        'swagger_definition_name' => 'Read',
    ],
    denormalizationContext: [
        'groups' => ['course_category:write', 'course:write'],
    ],
    security: "is_granted('ROLE_ADMIN')"
)]
#[ORM\Table(name: 'course_category')]
#[ORM\Index(columns: ['parent_id'], name: 'parent_id')]
#[ORM\Index(columns: ['tree_pos'], name: 'tree_pos')]
#[ORM\UniqueConstraint(name: 'code', columns: ['code'])]
#[ORM\Entity(repositoryClass: CourseCategoryRepository::class)]
#[ApiFilter(filterClass: SearchFilter::class, properties: ['name' => 'partial', 'code' => 'partial'])]
#[ApiFilter(filterClass: PropertyFilter::class)]
#[ApiFilter(filterClass: OrderFilter::class, properties: ['name', 'code'])]
#[ApiResource(
    uriTemplate: '/courses/{id}/categories.{_format}',
    operations: [
        new GetCollection(),
    ],
    uriVariables: [
        'id' => new Link(
            fromClass: Course::class,
            identifiers: ['id']
        ),
    ],
    status: 200,
    normalizationContext: [
        'groups' => ['course_category:read', 'course:read'],
    ],
)]
class CourseCategory implements Stringable
{
    #[Groups(['course_category:read', 'course:read'])]
    #[ORM\Column(name: 'id', type: 'integer')]
    #[ORM\Id]
    #[ORM\GeneratedValue]
    protected ?int $id = null;

    /**
     * @var Collection<int, CourseCategory>
     */
    #[ORM\OneToMany(mappedBy: 'parent', targetEntity: self::class)]
    protected Collection $children;
    #[Assert\NotBlank]
    #[Groups(['course_category:read', 'course_category:write', 'course:read', 'session:read'])]
    #[ORM\Column(name: 'title', type: 'text', nullable: false)]
    protected string $title;
    #[Assert\NotBlank]
    #[Groups(['course_category:read', 'course_category:write', 'course:read'])]
    #[ORM\Column(name: 'code', type: 'string', length: 40, nullable: false)]
    protected string $code;
    #[ORM\ManyToOne(targetEntity: self::class, inversedBy: 'children')]
    #[ORM\JoinColumn(name: 'parent_id', referencedColumnName: 'id', onDelete: 'CASCADE')]
    protected ?CourseCategory $parent = null;
    #[ORM\Column(name: 'tree_pos', type: 'integer', nullable: true)]
    protected ?int $treePos = null;
    #[ORM\Column(name: 'children_count', type: 'smallint', nullable: true)]
    protected ?int $childrenCount;
    #[ORM\Column(name: 'auth_course_child', type: 'string', length: 40, nullable: true)]
    protected ?string $authCourseChild = null;
    #[ORM\Column(name: 'auth_cat_child', type: 'string', length: 40, nullable: true)]
    protected ?string $authCatChild = null;
    #[ORM\ManyToOne(targetEntity: Asset::class, cascade: ['remove'])]
    #[ORM\JoinColumn(name: 'asset_id', referencedColumnName: 'id', onDelete: 'SET NULL')]
    protected ?Asset $asset = null;
    #[Groups(['course_category:read', 'course_category:write'])]
    #[ORM\Column(name: 'description', type: 'text', nullable: true)]
    protected ?string $description = null;

    /**
     * @var Collection<int, AccessUrlRelCourseCategory>
     */
    #[ORM\OneToMany(
        mappedBy: 'courseCategory',
        targetEntity: AccessUrlRelCourseCategory::class,
        cascade: ['persist'],
        orphanRemoval: true
    )]
    protected Collection $urls;

    /**
     * @var Collection<int, Course>
     */
    #[ORM\ManyToMany(targetEntity: Course::class, mappedBy: 'categories')]
    protected Collection $courses;

    public function __construct()
    {
        $this->childrenCount = 0;
        $this->authCatChild = 'TRUE';
        $this->authCourseChild = 'TRUE';
        $this->urls = new ArrayCollection();
        $this->children = new ArrayCollection();
        $this->courses = new ArrayCollection();
    }

    public function __toString(): string
    {
        $name = strip_tags($this->title);

        return \sprintf('%s (%s)', $name, $this->code);
    }

    /**
     * Get id.
     *
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    public function getParent(): ?self
    {
        return $this->parent;
    }

    public function setParent(self $parent): self
    {
        $this->parent = $parent;

        return $this;
    }

    /**
     * @return Collection<int, CourseCategory>
     */
    public function getChildren(): Collection
    {
        return $this->children;
    }

    public function addChild(self $child): self
    {
        $this->children[] = $child;
        $child->setParent($this);

        return $this;
    }

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

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

        return $this;
    }

    /**
     * Get code.
     *
     * @return string
     */
    public function getCode()
    {
        return $this->code;
    }

    public function setCode(string $code): self
    {
        $this->code = $code;

        return $this;
    }

    /**
     * Get treePos.
     *
     * @return int
     */
    public function getTreePos()
    {
        return $this->treePos;
    }

    public function setTreePos(int $treePos): self
    {
        $this->treePos = $treePos;

        return $this;
    }

    /**
     * Get childrenCount.
     *
     * @return int
     */
    public function getChildrenCount()
    {
        return $this->childrenCount;
    }

    public function setChildrenCount(int $childrenCount): self
    {
        $this->childrenCount = $childrenCount;

        return $this;
    }

    public function getAuthCourseChild(): ?string
    {
        return $this->authCourseChild;
    }

    public function setAuthCourseChild(string $authCourseChild): self
    {
        $this->authCourseChild = $authCourseChild;

        return $this;
    }

    public function getAuthCatChild(): ?string
    {
        return $this->authCatChild;
    }

    public function setAuthCatChild(string $authCatChild): self
    {
        $this->authCatChild = $authCatChild;

        return $this;
    }

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

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

        return $this;
    }

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

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

        return $this;
    }

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

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

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

        return $this;
    }

    public function addCourse(Course $course): void
    {
        $this->courses[] = $course;
    }

    public function getUrls(): array|Collection
    {
        return $this->urls;
    }

    /**
     * @param AccessUrlRelCourseCategory[]|Collection $urls
     */
    public function setUrls(array|Collection $urls): self
    {
        $this->urls = $urls;

        return $this;
    }

    public function addUrl(AccessUrl $accessUrl): self
    {
        if (!$this->hasUrl($accessUrl)) {
            $item = (new AccessUrlRelCourseCategory())->setCourseCategory($this)->setUrl($accessUrl);
            $this->urls->add($item);
        }

        return $this;
    }

    public function hasUrl(AccessUrl $accessUrl): bool
    {
        if (0 !== $this->urls->count()) {
            $criteria = Criteria::create()->where(Criteria::expr()->eq('url', $accessUrl));
            $relation = $this->urls->matching($criteria);

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

        return false;
    }
}