FastComments.com

Add Comments to Your Laravel App

Dette er den officielle Laravel-pakke til FastComments.

Tilføj livekommentarer, chat og mere til din Laravel-applikation.

Repository

Se på GitHub

Krav Internal Link


  • PHP 8.1+
  • Laravel 10, 11 eller 12

Installation Internal Link

composer require fastcomments/laravel

Publicer konfigurationsfilen:

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

Tilføj dine legitimationsoplysninger til .env:

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

For EU-regionen:

FASTCOMMENTS_REGION=eu

Blade-komponenter Internal Link

Kommentar-widget

<x-fastcomments />

{{-- Med indstillinger --}}
<x-fastcomments
    url-id="my-page-id"
    url="https://example.com/my-page"
    locale="en_us"
    :has-dark-background="true"
    default-sort-direction="MR"
/>

Livechat

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

Antal kommentarer

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

SSO Internal Link

Aktivér SSO i din .env:

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

API-nøglen er påkrævet for secure SSO — den bruges til at signere SSO-payloaden.

Konfigurationsbaseret kortlægning

I config/fastcomments.php, kortlæg FastComments-felter til dine User-modelattributter:

'sso' => [
    'enabled' => true,
    'mode' => 'secure',
    'user_map' => [
        'id' => 'id',
        'email' => 'email',
        'username' => 'name',
        'avatar' => 'profile.avatar_url', // punktnotation understøttet
    ],
    'is_admin' => fn ($user) => $user->hasRole('admin'),
    'is_moderator' => fn ($user) => $user->hasRole('moderator'),
],

Interface-baseret kortlægning

For mere kontrol, implementer MapsToFastCommentsUser-interfacet på din User-model:

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

Når interfacet er implementeret, har det forrang frem for konfigurationsbaseret kortlægning.

SSO i Blade

Når SSO er aktiveret, injicerer <x-fastcomments />-komponenten automatisk SSO-data for den autentificerede bruger.

API-adgang Internal Link

Via Facade

use FastComments\Laravel\Facades\FastComments;

// Admin-API (kræver API-nøgle)
$comments = FastComments::admin()->getComments('tenant-id');

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

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

Via Afhængighedsinjektion

use FastComments\Laravel\FastCommentsManager;

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

Direkte SDK-adgang

use FastComments\Client\Api\DefaultApi;

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

Konfigurationsreference Internal Link

Key Env Variable Default Description
tenant_id FASTCOMMENTS_TENANT_ID '' Dit FastComments tenant-ID
api_key FASTCOMMENTS_API_KEY '' API-nøgle til server-side-opkald
region FASTCOMMENTS_REGION null null (US) eller 'eu'
sso.enabled FASTCOMMENTS_SSO_ENABLED false Aktivér SSO
sso.mode FASTCOMMENTS_SSO_MODE 'secure' 'secure' eller 'simple'
sso.login_url FASTCOMMENTS_SSO_LOGIN_URL null Login-URL (falder tilbage til Laravel-route)
sso.logout_url FASTCOMMENTS_SSO_LOGOUT_URL null Logout-URL (falder tilbage til Laravel-route)
widget_defaults [] Standardindstillinger for widgetkonfiguration

Tilpas visninger Internal Link

For at tilpasse Blade-skabelonen:

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

Skabelonerne vil blive publiceret til resources/views/vendor/fastcomments/.

Brug for hjælp?

Hvis du støder på problemer eller har spørgsmål om Laravel-pakken, så:

Bidrag

Bidrag er velkomne! Besøg venligst GitHub-repositoriet for retningslinjer for bidrag.