Merge pull request #1637 from wielebenwir/bugfix/issue-1636

Cache: Warmup does not exit if an shortcode call has an exception

src/Map/BaseShortcode.php

@@ -2,12 +2,22 @@
 
 namespace CommonsBooking\Map;
 
+/**
+ * Map shortcode base implementation.
+ * Derive from this class to create custom map shortcode.
+ * Examples of how to implement the abstract methods called in `execute` are {@see MapShortcode} and {@see SearchShortcode}.
+ */
 abstract class BaseShortcode {
+
 	/**
-	 * the shortcode handler - load all the needed assets and render the map container
+	 * The shortcode handler - load all the needed assets and render the map container
+	 *
+	 * @param array  $atts attributes for parametrization.
+	 * @param string $content content to display, if shortcode implementation allows to.
 	 **/
-	public function execute($atts, $content): string {
-		$attrs = $this->parse_attributes($atts);
+	public static function execute( array $atts, string $content ): string {
+		$instance = new static();
+		$attrs = $instance->parse_attributes($atts);
 		$options = array_filter($atts, "is_int", ARRAY_FILTER_USE_KEY);
 
 		if (! (int) $attrs['id']) {
@@ -25,10 +35,9 @@ public function execute($atts, $content): string {
 		}
 
 		$cb_map_id = $post->ID;
-		$this->inject_script($cb_map_id);
-		return $this->create_container($cb_map_id, $attrs, $options, $content);
+		$instance->inject_script($cb_map_id);
+		return $instance->create_container($cb_map_id, $attrs, $options, $content);
 	}
-
 	abstract protected function parse_attributes($atts);
 	abstract protected function inject_script($cb_map_id);
 	abstract protected function create_container($cb_map_id, $attrs, $options, $content);

src/Map/MapShortcode.php

@@ -2,6 +2,9 @@
 
 namespace CommonsBooking\Map;
 
+/**
+ * Shortcode for the legacy map with the old non-responsive standard leaflet style.
+ */
 class MapShortcode extends BaseShortcode {
 	protected function create_container($cb_map_id, $attrs, $options, $content) {
 		$map_height = MapAdmin::get_option( $cb_map_id, 'map_height' );

src/Map/SearchShortcode.php

@@ -1,6 +1,10 @@
 <?php
 
 namespace CommonsBooking\Map;
+
+/**
+ * Short code for a multi-widget with map, search and table capabilities.
+ */
 class SearchShortcode extends BaseShortcode {
 	protected $processed_map_ids = [];
 

src/Plugin.php

@@ -652,7 +652,7 @@ public static function registerScriptsAndStyles() {
 	}
 
 	public function registerShortcodes() {
-		add_shortcode('cb_search', array(new SearchShortcode(), 'execute'));
+		add_shortcode( 'cb_search', array( SearchShortcode::class, 'execute' ) );
 	}
 
 	/**

src/Service/Cache.php

@@ -374,19 +374,26 @@ public static function renderClearCacheButton( $field_args, $field ) {
 	}
 
 	/**
-	 * Iterates through array and executes shortcodecalls.
-	 * @param $shortCodeCalls
+	 * Iterates through array and statically executes given functions.
+	 *
+	 * @param string[] $shortCodeCalls array of tuples of shortcode name strings and tuples of class + static function.
 	 *
 	 * @return void
 	 */
-	private static function runShortcodeCalls($shortCodeCalls) {
+	private static function runShortcodeCalls( array $shortCodeCalls ): void {
 		foreach($shortCodeCalls as $shortcode) {
 			$shortcodeFunction = array_keys($shortcode)[0];
 			$attributes = $shortcode[$shortcodeFunction];
 
 			if(array_key_exists($shortcodeFunction, self::$cbShortCodeFunctions)) {
 				list($class, $function) = self::$cbShortCodeFunctions[$shortcodeFunction];
-				$class::$function($attributes);
+
+				try {
+					$class::$function( $attributes );
+				} catch ( Exception $e ) {
+					// Writes error to log anyway
+					error_log( (string) $e ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
+				}
 			}
 		}
 	}

src/Wordpress/CustomPostType/Map.php

@@ -35,7 +35,7 @@ public function initHooks() {
 		}
 
 		// Add shortcodes
-		add_shortcode( 'cb_map', array( new MapShortcode(), 'execute' ) );
+		add_shortcode( 'cb_map', array( MapShortcode::class, 'execute' ) );
 
 		// Add actions
 		add_action( 'save_post_' . self::$postType, array( MapAdmin::class, 'validate_options' ), 10, 3 );