- Documentation
- Paquet Laravel · Version 0.1
- Méthodes par convention et priorités
Méthodes par convention et priorités
Sur cette page
Une méthode publique du modèle, nommée par convention et sans paramètre obligatoire, fait le même travail qu'un paramètre d'attribut. Quand plusieurs sources donnent un même champ, un ordre fixe décide laquelle l'emporte.
La table des noms
| Champ | Méthode commune | Méthode de réseau |
|---|---|---|
| Texte | socialContent() |
{network}Content() |
| Titre interne | socialTitle() |
— |
| Titre de l'épingle | — | pinterestTitle() |
| Image | socialCover() |
{network}Cover() |
| Texte alternatif | socialCoverAlt() |
{network}CoverAlt() |
| Lien | socialLink() |
{network}Link() |
| Tags | socialTags() |
{network}Tags() |
| Premier commentaire | socialFirstComment() |
{network}FirstComment() |
| Date de publication | socialPublishAt() |
— |
| Marque | socialBrand() |
— |
| Cibles | socialNetworks() |
— |
| Condition | shouldPublishSocially() |
shouldPublishTo{Network}() |
| Destination par son nom | — | {network}Destination() |
{network} vaut facebook, instagram, linkedin, threads, pinterest ou x : linkedinContent(), pinterestCover(), shouldPublishToInstagram(). PHP ignore la casse des noms de méthode : linkedInContent() marche aussi. mode et coverDisk n'ont pas de méthode. instagramLink() et pinterestFirstComment() sont refusées comme les paramètres d'attribut correspondants : Instagram ne prend pas de lien, Pinterest pas de premier commentaire.
Seules les méthodes publiques, non statiques et sans paramètre obligatoire comptent : une méthode privée ou protégée du même nom est ignorée. Une méthode de réseau, quelle qu'elle soit, déclare aussi le réseau pour les cibles implicites.
Un exemple
use DateTimeInterface;
class Article extends Model
{
use PublishesToSocial;
public function socialContent(): string
{
return $this->excerpt;
}
public function socialPublishAt(): ?DateTimeInterface
{
return $this->published_at;
}
public function shouldPublishSocially(): bool
{
return $this->status === 'published';
}
public function linkedinContent(): string
{
return $this->excerpt."\n\nL'article complet est sur notre site.";
}
public function pinterestTitle(): string
{
return $this->title;
}
}
Ce modèle ne nomme pas ses cibles : il déclare LinkedIn (linkedinContent()) et Pinterest (pinterestTitle()), et son post part vers ceux des deux qui ont une destination capable de publier.
Les priorités
Pour chaque champ, la première valeur non null l'emporte :
- la méthode du réseau (
linkedinContent()) ; - l'attribut du réseau (
#[LinkedIn(content: …)]) ; - la méthode commune (
socialContent()) ; - l'attribut commun (
#[SocialPost(content: …)]).
La valeur commune fait le post ; une valeur de réseau la remplace sur ce réseau seulement. Une méthode qui rend null passe la main au niveau suivant.
Trois règles hors de l'ordre
shouldPublishSocially(), quand elle existe, remplace entièrementwhenetskipde#[SocialPost].shouldPublishTo{Network}(), quand elle existe, remplace leskipde l'attribut de ce réseau : un réseau sauté n'est pas visé.{network}Destination()l'emporte sur ledestinationde l'attribut du réseau.
Un texte alternatif de réseau sans image de réseau décrit l'image commune sur ce réseau.