ComunicAPI/classes/components/comments.php

308 lines
8.0 KiB
PHP
Raw Normal View History

2017-12-25 08:58:30 +00:00
<?php
/**
* Comments component class
*
* @author Pierre HUBERT
*/
class Comments {
/**
* Comments table
*/
const COMMENTS_TABLE = "commentaires";
2018-01-31 05:47:25 +00:00
/**
* Create a comment
*
* @param int $postID The ID of the associated post
* @param int $userID The ID of the associated user
* @param string $content The content of the comment
* @param string $image The path of an associated image (if any)
* @return int The ID of the created comment or 0 in case of failure
*/
public function create(int $postID, int $userID, string $content, string $image = "") : int {
//Generate data set
$data = array(
"ID_texte" => $postID,
"ID_personne" => $userID,
"date_envoi" => mysql_date(),
"commentaire" => $content,
"image_commentaire" => $image == "" ? "" : "file:".$image
);
//Insert it in the database
if(!CS::get()->db->addLine($this::COMMENTS_TABLE, $data))
return 0;
//Get the ID of the last inserted comment and return it
return CS::get()->db->getLastInsertedID();
}
2017-12-25 08:58:30 +00:00
/**
* Fetch the comments of a post
*
* @param int $postID The ID of the post
2018-01-25 05:54:53 +00:00
* @param bool $load_comments Specify whether the comments should be
* loaded or not (default to true)
2017-12-25 08:58:30 +00:00
* @return array The list of comments of the post
*/
2018-01-25 05:54:53 +00:00
public function get(int $postID, bool $load_comments = true) : array {
2017-12-25 08:58:30 +00:00
//Perform a request on the database
$conditions = "WHERE ID_texte = ? ORDER BY ID";
$condValues = array($postID);
//Fetch the messages on the database
$result = CS::get()->db->select($this::COMMENTS_TABLE, $conditions, $condValues);
//Process comments list
$comments = array();
foreach($result as $entry){
2018-01-25 05:54:53 +00:00
$comments[] = $this->parse_comment($entry, $load_comments);
2017-12-25 08:58:30 +00:00
}
return $comments;
}
/**
* Get a single comment informations
*
* @param int $commentID The ID of the comment to get
* @param bool $include_likes Specify if likes has to be loaded
* @return Comment Information about the comment (invalid comment in case of failure)
*/
public function get_single(int $commentID, bool $include_likes = false) : Comment {
//Perform a request on the database
$conditions = "WHERE ID = ?";
$values = array($commentID);
//Fetch the comment on the database
$result = CS::get()->db->select($this::COMMENTS_TABLE, $conditions, $values);
//Check for results
if(count($result) == 0)
return new Comment();
//Return result
return $this->dbToComment($result[0], $include_likes);
}
2017-12-25 08:58:30 +00:00
/**
2018-01-13 18:07:15 +00:00
* Delete all the comments associated to a post
*
* @param int $postID The ID of the target post
* @return bool TRUE in case of success / FALSE else
*/
public function delete_all(int $postID) : bool {
2018-01-25 05:54:53 +00:00
//Get the list of comments for the post
$comments = $this->get($postID, FALSE);
foreach($comments as $comment){
//Delete the comment
if(!$this->process_delete($comment))
return false;
}
//Success
return true;
}
/**
* Delete a single comment
*
* @param int $commentID The ID of the comment to delete
* @return bool TRUE for a success / FALSE else
*/
public function delete(int $commentID) : bool {
//Get informations about the comment
$commentInfos = $this->get_single($commentID, false);
//Check for errors
if(!$commentInfos->isValid())
2018-01-25 05:54:53 +00:00
return false;
//Process deletion
return $this->process_delete($commentInfos);
}
/**
* Process comment deletion
*
* @param Comment $commentInfos Informations about the comment to delete
2018-01-25 05:54:53 +00:00
* @return bool TRUE for a success / FALSE else
*/
private function process_delete(Comment $commentInfos) : bool {
2018-01-25 05:54:53 +00:00
//Get comment ID
$commentID = $commentInfos->get_id();
2018-01-25 05:54:53 +00:00
//Check if an image is associated to the comment
if($commentInfos->has_img_path()){
2018-01-25 05:54:53 +00:00
$image_path = path_user_data($commentInfos->get_img_path(), true);
2018-01-25 05:54:53 +00:00
//Delete the image if it exists
if(file_exists($image_path))
unlink($image_path);
}
//Delete the likes associated to the comments
if(!components()->likes->delete_all($commentID, Likes::LIKE_COMMENT))
return false;
//Delete the comment
if(!CS::get()->db->deleteEntry($this::COMMENTS_TABLE, "ID = ?", array($commentID)))
return false;
//Success
return true;
2018-01-13 18:07:15 +00:00
}
/**
2018-01-24 05:39:37 +00:00
* Check if a comment exists or not
*
* @param int $commentID The ID of the comment to check
* @return bool
*/
public function exists(int $commentID) : bool {
return CS::get()->db->count($this::COMMENTS_TABLE, "WHERE ID = ?", array($commentID)) > 0;
}
2018-01-27 17:19:30 +00:00
/**
* Edit a comment content
*
* @param int $commentID The ID of the comment to update
* @param string $content The new content for the comment
* @return bool TRUE for a success / FALSE else
*/
public function edit(int $commentID, string $content) : bool {
//Perform a request on the database
$newValues = array(
"commentaire" => $content
);
//Try to perform request
return CS::get()->db->updateDB(
$this::COMMENTS_TABLE,
"ID = ?",
$newValues,
array($commentID));
}
/**
* Get the ID of the post associated to a comment
*
* @param int $commentID The ID of the comment
* @return int The ID of the associated post / 0 in case of failure
*/
public function getAssociatedPost(int $commentID) : int {
//Get a single comment informations
$comment = $this->get_single($commentID);
//Check if we have got the required information and return it
return $comment->has_postID() ? $comment->get_postID() : 0;
}
/**
* Check if a user is the owner of a comment or not
*
* @param int $userID The ID of the user to check
* @param int $commentID The ID of the comment to check
* @return bool TRUE if the user is the owner of the post / FALSE else
*/
public function is_owner(int $userID, int $commentID) : bool {
return CS::get()->db->count(
$this::COMMENTS_TABLE,
"WHERE ID = ? AND ID_personne = ?",
array($commentID, $userID)
) > 0;
}
2018-01-24 05:39:37 +00:00
/**
2017-12-25 08:58:30 +00:00
* Parse a comment informations
*
* @param array $src Informations from the database
* @param bool $load_likes Specify if the likes have to be loaded or not
2017-12-25 08:58:30 +00:00
* @return array Informations about the comments ready to be sent
*/
private function parse_comment(array $src, bool $load_likes = true): array {
2017-12-25 08:58:30 +00:00
$info = array();
$info["ID"] = $src["ID"];
$info["userID"] = $src["ID_personne"];
$info["postID"] = $src["ID_texte"];
2017-12-25 08:58:30 +00:00
$info["time_sent"] = strtotime($src["date_envoi"]);
$info["content"] = $src["commentaire"];
//Check for image
if($src["image_commentaire"] != ""){
$info["img_path"] = str_replace("file:", "", $src["image_commentaire"]);
$info["img_url"] = path_user_data($info["img_path"], false);
} else {
$info["img_path"] = null;
$info["img_url"] = null;
}
if($load_likes){
//Get informations about likes
$info["likes"] = CS::get()->components->likes->count($info["ID"], Likes::LIKE_COMMENT);
$info["userlike"] = user_signed_in() ? CS::get()->components->likes->is_liking(userID, $info["ID"], Likes::LIKE_COMMENT) : false;
}
2017-12-31 16:40:49 +00:00
2017-12-25 08:58:30 +00:00
return $info;
}
/**
* Turn a comment database entry into a Comment object
*
* @param array $data Database entry
* @param bool $load_likes Specify if the likes have to be loaded or not
* @return Comment Generated comment object
*/
private function dbToComment(array $data, bool $load_likes = true) : Comment {
$comment = new Comment();
$comment->set_id($data["ID"]);
$comment->set_userID($data["ID_personne"]);
$comment->set_postID($data["ID_texte"]);
$comment->set_time_sent(strtotime($data["date_envoi"]));
$comment->set_content($data["commentaire"]);
//Check for image
if($data["image_commentaire"] != ""){
$comment->set_img_path(str_replace("file:", "", $data["image_commentaire"]));
2018-04-21 16:58:02 +00:00
$comment->set_img_url(path_user_data($comment->get_img_path(), false));
}
if($load_likes){
//Get informations about likes
$comment->set_likes(CS::get()->components->likes->count($comment->get_id(), Likes::LIKE_COMMENT));
$comment->set_userLike(user_signed_in() ? CS::get()->components->likes->is_liking(userID, $comment->get_id(), Likes::LIKE_COMMENT) : false);
}
return $comment;
}
2017-12-25 08:58:30 +00:00
}
//Register class
Components::register("comments", new Comments());