Introduction

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. span style="color: #ff0000;">'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. 'flux.xml');
  3.  
  4. // on importe un flux à partir d'une variable PHP de type chaîne

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. // la ligne suivante est équivalente à celle ci-dessus ;
  3. // par défaut l'instance Zend_Feed_Atom est retournée
  4. 'atom');
  5.  
  6. // on importe un flux rss à partir d'un tableau
  7. 'rss');

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

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

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. // la ligne suivante est équivalente à celle ci-dessus ;
  3. // par défaut l'instance Zend_Feed_Atom est retournée
  4. 'atom');
  5.  
  6. // importe un flux rss à partir d'un constructeur personnalisé
  7. '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. span style="color: #808080; font-style: italic;">// décharge le flux dans l'affichage standard
  2. // envoie les en-têtes et décharge le flux

Introduction