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

<?php

declare(strict_types=1);

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

namespace Chamilo\CourseBundle\Entity;

use Chamilo\CoreBundle\Entity\AbstractResource;
use Chamilo\CoreBundle\Entity\ResourceInterface;
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 Symfony\Component\Validator\Constraints as Assert;

/**
 * Course forums.
 *
 * @ORM\Table(
 *     name="c_forum_forum",
 *     indexes={
 *     }
 * )
 * @ORM\Entity(repositoryClass="Chamilo\CourseBundle\Repository\CForumRepository")
 */
class CForum extends AbstractResource implements ResourceInterface
{
    /**
     * @ORM\Column(name="iid", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue
     */
    protected int $iid;

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

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

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

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

    /**
     * @ORM\ManyToOne(targetEntity="Chamilo\CourseBundle\Entity\CForumPost")
     * @ORM\JoinColumn(name="forum_last_post", referencedColumnName="iid")
     */
    protected ?CForumPost $forumLastPost = null;

    /**
     * @Gedmo\SortableGroup
     *
     * @ORM\ManyToOne(targetEntity="Chamilo\CourseBundle\Entity\CForumCategory", inversedBy="forums")
     * @ORM\JoinColumn(name="forum_category", referencedColumnName="iid", nullable=true, onDelete="SET NULL")
     */
    protected ?CForumCategory $forumCategory = null;

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

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

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

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

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

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

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

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

    /**
     * @Gedmo\SortablePosition
     *
     * @ORM\Column(name="forum_order", type="integer", nullable=true)
     */
    protected ?int $forumOrder = null;

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

    /**
     * @ORM\Column(name="forum_image", type="string", length=255, nullable=false)
     */
    protected string $forumImage;

    /**
     * @ORM\Column(name="start_time", type="datetime", nullable=true)
     */
    protected ?DateTime $startTime = null;

    /**
     * @ORM\Column(name="end_time", type="datetime", nullable=true)
     */
    protected ?DateTime $endTime = null;

    /**
     * @ORM\ManyToOne(targetEntity="Chamilo\CourseBundle\Entity\CLp", inversedBy="forums", cascade={"remove"})
     * @ORM\JoinColumn(name="lp_id", referencedColumnName="iid", nullable=true, onDelete="SET NULL")
     */
    protected ?CLp $lp = null;

    /**
     * @ORM\Column(name="moderated", type="boolean", nullable=true)
     */
    protected ?bool $moderated = null;

    /**
     * @var Collection|CForumThread[]
     *
     * @ORM\OneToMany(targetEntity="Chamilo\CourseBundle\Entity\CForumThread", mappedBy="forum")
     */
    protected Collection $threads;

    /**
     * @var Collection|CForumPost[]
     *
     * @ORM\OneToMany(targetEntity="Chamilo\CourseBundle\Entity\CForumPost", mappedBy="forum")
     */
    protected Collection $posts;

    public function __construct()
    {
        $this->threads = new ArrayCollection();
        $this->posts = new ArrayCollection();
        $this->locked = 0;
        $this->forumComment = '';
        $this->forumImage = '';
        $this->forumOfGroup = '';
        $this->forumPosts = 0;
        $this->forumGroupPublicPrivate = '';
    }

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

    public function setForumTitle(string $forumTitle): self
    {
        $this->forumTitle = $forumTitle;

        return $this;
    }

    public function getForumTitle(): string
    {
        return $this->forumTitle;
    }

    public function setForumComment(string $forumComment): self
    {
        $this->forumComment = $forumComment;

        return $this;
    }

    public function getForumComment(): string
    {
        return $this->forumComment;
    }

    public function setForumThreads(int $forumThreads): self
    {
        $this->forumThreads = $forumThreads;

        return $this;
    }

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

    public function hasThread(CForumThread $thread): bool
    {
        return $this->threads->contains($thread);
    }

    public function setForumPosts(int $forumPosts): self
    {
        $this->forumPosts = $forumPosts;

        return $this;
    }

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

    public function setForumCategory(CForumCategory $forumCategory = null): self
    {
        if (null !== $forumCategory) {
            $forumCategory->getForums()->add($this);
        }
        $this->forumCategory = $forumCategory;

        return $this;
    }

    /**
     * Get forumCategory.
     *
     * @return null|CForumCategory
     */
    public function getForumCategory()
    {
        return $this->forumCategory;
    }

    public function setAllowAnonymous(int $allowAnonymous): self
    {
        $this->allowAnonymous = $allowAnonymous;

        return $this;
    }

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

    public function setAllowEdit(int $allowEdit): self
    {
        $this->allowEdit = $allowEdit;

        return $this;
    }

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

    public function setApprovalDirectPost(string $approvalDirectPost): self
    {
        $this->approvalDirectPost = $approvalDirectPost;

        return $this;
    }

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

    public function setAllowAttachments(int $allowAttachments): self
    {
        $this->allowAttachments = $allowAttachments;

        return $this;
    }

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

    public function setAllowNewThreads(int $allowNewThreads): self
    {
        $this->allowNewThreads = $allowNewThreads;

        return $this;
    }

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

    public function setDefaultView(string $defaultView): self
    {
        $this->defaultView = $defaultView;

        return $this;
    }

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

    public function setForumOfGroup(string $forumOfGroup): self
    {
        $this->forumOfGroup = $forumOfGroup;

        return $this;
    }

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

    public function getForumGroupPublicPrivate(): string
    {
        return $this->forumGroupPublicPrivate;
    }

    /**
     * @return $this
     */
    public function setForumGroupPublicPrivate(string $forumGroupPublicPrivate)
    {
        $this->forumGroupPublicPrivate = $forumGroupPublicPrivate;

        return $this;
    }

    public function setForumOrder(int $forumOrder): self
    {
        $this->forumOrder = $forumOrder;

        return $this;
    }

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

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

        return $this;
    }

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

    public function setForumImage(string $forumImage): self
    {
        $this->forumImage = $forumImage;

        return $this;
    }

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

    public function setStartTime(?DateTime $startTime): self
    {
        $this->startTime = $startTime;

        return $this;
    }

    /**
     * Get startTime.
     *
     * @return DateTime
     */
    public function getStartTime()
    {
        return $this->startTime;
    }

    public function setEndTime(?DateTime $endTime): self
    {
        $this->endTime = $endTime;

        return $this;
    }

    /**
     * Get endTime.
     *
     * @return DateTime
     */
    public function getEndTime()
    {
        return $this->endTime;
    }

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

    public function setModerated(bool $moderated): self
    {
        $this->moderated = $moderated;

        return $this;
    }

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

    /**
     * Get threads.
     *
     * @return Collection|CForumThread[]
     */
    public function getThreads()
    {
        return $this->threads;
    }

    public function getForumLastPost(): ?CForumPost
    {
        return $this->forumLastPost;
    }

    public function setForumLastPost(CForumPost $forumLastPost): self
    {
        $this->forumLastPost = $forumLastPost;

        return $this;
    }

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

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

        return $this;
    }

    /**
     * @return Collection|CForumPost[]
     */
    public function getPosts()
    {
        return $this->posts;
    }

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

    public function getResourceName(): string
    {
        return $this->getForumTitle();
    }

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