Skip to content
Capell CMS

Comments

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

FieldValue
Composer packagecapell-app/comments
Package slugcomments
Product groupCapell Engagement & CRM
Tierpremium
Bundleengagement-crm
Runtime contextsadmin, frontend
Capell version^1.0
Source repositorycapell-app/packages
Source pathpackages/comments
Docs sourcepackages/comments/docs
Manifestcapell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Comments is an Available, Schema-owning Capell package in the Capell Engagement & CRM product group. It ships as capell-app/comments and extends these surfaces: admin, frontend.

Comments adds threaded public discussions with author verification, moderation, reactions, reply notifications, and privacy retention controls.

Visitors read and reply to approved threads, while editors review comments, authors, spam, and moderation history in the admin.

Evidence: capell.json, src/Models/Comment.php, src/Livewire/CommentThreadComponent.php, src/Providers/CommentsServiceProvider.php, docs/overview.admin.md, docs/screenshots.json, tests/Integration/Actions/PublicThreadActionTest.php, tests/Integration/Filament/CommentsAdminSurfaceTest.php.

Status details:

  • Status: Available
  • Tier: premium
  • Bundle: engagement-crm
  • Composer package: capell-app/comments
  • Namespace: Capell\Comments
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: A commentable registry and focused Actions provide extension points for new content types while keeping public thread building and moderation rules testable.

For teams: Editors can control what becomes public and retain a record of moderation decisions, while retention tools support privacy operations.

Evidence: src/Support/CommentableRegistry.php, src/Actions/BuildPublicThreadAction.php, src/Actions/TransitionCommentStatusAction.php, tests/Integration/Actions/PublicThreadActionTest.php, docs/admin-guide.md, src/Actions/CommentModerationEventAction.php, src/Actions/ApplyCommentPrivacyRetentionAction.php, tests/Feature/ModeratorNotificationTest.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Comment moderation inbox

Comments admin resource

  • Comment moderation inbox (admin, required).
  • Comments admin resource (admin, required).
  • Comment authors admin resource (admin, required).
  • Public comment thread (frontend, required).
  • Public comment thread closed state (frontend, optional).
  • Comment stats dashboard widget (admin, optional).
  • Comment reply notification email preview (email, optional).

Technical Shape

Section titled “Technical Shape”
  • Service providers: Capell\Comments\Providers\CommentsServiceProvider, Capell\Comments\Providers\AdminServiceProvider, Capell\Comments\Providers\FrontendServiceProvider.
  • Config files: packages/comments/config/capell-comments.php.
  • Migrations: packages/comments/database/migrations/2026_05_24_000001_create_comment_authors_table.php, packages/comments/database/migrations/2026_05_24_000002_create_comments_table.php, packages/comments/database/migrations/2026_05_24_000003_create_comment_tokens_table.php, packages/comments/database/migrations/2026_05_24_000004_create_comment_moderation_events_table.php, packages/comments/database/migrations/2026_05_24_000006_add_reply_notification_opt_out_to_comment_authors_table.php, packages/comments/database/migrations/2026_05_24_000007_create_comment_reactions_table.php.
  • Settings migrations: packages/comments/database/settings/2026_05_24_000005_create_comments_settings.php.
  • Settings classes: CommentSettings.
  • Models: Comment, CommentAuthor, CommentModerationEvent, CommentReaction, CommentToken.
  • Filament classes: CommentModerationInbox, CommentAuthorResource, ListCommentAuthors, CommentResource, ListComments, CommentsTable, CommentSettingsSchema, CommentsDashboardSettingsContributor, CommentStatsFilamentWidget, LatestCommentsFilamentWidget.
  • Livewire components: CommentThreadComponent.
  • Route files: packages/comments/routes/web.php.
  • Policies: CommentAuthorPolicy, CommentPolicy.
  • Extension contracts: CommentSpamProvider.
  • Events: CommentCreated.
  • Listeners: NotifyModeratorsOfNewComment.
  • Actions: ApplyCommentPrivacyRetentionAction, BuildCommentPrivacyExportAction, BuildPublicThreadAction, CommentModerationEventAction, CreateCommentAction, DisableCommentAuthorReplyNotificationsAction, EraseCommentPrivacyDataAction, InstallCommentsPackageAction, InvalidateCommentableCacheAction, ListCommentableTypeOptionsAction, RegisterCommentEmailTemplatesAction, RegisterDefaultCommentablesAction, and 10 more.
  • Data objects: CommentEmailTemplateData, CommentPrivacyRecordIdsData, CommentPrivacyRetentionResultData, CommentReactionResultData, CommentSpamCheckData, CommentSpamReasonData, CommentSpamScoreData, CommentableTypeData, CreateCommentData, PublicCommentData, PublicCommentableThreadData.
  • Command signatures: capell-comments:install, capell-comments:privacy-retention.
  • Manifest action API: applyPrivacyRetention: Capell\Comments\Actions\ApplyCommentPrivacyRetentionAction, disableReplyNotifications: Capell\Comments\Actions\DisableCommentAuthorReplyNotificationsAction, install: Capell\Comments\Actions\InstallCommentsPackageAction, requestReplyNotification: Capell\Comments\Actions\RequestCommentReplyNotificationAction, scoreSpam: Capell\Comments\Actions\ScoreCommentSpamAction, toggleReaction: Capell\Comments\Actions\ToggleCommentReactionAction.
  • Console command classes: InstallCommentsCommand, PruneCommentPrivacyDataCommand.
  • Manifest contributions: admin-resource: Capell\Comments\Manifest\CommentAdminResourcesContribution, dashboard-widget: Capell\Comments\Manifest\CommentDashboardFilamentWidgetsContribution, frontend-component: Capell\Comments\Manifest\CommentFrontendComponentsContribution, model: Capell\Comments\Manifest\CommentModelsContribution, route: Capell\Comments\Manifest\CommentRoutesContribution, setting: Capell\Comments\Manifest\CommentSettingsContribution.
  • Health checks: Capell\Comments\Health\CommentsHealthCheck.
  • Blade views: packages/comments/resources/views/emails/approved.blade.php, packages/comments/resources/views/emails/pending-moderation.blade.php, packages/comments/resources/views/emails/rejected.blade.php, packages/comments/resources/views/emails/reply-notification.blade.php, packages/comments/resources/views/emails/verify-email.blade.php, packages/comments/resources/views/filament/comment-context.blade.php, packages/comments/resources/views/filament/moderation-inbox.blade.php, packages/comments/resources/views/livewire/partials/comment-list.blade.php, packages/comments/resources/views/livewire/thread-livewire.blade.php, packages/comments/resources/views/livewire/thread-shell.blade.php, packages/comments/resources/views/livewire/thread.blade.php, packages/comments/resources/views/reply-notifications-disabled.blade.php, and 1 more.
  • Cache tags: comments.

