Page Contents

Rss

class Cake\View\Helper\RssHelper(View $view, array $config = [])

Le RssHelper permet de générer facilement le XML pour les flux RSS.

Obsolète depuis la version 3.5.0: Le RssHelper est déprécié à partir de 3.5.0 et sera supprimé dans 4.0.0

Créer un flux RSS avec RssHelper

Cet exemple suppose que vous ayez un Controller Articles, une Table Articles et une Entity Article déjà créés et que vous voulez créer une vue alternative pour les flux RSS.

Créer une version XML/RSS de articles/index est vraiment simple avec CakePHP. Après quelques étapes faciles, vous pouvez tout simplement ajouter l’extension .rss demandée à articles/index pour en faire votre URL articles/index.rss. Avant d’aller plus loin en essayant d’initialiser et de lancer notre service Web, nous avons besoin de faire un certain nombre de choses. Premièrement, le parsing d’extensions doit être activé dans config/routes.php:

Router::extensions('rss');

Dans l’appel ci-dessus, nous avons activé l’extension .rss. Quand vous utilisez Cake\Routing\Router::extensions(), vous pouvez passer une chaine de caractères ou un tableau d’extensions en tant que premier argument. Cela activera chaque extension/content-type utilisée dans votre application. Maintenant, quand l’adresse posts/index.rss est demandée, vous obtiendrez une version XML de votre posts/index. Cependant, nous devons éditer le controller pour y ajouter le code dédié au rss.

Code du Controller

C’est une bonne idée d’ajouter RequestHandler dans la méthode initialize() de votre controller Posts. Cela permettra beaucoup d’automagie:

public function initialize()
{
    parent::initialize();
    $this->loadComponent('RequestHandler');
}

Avant que nous puissions faire une version RSS de notre articles/index, nous avons besoin de mettre certaines choses en ordre. Il pourrait être tentant de mettre les métadonnées du canal dans l’action du controller et de le passer à votre vue en utilisant la méthode Cake\Controller\Controller::set(), mais ceci est inapproprié. Cette information pourrait également aller dans la vue. Cela arrivera sans doute plus tard, mais pour l’instant, si vous avez un ensemble de logique différent entre les données utilisées pour créer le flux RSS et les données pour la page HTML, vous pouvez utiliser la méthode Cake\Controller\Component\RequestHandler::isRss(), sinon votre controller pourrait rester le même:

// Modifie l'action du Controller Posts correspondant à
// l'action qui délivre le flux rss, laquelle est
// l'action index dans notre exemple

public function index()
{
    if ($this->RequestHandler->isRss() ) {
        $articles = $this->Articles
            ->find()
            ->limit(20)
            ->order(['created' => 'desc']);
        $this->set(compact('articles'));
    } else {
        // ceci n'est pas une requête RSS
        // donc on retourne les données utilisées par l'interface du site web
        $this->paginate = [
            'order' => ['created' => 'desc'],
            'limit' => 10
        ];
        $this->set('articles', $this->paginate($this->Articles));
        $this->set('_serialize', ['articles']);
    }
}

Maintenant que toutes ces variables de Vue sont définies, nous avons besoin de créer un layout rss.

Layout

Un layout Rss est très simple, mettez le contenu suivant dans src/Template/Layout/rss/default.ctp:

if (!isset($documentData)) {
    $documentData = [];
}
if (!isset($channelData)) {
    $channelData = [];
}
if (!isset($channelData['title'])) {
    $channelData['title'] = $this->fetch('title');
}
$channel = $this->Rss->channel([], $channelData, $this->fetch('content'));
echo $this->Rss->document($documentData, $channel);

Il ne ressemble pas à plus mais grâce à la puissance du RssHelper il fait beaucoup pour améliorer le visuel pour nous. Nous n’avons pas défini $documentData ou $channelData dans le controller, cependant dans CakePHP vos vues peuvent passer des variables au layout. C’est l’endroit où notre tableau $channelData va venir définir toutes les données meta de notre flux.

