- Documentation
- Paquet Laravel · Version 0.1
- Introduction
Introduction
Sur cette page
Le paquet quiet-social/laravel-social publie vos modèles Eloquent sur Facebook, Instagram, LinkedIn, Threads et Pinterest. Le post se décrit une fois, sur le modèle : le paquet l'envoie quand le modèle est enregistré, le remplace tant qu'il n'est pas parti, et l'annule quand le modèle est supprimé ou dépublié.
Premier exemple
use Illuminate\Database\Eloquent\Model;
use QuietSocial\Social\Attributes\LinkedIn;
use QuietSocial\Social\Attributes\SocialPost;
use QuietSocial\Social\Concerns\PublishesToSocial;
#[SocialPost(
content: 'excerpt',
link: 'url',
cover: 'cover_path',
publishAt: 'published_at',
when: 'is_published',
to: ['facebook', 'linkedin'],
)]
#[LinkedIn(content: 'linkedinTeaser')]
class Article extends Model
{
use PublishesToSocial;
public function linkedinTeaser(): string
{
return $this->excerpt."\n\nL'article complet est sur notre site.";
}
}
Enregistrer un article publié envoie son post, programmé à published_at. Changer ce que montre le post (le chapô, le lien, la couverture…) avant cette date remplace le post programmé ; dépublier ou supprimer l'article l'annule.
La clé API doit porter les droits publications:create, publications:read, publications:cancel et destinations:read, plus media:create pour la couverture. Une clé qui couvre tout un espace de travail demande aussi la marque pour laquelle publier : QUIET_SOCIAL_BRAND_ID, ou #[SocialPost(brand: ...)] modèle par modèle (voir Installation et configuration).
Comment il travaille
- Décrire. Des attributs PHP (
#[SocialPost],#[LinkedIn]…) ou des méthodes publiques nommées par convention (socialContent(),linkedinContent()…) disent ce que publie le modèle. - Synchroniser. Chaque enregistrement ou suppression met en file un job qui compare le post décrit à ce qui a déjà été envoyé, par une empreinte, et envoie, remplace, annule ou ne fait rien.
- Suivre. Les webhooks de Quiet Social tiennent à jour le statut de chaque post, et lèvent des événements Laravel.
Tout passe par le SDK PHP, installé avec le paquet, et par l'API REST v1 : le paquet n'ouvre aucune porte qu'elle n'ouvre pas, et ses droits sont ceux de la clé qui l'authentifie.
Les pages de cette documentation
- Installation et configuration : prérequis, clé API et droits, chaque clé de configuration.
- Adopter le paquet sur une base existante : la commande
social:baseline, à lire avant d'équiper un modèle qui a déjà des lignes. - Décrire un post : les attributs, les références, les cibles, les modes et les dates.
- Méthodes par convention et priorités : la table des noms, et qui l'emporte.
- Synchronisation automatique : le tableau de décision, le verrou et le cache, la file d'attente.
- Couvertures : URL, chemin, disque, et ce qui est refusé.
- Publier, annuler et prévisualiser à la main :
publishToSocial(),cancelSocialPublication(),toSocialPost(). - Événements Laravel : ce qui est levé, et quand.
- Webhooks : la route, le secret, les doublons.
- Tests :
SocialPublisher::fake()et ses assertions. - Le constructeur manuel : publier à la main, sans décrire de modèle.
Un plugin Filament construit sur ce paquet ajoute à votre panel la liste des publications, un relation manager et un widget de reconnexion ; il n'est pas encore publié.
Limites connues
- Les mises à jour en masse ne sont pas suivies. Seuls les événements Eloquent déclenchent la synchronisation :
Article::query()->update([...])ou une suppression en masse n'en lèvent aucun. AppelezpublishToSocial()sur les modèles concernés, ou enregistrez-les un par un. - Une image par post, et une par réseau. Ni galerie, ni vidéo.
- X se déclare, il ne se publie pas. Un modèle peut déclarer X : tant que l'API n'y publie pas, une cible implicite l'écarte, et un
to: ['x']explicite est refusé (SocialPostRejected). - La date de publication est ignorée en modes
draftetapproval: elle n'y est pas envoyée. - Pas encore de premier commentaire. Aucun réseau n'en publie : l'API ignore le commentaire commun et refuse celui qui est posé pour un seul réseau.
- Un post parti n'est pas corrigé. Une modification faite après la publication lève
SocialPostOutdated, et rien d'autre.
Versions
Le paquet suit le versionnage sémantique. Avant la 1.0, une version mineure peut changer l'API publique ; le journal des modifications du paquet (CHANGELOG.md) dit ce qui a changé. Cette documentation décrit la version 0.1, qui fonctionne avec la version 1 de l'API (/api/v1).
Le code source est publié sur GitHub, en miroir en lecture seule : les pull requests y sont fermées, les issues y sont bienvenues. Son composer.json déclare un dépôt path (../php-social), qui sert à développer le paquet à côté du SDK : Composer ne lit les dépôts que dans le projet racine, il n'affecte donc pas une installation par composer require.