Chamilo\CoreBundle\Entity\AccessUrl

Complexity

Total Complexity

74

Size/Duplication

Total Lines	603
Duplicated Lines	0 %

Importance

Changes

0

62 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	3	1
A	setLimitTeachers()	0	5	1
A	getLimitTeachers()	0	3	1
A	getCreatedBy()	0	3	1
A	setActive()	0	5	1
A	__construct()	0	14	1
A	getLimitDiskSpace()	0	3	1
A	setLimitActiveCourses()	0	5	1
A	getResourceIdentifier()	0	3	1
A	setSuperior()	0	5	1
A	getSessionCategories()	0	3	1
A	getChildren()	0	3	1
A	addUser()	0	8	2
A	setLimitSessions()	0	5	1
A	getResourceName()	0	6	1
A	getCourses()	0	3	1
A	getSuperior()	0	3	1
A	getSessions()	0	3	1
A	setSessionCategories()	0	5	1
A	getActiveColorTheme()	0	8	2
A	getActive()	0	3	1
A	getLimitUsers()	0	3	1
A	getLimitActiveCourses()	0	3	1
A	getEmail()	0	3	1
A	addColorTheme()	0	8	2
A	setResourceName()	0	3	1
A	setCourses()	0	5	1
A	getPlugins()	0	3	1
A	removeColorTheme()	0	10	3
A	setSettings()	0	5	1
A	getColorThemeByTheme()	0	8	2
A	__toString()	0	3	1
A	getUsers()	0	3	1
A	setIsLoginOnly()	0	5	1
A	getId()	0	3	1
A	setLimitDiskSpace()	0	5	1
A	hasCourse()	0	10	2
A	hasUser()	0	10	2
A	getSettings()	0	3	1
A	setUrlType()	0	5	1
A	setCreatedBy()	0	5	1
A	setUrl()	0	5	1
A	getTms()	0	3	1
A	addPlugin()	0	8	2
A	getLimitCourses()	0	3	1
A	setEmail()	0	5	1
A	removePlugin()	0	10	3
A	addCourse()	0	10	2
A	isLoginOnly()	0	3	1
A	getUrlType()	0	3	1
A	getCourseCategory()	0	3	1
A	getUrl()	0	3	1
A	setLimitCourses()	0	5	1
A	setTms()	0	5	1
A	getLvl()	0	3	1
A	getLimitSessions()	0	3	1
A	getColorThemes()	0	3	1
A	getLft()	0	3	1
A	getRgt()	0	3	1
A	setDescription()	0	5	1
A	setLimitUsers()	0	5	1
A	getRoot()	0	3	1

<?php

declare(strict_types=1);

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

namespace Chamilo\CoreBundle\Entity;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Link;
use Chamilo\CoreBundle\Controller\Api\UserAccessUrlsController;
use Chamilo\CoreBundle\Entity\Listener\AccessUrlListener;
use Chamilo\CoreBundle\Entity\Listener\ResourceListener;
use Chamilo\CoreBundle\Repository\Node\AccessUrlRepository;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\Common\Collections\Criteria;
use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
use Stringable;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

#[ApiResource(
    normalizationContext: [
        'groups' => ['access_url:read'],
        'swagger_definition_name' => 'Read',
    ],
    denormalizationContext: [
        'groups' => ['access_url:write', 'course_category:write'],
    ],
    security: "is_granted('ROLE_ADMIN')"
)]
#[ORM\Table(name: 'access_url')]
#[Gedmo\Tree(type: 'nested')]
#[ORM\Entity(repositoryClass: AccessUrlRepository::class)]
#[ORM\EntityListeners([AccessUrlListener::class, ResourceListener::class])]
#[ApiResource(
    uriTemplate: '/users/{id}/access_urls',
    operations: [new GetCollection(controller: UserAccessUrlsController::class)],
    uriVariables: [
        'id' => new Link(description: 'User identifier'),
    ],
    normalizationContext: ['groups' => ['user_access_url:read']],
    paginationEnabled: false,
)]
class AccessUrl extends AbstractResource implements ResourceInterface, Stringable
{
    public const DEFAULT_ACCESS_URL = 'http://localhost/';
    #[ORM\Column(name: 'id', type: 'integer')]
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[Groups(['access_url:read', 'access_url:write'])]
    protected ?int $id = null;

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

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

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

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

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

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

