Méthodes de la classe PHP rss200beta

Auteur : Tetsuo
Version : 2.2
Dernière modif : 25-10-2005
Source
Télecharger(.zip)
Télecharger(.tgz)
Les Methodes
Bug report

exemples
methodes
description

RSS 2.00 Beta

Création et parsing de fichier RSS.

La classe RSS 2.00 fournit des fonctions permettant de parser ou de créer des fichiers RSS conformément aux spécifications RSS 2.00. Le parser utilise les fonctions XML de PHP, il est donc impératif que votre document ait une syntaxe XML valide.

Cette classe utilise un wrapper http different de celui de php ainsi qu un systeme de cache, elle necessite donc des classe associées.

La classe est une version de test, normalement fonctionnelle mais pas exempte de bugs.

Les ajout par rapport a la au systeme de base :

un wrapper HTTP controlant plus finement les timeout et les erreur de reception des Feeds.
un cache HTTP evitant les requete http inutile.
la gestion faclité des encodage d'entrée et sortie du parser RSS.

Les Méthodes

RSS - Nouvelle Instance
Parser - Ouvrir un fichier pour le parser
Parse - Parser un fichier
return_infos - Retourner certaines infos uniquement
Output - Affichage simple
Creator - Création d' un fichier RSS
Create_channel - Création du Channel
Add_item - Ajouter un élément (ITEM) au channel
Add_copyright - Ajouter le Copyright
Add_pubdate - Ajouter la date de publication
Add_lastbuilddate - Ajouter la date de la dernière Mise à Jour
Add_docs - Ajouter une URL qui decrie le channel
Add_rating - Ajouter le label de votre site
Add_managingeditor - Ajouter l' adresse email du responsable du site
Add_webmaster - Ajouter l' adresse email du webmaster du site
Add_image - Ajouter une image au channel
Add_textinput - Ajouter les infos pour un formulaire de recherche
Add_skiphours - Ajouter les heures ou le channel n'est pas mis à jour
Add_skipdays - Ajouter les jours ou le channel n' est pas mis à jour
Create_file - Creation du document XML RSS.

Exemples

Description des Méthodes

Nouvelle Instance

RSS()

Nouvelle Instance de la Classe.

$xml = new RSS;

Ouvrir un fichier pour le parser

Parser( string File )

Ouvre le fichier File en lecture. Si File n' est pas une URL valide, une erreur est retournée

File : l' URL du fichier à parser.

$xml -> Parser( 'http://site.com/file.rss' );

Parser un fichier

Parse()

Parse le fichier ouvert avec la methode Parser(). Un array contenant toutes les infos de ce fichier est retourné

$xml -> Parse()

Retourner certaines infos uniquement

return_infos( string Info [, string Info ...] )

Parse le fichier ouvert avec la methode Parser(). Un array contenant les infos de votre choix est retourné

Info : Retourne les éléments de votre choix dans un array. Les différentes possibilités sont : channel, image, item, textinput, skipdays et skiphours. Ces parametres peuvent être passés dans l' ordre de votre choix.

$xml -> Return_infos('item')
$xml -> Return_infos('item', 'channel')
$xml -> Return_infos('image', 'channel', 'skipdays', 'skiphours')

Affichage simple

Output( [ int Limit] )

Affichage simple des résultats. Si Limit est spécifié, Limit résultats seront retournés.

Limit : Spécifie le nombre maximum de résultats retournés. Limit = 10 par défaut.

$xml -> Output()
$xml -> Output(5)

Création d' un fichier RSS

Creator( string File )

Ouvre le fichier File en ecriture. Si File n' existe pas, on tente de le créer.

File : URL vers le fichier RSS a créer ou à regénérer.

$xml -> Creator('fichier.rss')

Création du Channel

Create_channel( string Description, string Lang, string Link, string Title )

Création du channel et définition des 4 éléments minimums.

Description : Description textuelle du channel.
Lang : Langue du channel.
Link : URL vers le site.
Title : Titre du channel.

$xml -> Create_channel('Channel PHP', 'fr', 'http://scriptsphp.org', 'Scripts PHP')

Ajouter un élément (ITEM) au channel

Add_item( string Titre, string Desc, string Link, array addParam )

Ajoute un item au channel. addParam est un tableau associatif qui peut comprendre les clefs suivantes 'DCdate','DClanguage','DCcreator','DCsubject','CONTENT', 'trackback_ping','trackback_about','creativeCommons_license','enclosure_url','enclosure_type','enclosure_length'.

Titre : Titre du lien.
Desc : Description du lien.
Link : URL vers la ressource.
addParam : parametres additionnels.

