Contenu
in package
Classe de fonctions utilitaires concernant les contenus.
Les contenus peuvent être des articles ou des brèves
Table of Contents
- auteur() : string
- Retourner l'auteur de l'article
- chapo() : string
- Retourner le chapo (champs acf) d'un contenu
- couverture() : void
- Même fonctionnement que illustration() mais pour la couverture d'un article (image affichée en dehors de la page article)
- date() : array<string|int, mixed>
- Retourner la date de l'article
- extrait() : string
- Retourner le excerpt d'un contenu
- galerie() : array<string|int, mixed>
- Retourne un tableau des images pour la colonne de gauche
- get() : mixed
- Aller chercher un contenu donné dans l'api
- getIllustrationNotUsed() : void
- Retourne la source de l'illustration
- getPostField() : mixed
- Permet d'aller chercher des données dans un objet contenu, qu'il soit formatté comme un objet WP classique ou formatté pour l'api (avec des champs "rendered")
- getPreview() : array<string|int, mixed>
- Retourne l'aperçu (la dernière révision) de cet contenu
- id() : int
- Retourne le champ id d'un contenu. Si la donnée envoyée est déjà un int, on estime qu'il s'agit de l'id de l'contenu et on le retourne tel quel
- illustration() : string
- Retourne les infos de l'illustration du contenu $cham peut avoir comme valeur : - une des url dans une des tailles contenues dans la données ['tailles'] - `legende` pour la légende de l'image
- jsSplitLimit() : int
- Retourner le délimiteur pour le JS Split Limit pour le titre
- list() : void
- Retourne une liste de contenus
- ps() : string
- Retourner le post-scriptum de l'article
- slug() : string
- Retourner le slug (post_name) d'un contenu
- storyId() : int
- Retourne le storyId du contenu (utilisé par reactions)
- surtitre() : array<string|int, mixed>
- Retourner le surtitre
- texte() : string
- Retourner le texte (post_content) d'un contenu
- titre() : string
- Retourner le titre (post_title) d'un contenu
- type() : string
- Retourner le type d'un contenu
- url() : string
- Construction de l'url d'un contenu en fonction de son type
Methods
auteur()
Retourner l'auteur de l'article
public
static auteur(array<string|int, mixed> $contenu) : string
Parameters
- $contenu : array<string|int, mixed>
Return values
string —l'auteur
chapo()
Retourner le chapo (champs acf) d'un contenu
public
static chapo(array<string|int, mixed> $contenu) : string
Parameters
- $contenu : array<string|int, mixed>
Return values
string —le chapo
couverture()
Même fonctionnement que illustration() mais pour la couverture d'un article (image affichée en dehors de la page article)
public
static couverture(mixed $contenu[, mixed $champ = null ]) : void
Parameters
- $contenu : mixed
- $champ : mixed = null
Return values
void —date()
Retourner la date de l'article
public
static date(array<string|int, mixed> $contenu) : array<string|int, mixed>
Parameters
- $contenu : array<string|int, mixed>
Return values
array<string|int, mixed> —la date
extrait()
Retourner le excerpt d'un contenu
public
static extrait(array<string|int, mixed> $contenu) : string
Parameters
- $contenu : array<string|int, mixed>
Return values
string —le excerpt
galerie()
Retourne un tableau des images pour la colonne de gauche
public
static galerie(mixed $contenu) : array<string|int, mixed>
Parameters
- $contenu : mixed
Return values
array<string|int, mixed> —les urls des images
get()
Aller chercher un contenu donné dans l'api
public
static get(mixed $identifiant[, mixed $options = [] ]) : mixed
Parameters
- $identifiant : mixed
-
Le slug ou l'id de l'contenu
- $options : mixed = []
-
Options de la requète
Return values
mixed —Le contenu demandé, ou nulls'il n'a pas été trouvé
getIllustrationNotUsed()
Retourne la source de l'illustration
public
static getIllustrationNotUsed(mixed $contenu) : void
Parameters
- $contenu : mixed
Return values
void —getPostField()
Permet d'aller chercher des données dans un objet contenu, qu'il soit formatté comme un objet WP classique ou formatté pour l'api (avec des champs "rendered")
public
static getPostField(array<string|int, mixed> $contenu, string $field) : mixed
Parameters
- $contenu : array<string|int, mixed>
-
La donnée contenu
- $field : string
-
le champ à retourner
Return values
mixed —La valeur du champ $field dans $contenu
getPreview()
Retourne l'aperçu (la dernière révision) de cet contenu
public
static getPreview(mixed $contenu[, mixed $options = [] ]) : array<string|int, mixed>
Parameters
- $contenu : mixed
-
Un contenu
- $options : mixed = []
Return values
array<string|int, mixed> —L'aperçu demandé
id()
Retourne le champ id d'un contenu. Si la donnée envoyée est déjà un int, on estime qu'il s'agit de l'id de l'contenu et on le retourne tel quel
public
static id(mixed $contenu) : int
Parameters
- $contenu : mixed
Return values
int —id
illustration()
Retourne les infos de l'illustration du contenu $cham peut avoir comme valeur : - une des url dans une des tailles contenues dans la données ['tailles'] - `legende` pour la légende de l'image
public
static illustration(mixed $contenu[, string $champ = null ][, mixed $image = 'illustration' ]) : string
Parameters
- $contenu : mixed
- $champ : string = null
- $image : mixed = 'illustration'
Tags
Return values
string —jsSplitLimit()
Retourner le délimiteur pour le JS Split Limit pour le titre
public
static jsSplitLimit(array<string|int, mixed> $contenu) : int
Parameters
- $contenu : array<string|int, mixed>
Return values
int —délimiteur
list()
Retourne une liste de contenus
public
static list() : void
Return values
void —ps()
Retourner le post-scriptum de l'article
public
static ps(array<string|int, mixed> $contenu) : string
Parameters
- $contenu : array<string|int, mixed>
Return values
string —le PS
slug()
Retourner le slug (post_name) d'un contenu
public
static slug(array<string|int, mixed> $contenu) : string
Parameters
- $contenu : array<string|int, mixed>
Return values
string —le slug
storyId()
Retourne le storyId du contenu (utilisé par reactions)
public
static storyId(mixed $contenu) : int
Parameters
- $contenu : mixed
Return values
int —surtitre()
Retourner le surtitre
public
static surtitre(array<string|int, mixed> $contenu) : array<string|int, mixed>
Parameters
- $contenu : array<string|int, mixed>
Return values
array<string|int, mixed> —le surtitre
texte()
Retourner le texte (post_content) d'un contenu
public
static texte(array<string|int, mixed> $contenu) : string
Parameters
- $contenu : array<string|int, mixed>
Return values
string —le texte
titre()
Retourner le titre (post_title) d'un contenu
public
static titre(array<string|int, mixed> $contenu) : string
Parameters
- $contenu : array<string|int, mixed>
Return values
string —le titre
type()
Retourner le type d'un contenu
public
static type(array<string|int, mixed> $contenu) : string
Parameters
- $contenu : array<string|int, mixed>
Return values
string —le type
url()
Construction de l'url d'un contenu en fonction de son type
public
static url(mixed $contenu) : string
Parameters
- $contenu : mixed