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 ключът е задължителен за защитеното 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 '' Вашият FastComments tenant ID
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 [] Опции за конфигурация на widget по подразбиране
---

Персонализиране на изгледите Internal Link


За да персонализирате шаблона Blade:

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

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

Нуждаете ли се от помощ?

Ако срещнете проблеми или имате въпроси относно пакета за Laravel, моля:

Принос

Вашите приноси са добре дошли! Моля, посетете хранилището в GitHub за указания как да допринесете.