====== CommentService ======

**Layer:** ''Service'' · **Source:** ''lib/service/CommentService.php:22'' (lines 22–300)

----
<code>
class CommentService
</code>

======= Docblock Metadata =======

^ Tag ^ Value ^
| ''@category'' | Service class |
| ''@author'' | M.Noermoehammad |
| ''@license'' | MIT |
| ''@version'' | 1.0 |
| ''@since'' | Since Release 1.0 |

======= Inheritance =======

//No parent, interface or trait. This is a root type.//

======= Constants (0) =======

//None.//

======= Properties (11) =======

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$comment_id'' |  | 28 |
| ''private'' | ''(untyped)'' | ''$post_id'' |  | 34 |
| ''private'' | ''(untyped)'' | ''$author_name'' |  | 40 |
| ''private'' | ''(untyped)'' | ''$author_ip'' |  | 46 |
| ''private'' | ''(untyped)'' | ''$author_email'' |  | 53 |
| ''private'' | ''(untyped)'' | ''$content'' |  | 59 |
| ''private'' | ''(untyped)'' | ''$status'' |  | 65 |
| ''private'' | ''(untyped)'' | ''$created_at'' |  | 72 |
| ''private'' | ''(untyped)'' | ''$commentDao'' |  | 80 |
| ''private'' | ''(untyped)'' | ''$validator'' |  | 88 |
| ''private'' | ''(untyped)'' | ''$sanitizer'' |  | 95 |

======= Methods (23) =======

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 97 |
| public | ''setCommentId()'' | (undocumented) | 104 |
| public | ''setPostId()'' | (undocumented) | 109 |
| public | ''setAuthorName()'' | (undocumented) | 114 |
| public | ''setAuthorIP()'' | (undocumented) | 119 |
| public | ''setAuthorEmail()'' | (undocumented) | 124 |
| public | ''setCommentContent()'' | (undocumented) | 129 |
| public | ''setCommentStatus()'' | (undocumented) | 134 |
| public | ''setCommentDate()'' | (undocumented) | 139 |
| public | ''grabComments()'' | (undocumented) | 144 |
| public | ''grabComment()'' | (undocumented) | 149 |
| public | ''getApprovedCommentsApi()'' | Get paginated approved comments for API | 164 |
| public | ''countApprovedCommentsApi()'' | Count approved comments for API | 176 |
| public | ''modifyComment()'' | (undocumented) | 181 |
| public | ''removeComment()'' | Remove Comment | 197 |
| public | ''commentStatementDropDown()'' | Comment Statement DropDown | 217 |
| public | ''totalComments()'' | Total Comments recorded | 229 |
| public | ''countReplies()'' | Count Replies for a Comment | 240 |
| public | ''getCommentApi()'' | Get a single comment with post info for the API. | 251 |
| public | ''createCommentApi()'' | Create a comment from raw data for the API. | 262 |
| public | ''updateCommentApi()'' | Update a comment with raw data for the API. | 274 |
| public | ''removeCommentApi()'' | Delete a comment and its replies for the API. | 285 |
| public | ''checkPostAcceptsComments()'' | Check if a post exists and allows comments. | 296 |


======== __construct() ========

<code>
public function __construct(CommentDao $commentDao, FormValidator $validator, Sanitize $sanitize)
</code>

//lines 97–102 (6)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$commentDao'' |  [[scriptlog:lib:dao:commentdao|''CommentDao'']] |  //required// |  //none// |
|  ''$validator'' |  [[scriptlog:lib:core:formvalidator|''FormValidator'']] |  //required// |  //none// |
|  ''$sanitize'' |  [[scriptlog:lib:core:sanitize|''Sanitize'']] |  //required// |  //none// |


======== setCommentId() ========

<code>
public function setCommentId($comment_id)
</code>

//lines 104–107 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$comment_id'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setPostId() ========

<code>
public function setPostId($post_id)
</code>

//lines 109–112 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$post_id'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setAuthorName() ========

<code>
public function setAuthorName($author_name)
</code>

//lines 114–117 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$author_name'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setAuthorIP() ========

<code>
public function setAuthorIP($author_ip)
</code>

//lines 119–122 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$author_ip'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setAuthorEmail() ========

<code>
public function setAuthorEmail($author_email)
</code>

//lines 124–127 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$author_email'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setCommentContent() ========

<code>
public function setCommentContent($content)
</code>