Data Model

Section titled “Data Model”
  • Required tables: comment_authors, comments, comment_tokens, comment_moderation_events, comment_reactions.
  • Models: Comment, CommentAuthor, CommentModerationEvent, CommentReaction, CommentToken.
  • Core record references in migrations: sites via site_id, languages via language_id, users via user_id.
  • Migration files: 2026_05_24_000001_create_comment_authors_table.php, 2026_05_24_000002_create_comments_table.php, 2026_05_24_000003_create_comment_tokens_table.php, 2026_05_24_000004_create_comment_moderation_events_table.php, 2026_05_24_000006_add_reply_notification_opt_out_to_comment_authors_table.php, 2026_05_24_000007_create_comment_reactions_table.php.
  • Migration impact: run host migrations through the package install flow before opening package surfaces.
  • Deletion/retention behaviour: migrations declare cascade-on-delete relationships and null-on-delete relationships; no timed pruning or retention schedule is declared in capell.json.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core, capell-app/frontend.
  • Admin navigation: declares admin-resource: CommentAdminResourcesContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: dashboard-widget: CommentDashboardFilamentWidgetsContribution.
  • Permissions: ViewAny:Comment, View:Comment, Update:Comment, Approve:Comment, Delete:Comment, ViewAny:CommentAuthor, View:CommentAuthor, Update:CommentAuthor.
  • Public routes: loads routes/web.php; registers CommentRoutesContribution.
  • Database changes: package migrations are declared.
  • Config: config/capell-comments.php.
  • Settings: Capell\Comments\Settings\CommentSettings.
  • Queues or schedules: none declared.
  • Cache tags: comments.
  • Commands: capell-comments:install, capell-comments:privacy-retention.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/frontend.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/capell-comments.php, Capell\Comments\Settings\CommentSettings.
  • Review middleware, throttling, signatures, and public-output safety in routes/web.php before exposing routes.
  • Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
  • Custom write integrations must preserve invalidation for comments cache tags.

Troubleshooting

Section titled “Troubleshooting”
SymptomLikely causeCheckFix
Package surface is missing after installProvider or manifest is not loadedConfirm capell.json, package composer.json, and provider registrationReinstall the package, refresh Composer autoload, and clear host caches
Admin screen or command fails on missing tablePackage migrations have not runCheck the tables listed in Data ModelRun host migrations and rerun the focused package test
Route returns unexpected outputRoute cache, middleware, or signed URL setup does not match the package route fileCheck the route files listed in Technical ShapeClear route cache and verify middleware before exposing public routes
Public output leaks unexpected stateRender data, cache variation, or authoring boundary has regressedCheck public Blade, cache tags, and public-output safety testsMove data loading out of Blade and rerun the package public-output tests

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/comments.
  2. Run the required setup: php artisan capell-comments:install.
  3. Open the Comment moderation inbox and confirm the admin workflow loads.

Next Steps

Section titled “Next Steps”