chamilo-lms/src/CourseBundle/Entity/CLpItem.php

<?php

declare(strict_types=1);

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

namespace Chamilo\CourseBundle\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * Items from a learning path (LP).
 *
 * @Gedmo\Tree(type="nested")
 * @ORM\Table(
 *     name="c_lp_item",
 *     indexes={
 *         @ORM\Index(name="lp_id", columns={"lp_id"}),
 *     }
 * )
 * @ORM\Entity
 */
class CLpItem
{
    /**
     * @ORM\Column(name="iid", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue
     */
    protected ?int $iid = null;

    /**
     * @ORM\Column(name="title", type="string", length=511, nullable=false)
     */
    #[Assert\NotBlank]
    protected string $title;

    /**
     * @ORM\Column(name="item_type", type="string", length=32, nullable=false)
     */
    #[Assert\NotBlank]
    protected string $itemType;

    /**
     * @ORM\Column(name="ref", type="text", nullable=false)
     */
    protected string $ref;

    /**
     * @ORM\Column(name="description", type="string", length=511, nullable=true)
     */
    protected ?string $description;

    /**
     * @ORM\Column(name="path", type="text", nullable=false)
     */
    protected string $path;

    /**
     * @ORM\Column(name="min_score", type="float", precision=10, scale=0, nullable=false)
     */
    protected float $minScore;

    /**
     * @ORM\Column(name="max_score", type="float", precision=10, scale=0, nullable=true, options={"default":"100"})
     */
    protected ?float $maxScore;

    /**
     * @ORM\Column(name="mastery_score", type="float", precision=10, scale=0, nullable=true)
     */
    protected ?float $masteryScore = null;

    /**
     * @ORM\Column(name="display_order", type="integer", nullable=false)
     */
    protected int $displayOrder;

    /**
     * @ORM\Column(name="prerequisite", type="text", nullable=true)
     */
    protected ?string $prerequisite = null;

    /**
     * @ORM\Column(name="parameters", type="text", nullable=true)
     */
    protected ?string $parameters = null;

    /**
     * @ORM\Column(name="launch_data", type="text", nullable=false)
     */
    protected string $launchData;

    /**
     * @ORM\Column(name="max_time_allowed", type="string", length=13, nullable=true)
     */
    protected ?string $maxTimeAllowed = null;

    /**
     * @ORM\Column(name="terms", type="text", nullable=true)
     */
    protected ?string $terms = null;

    /**
     * @ORM\Column(name="search_did", type="integer", nullable=true)
     */
    protected ?int $searchDid = null;

    /**
     * @ORM\Column(name="audio", type="string", length=250, nullable=true)
     */
    protected ?string $audio = null;

    /**
     * @ORM\Column(name="prerequisite_min_score", type="float", precision=10, scale=0, nullable=true)
     */
    protected ?float $prerequisiteMinScore = null;

    /**
     * @ORM\Column(name="prerequisite_max_score", type="float", precision=10, scale=0, nullable=true)
     */
    protected ?float $prerequisiteMaxScore = null;

    /**
     * @Gedmo\TreeRoot
     * @ORM\ManyToOne(targetEntity="Chamilo\CourseBundle\Entity\CLp", inversedBy="items", cascade={"persist", "remove"})
     * @ORM\JoinColumn(name="lp_id", referencedColumnName="iid", onDelete="CASCADE")
     */
    protected CLp $lp;

    /**
     * @Gedmo\TreeParent
     * @ORM\ManyToOne(targetEntity="CLpItem", inversedBy="children", cascade={"persist"})
     * @ORM\JoinColumn(name="parent_item_id", referencedColumnName="iid", onDelete="SET NULL")
     */
    protected ?CLpItem $parent = null;

    /**
     * @var Collection|CLpItem[]
     * @ORM\OneToMany(targetEntity="CLpItem", mappedBy="parent")
     */
    protected Collection $children;

    /**
     * @Gedmo\TreeLeft
     * @ORM\Column(name="previous_item_id", type="integer", nullable=true)
     */
    protected ?int $previousItemId = null;

    /**
     * @Gedmo\TreeRight
     * @ORM\Column(name="next_item_id", type="integer", nullable=true)
     */
    protected ?int $nextItemId = null;

