Add Comments to Your Laravel App

• PHP 8.1+
• Laravel 10, 11, 或 12

composer require fastcomments/laravel

發佈設定檔：

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

將您的憑證加入 .env：

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

如需 EU 區域：

FASTCOMMENTS_REGION=eu

評論小工具

<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" />

在你的 .env 中啟用 SSO：

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

The API key is required for secure SSO — it is used to sign the SSO payload.

設定檔對應

在 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'),
],

介面式對應

若需更細緻的控制，在你的 User 模型上實作 MapsToFastCommentsUser 介面：

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'),
        ];
    }
}

When the interface is implemented, it takes precedence over config-based mapping.

在 Blade 中使用 SSO

當啟用 SSO 時，<x-fastcomments /> 元件會自動為已驗證的使用者注入 SSO 資料。

透過 Facade

use FastComments\Laravel\Facades\FastComments;

// 管理 API（需要 API 金鑰）
$comments = FastComments::admin()->getComments('tenant-id');

// 公開 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');
        // ...
    }
}

要自訂 Blade 範本：

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

範本將會發佈到 resources/views/vendor/fastcomments/。