Introduction
Zend_Feed
Programmer's Reference Guide

Importer des flux

Zend_Feed permet aux développeurs d'obtenir très facilement des flux. Si vous connaissez l'URI d'un flux, utilisez simplement la méthode Zend_Feed::import() :

  1. $flux = Zend_Feed::import('http://flux.example.com/nomDuFlux');

Vous pouvez aussi utiliser Zend_Feed pour aller chercher le contenu d'un flux à partir d'un fichier ou d'une chaîne PHP :

  1. // on importe un flux à partir d'un fichier texte
  2. $fluxAPartirDeFichierTexte = Zend_Feed::importFile('flux.xml');
  3.  
  4. // on importe un flux à partir d'une variable PHP de type chaîne
  5. $fluxAPartirDePHP = Zend_Feed::importString($chaineFlux);

Dans chacun des exemples ci-dessus, une instance d'une classe étendant Zend_Feed_Abstract est renvoyée en cas de succès, selon le type du flux. Si un flux RSS a été obtenu au moyen de l'une des méthodes d'importation décrites ci-dessus, alors un objet Zend_Feed_Rss sera renvoyé. Par contre, si un flux Atom a été importé, alors un objet Zend_Feed_Atom est renvoyé. Les méthodes d'importation déclencheront aussi une exception Zend_Feed_Exception en cas d'échec, par exemple si le flux est illisible ou malformé.

Flux personnalisés

Zend_Feed permet aux développeurs de créer du flux personnalisé très facilement. Vous devez juste créer un tableau et l'importer avec Zend_Feed. Ce tableau peut être importé avec Zend_Feed::importArray() ou avec Zend_Feed::importBuilder(). Dans ce dernier cas, le tableau sera calculé instantanément par une source de données personnalisée implémentant Zend_Feed_Builder_Interface.

Importer un tableau personnalisé

  1. // on importe un flux atom à partir d'un tableau
  2. $atomFeedFromArray = Zend_Feed::importArray($array);
  3.  
  4. // la ligne suivante est équivalente à celle ci-dessus ;
  5. // par défaut l'instance Zend_Feed_Atom est retournée
  6. $atomFeedFromArray = Zend_Feed::importArray($array, 'atom');
  7.  
  8. // on importe un flux rss à partir d'un tableau
  9. $rssFeedFromArray = Zend_Feed::importArray($array, 'rss');

