- Documentación
- Paquete Laravel · Versión 0.1
- Métodos por convención y prioridades
Métodos por convención y prioridades
En esta página
Un método público del modelo, con nombre convencional y sin parámetros obligatorios, hace el mismo trabajo que un parámetro de atributo. Cuando varias fuentes dan un mismo campo, un orden fijo decide cuál prevalece.
La tabla de nombres
| Campo | Método común | Método de red |
|---|---|---|
| Texto | socialContent() |
{network}Content() |
| Título interno | socialTitle() |
— |
| Título del pin | — | pinterestTitle() |
| Imagen | socialCover() |
{network}Cover() |
| Texto alternativo | socialCoverAlt() |
{network}CoverAlt() |
| Enlace | socialLink() |
{network}Link() |
| Etiquetas | socialTags() |
{network}Tags() |
| Primer comentario | socialFirstComment() |
{network}FirstComment() |
| Fecha de publicación | socialPublishAt() |
— |
| Marca | socialBrand() |
— |
| Destinos | socialNetworks() |
— |
| Condición | shouldPublishSocially() |
shouldPublishTo{Network}() |
| Destino por su nombre | — | {network}Destination() |
{network} vale facebook, instagram, linkedin, threads, pinterest o x: linkedinContent(), pinterestCover(), shouldPublishToInstagram(). PHP no distingue mayúsculas y minúsculas en los nombres de método: linkedInContent() también funciona. mode y coverDisk no tienen método. instagramLink() y pinterestFirstComment() se rechazan como los parámetros de atributo correspondientes: Instagram no admite enlace, Pinterest no admite primer comentario.
Solo cuentan los métodos públicos, no estáticos y sin parámetros obligatorios: un método privado o protegido con el mismo nombre se ignora. Un método de red, sea cual sea, también declara la red para los destinos implícitos.
Un ejemplo
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\nEl artículo completo está en nuestro sitio.";
}
public function pinterestTitle(): string
{
return $this->title;
}
}
Este modelo no nombra sus destinos: declara LinkedIn (linkedinContent()) y Pinterest (pinterestTitle()), y su post va a aquellas de las dos que tengan un destino capaz de publicar.
Las prioridades
Para cada campo, prevalece el primer valor que no sea null:
- el método de la red (
linkedinContent()); - el atributo de la red (
#[LinkedIn(content: …)]); - el método común (
socialContent()); - el atributo común (
#[SocialPost(content: …)]).
El valor común forma el post; un valor de red lo sustituye solo en esa red. Un método que devuelve null cede el paso al nivel siguiente.
Tres reglas fuera del orden
shouldPublishSocially(), cuando existe, sustituye por completowhenyskipde#[SocialPost].shouldPublishTo{Network}(), cuando existe, sustituye elskipdel atributo de esa red: una red omitida no recibe el post.{network}Destination()prevalece sobre eldestinationdel atributo de la red.
Un texto alternativo de red sin imagen de red describe la imagen común en esa red.