$xml -> Add_item('Titre', 'description', 'http://site.com', array( 'DClanguage' => 'fr' ))

Ajouter le Copyright

Add_copyright( string Copyright )

Ajoute le copyright.

Copyright : Le copyright.

$xml -> Add_copyright('Copyright 2002-2003 - Classes.ScriptsPHP.org')

Ajouter la date de publication

Add_pubdate( string Pubdate )

Ajoute la date de publication du channel.

Pudate : Date de publication du channel.

$xml -> Add_pubdate('Thu, 08 Jul 1999 07:00:00 GMT')

Ajouter la date de la dernière Mise à Jour

Add_lastbuilddate( string Lastbuilddate )

Ajoute la date de la dernière mise a jour du channel.

Lastbuilddate : Date de la dernière mise à jour du Channel.

$xml -> Add_lastbuildate('Thu, 08 Jul 1999 07:00:00 GMT')

Ajouter une URL qui decrie le channel

Add_docs( string Docs )

Ajoute une URL qui pointe vers une page decrivant le channel.

Docs : URL vers le fichier.

$xml -> Add_docs('http://site.com/doc.rss.html')

Ajouter le label de votre site

Add_rating( string Rating )

Ajoute le label de votre site. Voici quelques URL

http://www.w3.org/PICS/raters.htm (W3 maintained list of rating agency links)
RSACi http://www.rsac.org (Click on 'register' link)
SafeSurf http://www.safesurf.com/ http://www.safesurf.com/classify/index.html (direct)

Rating : Votre label.

$xml -> Add_rating('(PICS-1.1 "http://www.classify.org/safesurf/" l r (SS~~000 1))')

Ajouter l' adresse email du responsable du site

Add_managingeditor( string Managingeditor )

Ajoute l' adresse email du responsable du site.

Managingeditor : Adresse email du responsable du site.

$xml -> Add_managingeditor('responsable@email.com')

Ajouter l' adresse email du webmaster du site

Add_webmaster( string Webmaster )

Ajoute l' adresse email du Webmaster du site.

Webmaster : Adresse email du webmaster du site.

$xml -> Add_webmaster('webmaster@email.com')

Ajouter une image au channel

Add_image( string Title, string Link, string Url [ , int W [ , int H [ string Desc ]]] )

Ajoute une image du channel.

Title : Titre de l' image. C' est ce qui sera inséré dans le alt de l' image.
Link : Indique l' URL vers laquelle pointra le lien de l' image.
Url : Indique l' URL vers la ressource image qu' on va utiliser.
W : Largeur de l' image.
H : Hauteur de l' image.
Desc : Description textuelle de l' image.

$xml -> Add_image('Logo', 'http://site.com', 'http://site.com/logo.png')
$xml -> Add_image('Logo', 'http://site.com', 'http://site.com/logo.png', 88, 31)
$xml -> Add_image('Logo', 'http://site.com', 'http://site.com/logo.png', 88, 31, 'channel PHP')

Ajouter les infos pour un formulaire de recherche

Add_textinput( string Title, string Desc, string Name, string Link )

Ajoute toutes les infos necessaires pour créer un formulaire de recherche pointant vers votre site.

Title : Titre du formulaire.
Desc : Desctription du formulaire.
Name : Nom du champ input pour la recherche.
Link : URL vers laquelle pointra le formulaire.

$xml -> Add_textinput('Recherche', 'Recherchez sur le site', 'form', 'http://site.com/form.php')

Ajouter les heures ou le channel n'est pas mis à jour

Add_skiphours( void Hours )

Ajoute toutes les heures ou votre site (fichier RSS) n' est pas mis à jour.

Hours : La (ou les) heure(s) ou votre channel n' est pas mis à jour.

$xml -> Add_skiphpours(9)
$xml -> Add_skiphpours(array(9, 10, 11, 12) )

Ajouter les jours ou le channel n' est pas mis à jour

Add_skipdays( void Days )

Ajoute tous les jours ou votre site (fichier RSS) n' est pas mis à jour.

Days : Le (ou les) jour(s) ou votre channel n' est pas mis à jour.

$xml -> Add_skipdays(9)
$xml -> Add_skipdays(array(9, 10, 11, 12) )

Creation du document XML RSS.

Create_file( string fileName )

Génére le document XML RSS, l'écrit dans un fichier si un nom de fichier est passé, le renvoi en valeur de retour sinon.

fileName : Paramètre optionnel, designant le nom du fichier de sortie.

$xml -> Create_file()
$xml -> Create_file('monRss.xml')