Le format du tableau doit être conforme à cette structure :

  2.     // obligatoire
  3.     'title'       => 'titre du flux',
  4.     'link'        => 'url canonique du flux',
  5.  
  6.     // optionel
  7.     'lastUpdate'  => 'date de la mise à jour au format timestamp',
  8.     'published'   => 'date de la publication au format timestamp',
  9.  
  10.     // obligatoire
  11.     'charset'     => 'charset des données textuelles',
  12.  
  13.     // optionel
  14.     'description' => 'description courte du flux',
  15.     'author'      => 'auteur du flux',
  16.     'email'       => 'email de l'auteur du flux',
  17.  
  18.      // optionel, ignoré si le flux est de type atom
  19.     'webmaster'   => 'email de la personne responsable'
  20.                    . 'en cas de problème technique'
  21.  
  22.     // optionel
  23.     'copyright'   => 'informations de copyright',
  24.     'image'       => 'url de l'image',
  25.     'generator'   => 'générateur du flux',
  26.     'language'    => 'langue dans la quelle le flux est écrit',
  27.  
  28.     // optionel, ignoré si le flux est de type atom
  29.     'ttl'         => 'combien de temps en minutes un flux peut être'
  30.                    . 'mis en cache avant rafraichissement',
  31.     'rating'      => 'l'évaluation PICS du canal',
  32.  
  33.     // optionel, ignoré si le flux est de type atom
  34.     // un nuage pour être averti des mises à jour
  35.     'cloud'       => array(
  36.         // obligatoire
  37.         'domain'            => 'domaine du nuage, ex. rpc.sys.com',
  38.  
  39.         // optionel, par défault port 80
  40.         'port'              => 'port de connexion',
  41.  
  42.         // obligatoire
  43.         'path'              => 'chemin du nuage, ex. /RPC2',
  44.         'registerProcedure' => 'procédure à appeler, '
  45.                              . 'ex. myCloud.rssPleaseNotify',
  46.         'protocol'          => 'protocole à utiliser , ex. soap ou xml-rpc',
  47.     ),
  48.  
  49.     // optionel, ignoré si le flux est de type atom
  50.     // une boîte de saisie qui peut être montrée avec le flux
  51.     'textInput'   => array(
  52.         // obligatoire
  53.         'title'       => 'l'intitulé du bouton de validation '
  54.                        . 'de la boîte de saisie',
  55.         'description' => 'explication de la boîte de saisie',
  56.         'name'        => 'le nom de l'objet texte',
  57.         'link'        => 'l'URL du CGI qui va analyser la requête',
  58.     )
  59.  
  60.     // optionel, ignoré si le flux est de type atom
  61.     // Information disant aux aggrégateurs quelles heures ils peuvent ignorer
  62.     'skipHours'   => array(
  63.         // jusqu'à 24 lignes dont les valeurs
  64.         // sont des nombres commpris entre 0 et 23
  65.         // ex. 13 (1pm)
  66.         'heures dans le format 24H',
  67.     )
  68.  
  69.     // optionel, ignoré si le flux est de type atom
  70.     // Information disant aux aggrégateurs quels jours ils peuvent ignorer
  71.     'skipDays '   => array(
  72.         // jusqu'à 7 lignes dont les valeurs peuvent être
  73.         // Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday
  74.         // ex. Monday
  75.         'jour'
  76.     )
  77.  
  78.     // optionel, ignoré si le flux est de type atom
  79.     // Données d'extension iTunes
  80.     'itunes'      => array(
  81.         // optionel, par défaut l'auteur principal
  82.         'author'       => 'nom de l'artiste',
  83.  
  84.         // optionel, default l'auteur principal
  85.         'owner'        => array(
  86.             'name'  => 'nom du propriétaire' ,
  87.             'email' => 'email du propriétaire',
  88.         )
  89.  
  90.         // optionel, default to the main image value
  91.         'image'        => 'image de l'album/podcast',
  92.  
  93.         // optionel, default to the main description value
  94.         'subtitle'     => 'description courte',
  95.  
  96.         // optionel, default to the main description value
  97.         'summary'      => 'description longue',
  98.  
  99.         // optionel
  100.         'block'        => 'empêcher l'apparition d'un épisode (yes|no)',
  101.  
  102.         // obligatoire, catégorie et information de recherche
  103.         // dans iTunes Music Store
  104.         'category'     => array(
  105.             // jusqu'à 3 lignes
  106.             array(
  107.                 // obligatoire
  108.                 'main' => 'catégorie principale',
  109.                 // optionel
  110.                 'sub'  => 'sous-catégorie'
  111.             ),
  112.         )
  113.  
  114.         // optionel
  115.         'explicit'     => 'graphique d'avertissement parental (yes|no|clean)',
  116.         'keywords'     => 'une liste d'au maximum 12 mot clés'
  117.                         . 'séparés par des virgules',
  118.         'new-feed-url' => 'utiliser pour informer iTunes'
  119.                         . 'd'un nouvel URL de flux',
  120.     )
  121.  
  122.     'entries'     => array(
  123.         array(
  124.             // obligatoire
  125.             'title'        => 'titre de l'item',
  126.             'link'         => 'url de cet item',
  127.  
  128.             // obligatoire, seulement du text, pas d'html
  129.             'description'  => 'version raccourci du texte',
  130.  
  131.             // optionel
  132.             'guid'         => 'id de l'article, si aucun alors'
  133.                             . 'la valeur link est utilisée',
  134.  
  135.              // optionel, peut contenir html
  136.             'content'      => 'version complète de l'information',
  137.  
  138.             // optionel
  139.             'lastUpdate'   => 'date de publication au format timestamp',
  140.             'comments'     => 'page de commentaires de l'item',
  141.             'commentRss'   => 'l'url du flux des commentaires associés',
  142.  
  143.             // optionel, source originale de l'item
  144.             'source'       => array(
  145.                 // obligatoire
  146.                 'title' => 'titre de la source originale',
  147.                 'url' => 'url de la source originale'
  148.             )
  149.  
  150.             // optionel, liste des catégories attachées
  151.             'category'     => array(
  152.                 array(
  153.                     // obligatoire
  154.                     'term' => 'intitulé de la première catégorie',
  155.  
  156.                     // optionel
  157.                     'scheme' => 'url qui décrit l'organisation de la catégorie'
  158.                 ),
  159.                 array(
  160.                     //données de la seconde catégorie et ainsi de suite
  161.                 )
  162.             ),
  163.  
  164.             // optionel, liste des pièces jointes à l'item
  165.             'enclosure'    => array(
  166.                 array(
  167.                     // obligatoire
  168.                     'url' => 'url de la pièce jointe',
  169.  
  170.                     // optionel
  171.                     'type' => 'type mime de la pièce jointe',
  172.                     'length' => 'length de la pièce jointe en octets'
  173.                 ),
  174.                 array(
  175.                     //données de la seconde pièce jointe et ainsi de suite
  176.                 )
  177.             )
  178.         ),
  179.  
  180.         array(
  181.             //données du second item et ainsi de suite
  182.         )
  183.     )
  184. );