    #[ORM\JoinColumn(onDelete: 'CASCADE')]
    #[Gedmo\TreeParent]
    #[ORM\ManyToOne(targetEntity: self::class, inversedBy: 'children')]
    protected ?AccessUrl $parent = null;

    /**
     * @var Collection<int, AccessUrl>
     */
    #[ORM\OneToMany(mappedBy: 'parent', targetEntity: self::class)]
    #[ORM\OrderBy(['id' => 'ASC'])]
    protected Collection $children;

    #[Gedmo\TreeLeft]
    #[ORM\Column(name: 'lft', type: 'integer')]
    protected int $lft;

    #[Gedmo\TreeLevel]
    #[ORM\Column(name: 'lvl', type: 'integer')]
    protected int $lvl;

    #[Gedmo\TreeRight]
    #[ORM\Column(name: 'rgt', type: 'integer')]
    protected int $rgt;

    #[Gedmo\TreeRoot]
    #[ORM\ManyToOne(targetEntity: self::class)]
    #[ORM\JoinColumn(name: 'tree_root', onDelete: 'CASCADE')]
    protected ?AccessUrl $root = null;

    #[Assert\NotBlank]
    #[Groups(['access_url:read', 'access_url:write', 'user_access_url:read'])]
    #[ORM\Column(name: 'url', type: 'string', length: 255)]
    protected string $url;

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

    #[ORM\Column(name: 'active', type: 'integer')]
    protected int $active;

    #[ORM\Column(name: 'created_by', type: 'integer')]
    protected int $createdBy;

    #[ORM\Column(name: 'tms', type: 'datetime', nullable: true)]
    protected ?DateTime $tms;

    #[ORM\Column(name: 'url_type', type: 'boolean', nullable: true)]
    protected ?bool $urlType = null;

    #[ORM\Column(name: 'limit_courses', type: 'integer', nullable: true)]
    protected ?int $limitCourses = null;

    #[ORM\Column(name: 'limit_active_courses', type: 'integer', nullable: true)]
    protected ?int $limitActiveCourses = null;

    #[ORM\Column(name: 'limit_sessions', type: 'integer', nullable: true)]
    protected ?int $limitSessions = null;

    #[ORM\Column(name: 'limit_users', type: 'integer', nullable: true)]
    protected ?int $limitUsers = null;

    #[ORM\Column(name: 'limit_teachers', type: 'integer', nullable: true)]
    protected ?int $limitTeachers = null;

    #[ORM\Column(name: 'limit_disk_space', type: 'integer', nullable: true)]
    protected ?int $limitDiskSpace = null;

    #[Assert\Email]
    #[ORM\Column(name: 'email', type: 'string', length: 255, nullable: true)]
    protected ?string $email = null;

    /**
     * @var Collection<int, AccessUrlRelColorTheme>
     */
    #[ORM\OneToMany(mappedBy: 'url', targetEntity: AccessUrlRelColorTheme::class, cascade: ['persist'], orphanRemoval: true)]
    private Collection $colorThemes;

    /**
     * @var Collection<int, AccessUrlRelPlugin>
     */
    #[ORM\OneToMany(mappedBy: 'url', targetEntity: AccessUrlRelPlugin::class, fetch: 'EXTRA_LAZY', orphanRemoval: true)]
    private Collection $plugins;

    #[ORM\Column(options: ['default' => false])]
    private bool $isLoginOnly = false;

