- Documentación
- Paquete Laravel · Versión 0.1
- Describir un post
Describir un post
En esta página
Un modelo describe su post con el trait PublishesToSocial y atributos PHP, con métodos públicos de nombre convencional, o con ambos. Esta página describe los atributos, lo que designa una referencia, y adónde va el post.
El atributo común
#[SocialPost] describe el post en todas las redes:
| Parámetro | Tipo | Lo que aporta |
|---|---|---|
content |
referencia | El texto del post. Obligatorio. |
title |
referencia | Un título interno, que solo se muestra en el panel de Quiet Social. |
cover |
referencia | La imagen: una URL, una ruta absoluta, una ruta en un disco, o una Image del SDK. Consulta Portadas. |
coverAlt |
referencia | El texto alternativo de la imagen. |
coverDisk |
literal | El disco de una ruta de portada relativa. |
link |
referencia | Una URL absoluta en http(s). |
tags |
referencia | Un iterable de palabras o expresiones, sin #: la API convierte cada una en un hashtag. |
firstComment |
referencia | Un primer comentario, allí donde una red lo admita (ninguna por ahora). |
publishAt |
referencia | Un DateTimeInterface o una fecha en cadena. Vacía, pasada o a menos de un minuto: se publica enseguida. |
when |
referencia | Publicar solo mientras este valor sea verdadero. |
skip |
referencia | No publicar en ninguna parte mientras este valor sea verdadero. |
brand |
referencia | La marca brd_…, en lugar de QUIET_SOCIAL_BRAND_ID. |
to |
literal | Nombres de red o identificadores de destino dst_…. |
mode |
literal | publish (por defecto), draft o approval. |
Lo que designa una referencia
Una referencia designa, en este orden:
- una columna presente en el modelo, o un accessor;
- una relación cargada;
- un método público sin parámetros obligatorios, al que se llama cuando los pasos anteriores han dado
null.
Una columna con valor prevalece, por tanto, sobre un método del mismo nombre, y se llama al método cuando la columna es nula. Un método que devuelve una relación aporta sus modelos, no la consulta.
Una referencia que no designa nada en un modelo leído de la base lanza InvalidSocialConfiguration. Nunca se llama a los métodos del framework ni de este paquete (save(), delete()…), ni a los métodos privados, protegidos o estáticos, y un modelo estricto (Model::shouldBeStrict()) nunca se lee sobre un atributo ausente.
Un valor de texto puede ser una cadena, un objeto Stringable o un número; una cadena vacía equivale a null. Un valor de otro tipo lanza InvalidSocialConfiguration.
Los atributos de red
#[Facebook], #[Instagram], #[LinkedIn], #[Threads], #[Pinterest] y #[X] describen lo que cambia en una red. Sus parámetros son content, cover, coverAlt, link, tags, firstComment y skip (referencias), y destination (un literal: el nombre de un destino de la red, como un tablero de Pinterest). #[Pinterest] admite también title, el título del pin. Dos se rechazan y hacen que el post sea inválido (SocialPostRejected): link en #[Instagram], que no admite enlace, y firstComment en #[Pinterest], que no admite primer comentario.
#[SocialPost(content: 'excerpt', cover: 'cover_path', link: 'url')]
#[Pinterest(title: 'title', destination: 'Recetas')]
#[Instagram(content: 'instagramCaption', skip: 'is_sponsored')]
class Recipe extends Model
{
use PublishesToSocial;
}
Un valor null en el nivel de una red deja el valor común. Un atributo de red también declara la red: consulta los destinos implícitos más abajo. Los atributos se leen en la clase del modelo, o en su padre más cercano que los lleve.
Los mismos campos se escriben también como métodos públicos: consulta Métodos por convención y prioridades.
Adónde va el post
- Destinos explícitos.
socialNetworks(), si no#[SocialPost(to: [...])]: nombres de red o identificadoresdst_…, tomados tal cual. Una red sin ningún destino capaz de publicar hace que la API rechace el post (SocialPostRejected). - Destinos implícitos. Sin ellos, el post va a las redes que el modelo declara, mediante un atributo de red o un método de red, entre las que tienen un destino capaz de publicar en la marca. Estos destinos se leen en la API y se guardan en caché
destinations_ttlsegundos. Si no queda ninguna, no se envía nada y se registra una advertencia en el log.
Un modelo que no declara ninguna red, o ningún contenido, lanza InvalidSocialConfiguration.
Para apuntar a un destino concreto de una red que tiene varios, nómbralo con el parámetro destination del atributo de la red, o pasa su identificador dst_… en to.
Modos y fechas
publish(por defecto) envía el post enseguida, o lo programa en su fecha de publicación cuando está a más de un minuto.draftyapprovalcrean un borrador, o un post pendiente de validación en el panel. La fecha de publicación no se envía en estos modos: la API la ignora en ellos.
La fecha se lee como un DateTimeInterface, o como una cadena que una fecha sepa leer (ISO 8601 preferentemente). Una cadena que no es una fecha hace que el post sea inválido (SocialPostRejected).
La referencia del post
Cada post sale con la referencia {clase morph}:{clave} del modelo (App\Models\Article:42, o article:42 con un alias de morph). Vuelve en los webhooks bajo external_reference.