VBRAtom

Script d'affichage de fils Atom

Présentation de VBRAtom

VBRAtom est un script codé en PHP 5 permettant d'afficher sur une page Web des fils Atom.

Il s'agit d'une classe qui se base sur la bibliothèque SimpleXML et qui permet d'afficher un ou plusieurs fils Atom selon certains paramètres (possibilité d'afficher ou non un extrait des entrées du fil, possibilité d'ajouter ou non l'attribut rel="nofollow" aux liens hypertextes), tout en sauvegardant le fil sous forme de fichier statique (possibilité de paramétrer la durée de conservation avant rechargement du fil), de façon à garantir le chargement rapide de la page affichant le(s) fil(s).

Téléchargement

VBRAtom v. 1.1.2 est disponible sous deux formats

Licence

Le script est distribué sous la licence GNU GPL.

Exemple d'utilisation de VBRAtom

<body>
<?php
// Appel du fichier contenant le script
include ('vbratom.php');

// Instanciation de la classe en laissant les paramètres par défaut
// (fichier XML sauvegardé pendant 4 heures dans un dossier xml situé au même niveau que la page d'exécution du script)
$vbratom = new VBRAtom;

// Affichage d'un fil Atom (Intitulé du fil et des entrées)
$vbratom -> entree ('http://exemple.com/fil-atom', 'identifiant-du-fil-atom');
?>
</body>

L'instanciation de la classe peut recevoir deux paramètres optionnels :

  1. le chemin vers le dossier de sauvegarde des fils (par défaut, xml/),
  2. la durée, en minutes, de sauvegarde des fils avant rechargement (par défaut, 240).

La méthode entree () contient deux paramètres obligatoires 

  1. l'URL vers le fil Atom,
  2. un identifiant permettant de nommer le fichier XML sauvegardé ('identifiant' indique que le fil sera enregistré sous le nom identifiant.xml) 

et un paramètre optionnel, sous forme de tableau associatif comportant les couples clé / valeur suivants :

  1. une clé titre ayant pour valeur l'intitulé du fil (si la valeur est une chaîne ou que le tableau n'est pas défini, l'intitulé du fil Atom est affiché),
  2. 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),
  3. 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),
  4. 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),
  5. une clé date_format ayant pour valeur une chaîne formatée selon la fonction PHP strftime () (par défaut, la clé vaut %d-%m-%Y) pour formater l'affichage de la date,
  6. une clé date_locale ayant pour valeur une chaîne indiquant la langue de la configuration locale pour le formatage de la date (par défaut, la clé vaut fr_FR),
  7. une clé nombre_entrees ayant pour valeur un entier positif (par défaut, 0) indiquant le nombre d'entrées à afficher (si la clé vaut 0, toutes les entrées disponibles dans le fil seront affichées).

Démonstration de VBRAtom : résultat à l'affichage

© VBRAtom 2008 - Site hébergé par Nuxit