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

  • New blog: Debugging tools built-in to ProcessWire. ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them… More
    1 July 2022
  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.