App\Models\CommentModel

Complexity

Total Complexity

14

Size/Duplication

Total Lines	259
Duplicated Lines	0 %

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	purifyHtml()	0	5	1
A	baseSql()	0	9	1
A	__construct()	0	7	1
A	countCommentsOnPost()	0	7	1
A	countPendingComments()	0	6	1
A	getPendingCommentsList()	0	13	1
A	getCommentsListOnPost()	0	15	1
A	countComments()	0	3	1
A	addComment()	0	15	1
A	delete()	0	9	1
A	getCommentsList()	0	12	1
A	update()	0	18	1
A	setApproved()	0	13	1
A	getCommentById()	0	11	1

<?php

namespace App\Models;

use Core\Model;
use Core\Container;
use Core\Constant;
use HTMLPurifier;
use HTMLPurifier_Config;

class CommentModel extends Model{

    private $commentTbl;
    private $userTbl;
    private $postTbl;

    public function __construct(Container $container)
    {
        parent::__construct($container);

        $this->commentTbl = $this->getTablePrefix("comments");
        $this->userTbl = $this->getTablePrefix("users");
        $this->postTbl = $this->getTablePrefix("posts");
    }

    /**
     * the base Select SQl
     * @return string
     */
    private function baseSql():string
    {
        $sql = "
            SELECT idcomments, users_idusers, posts_idposts, comment, approved, comment_date, idposts, title, posts_slug, idusers, username, avatar
            FROM $this->commentTbl 
            LEFT JOIN $this->postTbl ON $this->commentTbl.posts_idposts = $this->postTbl.idposts
            LEFT JOIN $this->userTbl ON $this->commentTbl.users_idusers = $this->userTbl.idusers
        ";
        return $sql;
    }

    /**
     * secure the HTML thanks to HTML Purifier
     * @param $dirtyHtml
     * @return string
     */
    private function purifyHtml($dirtyHtml):string
    {
        $config = HTMLPurifier_Config::createDefault();
        $purifier = new HTMLPurifier($config);
        return $purifier->purify($dirtyHtml);
    }

    /**
     * Count the number of comments on a post
     * @param int $postId
     * @return int
     * @throws \Exception
     */
    public function countCommentsOnPost(int $postId): int
    {
        $sql = "SELECT COUNT(*) FROM $this->commentTbl WHERE posts_idposts = :postId";
        $this->query($sql);
        $this->bind(":postId", $postId);
        $this->execute();
        return $this->stmt->fetchColumn();
    }

    /**
     * the list of comments on a post with limit and offset
     * @param int $postId
     * @param int $offset
     * @param int $limit
     * @return array
     * @throws \Exception
     */
    public function getCommentsListOnPost(int $postId, int $offset = 0, int $limit = Constant::COMMENTS_PER_PAGE):array
    {
        $sql = $this->baseSql();
        $sql .= "
            WHERE approved = 1
            AND posts_idposts = :postId
            LIMIT :limit OFFSET :offset
        ";

        $this->query($sql);
        $this->bind(":limit", $limit);
        $this->bind(":offset", $offset);
        $this->bind(":postId", $postId);
        $this->execute();
        return $this->fetchAll();
    }

    /**
     * count the number of pending comments
     * @return mixed
     * @throws \Exception
     */
    public function countPendingComments():int
    {
        $sql = "SELECT COUNT(*) FROM $this->commentTbl WHERE approved = 0";
        $this->query($sql);
        $this->execute();
        return $this->stmt->fetchColumn();
    }

    /**
     * get the list of pending comments with limit and offset
     * @param int $offset
     * @param int $limit
     * @return array
     * @throws \Exception
     */
    public function getPendingCommentsList(int $offset = 0, int $limit = Constant::COMMENTS_PER_PAGE):array
    {
        $sql = $this->baseSql();
        $sql .= "
          WHERE approved = 0
          LIMIT :limit OFFSET :offset
        ";
        $this->query($sql);
        $this->bind(":limit", $limit);
        $this->bind(":offset", $offset);
        $this->execute();

        return $this->fetchAll();
    }

    /**
     * counts all the comments
     * @return int
     * @throws \Exception
     */
    public function countComments(): int
    {
        return $this->count($this->commentTbl);
    }


    /**
     * get the list of all the comments
     * @param int $offset
     * @param int $limit
     * @return array
     * @throws \Exception
     */
    public function getCommentsList(int $offset = 0, int $limit = Constant::POSTS_PER_PAGE):array
    {
        $sql = $this->baseSql();
        $sql .= "
          LIMIT :limit OFFSET :offset
        ";
        $this->query($sql);
        $this->bind(":limit", $limit);
        $this->bind(":offset", $offset);
        $this->execute();

        return $this->fetchAll();
    }

    /**
     * Add a comment to a post
     * @param int $postId
     * @param int $userId
     * @param string $comment
     * @param bool $admin
     * @return int
     * @throws \Exception
     */
    public function addComment(int $postId, int $userId, string $comment, bool $admin=false):int
    {
        $comment = $this->purifyHtml($comment);
        $sql="
            INSERT INTO $this->commentTbl (users_idusers, posts_idposts, comment, approved, comment_date)
            VALUES (:userId, :postId, :comment, :approved, NOW())
        ";
        $this->query($sql);
        $this->bind(':userId', $userId);
        $this->bind(':postId', $postId);
        $this->bind(':comment', $comment);
        $this->bind(':approved', $admin);

        $this->execute();
        return (int)$this->dbh->lastInsertId();
    }

    /**
     * delete a comment by it's ID
     * @param int $commentId
     * @return bool
     * @throws \Exception
     */
    public function delete(int $commentId):bool
    {
        $sql = "
        DELETE FROM $this->commentTbl 
        WHERE idcomments = :commentId
        ";
        $this->query($sql);
        $this->bind(":commentId", $commentId);
        return $this->finalExecute();
    }

    /**
     * Update an existing comment
     * @param int $commentId
     * @param string $comment
     * @param bool $approved
     * @return bool
     * @throws \Exception
     */
    public function update(int $commentId, string $comment, bool $approved):bool
    {
        $comment = $this->purifyHtml($comment);

        $sql="
            UPDATE $this->commentTbl 
            SET
              comment = :comment,
              approved = :state
            WHERE
              idcomments = :commentId
        ";

        $this->query($sql);
        $this->bind(":commentId", $commentId);
        $this->bind(":comment", $comment);
        $this->bind(":state", $approved);
        return $this->finalExecute();
    }

    /**
     * get a comment from it's ID
     * @param int $commentId
     * @return mixed
     * @throws \Exception
     */
    public function getCommentById(int $commentId)
    {
        $sql = $this->baseSql();
        $sql .= "
          WHERE idcomments = :commentId
        ";
        $this->query($sql);
        $this->bind(':commentId', $commentId);
        $this->execute();

        return $this->fetch();
    }

    /**
     * Set the approved state
     * @param bool $state
     * @param int $commentId
     * @return bool
     * @throws \Exception
     */
    public function setApproved(bool $state, int $commentId):bool
    {
        $sql = "
            UPDATE $this->commentTbl 
            SET
              approved = :state
            WHERE
              idcomments = :commentId
        ";
        $this->query($sql);
        $this->bind(":commentId", $commentId);
        $this->bind(":state", $state);
        return $this->finalExecute();
    }



}