    public function __construct()
    {
        $this->description = '';
        $this->tms = new DateTime();
        $this->createdBy = 1;
        $this->courses = new ArrayCollection();
        $this->sessions = new ArrayCollection();
        $this->users = new ArrayCollection();
        $this->settings = new ArrayCollection();
        $this->sessionCategories = new ArrayCollection();
        $this->courseCategory = new ArrayCollection();
        $this->children = new ArrayCollection();
        $this->colorThemes = new ArrayCollection();
        $this->plugins = new ArrayCollection();
    }

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

    public function getUrl(): string
    {
        return $this->url;
    }

    public function setUrl(string $url): self
    {
        $this->url = $url;

        return $this;
    }

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

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

        return $this;
    }

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

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

        return $this;
    }

    public function getCreatedBy(): int
    {
        return $this->createdBy;
    }

    public function setCreatedBy(int $createdBy): self
    {
        $this->createdBy = $createdBy;

        return $this;
    }

    public function getTms(): ?DateTime
    {
        return $this->tms;
    }

    public function setTms(DateTime $tms): self
    {
        $this->tms = $tms;

        return $this;
    }

    public function getUrlType(): ?bool
    {
        return $this->urlType;
    }

    public function setUrlType(bool $urlType): self
    {
        $this->urlType = $urlType;

        return $this;
    }

    public function getLimitActiveCourses(): ?int
    {
        return $this->limitActiveCourses;
    }

    public function setLimitActiveCourses(int $limitActiveCourses): self
    {
        $this->limitActiveCourses = $limitActiveCourses;

        return $this;
    }

    public function getLimitSessions(): ?int
    {
        return $this->limitSessions;
    }

    public function setLimitSessions(int $limitSessions): self
    {
        $this->limitSessions = $limitSessions;

        return $this;
    }

    public function getLimitUsers(): ?int
    {
        return $this->limitUsers;
    }

    public function setLimitUsers(int $limitUsers): self
    {
        $this->limitUsers = $limitUsers;

        return $this;
    }

    public function getLimitTeachers(): ?int
    {
        return $this->limitTeachers;
    }

    public function setLimitTeachers(int $limitTeachers): self
    {
        $this->limitTeachers = $limitTeachers;

        return $this;
    }

    public function getLimitDiskSpace(): ?int
    {
        return $this->limitDiskSpace;
    }

    public function setLimitDiskSpace(int $limitDiskSpace): self
    {
        $this->limitDiskSpace = $limitDiskSpace;

        return $this;
    }

    public function getEmail(): ?string
    {
        return $this->email;
    }

    public function setEmail(string $email): self
    {
        $this->email = $email;

        return $this;
    }

    /**
     * @return Collection<int, SettingsCurrent>
     */
    public function getSettings(): Collection
    {
        return $this->settings;
    }

    /**
     * @param Collection<int, SettingsCurrent> $settings
     */
    public function setSettings(Collection $settings): self
    {
        $this->settings = $settings;

        return $this;
    }

    public function getLimitCourses(): ?int
    {
        return $this->limitCourses;
    }

    public function setLimitCourses(int $limitCourses): self
    {
        $this->limitCourses = $limitCourses;

        return $this;
    }

    /**
     * @return Collection<int, AccessUrlRelCourse>
     */
    public function getCourses(): Collection
    {
        return $this->courses;
    }

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

        return $this;
    }

    public function addCourse(Course $course): self
    {
        if (!$this->hasCourse($course)) {
            $urlRelCourse = (new AccessUrlRelCourse())->setUrl($this);
            $course->addUrls($urlRelCourse);

            $this->courses->add($urlRelCourse);
        }

        return $this;
    }

    public function hasCourse(Course $course): bool
    {
        if ($this->courses->count() > 0) {
            $criteria = Criteria::create()->where(Criteria::expr()->eq('course', $course));
            $found = $this->courses->matching($criteria);

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

        return false;
    }

    /**
     * @return Collection<int, SessionCategory>
     */
    public function getSessionCategories(): Collection
    {
        return $this->sessionCategories;
    }

    public function setSessionCategories(Collection $sessionCategories): self
    {
        $this->sessionCategories = $sessionCategories;

        return $this;
    }

    /**
     * @return Collection<int, AccessUrlRelSession>
     */
    public function getSessions(): Collection
    {
        return $this->sessions;
    }

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

    /**
     * @return Collection<int, AccessUrlRelUser>
     */
    public function getUsers(): Collection
    {
        return $this->users;
    }

    public function addUser(User $user): self
    {
        if (!$this->hasUser($user)) {
            $accessUrlRelUser = (new AccessUrlRelUser())->setUser($user)->setUrl($this);
            $this->users->add($accessUrlRelUser);
        }

        return $this;
    }

    public function hasUser(User $user): bool
    {
        if (0 !== $this->users->count()) {
            $criteria = Criteria::create()->where(Criteria::expr()->eq('user', $user));
            $relation = $this->users->matching($criteria);

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

        return false;
    }

    /**
     * @return Collection<int, AccessUrlRelCourseCategory>
     */
    public function getCourseCategory(): Collection
    {
        return $this->courseCategory;
    }

    public function getLft(): int
    {
        return $this->lft;
    }

    public function getLvl(): int
    {
        return $this->lvl;
    }

    public function getRgt(): int
    {
        return $this->rgt;
    }

    public function getRoot(): ?self
    {
        return $this->root;
    }

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

The expression return $this->getId() could return the type null which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

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

    public function getResourceName(): string
    {
        $url = $this->getUrl();
        $url = parse_url($url);

        return $url['host'];
    }

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

    public function getActiveColorTheme(): ?AccessUrlRelColorTheme
    {
        $criteria = Criteria::create();
        $criteria->where(
            Criteria::expr()->eq('active', true)
        );

        return $this->colorThemes->matching($criteria)->first() ?: null;
    }

    /**
     * @return Collection<int, AccessUrlRelColorTheme>
     */
    public function getColorThemes(): Collection
    {
        return $this->colorThemes;
    }

    public function addColorTheme(AccessUrlRelColorTheme $colorTheme): static
    {
        if (!$this->colorThemes->contains($colorTheme)) {
            $this->colorThemes->add($colorTheme);
            $colorTheme->setUrl($this);
        }

        return $this;
    }

    public function removeColorTheme(AccessUrlRelColorTheme $colorTheme): static
    {
        if ($this->colorThemes->removeElement($colorTheme)) {
            // set the owning side to null (unless already changed)
            if ($colorTheme->getUrl() === $this) {
                $colorTheme->setUrl(null);
            }
        }

        return $this;
    }

    public function getColorThemeByTheme(ColorTheme $theme): ?AccessUrlRelColorTheme
    {
        $criteria = Criteria::create();
        $criteria->where(
            Criteria::expr()->eq('colorTheme', $theme)
        );

        return $this->colorThemes->matching($criteria)->first() ?: null;
    }

    /**
     * @return Collection<int, AccessUrlRelPlugin>
     */
    public function getPlugins(): Collection
    {
        return $this->plugins;
    }

    public function addPlugin(AccessUrlRelPlugin $plugin): static
    {
        if (!$this->plugins->contains($plugin)) {
            $this->plugins->add($plugin);
            $plugin->setUrl($this);
        }

        return $this;
    }

    public function removePlugin(AccessUrlRelPlugin $plugin): static
    {
        if ($this->plugins->removeElement($plugin)) {
            // set the owning side to null (unless already changed)
            if ($plugin->getUrl() === $this) {
                $plugin->setUrl(null);
            }
        }

        return $this;
    }

    public function isLoginOnly(): bool
    {
        return $this->isLoginOnly;
    }

    public function setIsLoginOnly(bool $isLoginOnly): static
    {
        $this->isLoginOnly = $isLoginOnly;

        return $this;
    }

    public function setSuperior(?AccessUrl $accessUrl): static
    {
        $this->parent = $accessUrl;

        return $this;
    }

    public function getSuperior(): ?AccessUrl
    {
        return $this->parent;
    }
}