FastComments.com

Add Comments to Your Laravel App

Это официальный пакет Laravel для FastComments.

Добавьте живые комментарии, чат и многое другое в ваше приложение на Laravel.

Репозиторий

Просмотреть на GitHub


Требования Internal Link


  • PHP 8.1+
  • Laravel 10, 11, или 12

Установка Internal Link

composer require fastcomments/laravel

Опубликуйте файл конфигурации:

php artisan vendor:publish --tag=fastcomments-config

Добавьте ваши учетные данные в .env:

FASTCOMMENTS_TENANT_ID=your-tenant-id
FASTCOMMENTS_API_KEY=your-api-key

Для региона ЕС:

FASTCOMMENTS_REGION=eu

Компоненты Blade Internal Link

Виджет комментариев

<x-fastcomments />

{{-- С опциями --}}
<x-fastcomments
    url-id="my-page-id"
    url="https://example.com/my-page"
    locale="en_us"
    :has-dark-background="true"
    default-sort-direction="MR"
/>

Онлайн-чат

<x-fastcomments-live-chat url-id="chat-room-1" />

Счетчик комментариев

<x-fastcomments-comment-count url-id="my-page-id" />
<x-fastcomments-comment-count url-id="my-page-id" :number-only="true" />

SSO (Единый вход) Internal Link

Включите SSO в вашем .env:

FASTCOMMENTS_API_KEY=your-api-key
FASTCOMMENTS_SSO_ENABLED=true
FASTCOMMENTS_SSO_MODE=secure

API-ключ обязателен для secure SSO — он используется для подписи полезной нагрузки SSO.

Сопоставление через конфигурацию

В config/fastcomments.php сопоставьте поля FastComments с атрибутами вашей модели User:

'sso' => [
    'enabled' => true,
    'mode' => 'secure',
    'user_map' => [
        'id' => 'id',
        'email' => 'email',
        'username' => 'name',
        'avatar' => 'profile.avatar_url', // поддерживается точечная нотация
    ],
    'is_admin' => fn ($user) => $user->hasRole('admin'),
    'is_moderator' => fn ($user) => $user->hasRole('moderator'),
],

Сопоставление через интерфейс

Для большего контроля реализуйте интерфейс MapsToFastCommentsUser в вашей модели User:

use FastComments\Laravel\SSO\Contracts\MapsToFastCommentsUser;

class User extends Authenticatable implements MapsToFastCommentsUser
{
    public function toFastCommentsUserData(): array
    {
        return [
            'id' => (string) $this->id,
            'email' => $this->email,
            'username' => $this->display_name,
            'avatar' => $this->avatar_url,
            'is_admin' => $this->hasRole('admin'),
        ];
    }
}

Когда интерфейс реализован, он имеет приоритет над сопоставлением, заданным в конфигурации.

SSO в Blade

Когда SSO включен, компонент <x-fastcomments /> автоматически добавляет данные SSO для аутентифицированного пользователя.

Доступ к API Internal Link

Через фасад

use FastComments\Laravel\Facades\FastComments;

// Admin API (требуется API-ключ)
$comments = FastComments::admin()->getComments('tenant-id');

// Public API
$comments = FastComments::publicApi()->getCommentsPublic('tenant-id', 'url-id');

// SSO
$ssoPayload = FastComments::sso()->forWidget();
$token = FastComments::sso()->tokenFor($user);

Через внедрение зависимостей

use FastComments\Laravel\FastCommentsManager;

class CommentController extends Controller
{
    public function index(FastCommentsManager $fc)
    {
        $comments = $fc->admin()->getComments($fc->tenantId());
        // ...
    }
}

Прямой доступ к SDK

use FastComments\Client\Api\DefaultApi;

class CommentController extends Controller
{
    public function index(DefaultApi $api)
    {
        $comments = $api->getComments('tenant-id');
        // ...
    }
}

Справочник конфигурации Internal Link

Ключ Переменная окружения По умолчанию Описание
tenant_id FASTCOMMENTS_TENANT_ID '' ID вашего tenant в FastComments
api_key FASTCOMMENTS_API_KEY '' API-ключ для серверных вызовов
region FASTCOMMENTS_REGION null null (US) или 'eu'
sso.enabled FASTCOMMENTS_SSO_ENABLED false Включить SSO
sso.mode FASTCOMMENTS_SSO_MODE 'secure' 'secure' или 'simple'
sso.login_url FASTCOMMENTS_SSO_LOGIN_URL null URL для входа (при отсутствии используется маршрут Laravel)
sso.logout_url FASTCOMMENTS_SSO_LOGOUT_URL null URL для выхода (при отсутствии используется маршрут Laravel)
widget_defaults [] Параметры конфигурации виджета по умолчанию

Настройка представлений Internal Link

Чтобы настроить шаблон Blade:

php artisan vendor:publish --tag=fastcomments-views

Шаблоны будут опубликованы в resources/views/vendor/fastcomments/.

Нужна помощь?

Если вы столкнулись с какими-либо проблемами или у вас есть вопросы по пакету Laravel, пожалуйста:

Вклад

Вклады приветствуются! Пожалуйста, посетите репозиторий на GitHub для руководства по внесению вкладов.