The Comments facade

Comments — RoundlyConsulting\Comments\Facades\Comments — is the whole API in one place. Writes start from a fluent builder that reads like a sentence; reads start from a query:

use RoundlyConsulting\Comments\Facades\Comments;

// Write — a fluent builder, or a typed DTO
$comment = Comments::on($post)->as($user)->body('Nice write-up!')->post();
Comments::write($writeCommentData);

// Edit and moderate
Comments::update($comment, 'Edited body');
Comments::delete($comment);
Comments::restore($comment);
Comments::approve($comment);
Comments::hide($comment);

// Read — site-wide, per subject or per author
Comments::query()->pending()->mostReported()->paginate();
Comments::for($post)->visible()->rootsOnly()->withReplies()->get();
Comments::byAuthor($user)->get();

// Lock a subject, or the thread under one comment
Comments::lock($post);         Comments::unlock($post);         Comments::isLocked($post);
Comments::lockThread($comment); Comments::unlockThread($comment); Comments::isThreadLocked($reply);

Builders

• Comments::on($subject) returns a CommentBuilder — as(), body(), visible(), reply(), then post(). The subject is a scope: a reply to another subject’s comment throws InvalidCommentParentException.
• Comments::query(), for($subject) and byAuthor($author) return a CommentQuery — filters, ordering, get() / paginate() / count() and the bulk approveAll() / hideAll() / deleteAll(). Build it through the facade or the manager: its bulk terminals run through the manager.

Model shorthands

$user->writeComment() and $comment->lockReplies() / unlockReplies() are sugar over the same manager, so behaviour, events and Comments::fake() are identical whichever form you use.