Atom
Création / Parsing de fil Atom.
Ce module se compose de deux classes instanciables permettant de créer ou de parser des fichiers au format
Atom.
Cette documentation est en cours de rédaction.
PHP 5 powa
Les Méthodes
- AtomCreator :: AtomCreator - Nouvelle Instance
- AtomCreator :: CreateFeed - Création du fil Atom
- AtomCreator :: AddTitle - Ajouter un titre
- AtomCreator :: AddLink - Ajouter un lien en relation
- AtomCreator :: AddAuthor - Ajouter l'auteur
- AtomCreator :: AddContributor - Ajouter un contributeur
- AtomCreator :: AddTagline - Ajouter une description
- AtomCreator :: AddId - Ajouter l'URI du fil
- AtomCreator :: AddCopyright - Ajouter un copyright
- AtomCreator :: AddInfo - Ajouter des informations sur le fil
- AtomCreator :: AddModified - Ajouter la date de modification
- AtomCreator :: NewEntry - Ajouter une entrée au fil
- AtomCreator :: AddEntryLink - Ajouter un lien en relation avec l'entrée
- AtomCreator :: AddEntryContent - Ajouter le contenu de l'entrée
- AtomCreator :: AddEntrySummary - Ajouter un résumé de l'entrée
- AtomCreator :: AddEntryAuthor - Ajouter l'auteur de l'entrée
Exemples
Description des Méthodes
Nouvelle Instance
AtomCreator :: AtomCreator()
Nouvelle Instance de la classe AtomCreator.
$atom = new AtomCreator();
Création du fil Atom
AtomCreator :: CreateFeed( [ string Lang ] )
Création du fil Atom. Cette méthode est optionnelle.
- Lang : Langue du fil. Optionnel.
$atom -> CreateFeed( 'fr' );
Ajouter un titre
AtomCreator :: AddTitle( string Title )
Ajoute le titre au fil Atom (obligatoire).
- Title : Titre du fil.
$atom -> AddTitle( 'Titre du fil' );
Ajouter un lien en relation
AtomCreator :: AddLink( string Title , string URI , string Rel , string Type )
Ajoute un lien en relation avec le fil Atom (obligatoire).
- Title : Titre du lien.
- URI : URI valide de la ressource.
- Rel : Type de relation avec le lien. Un seul lien de type alternate est autorisé.
- Type : Type de media.
$atom -> AddLink( 'Titre', 'http://monsite.com', 'alternate', 'text/html' );
Ajouter l'auteur
AtomCreator :: AddAuthor( string Name [ , string URI [ , string Email ]] )
Ajoute l'auteur du fil Atom. Il ne peut y avoir qu'un seul auteur.
- Name : Nom de l'auteur.
- URI : URI valide en relation avec l'auteur.
- Email : Adresse email de l'auteur.
$atom -> AddAuthor( 'Fabrice' );$atom -> AddAuthor( 'Fabrice', '', 'fabrice@monsite.com' );$atom -> AddAuthor( 'Fabrice', 'http://fabrice.com', 'fabrice@monsite.com' );
Ajouter un contributeur
AtomCreator :: AddContributor( string Name [ , string URI [ , string Email ]] )
Ajoute un contributeur du fil Atom. Il peut y avoir plusieurs contributeurs.
- Name : Nom du contributeur.
- URI : URI valide en relation avec le contributeur.
- Email : Adresse email du contributeur.
$atom -> AddContributor( 'Fabrice' );$atom -> AddContributor( 'Fabrice', '', 'fabrice@monsite.com' );$atom -> AddContributor( 'Fabrice', 'http://fabrice.com', 'fabrice@monsite.com' );
Ajouter une description
AtomCreator :: AddTagline( string Type , string Mode [ , string Description ] )
Ajoute une description au fil Atom.
- Type : Type de média.
- Mode : Mode du contenu. Les différents modes possibles sont escaped, xml, base64.
- Description : La description.
$atom -> AddTagline( 'text/plain', 'escaped', 'ma description ..;' );
Ajouter l'URI du fil
AtomCreator :: AddId( string URI )
Ajoute l'URI du fil Atom.
- URI : URI valide et permanente (dans la mesure du possible) vers le fil Atom.
$atom -> AddId( 'http://classes.scriptsphp.net/filatom' );
Ajouter un copyright
AtomCreator :: AddCopyright( string Copyright )
Ajoute un copyright au fil Atom.
- Copyright : Le copyright.
$atom -> AddCopyrigt( 'Copyright CSP' );
Ajouter des informations sur le fil
AtomCreator :: AddInfo( )
Cette méthode n'est pasdocumentée.
$atom -> AddInfo( );
Ajouter la date de modification
AtomCreator :: AddModified( string Date )
Ajoute la date de la dernière modification du fil Atom.
- Date : Date de modification , format valide selon le W3C.
$atom -> AddModified( '2004-01-31T16:51:10+00:00' );
Ajouter une entrée au fil
AtomCreator :: NewEntry( string Title )
Cette méthode ajoute une entrée a fil Atom et renvoie un pointeur qui devra être utilisé pour rajouter les informations supplémentaires.
- Title : Titre de la nouvelle entrée.
$atom -> NewEntry( 'titre de mon billet' );
Ajouter un lien en relation avec l'entrée
AtomCreator :: AddEntryLink( ressoucre R , string Title , string URI , string Rel , string Type )
Ajoute un lien en relation avec l'entrée.
- R : Ressource valide renvoyée par la méthode NewEntry().
- Title : Titre du lien.
- URI : URI valide de la ressource.
- Rel : Type de relation avec le lien. Un seul lien de type alternate est autorisé.
- Type : Type de media.
$atom -> AddEntryLink( 'Titre', 'http://monsite.com', 'alternate', 'text/html' );
Ajouter le contenu de l'entrée
AtomCreator :: AddEntryContent( ressource R , string Type , string Mode [ , string Content ] )
Ajoute le contenu pour une entrée.
- R : Ressource valide renvoyée par la méthode NewEntry().
- Type : Type de média.
- Mode : Mode du contenu. Les différents modes possibles sont escaped, xml, base64.
- Content : Le contenu.
$atom -> AddEntryContent( 'text/plain', 'escaped', ' le contenu ' );
Ajouter un résumé de l'entrée
AtomCreator :: AddEntrySummary( ressource R , string Type , string Mode [ , string Content ] )
Ajoute le résumé pour une entrée.
- R : Ressource valide renvoyée par la méthode NewEntry().
- Type : Type de média.
- Mode : Mode du résumé. Les différents modes possibles sont escaped, xml, base64.
- Content : Le résumé.
$atom -> AddEntrySummary( 'text/plain', 'escaped', ' le contenu ' );
Ajouter l'auteur de l'entrée
AtomCreator :: AddEntryAuthor( ressource R , string Name [ , string URI [ , string Email ]] )
Ajoute l'auteur de l'entrée. Il ne peut y avoir qu'un seul auteur par entrée.
- R : Ressource valide renvoyée par la méthode NewEntry().
- Name : Nom de l'auteur de l'entrée.
- URI : URI valide en relation avec l'auteur.
- Email : Adresse email de l'auteur.
$atom -> AddEntryAuthor( 'Fabrice' );$atom -> AddEntryAuthor( 'Fabrice', '', 'fabrice@monsite.com' );$atom -> AddEntryAuthor( 'Fabrice', 'http://fabrice.com', 'fabrice@monsite.com' );