Documentation easyRSS v1.1

J'ai apporté quelques compléments à cette page de Philippe RODIER pour indiquer les modifications que j'ai faites.
Tout ce que j'ai ajouté est écrit en violet.
Alain SICHEL

Description :

easyRSS est classe qui va vous permettre de créer des fichiers RFD/RSS (Rich Site Summary).
En effet, il est bien utile de mettre à disposition de la communauté le contenu de son site tel que
un fil de news, les dernières discussions du forum, etc...

Cette classe va pour permettre aussi de parser le contenu des fichiers RDF/RSS des autres
sites afin de l'afficher sur le votre et ceci de manière très simple.


Exemples :

Le script exemple1.php vous montre comment créer un fichier RSS.
Le script exemple2.php vous montre comment parser le fichier RSS de news du site Phpinfo.net.


Méthodes :

$var = new easyRSS();
Constructeur de la classe easyRSS.

$var -> channel($title, $link, $description, $language, $copyright, $webmaster);
Déclare les éléments title, link, description, language, copyright, webMaster de l'élément channel :
$title correspond au nom du channel, doit être le titre de votre site web. Longueur maximum 100 caractères.
$link correspond à une URL pointant sur le site web nommé dans $title. Longueur maximum 500 caractères.
$description correspond à une phrase qui décrit votre channel. Longueur maximum 500 caractères.
$language correspond à la langue dans laquelle est écrit le channel. Consultez la liste des valeurs ici.
$copyright correspond à une note de copyright sur le contenu du channel. Longueur maximum 100 caractères.
$webmaster correspond à l'adresse email du webMaster pour le channel = la personne à contacter en cas de problèmes techniques. Longueur maximum 100 caractères.

$var -> image($title, $url, $link, $width, $height, $description);
Déclare l'élément image avec title, url, link, width, height, description :
$title correspond à la description de l'image qui est utilisée dans l'attribut ALT du tag HTML <img>. Longueur maximum 100 caractères.
$url correspond à l'URL d'une image GIF, JPEG or PNG qui représente le channel. Longueur maximum 500 caractères.
$link correspond à l'URL du site (lien vers le site). En pratique $title et $link doivent avoir la même valeur que $title et $link de channel. D'ailleurs le fait de laisser vide $title et $link permet de prendre les valeurs $title et $link définies dans la fonction $var -> channel(..). Longueur maximum 500 caractères.
$width correspond à la largeur de l'image en pixels. Le fait de laisser vide $width, assigne la valeur par défaut à 88. Valeur maximum 144.
$height correspond à la hauteur de l'image en pixels. Le fait de laisser vide $height, assigne la valeur par défaut à 31. Valeur maximum 400.
$description correspond au texte qui est placé dans l'attribut TITLE du lien formé autour de l'image dans l'affichage HTML. Longueur maximum 500 caractères.

$var -> add_item($title, $link);
Ajoute un élément item au channel :
$title correspond au titre de l'item (titre de la news par ex.). Longueur maximum 100 caractères.
$link correspond à l'URL (lien vers la news par ex.). Longueur maximum 500 caractères.
Vous pouvez ajouter autant d'élément item que vous le souhaitez en appelant plusieurs fois $var -> add_item(..).

$var -> textinput($title, $description, $name, $link);
Ajoute un élément textinput au channel ; textinput est optionnel pour le channel. Il contient $title, $description, $name, $link pour affichage d'un formulaire :
$title correspond au texte du bouton Submit du formualire. Longueur maximum 100 caractères.
$description correspond au texte qui annonce le champs input. Longueur maximum 500. caractères.
$name correspond au nom défini dans l'attribut NAME de l'objet HTML <input>. Longueur maximum 20 caractères.
$link correspond à l'URL du script PHP ou CGI qui traite la requete du formualire. Longueur maximum 500 caractères.

$string = $var -> as_string();
Retourne une chaine dans $string contenant l'objet RSS. Le contenu peut être accessible via des fonctions*.

$var -> save($filename);
Créer l'objet RSS dans le fichier $filename. Le contenu peut être accessible via des fonctions*.

$var -> parsefile($filename, $maxitem);
Parse un fichier RSS $filename en limitant le nombre d'item à $maxitem. Si $maxitem est laissé vide, la valeur par défaut est 1.
Le contenu est maintenant accessible via des fonctions*.

$bool = $var -> exist_channel();
Renvoi true ou false si l'élément channel existe ou pas.

$bool = $var -> exist_image();
Renvoi true ou false si l'élément image existe ou pas.

$bool = $var -> exist_items();
Renvoi true ou false si au moins 1 élément item existe ou pas.

$bool = $var -> exist_textinput();
Renvoi true ou false si l'élément textinput existe ou pas.



*Fonctions permettant de récupérer les valeurs des différents éléments :

$string = $var -> get_channel_title();
Renvoi dans $string le contenu du sous-élément title de l'élément channel si il existe.

$string = $var -> get_channel_link();
Renvoi dans $string le contenu du sous-élément link de l'élément channel si il existe.

$string = $var -> get_channel_description();
Renvoi dans $string le contenu du sous-élément description de l'élément channel si il existe.

$string = $var -> get_channel_language();
Renvoi dans $string le contenu du sous-élément language de l'élément channel si il existe.

$string = $var -> get_channel_copyright();
Renvoi dans $string le contenu du sous-élément copyright de l'élément channel si il est existe.

$string = $var -> get_channel_webmaster();
Renvoi dans $string le contenu du sous-élément webMaster de l'élément channel si il existe.

$string = $var -> get_image_title();
Renvoi dans $string le contenu du sous-élément title de l'élément image si il existe.

$string = $var -> get_image_url();
Renvoi dans $string le contenu du sous-élément url de l'élément image si il existe.

$string = $var -> get_image_link();
Renvoi dans $string le contenu du sous-élément link de l'élément image si il existe.

$string = $var -> get_image_width();
Renvoi dans $string le contenu du sous-élément width de l'élément image si il existe.

$string = $var -> get_image_height();
Renvoi dans $string le contenu du sous-élément height de l'élément image si il existe.

$string = $var -> get_image_description();
Renvoi dans $string le contenu du sous-élément description de l'élément image si il existe.

$array = $var -> get_items_title();
 Renvoi dans le tableau $array la liste des sous-éléments title des items indexée à partir de 1.

$array = $var -> get_items_link();
 Renvoi dans le tableau $array la liste des sous-éléments link des items indexée à partir de 1.

$array = $var -> get_items_description();
 Renvoi dans le tableau $array la liste des sous-éléments description des items indexée à partir de 1.

$array = $var -> get_items_author();
 Renvoi dans le tableau $array la liste des sous-éléments author des items indexée à partir de 1.

$array = $var -> get_items_date();
 Renvoi dans le tableau $array la liste des sous-éléments date des items indexée à partir de 1.

$value = $var -> get_num_items();
 Renvoi dans $value le nombre d'items du channel.

$string = $var -> get_textinput_title();
Renvoi dans $string le contenu du sous-élément title de l'élément textinput si il existe.

$string = $var -> get_textinput_description();
Renvoi dans $string le contenu du sous-élément description de l'élément textinput si il existe.

$string = $var -> get_textinput_name();
Renvoi dans $string le contenu du sous-élément name de l'élément textinput si il existe.

$string = $var -> get_textinput_link();
Renvoi dans $string le contenu du sous-élément link de l'élément textinput si il existe.



Auteur :

Philippe RODIER <webmaster@phpspirit.com>