Update composer file; Optimize library loading; Update library versions; Optimize backend preview

Author: julianwinkel

.gitattributes

@@ -0,0 +1,2 @@
+*.css linguist-detectable=false
+*.js linguist-detectable=false

ProcessPodcastSubscriptions.module

@@ -1,38 +1,34 @@
 <?php
 /**
 * COPYRIGHT NOTICE
-* Copyright (c) 2022 Neue Rituale GbR
+* Copyright (c) 2023 Neue Rituale GbR
 * @author NR <code@neuerituale.com>
 */
 
 namespace ProcessWire;
 
-use Exception;
 use Lukaswhite\PodcastFeedParser\Exceptions\FileNotFoundException;
 use Lukaswhite\PodcastFeedParser\Exceptions\InvalidXmlException;
 use Lukaswhite\PodcastFeedParser\Parser;
 use Lukaswhite\PodcastFeedParser\Podcast;
-use PDO;
-use PDOException;
-
-require_once(/*NoCompile*/__DIR__ . '/vendor/autoload.php');
 
 /**
+ * @method void processPodcast(WireData $feed, Podcast $podcast)
+ * @method array filterDbFeedInput(string $feedUrl, Podcast $podcast)
+ * @method array filterDbFeedUpdate(int $id, Podcast $podcast)
  * @method Parser getFeedParserInstance($args = null)
  */