Références :

Importer une source de données personnalisée

Vous pouvez créer une instance Zeed_Feed à partir de n'importe quelle source de données implémentant Zend_Feed_Builder_Interface. Vous devez juste implémenter les méthodes getHeader() et getEntries() pour pouvoir utiliser votre objet avec Zend_Feed::importBuilder(). Par une simple référence d'implémentation vous pouvez utiliser Zend_Feed_Builder, qui prend un tableau dans son constructeur, réalise quelques validations mineures, et peut être utilisé dans la méthode importBuilder(). La méthode getHeader() doit retourner une instance de Zend_Feed_Builder_Header, et getEntries() doit retourner un tableau d'instances Zend_Feed_Builder_Entry

Note: Zend_Feed_Builder fournit une mise en oeuvre concrète afin de montrer l'utilisation. Les utilisateurs sont encouragés à faire leurs classes propres mettre en oeuvre Zend_Feed_Builder_Interface.

Voici un exemple d'utilisation de Zend_Feed::importBuilder() :

  1. // importe un flux atom à partir d'un constructeur personnalisé
  2. $atomFeedFromArray =
  3.     Zend_Feed::importBuilder(new Zend_Feed_Builder($array));
  4.  
  5. // la ligne suivante est équivalente à celle ci-dessus ;
  6. // par défaut l'instance Zend_Feed_Atom est retournée
  7. $atomFeedFromArray =
  8.     Zend_Feed::importBuilder(new Zend_Feed_Builder($array), 'atom');
  9.  
  10. // importe un flux rss à partir d'un constructeur personnalisé
  11. $rssFeedFromArray =
  12.     Zend_Feed::importBuilder(new Zend_Feed_Builder($array), 'rss');

Décharger le contenu d'un flux

Pour décharger le contenu d'une instance Zend_Feed_Abstract, vous pouvez utiliser les méthodes send() ou saveXml().

  1. assert($feed instanceof Zend_Feed_Abstract);
  2.  
  3. // décharge le flux dans l'affichage standard
  4. print $feed->saveXML();
  5.  
  6. // envoie les en-têtes et décharge le flux
  7. $feed->send();
Introduction
Zend_Feed
Programmer's Reference Guide