    /**
     * @Gedmo\TreeLevel
     * @ORM\Column(name="lvl", type="integer")
     */
    protected ?int $lvl;

    public function __construct()
    {
        $this->children = new ArrayCollection();
        $this->path = '';
        $this->ref = '';
        $this->lvl = 0;
        $this->launchData = '';
        $this->description = '';
        $this->displayOrder = 0;
        $this->minScore = 0;
        $this->maxScore = 100.0;
    }

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

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

    public function setLp(CLp $lp): self
    {
        $this->lp = $lp;

        return $this;
    }

    public function getLp(): CLp
    {
        return $this->lp;
    }

    public function setItemType(string $itemType): self
    {
        $this->itemType = $itemType;

        return $this;
    }

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

    public function setRef(string $ref): self
    {
        $this->ref = $ref;

        return $this;
    }

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

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

        return $this;
    }

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

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

        return $this;
    }

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

    public function setPath(string $path): self
    {
        $this->path = $path;

        return $this;
    }

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

    public function setMinScore(float $minScore): self
    {
        $this->minScore = $minScore;

        return $this;
    }

    /**
     * Get minScore.
     *
     * @return float
     */
    public function getMinScore()
    {
        return $this->minScore;
    }

    public function setMaxScore(float $maxScore): self
    {
        $this->maxScore = $maxScore;

        return $this;
    }

    /**
     * Get maxScore.
     *
     * @return float
     */
    public function getMaxScore()
    {
        return $this->maxScore;
    }

    public function setMasteryScore(float $masteryScore): self
    {
        $this->masteryScore = $masteryScore;

        return $this;
    }

    /**
     * Get masteryScore.
     *
     * @return float
     */
    public function getMasteryScore()
    {
        return $this->masteryScore;
    }

    public function setPreviousItemId(?int $previousItemId): self
    {
        $this->previousItemId = $previousItemId;

        return $this;
    }

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

    public function setNextItemId(?int $nextItemId): self
    {
        $this->nextItemId = $nextItemId;

        return $this;
    }

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

    public function setDisplayOrder(int $displayOrder): self
    {
        $this->displayOrder = $displayOrder;

        return $this;
    }

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

    public function setPrerequisite(string $prerequisite): self
    {
        $this->prerequisite = $prerequisite;

        return $this;
    }

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

    public function setParameters(string $parameters): self
    {
        $this->parameters = $parameters;

        return $this;
    }

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

    public function setLaunchData(string $launchData): self
    {
        $this->launchData = $launchData;

        return $this;
    }

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

    public function setMaxTimeAllowed(string $maxTimeAllowed): self
    {
        $this->maxTimeAllowed = $maxTimeAllowed;

        return $this;
    }

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

    public function setTerms(string $terms): self
    {
        $this->terms = $terms;

        return $this;
    }

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

    public function setSearchDid(int $searchDid): self
    {
        $this->searchDid = $searchDid;

        return $this;
    }

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

    public function setAudio(string $audio): self
    {
        $this->audio = $audio;

        return $this;
    }

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

    public function setPrerequisiteMinScore(float $prerequisiteMinScore): self
    {
        $this->prerequisiteMinScore = $prerequisiteMinScore;

        return $this;
    }

    /**
     * Get prerequisiteMinScore.
     *
     * @return float
     */
    public function getPrerequisiteMinScore()
    {
        return $this->prerequisiteMinScore;
    }

    public function setPrerequisiteMaxScore(float $prerequisiteMaxScore): self
    {
        $this->prerequisiteMaxScore = $prerequisiteMaxScore;

        return $this;
    }

    /**
     * Get prerequisiteMaxScore.
     *
     * @return float
     */
    public function getPrerequisiteMaxScore()
    {
        return $this->prerequisiteMaxScore;
    }

    public function getParentItemId(): int
    {
        if (null === $this->parent) {
            return 0;
        }

        return $this->getParent()->getIid();
    }

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

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

        return $this;
    }

    /**
     * @return CLpItem[]|Collection
     */
    public function getChildren()
    {
        return $this->children;
    }

    /**
     * @param CLpItem[]|Collection $children
     */
    public function setChildren(Collection $children): self
    {
        $this->children = $children;

        return $this;
    }

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

    public function setLvl(int $lvl): self
    {
        $this->lvl = $lvl;

        return $this;
    }
}