ProcessPodcastSubscriptions by Neue Rituale

Subscribe Podcast RSS feed and save episodes as new page

ProcessPodcastSubscriptions

What it does


Subscribe to podcast RSS feeds and save the data as anything you want. The module uses the great PHP Library podcast-feed-parser by Lukas White, which makes processing the podcast data a breeze. Thanks!

The module comes with an example module ProcessPodcastSubscriptionsEpisodes to demonstrate how to create new pages per episode.

Features


  • Subscribe / Unsubscribe Podcast XML-Feeds
  • Periodically fetch feeds with LazyCron
  • Simple hookable actions
  • ProcessModule for administration
  • Optional module ProcessPodcastSubscriptionsEpisodes

Install


  1. Copy the files for this module to /site/modules/ProcessPodcastSubscriptions/
  2. Execute the following command in the /site/modules/ProcessPodcastSubscriptions/ directory.
    composer install
  3. If not done automatically, create a new admin page with the process ProcessPodcastSubscriptions
  4. Install the additional module ProcessPodcastSubscriptionsEpisodes (optional) or build your own processor
  5. Subscribe to Podcast feeds...

Configure Lazycron

Modules > Configure > ProcessPodcastSubscriptions

Setup the LazyCron schedule. The cache expiration is configurable in the field settings.

Lazycron

Episode Parent

Modules > Configure > ProcessPodcastSubscriptionsEpisodes

Episode Parent

Podcast Class and Episode Class


The Podcast object has a lot of handy methods to do anything you want with the returned data.

class Podcast implements HasArtwork {

   public array getEpisodes()
   public string getLanguage()
   public string getAuthor()
   public string getTitle()
   public string getSubtitle()
   public string getDescription()
   public DateTime getLastBuildDate()

   public string getType()
   public bool isEpisodic()
   public bool isSerial()

   public string getUpdatePeriod()
   public Artwork getArtwork()
   public string getExplicit()
   public array getCategories()

   /* ... and much more ... */
}
class Episode {

    public string getGuid()
    public int getEpisodeNumber()
    public Media getMedia()
    public DateTime getPublishedDate()
    public string getTitle()
    public string getDescription()
    public Artwork getArtwork()
    public string getLink()
    public string getExplicit()

    /* ... and much more ... */
}

Hook


// init.php or ready.php
$wire->addHookBefore('ProcessPodcastSubscriptions::processPodcast', function (HookEvent $event) {

    /** @var \ProcessWire\WireData $feed */
    $feed = $event->arguments(0);

    /** @var \Lukaswhite\PodcastFeedParser\Podcast $podcast */
    $podcast = $event->arguments(1);

    // process
    foreach($podcast->getEpisodes() as $episode) {
        /* create or update episode pages... */
    }

});

Todos


  • Respect lastBuildDate from feed for update action.
  • Handle long running script on subscribe.

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • Weekly update: Smooth rollout for ProcessWire 3.0.200 main/master, plus getting started on a new WP-to-PW site conversion and why they can be so rewarding— More
    20 May 2022
  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022

Latest news

  • ProcessWire Weekly #419
    In issue 419 of ProcessWire Weekly we'll check out this week's core updates, introduce a brand new recipe of the week, and more. Read on!
    Weekly.pw / 21 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer