FastComments.com

Add Comments to Your Laravel App

To jest oficjalny pakiet Laravel dla FastComments.

Dodaj komentarze na żywo, czat i inne funkcje do swojej aplikacji Laravel.

Repozytorium

Zobacz na GitHub


Wymagania Internal Link


  • PHP 8.1+
  • Laravel 10, 11 lub 12

Instalacja Internal Link

composer require fastcomments/laravel

Opublikuj plik konfiguracyjny:

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

Dodaj swoje dane uwierzytelniające do .env:

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

Dla regionu UE:

FASTCOMMENTS_REGION=eu

Komponenty Blade Internal Link

Widżet komentarzy

<x-fastcomments />

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

Czat na żywo

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

Liczba komentarzy

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

SSO Internal Link


Włącz SSO w swoim pliku .env:

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

Klucz API jest wymagany dla bezpiecznego SSO — służy do podpisywania danych SSO.

Mapowanie oparte na konfiguracji

W pliku config/fastcomments.php zmapuj pola FastComments na atrybuty modelu User:

'sso' => [
    'enabled' => true,
    'mode' => 'secure',
    'user_map' => [
        'id' => 'id',
        'email' => 'email',
        'username' => 'name',
        'avatar' => 'profile.avatar_url', // obsługa notacji kropkowej
    ],
    'is_admin' => fn ($user) => $user->hasRole('admin'),
    'is_moderator' => fn ($user) => $user->hasRole('moderator'),
],

Mapowanie oparte na interfejsie

Dla większej kontroli zaimplementuj interfejs MapsToFastCommentsUser w swoim modelu 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'),
        ];
    }
}

Gdy interfejs jest zaimplementowany, ma on pierwszeństwo przed mapowaniem opartym na konfiguracji.

SSO w Blade

Gdy SSO jest włączone, komponent <x-fastcomments /> automatycznie wstrzykuje dane SSO dla uwierzytelnionego użytkownika.

Dostęp do API Internal Link

Za pomocą Facade

use FastComments\Laravel\Facades\FastComments;

// Admin API (wymaga klucza API)
$comments = FastComments::admin()->getComments('tenant-id');

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

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

Za pomocą Dependency Injection

use FastComments\Laravel\FastCommentsManager;

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

Bezpośredni dostęp do SDK

use FastComments\Client\Api\DefaultApi;

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

Referencja konfiguracji Internal Link

Klucz Zmienna środowiskowa Domyślne Opis
tenant_id FASTCOMMENTS_TENANT_ID '' Twój identyfikator tenantu FastComments
api_key FASTCOMMENTS_API_KEY '' Klucz API do wywołań po stronie serwera
region FASTCOMMENTS_REGION null null (USA) lub 'eu'
sso.enabled FASTCOMMENTS_SSO_ENABLED false Włącz SSO
sso.mode FASTCOMMENTS_SSO_MODE 'secure' 'secure' lub 'simple'
sso.login_url FASTCOMMENTS_SSO_LOGIN_URL null URL logowania (w przeciwnym razie używana jest trasa Laravela)
sso.logout_url FASTCOMMENTS_SSO_LOGOUT_URL null URL wylogowania (w przeciwnym razie używana jest trasa Laravela)
widget_defaults [] Domyślne opcje konfiguracji widgetu

Dostosowywanie widoków Internal Link


Aby dostosować szablon Blade:

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

Szablony zostaną opublikowane w resources/views/vendor/fastcomments/.

Potrzebujesz pomocy?

Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące pakietu Laravel, prosimy:

Wkład

Wkłady są mile widziane! Odwiedź repozytorium GitHub po wytyczne dotyczące wkładu.