Ensuite il y a le fichier de vue pour mes articles/index. Un peu comme le fichier de layout que nous avons créé, nous devons créer un répertoire src/Template/Posts/rss/ et un nouveau fichier index.ctp à l’intérieur de celui-ci. Les contenus du fichier sont ci-dessous.

View

Notre vue, localisée dans src/Template/Posts/rss/index.ctp, commence par définir les variables $documentData et $channelData pour le layout, celles-ci contiennent toutes les metadonnées pour notre flux RSS. Cela est réalisé via la méthode Cake\View\View::set() qui est analogue à la méthode Cake\Controller\Controller::set(). Ici nous passons les données des canaux en retour au layout:

$this->set('channelData', [
    'title' => __("Most Recent Posts"),
    'link' => $this->Url->build('/', true),
    'description' => __("Most recent posts."),
    'language' => 'en-us'
]);

La seconde partie de la vue génère les éléments pour les enregistrements actuels du flux. Ceci est accompli en bouclant sur les données qui ont été passées à la vue ($items) et en utilisant la méthode RssHelper::item(). L’autre méthode que vous pouvez utiliser RssHelper::items() qui prend un callback et un tableau des items pour le flux. La méthode de callback est généralement appelée transformRss(). Il y a un problème avec cette méthode, qui est qu’elle n’utilise aucune des classes de helper pour préparer vos données à l’intérieur de la méthode de callback parce que la portée à l’intérieur de la méthode n’inclut pas tout ce qui n’est pas passé à l’intérieur, ainsi ne donne pas accès au TimeHelper ou à tout autre helper dont vous auriez besoin. RssHelper::item() transforme le tableau associatif en un élément pour chaque paire de valeur de clé.

Note

Vous devrez modifier la variable $link comme il se doit pour votre application. Vous pourriez également utiliser une propriété virtuelle dans votre Entity.

foreach ($articles as $article) {
    $created = strtotime($article->created);

    $link = [
        'controller' => 'Articles',
        'action' => 'view',
        'year' => date('Y', $created),
        'month' => date('m', $created),
        'day' => date('d', $created),
        'slug' => $article->slug
    ];

    // Retire & échappe tout HTML pour être sûr que le contenu va être validé.
    $body = h(strip_tags($article->body));
    $body = $this->Text->truncate($body, 400, [
        'ending' => '...',
        'exact'  => true,
        'html'   => true,
    ]);

    echo  $this->Rss->item([], [
        'title' => $article->title,
        'link' => $link,
        'guid' => ['url' => $link, 'isPermaLink' => 'true'],
        'description' => $body,
        'pubDate' => $article->created
    ]);
}

Vous pouvez voir ci-dessus que nous pouvons utiliser la boucle pour préparer les données devant être transformées en éléments XML. Il est important de filtrer tout caractère de texte non brute en-dehors de la description, spécialement si vous utilisez un éditeur de texte riche pour le corps de votre blog. Dans le code ci-dessus nous utilisons strip_tags() et h() pour retirer/échapper tout caractère spécial XML du contenu, puisqu’ils peuvent entraîner des erreurs de validation. Une fois que nous avons défini les données pour le flux, nous pouvons ensuite utiliser la méthode RssHelper::item() pour créer le XML dans le format RSS. Une fois que vous avez toutes ces configurations, vous pouvez tester votre flux RSS en allant à votre /posts/index.rss et que vous verrez votre nouveau flux. Il est toujours important que vous validiez votre flux RSS avant de le mettre en live. Ceci peut être fait en visitant les sites qui valident le XML comme Le Validateur de flux ou le site de w3c à https://validator.w3.org/feed/.

Note

Vous aurez besoin de définir la valeur de “debug” dans votre configuration du cœur à false pour obtenir un flux valide, à cause des différentes informations de debug ajoutées automatiquement sous des paramètres de debug plus haut qui cassent la syntaxe XML ou les règles de validation du flux.