-
-class ProcessPodcastSubscriptions extends Process implements Module, ConfigurableModule
-{
+class ProcessPodcastSubscriptions extends Process implements Module, ConfigurableModule {
 
 	const dbTableName = 'podcast_subscriptions';
 	const logFileName = 'podcast-subscriptions';
 	const SCHEMA_VERSION = 2;
 	private ?WireArray $feedsCache = null;
 
-	public static function getModuleInfo() {
-		return array(
+	public static function getModuleInfo(): array {
+		return [
 			'title' => 'Process Podcast Subscriptions',
-			'version' => 102,
+			'version' => 103,
 			'summary' => 'Subscribe Podcast RSS feed and save as new page',
 			'icon' => 'clock-o',
 			'requires' => ['LazyCron'],
@@ -44,7 +40,7 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 				'parent' => 'admin',
 				'title' => __('Podcasts'),
 			],
-		);
+		];
 	}
 
 	/**
@@ -72,7 +68,7 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 		$this->subscriptionLinks = $subscriptionLinks;
 
 		// find hookname and init lazy cron hook
-		$hookName = @$this->timeFuncs[$this->cronSchedule];
+		$hookName = $this->timeFuncs[$this->cronSchedule] ?? false;
 		if($hookName && $this->modules->isInstalled('LazyCron')) $this->addHook('LazyCron::' . $hookName, $this, 'updateAllFeeds');
 	}
 
@@ -108,7 +104,7 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 				$feedUrl = $this->input->post('feed_url', 'url');
 				try {
 					$this->addFeed($feedUrl);
-				} catch(Exception $exception) {
+				} catch(\Exception $exception) {
 					$this->error($exception->getMessage());
 				}
 			}
@@ -171,16 +167,16 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 	public function addFeed(string $feedUrl = '') : Podcast {
 
 		// check url
-		if(empty($feedUrl)) throw new Exception($this->_('Empty feed url'));
+		if(empty($feedUrl)) throw new \Exception($this->_('Empty feed url'));
 
 		// duplication check
 		$checkStatement = $this->database->prepare('SELECT * FROM ' . self::dbTableName . ' WHERE feed_url=:feedUrl');
 		$checkStatement->execute(['feedUrl' => $feedUrl]);
-		if($checkStatement->fetchColumn(0)) throw new Exception($this->_('Feed already exists'));
+		if($checkStatement->fetchColumn(0)) throw new \Exception($this->_('Feed already exists'));
 
 		// check feed
 		$podcast = $this->fetchAndParseFeed($feedUrl);
-		if(!$podcast) throw new Exception($this->_('Invalid feed, no type found.'));
+		if(!$podcast) throw new \Exception($this->_('Invalid feed, no type found.'));
 
 		// add to db
 		$addStatement = $this->database->prepare('INSERT INTO ' . self::dbTableName . ' (title,description,artwork_url,feed_url,media_count) VALUE (:title,:description,:artwork_url,:feed_url,:media_count)');
@@ -208,7 +204,7 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 
 		// find feed
 		$feed = $this->getFeeds('id=' . $id)->first();
-		if(!$feed) throw new Exception($this->_('Invalid feed id'));
+		if(!$feed) throw new \Exception($this->_('Invalid feed id'));
 		$podcast = $this->fetchAndParseFeed($feed->feed_url);
 
 		// Update feed in db and the wireData for return
@@ -258,7 +254,7 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 			// Get from database
 			$statement = $this->database->prepare('SELECT * FROM ' . self::dbTableName);
 			$statement->execute();
-			$items = $statement->fetchAll(PDO::FETCH_CLASS, Feed::class);
+			$items = $statement->fetchAll(\PDO::FETCH_CLASS, Feed::class);
 
 			if(!is_array($items)) {
 				$this->feedsCache = null;
@@ -276,14 +272,14 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 	 * Delete feed by id
 	 * @param int $id
 	 * @return bool
-	 * @throws WireException|Exception
+	 * @throws WireException|\Exception
 	 */
 	public function deleteFeed(int $id) : bool {
 		$feed = $this->getFeeds('id=' . $id)->first();
-		if(!$feed) throw new Exception($this->_('Invalid feed id'));
+		if(!$feed) throw new \Exception($this->_('Invalid feed id'));
 
 		$statement = $this->database->prepare('DELETE FROM '.self::dbTableName.' WHERE id=:id');
-		$statement->bindValue('id', $feed->id, PDO::PARAM_INT);
+		$statement->bindValue('id', $feed->id, \PDO::PARAM_INT);
 		return $statement->execute();
 	}
 
@@ -292,7 +288,7 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 	 * @param array $meta
 	 * @return Feed
 	 */
-	public function updateFeedMeta(Feed $feed, array $meta = []) {
+	public function updateFeedMeta(Feed $feed, array $meta = []): Feed {
 		$json = count($meta)
 			? json_encode($meta, JSON_UNESCAPED_UNICODE|JSON_UNESCAPED_SLASHES)
 			: 'null'
@@ -316,7 +312,7 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 	public function fetchAndParseFeed($feedUrl) : ?Podcast {
 
 		$fileContent = $this->files->fileGetContents($feedUrl);
-		if(!$fileContent) throw new Exception($this->_('Invalid feed url'));
+		if(!$fileContent) throw new \Exception($this->_('Invalid feed url'));
 
 		libxml_use_internal_errors(true);
 		$parser = $this->getFeedParserInstance();
@@ -343,7 +339,6 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 	 *
 	 * @param string $feedUrl
 	 * @param Podcast $podcast
-	 * @param int $id
 	 * @return array
 	 * @throws WireException
 	 */
@@ -382,7 +377,7 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 	 * @return array
 	 * @throws WireException
 	 */
-	public function processMetaInput() {
+	public function processMetaInput(): array {
 
 		$meta = [];
 
@@ -405,7 +400,7 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 	public function install() {
 
 		// Create Database
-		$this->wire('database')->exec("
+		wire()->database->exec("
 			CREATE TABLE ".self::dbTableName." (
 				`id` int(11) NOT NULL,
 				`title` tinytext NOT NULL,
@@ -435,8 +430,8 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 	 */
 	public function uninstall() {
 		try {
-			$this->wire('database')->exec('DROP TABLE ' . self::dbTableName);
-		} catch(Exception $exception) {
+			wire()->database->exec('DROP TABLE ' . self::dbTableName);
+		} catch(\Exception $exception) {
 			$this->error($exception->getMessage());
 		}
 	}
@@ -511,7 +506,7 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 		try {
 			$updatedRows = $this->database->exec($sql);
 			return $updatedRows !== false;
-		} catch (PDOException $e) {
+		} catch (\PDOException $e) {
 			if (isset($e->errorInfo[1]) && in_array($e->errorInfo[1], [1060, 1061, 1091])) {
 				// 1060 (column already exists), 1061 (duplicate key name), and 1091 (can't drop index) are errors that
 				// can be safely ignored here; the most likely issue would be that this update has already been applied
@@ -560,11 +555,25 @@ class ProcessPodcastSubscriptions extends Process implements Module, Configurabl
 	 * Get Parser Instance
 	 * @param $args
 	 * @return Parser
+	 * @throws \Exception
 	 */
-	public function ___getFeedParserInstance($args = null) {
+	public function ___getFeedParserInstance($args = null): Parser {
+		$this->loadFeedParserLib();
 		return new Parser($args);
 	}
 
+	/**
+	 * Load PodcastFeedParser Library
+	 * @return void
+	 * @throws \Exception
+	 */
+	public function loadFeedParserLib() {
+		if(!class_exists("\Lukaswhite\PodcastFeedParser\Parser")) {
+			if(!file_exists(__DIR__ . '/vendor/autoload.php')) throw new \Exception("Please install the PodcastFeedParser library via `composer install` in the ProcessPodcastSubscriptions module directory.");
+			require_once(/*NoCompile*/__DIR__ . '/vendor/autoload.php');
+		}
+	}
+
 }
 
 class Feed extends WireData {

ProcessPodcastSubscriptionsConfig.php

@@ -1,20 +1,19 @@
 <?php
 /**
  * COPYRIGHT NOTICE
- * Copyright (c) 2021 Neue Rituale GbR
+ * Copyright (c) 2023 Neue Rituale GbR
  * @author NR <code@neuerituale.com>
  */
 
 namespace ProcessWire;
 
-
 class ProcessPodcastSubscriptionsConfig extends ModuleConfig
 {
 	/**
 	 * @return array
 	 * @throws WireException
 	 */
-	public function getDefaults() {
+	public function getDefaults(): array {
 
 		// get schedules from Lazy Cron
 		$lazyCronInstance = $this->modules->get('LazyCron');
@@ -30,9 +29,8 @@ public function getDefaults() {
 
 	/**
 	 * @return InputfieldWrapper
-	 * @throws WireException
 	 */
-	public function getInputfields() {
+	public function getInputfields(): InputfieldWrapper {
 
 		$inputfields = parent::getInputfields();
 

ProcessPodcastSubscriptionsEpisodes.module

@@ -1,7 +1,7 @@
 <?php
 /**
 * COPYRIGHT NOTICE
-* Copyright (c) 2022 Neue Rituale GbR
+* Copyright (c) 2023 Neue Rituale GbR
 * @author NR <code@neuerituale.com>
 */
 
@@ -11,12 +11,17 @@ use Lukaswhite\PodcastFeedParser\Artwork;
 use Lukaswhite\PodcastFeedParser\Episode;
 use Lukaswhite\PodcastFeedParser\Podcast;
 
+/**
+ * @method void updateOrCreatePodcastEpisode(Episode $episode, Podcast $podcast, WireData $feed)
+ * @method NullPage|Page getPodcastEpisodePageByIdOrCreateNew($episode_id, string $title = '')
+ * @method float parseDuration($duration)
+ */
 class ProcessPodcastSubscriptionsEpisodes extends WireData implements Module, ConfigurableModule
 {
 	public static function getModuleInfo() {
 		return array(
 			'title' => 'Process Podcast Create Episode Pages',
-			'version' => 102,
+			'version' => 103,
 			'summary' => 'Example Module for creating podcast episodes pages with ProcessPodcastSubscriptions',
 			'icon' => 'clock-o',
 			'requires' => ['LazyCron', 'ProcessPodcastSubscriptions'],
@@ -55,13 +60,13 @@ class ProcessPodcastSubscriptionsEpisodes extends WireData implements Module, Co
 	 * @param Episode $episode
 	 * @param Podcast $podcast
 	 * @param WireData $feed
-	 * @return void|null
+	 * @return void
 	 * @throws WireException
 	 */
 	public function ___updateOrCreatePodcastEpisode(Episode $episode, Podcast $podcast, WireData $feed) {
 
 		$podcastId = $episode->getGuid();
-		if(!$podcastId) return null;
+		if(!$podcastId) return;
 
 		$title = $episode->getTitle();
 
@@ -153,9 +158,9 @@ class ProcessPodcastSubscriptionsEpisodes extends WireData implements Module, Co
 	/**
 	 * Parse time to seconds
 	 * @param $duration
-	 * @return float|int
+	 * @return float
 	 */
-	public function ___parseDuration($duration) {
+	public function ___parseDuration($duration): float {
 
 		// HH:MM:SS, MM:SS, MMM:SS
 		if (preg_match('/\:/', $duration)) {

README.md

@@ -1,7 +1,6 @@
 # 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](https://github.com/lukaswhite/podcast-feed-parser) by
 Lukas White, which makes processing the podcast data a breeze. Thanks!
@@ -16,7 +15,6 @@ The module comes with an example module `ProcessPodcastSubscriptionsEpisodes` to
 - 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.
    ```bash
@@ -26,9 +24,13 @@ The module comes with an example module `ProcessPodcastSubscriptionsEpisodes` to
 4. Install the additional module `ProcessPodcastSubscriptionsEpisodes` (optional) or build your own processor
 5. Subscribe to Podcast feeds...
 
+## Install via composer
+1. Execute the following command in your website root directory.
+   ```bash
+   composer require nr/processpodcastsubscriptions
+   ```
 
 ## Configuration Subscriptions
-
 `Modules` > `Configure` > `ProcessPodcastSubscriptions`
 
 ###  Lazycron

composer.json

@@ -1,13 +1,26 @@
 {
     "name": "nr/processpodcastsubscriptions",
+    "type": "pw-module",
+    "description": "Subscribe Podcast RSS feed and save as new page",
+    "keywords": [ "processwire", "module", "podcast" ],
+    "homepage": "https://github.com/neuerituale/ProcessPodcastSubscriptions",
     "license": "MIT",
     "authors": [
         {
             "name": "Neue Rituale",
-            "email": "code@neuerituale.com"
+            "email": "code@neuerituale.com",
+            "homepage": "https://neuerituale.com/",
+            "role": "Developer"
         }
     ],
+    "minimum-stability": "beta",
     "require": {
-        "lukaswhite/podcast-feed-parser": "^0.0.7"
+        "hari/pw-module": "~1.0",
+        "lukaswhite/podcast-feed-parser": "^1.2.0"
+    },
+    "config": {
+        "allow-plugins": {
+            "hari/pw-module": true
+        }
     }
 }

templates/podcasts-example.php

@@ -110,7 +110,7 @@ class="uk-text-muted"
 												: $datetime->formatDate($episode->created, '%e. %h %Y'); ?>
 										</time>
 									</span>
-									<span style="white-space: nowrap"><?= sprintf(__('%d min.'), round($episode->episode_duration/60, 0)); ?></span>
+									<span style="white-space: nowrap"><?= sprintf(__('%d min.'), round((int)$episode->episode_duration/60, 0)); ?></span>
 								</div>
 
 							</a>