docs: update all documentation for refactored naming conventions

- CanComment trait replaces IsCommenter
- Commentator interface replaces Commenter
- Models moved to Models\ namespace (Comment, Reaction, Attachment, Subscription)
- commenter_type/commenter_id columns replace user_type/user_id
- CommentsConfig replaces Config class
- table_names config key replaces tables
- getCommentDisplayName() replaces getCommentName()
This commit is contained in:
manukminasyan
2026-03-27 15:01:50 +04:00
parent b2ee8a1036
commit a4d4418963
10 changed files with 71 additions and 58 deletions

View File

@@ -15,21 +15,34 @@ php artisan vendor:publish --tag=comments-config
This creates `config/comments.php` with all available options.
## Table Name
## Table Names
```php
'tables' => [
'table_names' => [
'comments' => 'comments',
'reactions' => 'comment_reactions',
'mentions' => 'comment_mentions',
'subscriptions' => 'comment_subscriptions',
'attachments' => 'comment_attachments',
],
```
Change the table name if it conflicts with your application.
Change the table names if they conflict with your application.
## Column Names
```php
'column_names' => [
'commenter_id' => 'commenter_id',
'commenter_type' => 'commenter_type',
],
```
## Models
```php
'models' => [
'comment' => \Relaticle\Comments\Comment::class,
'comment' => \Relaticle\Comments\Models\Comment::class,
],
'commenter' => [
@@ -178,10 +191,10 @@ When broadcasting is disabled, the Livewire component polls for new comments at
Override how the authenticated user is resolved:
```php
use Relaticle\Comments\Config;
use Relaticle\Comments\CommentsConfig;
// In AppServiceProvider::boot()
Config::resolveAuthenticatedUserUsing(function () {
CommentsConfig::resolveAuthenticatedUserUsing(function () {
return auth()->user();
});
```