Configuration requise - Manuel VBRAtom - Script d'affichage de fils Atom

Manuel VBRAtom > Méthode entree

Chapitre 3 - Méthode entree

Paramètres
- Paramètres pour les versions 1.0.*

Pour afficher un fil Atom, il suffit d'employer une seule méthode de la classe instanciée : la méthode entree ().

Paramètres

Avertissement

Pour les versions de VBRAtom antérieures à la 1.1, se référer aux paramètres pour les versions 1.0.*.

La méthode possède les paramètres suivants :

une chaîne de caractères contenant l'URL du fil Atom à charger,
une chaîne de caractères contenant l'identifiant, qui est le nom du fichier XML sous lequel le fil Atom est enregistré et mis en cache,
un tableau pouvant contenir divers paramètres (facultatif).

Le tableau de paramètres peut contenir les clés suivantes :

une clé 'titre' ayant pour valeur une chaîne de caractères indiquant l'intitulé du fil (si la valeur est une chaîne vide, l'intitulé du fil Atom est affiché),
une clé 'extrait' ayant pour valeur un booléen permettant l'affichage d'un extrait d'entrée s'il vaut true (par défaut, false),
une clé 'nofollow' ayant pour valeur un booléen permettant d'ajouter l'attribut rel="nofollow" aux liens hypertextes s'il vaut true (par défaut, false),
une clé 'date' ayant pour valeur un booléen permettant d'indiquer la date de mise à jour de l'entrée s'il vaut true (par défaut, false),
une clé 'date_format' ayant pour valeur une chaîne formatée selon la fonction PHP strftime () pour formater l'affichage de la date (par défaut, la clé vaut '%d-%m-%Y'),
une clé 'date_locale' ayant pour valeur une chaîne de caractères indiquant la langue de la configuration locale pour le formatage de la date (par défaut, la clé vaut 'fr_FR'),
une clé 'nombre_entrees' ayant pour valeur un entier positif indiquant le nombre d'entrées à afficher (si la clé vaut 0, valeur par défaut, toutes les entrées disponibles dans le fil seront affichées),
une clé 'balise_titre' (introduite dans la version 1.2.0) ayant pour valeur une chaîne de caractères indiquant l'élément HTML à utiliser pour l'intitulé du fil (valeurs possibles : 'h1', 'h2', 'h3', 'h4', 'h5' et 'h6', par défaut 'h2'),
une clé 'balise_entree' (introduite dans la version 1.2.0) ayant pour valeur une chaîne de caractères indiquant l'élément HTML à utiliser pour l'intitulé de l'entrée (valeurs possibles : les mêmes que pour la clé 'balise_titre', plus 'dl' (depuis la version 1.2.1), 'ol' et 'ul', par défaut 'ul' ; si la valeur est 'dl', l'élément indiqué en valeur englobera l'ensemble des entrées (chaque intitulé d'entrée étant encadré par l'élément dt et chaque extrait d'entrée, s'il est affiché, par l'élément dd) ; si la valeur est 'ol' ou 'ul', l'élément indiqué en valeur englobera l'ensemble des entrées (chaque entrée étant encadrée par l'élément li),
une clé 'citation_extrait' (introduite dans la version 1.2.0) ayant pour valeur un booléen permettant d'insérer l'extrait de chaque entrée dans un élément blockquote (muni d'un attribut cite dont la valeur est l'URL de l'entrée) s'il vaut true (par défaut, false),
une clé 'titre_lien' (introduite dans la version 1.3.0) ayant pour valeur un booléen permettant de ne pas faire de l'intitulé du fil Atom un lien s'il vaut false (par défaut, true),
une clé 'titre_url' (introduite dans la version 1.3.0) ayant pour valeur une chaîne de caractères indiquant l'URL vers laquelle pointe le lien de l'intitulé du fil Atom, pour autant que la clé 'titre_lien' ne vaille pas false (si la valeur est une chaîne vide, c'est l'URL fournie par le fil Atom pour son intitulé qui est utilisée).

En PHP, cela donne le tableau suivant (avec les valeurs par défaut) :

<?php
array (
  'titre' => '',
  'extrait' => false,
  'nofollow' => false,
  'date' => false,
  'date_format' => '%d-%m-%Y',
  'date_locale' => 'fr_FR',
  'nombre_entrees' => 0,
  'balise_titre' => 'h2',
  'balise_entree' => 'ul',
  'citation_extrait' => false,
  'titre_lien' => true,
  'titre_url' => ''
);
?>

Lorsque le tableau de paramètres est défini, il n'est pas obligatoire de mentionner toutes les clés si l'on n'en modifie pas la valeur par défaut.

<?php
// Affichage d'un fil Atom sans définir de tableau de paramètres (ces derniers sont donc définis à leur valeur par défaut)
include ('vbratom.php');
$vbratom = new VBRAtom;
$vbratom -> entree ('http://exemple.com/fil-atom', 'un-fil-atom');
?>

<?php
// Affichage des extraits des trois premières entrées d'un fil Atom (les autres paramètres sont omis, restant à leur valeur par défaut)
include ('vbratom.php');
$vbratom = new VBRAtom;
$parametres = array (
  'extrait' => true,
  'nombre_entrees' => 3
);
$vbratom -> entree ('http://exemple.com/fil-atom', 'un-fil-atom', $parametres);
?>

Paramètres pour les versions 1.0.*

Les paramètres sont les suivants :

une chaîne de caractères contenant l'URL du fil Atom à charger,
une chaîne de caractères contenant l'identifiant, qui est le nom du fichier XML sous lequel le fil Atom est enregistré et mis en cache,
une chaîne de caractères permettant de personnaliser l'intitulé du fil Atom (par défaut, la chaîne est vide, ce qui revient à récupérer l'intitulé du fil tel qu'indiqué dans ce dernier) (facultatif),
un booléen permettant d'indiquer si, pour chaque entrée, un extrait doit être affiché ou non (par défaut, il vaut false) (facultatif),
un booléen permettant d'ajouter ou non l'attribut rel="nofollow" (par défaut, il vaut false) (facultatif).