//lines 129–132 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$content'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setCommentStatus() ========

<code>
public function setCommentStatus($status)
</code>

//lines 134–137 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$status'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setCommentDate() ========

<code>
public function setCommentDate($created_at)
</code>

//lines 139–142 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$created_at'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== grabComments() ========

<code>
public function grabComments($orderBy = &#039;ID&#039;)
</code>

//lines 144–147 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$orderBy'' |  ''(untyped)'' |  '''ID''' |  //none// |

**Returns:** ''(none declared)''


======== grabComment() ========

<code>
public function grabComment($id)
</code>

//lines 149–152 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$id'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== getApprovedCommentsApi() ========

<code>
public function getApprovedCommentsApi($page = 1, $perPage = 10, $sortBy = &#039;ID&#039;, $sortOrder = &#039;DESC&#039;, $postId = null)
</code>

//lines 164–168 (5)//

Get paginated approved comments for API

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$page'' |  ''(untyped)'' |  ''1'' |  //none// |
|  ''$perPage'' |  ''(untyped)'' |  ''10'' |  //none// |
|  ''$sortBy'' |  ''(untyped)'' |  '''ID''' |  //none// |
|  ''$sortOrder'' |  ''(untyped)'' |  '''DESC''' |  //none// |
|  ''$postId'' |  ''(untyped)'' |  ''null'' |  //none// |

**Returns:** ''(none declared)'' — array


======== countApprovedCommentsApi() ========

<code>
public function countApprovedCommentsApi($postId = null)
</code>

//lines 176–179 (4)//

Count approved comments for API

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$postId'' |  ''(untyped)'' |  ''null'' |  //none// |

**Returns:** ''(none declared)'' — integer


======== modifyComment() ========

<code>
public function modifyComment()
</code>

//lines 181–191 (11)//

//Takes no parameters.//

**Returns:** ''(none declared)''


======== removeComment() ========

<code>
public function removeComment()
</code>

//lines 197–208 (12)//

Remove Comment

//Takes no parameters.//

**Returns:** ''(none declared)'' — integer


======== commentStatementDropDown() ========

<code>
public function commentStatementDropDown($selected = &quot;&quot;)
</code>

//lines 217–220 (4)//

Comment Statement DropDown

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$selected'' |  ''(untyped)'' |  ''""'' |  //none// |

**Returns:** ''(none declared)'' — string


======== totalComments() ========

<code>
public function totalComments($data = null)
</code>

//lines 229–232 (4)//

Total Comments recorded

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$data'' |  ''(untyped)'' |  ''null'' |  //none// |

**Returns:** ''(none declared)'' — integer


======== countReplies() ========

<code>
public function countReplies($commentId)
</code>

//lines 240–243 (4)//

Count Replies for a Comment

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$commentId'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)'' — int


======== getCommentApi() ========

<code>
public function getCommentApi($commentId)
</code>

//lines 251–254 (4)//

Get a single comment with post info for the API.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$commentId'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)'' — array&#124;false


======== createCommentApi() ========

<code>
public function createCommentApi(array $data)
</code>

//lines 262–265 (4)//

Create a comment from raw data for the API.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$data'' |  ''array'' |  //required// |  //none// |

**Returns:** ''(none declared)'' — int


======== updateCommentApi() ========

<code>
public function updateCommentApi($commentId, array $data)
</code>

//lines 274–277 (4)//

Update a comment with raw data for the API.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$commentId'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$data'' |  ''array'' |  //required// |  //none// |

**Returns:** ''(none declared)'' — void


======== removeCommentApi() ========

<code>
public function removeCommentApi($commentId)
</code>

//lines 285–288 (4)//

Delete a comment and its replies for the API.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$commentId'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)'' — void


======== checkPostAcceptsComments() ========

<code>
public function checkPostAcceptsComments($postId)
</code>

//lines 296–299 (4)//

Check if a post exists and allows comments.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$postId'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)'' — string&#124;null Returns comment_status value or null if post not found

======= Imports =======

^ Alias ^ Fully-qualified name ^
| ''FormValidator'' | [[scriptlog:lib:core:formvalidator|''Scriptlog\Core\FormValidator'']] |
| ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] |
| ''CommentDao'' | [[scriptlog:lib:dao:commentdao|''Scriptlog\Dao\CommentDao'']] |


----

//This page is generated from source by 'tools/gendoc'. Edits will be overwritten.//