eventespresso / event-espresso-core

core/services/shortcodes/EspressoShortcode.php

Indentation +214 added lines, -214 removed lines

@@ -23,220 +23,220 @@
 abstract class EspressoShortcode implements ShortcodeInterface
 {
 
-    /**
-     * transient prefix
-     *
-     * @type string
-     */
-    const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
-
-    /**
-     * @var PostRelatedCacheManager $cache_manager
-     */
-    private $cache_manager;
-
-    /**
-     * true if ShortcodeInterface::initializeShortcode() has been called
-     * if false, then that will get called before processing
-     *
-     * @var boolean $initialized
-     */
-    private $initialized = false;
-
-
-
-    /**
-     * EspressoShortcode constructor
-     *
-     * @param PostRelatedCacheManager $cache_manager
-     */
-    public function __construct(PostRelatedCacheManager $cache_manager)
-    {
-        $this->cache_manager = $cache_manager;
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function shortcodeHasBeenInitialized()
-    {
-        $this->initialized = true;
-    }
-
-
-
-    /**
-     * enqueues scripts then processes the shortcode
-     *
-     * @param array $attributes
-     * @return string
-     * @throws EE_Error
-     */
-    final public function processShortcodeCallback($attributes = array())
-    {
-        if ($this instanceof EnqueueAssetsInterface) {
-            if (is_admin()) {
-                $this->enqueueAdminScripts();
-            } else {
-                $this->enqueueScripts();
-            }
-        }
-        return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
-        );
-    }
-
-
-
-    /**
-     * If shortcode caching is enabled for the shortcode,
-     * and cached results exist, then that will be returned
-     * else new content will be generated.
-     * If caching is enabled, then the new content will be cached for later.
-     *
-     * @param array $attributes
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    private function shortcodeContent(array $attributes)
-    {
-        $shortcode = $this;
-        $post_ID = $this->currentPostID();
-        // something like "SC_EVENTS-123"
-        $cache_ID = $this->shortcodeCacheID($post_ID);
-        $this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
-        return $this->cache_manager->get(
-            $cache_ID,
-            // serialized attributes
-            wp_json_encode($attributes),
-            // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if($shortcode->initialized === false){
-                    $shortcode->initializeShortcode();
-                }
-                return $shortcode->processShortcode($attributes);
-            },
-            // filterable cache expiration set by each shortcode
-            apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
-                $this->cacheExpiration(),
-                $this->getTag(),
-                $this
-            )
-        );
-    }
-
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    private function currentPostID()
-    {
-        // try to get EE_Event any way we can
-        $event = EEH_Event_View::get_event();
-        // then get some kind of ID
-        if ($event instanceof EE_Event) {
-            return $event->ID();
-        }
-        global $post;
-        if ($post instanceof WP_Post) {
-            return $post->ID;
-        }
-        return 0;
-    }
-
-
-
-    /**
-     * @param int $post_ID
-     * @return string
-     * @throws EE_Error
-     */
-    private function shortcodeCacheID($post_ID)
-    {
-        $tag = str_replace('ESPRESSO_', '', $this->getTag());
-        return "SC_{$tag}-{$post_ID}";
-    }
-
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would return the following:
-     *      array('event_id' => 'absint')
-     * Entering 'skip_sanitization' for the callback value
-     * means that no sanitization will be applied
-     * on the assumption that the attribute
-     * will be sanitized at some point... right?
-     * You wouldn't pass around unsanitized attributes would you?
-     * That would be very Tom Foolery of you!!!
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden using the customAttributeSanitizationMap() method (see above),
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $custom_sanitization = $this->customAttributeSanitizationMap();
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[$key])) {
-                $callback = $custom_sanitization[$key];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[$key] = $value;
-                    continue;
-                }
-                if (function_exists($callback)) {
-                    $attributes[$key] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null :
-                case is_int($value) :
-                case is_float($value) :
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
-                    $attributes[$key] = $value;
-                    break;
-                case is_string($value) :
-                    $attributes[$key] = sanitize_text_field($value);
-                    break;
-                case is_array($value) :
-                    $attributes[$key] = $this->sanitizeAttributes($value);
-                    break;
-                default :
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[$key] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * transient prefix
+	 *
+	 * @type string
+	 */
+	const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
+
+	/**
+	 * @var PostRelatedCacheManager $cache_manager
+	 */
+	private $cache_manager;
+
+	/**
+	 * true if ShortcodeInterface::initializeShortcode() has been called
+	 * if false, then that will get called before processing
+	 *
+	 * @var boolean $initialized
+	 */
+	private $initialized = false;
+
+
+
+	/**
+	 * EspressoShortcode constructor
+	 *
+	 * @param PostRelatedCacheManager $cache_manager
+	 */
+	public function __construct(PostRelatedCacheManager $cache_manager)
+	{
+		$this->cache_manager = $cache_manager;
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function shortcodeHasBeenInitialized()
+	{
+		$this->initialized = true;
+	}
+
+
+
+	/**
+	 * enqueues scripts then processes the shortcode
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws EE_Error
+	 */
+	final public function processShortcodeCallback($attributes = array())
+	{
+		if ($this instanceof EnqueueAssetsInterface) {
+			if (is_admin()) {
+				$this->enqueueAdminScripts();
+			} else {
+				$this->enqueueScripts();
+			}
+		}
+		return $this->shortcodeContent(
+			$this->sanitizeAttributes((array)$attributes)
+		);
+	}
+
+
+
+	/**
+	 * If shortcode caching is enabled for the shortcode,
+	 * and cached results exist, then that will be returned
+	 * else new content will be generated.
+	 * If caching is enabled, then the new content will be cached for later.
+	 *
+	 * @param array $attributes
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	private function shortcodeContent(array $attributes)
+	{
+		$shortcode = $this;
+		$post_ID = $this->currentPostID();
+		// something like "SC_EVENTS-123"
+		$cache_ID = $this->shortcodeCacheID($post_ID);
+		$this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
+		return $this->cache_manager->get(
+			$cache_ID,
+			// serialized attributes
+			wp_json_encode($attributes),
+			// Closure for generating content if cache is expired
+			function () use ($shortcode, $attributes) {
+				if($shortcode->initialized === false){
+					$shortcode->initializeShortcode();
+				}
+				return $shortcode->processShortcode($attributes);
+			},
+			// filterable cache expiration set by each shortcode
+			apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
+				$this->cacheExpiration(),
+				$this->getTag(),
+				$this
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	private function currentPostID()
+	{
+		// try to get EE_Event any way we can
+		$event = EEH_Event_View::get_event();
+		// then get some kind of ID
+		if ($event instanceof EE_Event) {
+			return $event->ID();
+		}
+		global $post;
+		if ($post instanceof WP_Post) {
+			return $post->ID;
+		}
+		return 0;
+	}
+
+
+
+	/**
+	 * @param int $post_ID
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function shortcodeCacheID($post_ID)
+	{
+		$tag = str_replace('ESPRESSO_', '', $this->getTag());
+		return "SC_{$tag}-{$post_ID}";
+	}
+
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would return the following:
+	 *      array('event_id' => 'absint')
+	 * Entering 'skip_sanitization' for the callback value
+	 * means that no sanitization will be applied
+	 * on the assumption that the attribute
+	 * will be sanitized at some point... right?
+	 * You wouldn't pass around unsanitized attributes would you?
+	 * That would be very Tom Foolery of you!!!
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden using the customAttributeSanitizationMap() method (see above),
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$custom_sanitization = $this->customAttributeSanitizationMap();
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[$key])) {
+				$callback = $custom_sanitization[$key];
+				if ($callback === 'skip_sanitization') {
+					$attributes[$key] = $value;
+					continue;
+				}
+				if (function_exists($callback)) {
+					$attributes[$key] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null :
+				case is_int($value) :
+				case is_float($value) :
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
+					$attributes[$key] = $value;
+					break;
+				case is_string($value) :
+					$attributes[$key] = sanitize_text_field($value);
+					break;
+				case is_array($value) :
+					$attributes[$key] = $this->sanitizeAttributes($value);
+					break;
+				default :
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[$key] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}