eventespresso / event-espresso-core

core/libraries/shortcodes/EE_Event_Shortcodes.lib.php

Indentation +292 added lines, -292 removed lines

@@ -19,296 +19,296 @@
 {
 
 
-    /**
-     * Will hold the EE_Event if available
-     *
-     * @var EE_Event
-     */
-    protected $_event;
-
-
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label = __('Event Shortcodes', 'event_espresso');
-        $this->description = __('All shortcodes specific to event related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[EVENT_ID]'                              => __(
-                'Will be replaced by the event ID of an event',
-                'event_espresso'
-            ),
-            '[EVENT]'                                 => __('The name of the event', 'event_espresso'),
-            '[EVENT_NAME]'                            => __(
-                "This also can be used for the name of the event",
-                'event_espresso'
-            ),
-            '[EVENT_PHONE]'                           => __(
-                'The phone number for the event (usually an info number)',
-                'event_espresso'
-            ),
-            '[EVENT_DESCRIPTION]'                     => __('The description of the event', 'event_espresso'),
-            '[EVENT_EXCERPT]'                         => __(
-                'This gets parsed to the value for the excerpt field in the event or blank if there is no excerpt.',
-                'event_espresso'
-            ),
-            '[EVENT_LINK]'                            => __('A link associated with the event', 'event_espresso'),
-            '[EVENT_URL]'                             => __(
-                'A link to the event set up on the host site.',
-                'event_espresso'
-            ),
-            '[VIRTUAL_URL]'                           => __(
-                'What was used for the "URL of Event" field in the Venue settings',
-                'event_espresso'
-            ),
-            '[VIRTUAL_PHONE]'                         => __(
-                'An alternate phone number for the event. Typically used as a "call-in" number',
-                'event_espresso'
-            ),
-            '[EVENT_IMAGE]'                           => __(
-                'This will parse to the Feature image for the event.',
-                'event_espresso'
-            ),
-            '[EVENT_IMAGE_*]'                         => sprintf(
-                __(
-                    'This will parse to the Feature image for the event, %1$ssize%2$s can be set to determine the size of the image loaded by the shortcode. The %1$swidth%2$s and/or %1$sheight%2$s can also be set to determine the width and height of the image when output. By default the shortcode will load the %1$sthumbnail%2$s image size.',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[EVENT_TOTAL_AVAILABLE_SPACES_*]'        => sprintf(
-                __(
-                    'This will parse to the total available spaces for an event. Calculating total spaces is approximate because it is dependent on the complexity of limits on your event.  There are two methods of calculation (which can be indicated by the %1$smethod%2$s param on the shortcode).  %1$scurrent%2$s which will do a more accurate calculation of total available spaces based on current sales, and %1$sfull%2$s which will be the maximum total available spaces that is on the event in optimal conditions. The shortcode will default to current.',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[EVENT_TOTAL_SPOTS_TAKEN]'               => __(
-                'This shortcode will parse to the output the total approved registrations for this event',
-                'event_espresso'
-            ),
-            '[EVENT_FACEBOOK_URL]'                    => __(
-                'This will return the Facebook URL for the event if you have it set via custom field in your event, otherwise it will use the Facebook URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_facebook</code> and the value as your facebook url.',
-                'event_espresso'
-            ),
-            '[EVENT_TWITTER_URL]'                     => __(
-                'This will return the Twitter URL for the event if you have it set via custom field in your event, otherwise it will use the Twitter URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_twitter</code> and the value as your facebook url',
-                'event_espresso'
-            ),
-            '[EVENT_META_*]'                          => sprintf(
-                __(
-                    'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the event then it will be output in place of this shortcode. If you use shortcodes within your custom fields set %1$sdo_shortcode=true%2$s at the end of the shortcode to run the value through the do_shortcode function. ',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]' => __(
-                'This parses to the url for the registration list table filtered by registrations for this event.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-
-
-        $this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
-
-        // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
-        if (empty($this->_event)) {
-            $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-            $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
-
-            $this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
-                ? $aee->reg_obj->event() : null;
-        }
-
-
-        // If there is no event objecdt by now then get out.
-        if (! $this->_event instanceof EE_Event) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[EVENT_ID]':
-                return $this->_event->ID();
-                break;
-
-            case '[EVENT]':
-            case '[EVENT_NAME]':
-                return $this->_event->get('EVT_name');
-                break;
-
-            case '[EVENT_PHONE]':
-                return $this->_event->get('EVT_phone');
-                break;
-
-            case '[EVENT_DESCRIPTION]':
-                return $this->_event->get('EVT_desc');
-                break;
-
-            case '[EVENT_EXCERPT]':
-                return $this->_event->get('EVT_short_desc');
-                break;
-
-            case '[EVENT_LINK]':
-                return $this->_get_event_link($this->_event);
-                break;
-
-            case '[EVENT_URL]':
-                return $this->_get_event_link($this->_event, false);
-                break;
-
-            case '[VIRTUAL_URL]':
-                $venue = $this->_event->get_first_related('Venue');
-                if (empty($venue)) {
-                    return '';
-                }
-                return $venue->get('VNU_virtual_url');
-
-            case '[VIRTUAL_PHONE]':
-                $venue = $this->_event->get_first_related('Venue');
-                if (empty($venue)) {
-                    return '';
-                }
-                return $venue->get('VNU_virtual_phone');
-                break;
-
-            case '[EVENT_IMAGE]':
-                $image = $this->_event->feature_image_url(array(600, 300));
-                // @todo: eventually we should make this an attribute shortcode so that em can send along what size they want returned.
-                return ! empty($image)
-                    ? '<img src="' . $image . '" alt="'
-                      . sprintf(
-                          esc_attr__('%s Feature Image', 'event_espresso'),
-                          $this->_event->get('EVT_name')
-                      ) . '" />'
-                    : '';
-                break;
-
-            case '[EVENT_FACEBOOK_URL]':
-                $facebook_url = $this->_event->get_post_meta('event_facebook', true);
-                return empty($facebook_url) ? EE_Registry::instance()->CFG->organization->get_pretty('facebook')
-                    : $facebook_url;
-                break;
-
-            case '[EVENT_TWITTER_URL]':
-                $twitter_url = $this->_event->get_post_meta('event_twitter', true);
-                return empty($twitter_url) ? EE_Registry::instance()->CFG->organization->get_pretty('twitter')
-                    : $twitter_url;
-                break;
-
-            case '[EVENT_AUTHOR_EMAIL]':
-                $author_id = $this->_event->get('EVT_wp_user');
-                $user_data = get_userdata((int) $author_id);
-                return $user_data->user_email;
-                break;
-
-            case '[EVENT_TOTAL_SPOTS_TAKEN]':
-                return EEM_Registration::instance()->count(
-                    array(array('EVT_ID' => $this->_event->ID(), 'STS_ID' => EEM_Registration::status_id_approved)),
-                    'REG_ID',
-                    true
-                );
-                break;
-
-            case '[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]':
-                return EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'event_id' => $this->_event->ID(),
-                        'page'     => 'espresso_registrations',
-                        'action'   => 'default',
-                    ),
-                    admin_url('admin.php'),
-                    true
-                );
-                break;
-        }
-
-        if (strpos($shortcode, '[EVENT_META_*') !== false) {
-            // Strip the shortcode itself from $shortcode leaving any attributes set.
-            // Removing the * is correct here as _* is used to indiciate a dynamic shortcode.
-            $shortcode = str_replace('[EVENT_META_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-            // Get any attributes set on this shortcode.
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            // The meta_key set on the shortcode should always be the first value in the array.
-            $meta_key = $attrs[0];
-            // Pull the meta value from the event post.
-            $event_meta = $this->_event->get_post_meta($meta_key, true);
-            // If we have no event_meta, just return an empty string.
-            if (empty($event_meta)) {
-                return '';
-            }
-            // Add a filter to allow all instances of EVENT_META_* to run through do_shortcode, default to false.
-            // Check if a do_shortcode attribute was set to true and if so run $event_meta through that function.
-            if (apply_filters('FHEE__EventEspresso_core_libraries_shortcodes_EE_Event_Shortcodes___parser__event_meta_do_shortcode', false)
-                || !empty($attrs['do_shortcode']) && filter_var($attrs['do_shortcode'], FILTER_VALIDATE_BOOLEAN)
-            ) {
-                return do_shortcode($event_meta);
-            }
-            // Still here? We just need to return the event_meta value as is.
-            return $event_meta;
-        }
-
-        if (strpos($shortcode, '[EVENT_TOTAL_AVAILABLE_SPACES_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            $method = empty($attrs['method']) ? 'current' : $attrs['method'];
-            $method = $method === 'current';
-            $available = $this->_event->total_available_spaces($method);
-            return $available === EE_INF ? '&infin;' : $available;
-        }
-
-        if (strpos($shortcode, '[EVENT_IMAGE_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            $width = empty($attrs['width']) ? '' : ' width="' . $attrs['width'] . '"';
-            $height = empty($attrs['height']) ? '' : ' height="' . $attrs['height'] . '"';
-
-            // Size may be set to a string such as 'tumbnail' or "width, height" eg - '200,200'
-            if (! empty($attrs['size'])) {
-                $size = explode(',', $attrs['size']);
-                if (count($size) === 1) {
-                    $size = $size[0];
-                }
-            } else {
-                $size = 'thumbnail';
-            }
-
-            $image = $this->_event->feature_image_url($size);
-
-            return ! empty($image)
-                ? '<img src="' . $image . '" alt="'
-                  . sprintf(
-                      esc_attr__('%s Feature Image', 'event_espresso'),
-                      $this->_event->get('EVT_name')
-                  ) . '"' . $width . $height . '/>'
-                : '';
-        }
-
-        return '';
-    }
-
-
-    /**
-     * returns the link to the event
-     *
-     * @param  boolean $full_link if TRUE (default) we return the html for the name of the event linked to the event.
-     *                            Otherwise we just return the url of the event.
-     * @return string
-     */
-    private function _get_event_link($event, $full_link = true)
-    {
-        $url = get_permalink($event->ID());
-
-        return $full_link ? '<a href="' . $url . '">' . $event->get('EVT_name') . '</a>' : $url;
-    }
+	/**
+	 * Will hold the EE_Event if available
+	 *
+	 * @var EE_Event
+	 */
+	protected $_event;
+
+
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label = __('Event Shortcodes', 'event_espresso');
+		$this->description = __('All shortcodes specific to event related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[EVENT_ID]'                              => __(
+				'Will be replaced by the event ID of an event',
+				'event_espresso'
+			),
+			'[EVENT]'                                 => __('The name of the event', 'event_espresso'),
+			'[EVENT_NAME]'                            => __(
+				"This also can be used for the name of the event",
+				'event_espresso'
+			),
+			'[EVENT_PHONE]'                           => __(
+				'The phone number for the event (usually an info number)',
+				'event_espresso'
+			),
+			'[EVENT_DESCRIPTION]'                     => __('The description of the event', 'event_espresso'),
+			'[EVENT_EXCERPT]'                         => __(
+				'This gets parsed to the value for the excerpt field in the event or blank if there is no excerpt.',
+				'event_espresso'
+			),
+			'[EVENT_LINK]'                            => __('A link associated with the event', 'event_espresso'),
+			'[EVENT_URL]'                             => __(
+				'A link to the event set up on the host site.',
+				'event_espresso'
+			),
+			'[VIRTUAL_URL]'                           => __(
+				'What was used for the "URL of Event" field in the Venue settings',
+				'event_espresso'
+			),
+			'[VIRTUAL_PHONE]'                         => __(
+				'An alternate phone number for the event. Typically used as a "call-in" number',
+				'event_espresso'
+			),
+			'[EVENT_IMAGE]'                           => __(
+				'This will parse to the Feature image for the event.',
+				'event_espresso'
+			),
+			'[EVENT_IMAGE_*]'                         => sprintf(
+				__(
+					'This will parse to the Feature image for the event, %1$ssize%2$s can be set to determine the size of the image loaded by the shortcode. The %1$swidth%2$s and/or %1$sheight%2$s can also be set to determine the width and height of the image when output. By default the shortcode will load the %1$sthumbnail%2$s image size.',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[EVENT_TOTAL_AVAILABLE_SPACES_*]'        => sprintf(
+				__(
+					'This will parse to the total available spaces for an event. Calculating total spaces is approximate because it is dependent on the complexity of limits on your event.  There are two methods of calculation (which can be indicated by the %1$smethod%2$s param on the shortcode).  %1$scurrent%2$s which will do a more accurate calculation of total available spaces based on current sales, and %1$sfull%2$s which will be the maximum total available spaces that is on the event in optimal conditions. The shortcode will default to current.',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[EVENT_TOTAL_SPOTS_TAKEN]'               => __(
+				'This shortcode will parse to the output the total approved registrations for this event',
+				'event_espresso'
+			),
+			'[EVENT_FACEBOOK_URL]'                    => __(
+				'This will return the Facebook URL for the event if you have it set via custom field in your event, otherwise it will use the Facebook URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_facebook</code> and the value as your facebook url.',
+				'event_espresso'
+			),
+			'[EVENT_TWITTER_URL]'                     => __(
+				'This will return the Twitter URL for the event if you have it set via custom field in your event, otherwise it will use the Twitter URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_twitter</code> and the value as your facebook url',
+				'event_espresso'
+			),
+			'[EVENT_META_*]'                          => sprintf(
+				__(
+					'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the event then it will be output in place of this shortcode. If you use shortcodes within your custom fields set %1$sdo_shortcode=true%2$s at the end of the shortcode to run the value through the do_shortcode function. ',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]' => __(
+				'This parses to the url for the registration list table filtered by registrations for this event.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+
+
+		$this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
+
+		// if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
+		if (empty($this->_event)) {
+			$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+			$aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
+
+			$this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
+				? $aee->reg_obj->event() : null;
+		}
+
+
+		// If there is no event objecdt by now then get out.
+		if (! $this->_event instanceof EE_Event) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[EVENT_ID]':
+				return $this->_event->ID();
+				break;
+
+			case '[EVENT]':
+			case '[EVENT_NAME]':
+				return $this->_event->get('EVT_name');
+				break;
+
+			case '[EVENT_PHONE]':
+				return $this->_event->get('EVT_phone');
+				break;
+
+			case '[EVENT_DESCRIPTION]':
+				return $this->_event->get('EVT_desc');
+				break;
+
+			case '[EVENT_EXCERPT]':
+				return $this->_event->get('EVT_short_desc');
+				break;
+
+			case '[EVENT_LINK]':
+				return $this->_get_event_link($this->_event);
+				break;
+
+			case '[EVENT_URL]':
+				return $this->_get_event_link($this->_event, false);
+				break;
+
+			case '[VIRTUAL_URL]':
+				$venue = $this->_event->get_first_related('Venue');
+				if (empty($venue)) {
+					return '';
+				}
+				return $venue->get('VNU_virtual_url');
+
+			case '[VIRTUAL_PHONE]':
+				$venue = $this->_event->get_first_related('Venue');
+				if (empty($venue)) {
+					return '';
+				}
+				return $venue->get('VNU_virtual_phone');
+				break;
+
+			case '[EVENT_IMAGE]':
+				$image = $this->_event->feature_image_url(array(600, 300));
+				// @todo: eventually we should make this an attribute shortcode so that em can send along what size they want returned.
+				return ! empty($image)
+					? '<img src="' . $image . '" alt="'
+					  . sprintf(
+						  esc_attr__('%s Feature Image', 'event_espresso'),
+						  $this->_event->get('EVT_name')
+					  ) . '" />'
+					: '';
+				break;
+
+			case '[EVENT_FACEBOOK_URL]':
+				$facebook_url = $this->_event->get_post_meta('event_facebook', true);
+				return empty($facebook_url) ? EE_Registry::instance()->CFG->organization->get_pretty('facebook')
+					: $facebook_url;
+				break;
+
+			case '[EVENT_TWITTER_URL]':
+				$twitter_url = $this->_event->get_post_meta('event_twitter', true);
+				return empty($twitter_url) ? EE_Registry::instance()->CFG->organization->get_pretty('twitter')
+					: $twitter_url;
+				break;
+
+			case '[EVENT_AUTHOR_EMAIL]':
+				$author_id = $this->_event->get('EVT_wp_user');
+				$user_data = get_userdata((int) $author_id);
+				return $user_data->user_email;
+				break;
+
+			case '[EVENT_TOTAL_SPOTS_TAKEN]':
+				return EEM_Registration::instance()->count(
+					array(array('EVT_ID' => $this->_event->ID(), 'STS_ID' => EEM_Registration::status_id_approved)),
+					'REG_ID',
+					true
+				);
+				break;
+
+			case '[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]':
+				return EEH_URL::add_query_args_and_nonce(
+					array(
+						'event_id' => $this->_event->ID(),
+						'page'     => 'espresso_registrations',
+						'action'   => 'default',
+					),
+					admin_url('admin.php'),
+					true
+				);
+				break;
+		}
+
+		if (strpos($shortcode, '[EVENT_META_*') !== false) {
+			// Strip the shortcode itself from $shortcode leaving any attributes set.
+			// Removing the * is correct here as _* is used to indiciate a dynamic shortcode.
+			$shortcode = str_replace('[EVENT_META_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+			// Get any attributes set on this shortcode.
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			// The meta_key set on the shortcode should always be the first value in the array.
+			$meta_key = $attrs[0];
+			// Pull the meta value from the event post.
+			$event_meta = $this->_event->get_post_meta($meta_key, true);
+			// If we have no event_meta, just return an empty string.
+			if (empty($event_meta)) {
+				return '';
+			}
+			// Add a filter to allow all instances of EVENT_META_* to run through do_shortcode, default to false.
+			// Check if a do_shortcode attribute was set to true and if so run $event_meta through that function.
+			if (apply_filters('FHEE__EventEspresso_core_libraries_shortcodes_EE_Event_Shortcodes___parser__event_meta_do_shortcode', false)
+				|| !empty($attrs['do_shortcode']) && filter_var($attrs['do_shortcode'], FILTER_VALIDATE_BOOLEAN)
+			) {
+				return do_shortcode($event_meta);
+			}
+			// Still here? We just need to return the event_meta value as is.
+			return $event_meta;
+		}
+
+		if (strpos($shortcode, '[EVENT_TOTAL_AVAILABLE_SPACES_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			$method = empty($attrs['method']) ? 'current' : $attrs['method'];
+			$method = $method === 'current';
+			$available = $this->_event->total_available_spaces($method);
+			return $available === EE_INF ? '&infin;' : $available;
+		}
+
+		if (strpos($shortcode, '[EVENT_IMAGE_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			$width = empty($attrs['width']) ? '' : ' width="' . $attrs['width'] . '"';
+			$height = empty($attrs['height']) ? '' : ' height="' . $attrs['height'] . '"';
+
+			// Size may be set to a string such as 'tumbnail' or "width, height" eg - '200,200'
+			if (! empty($attrs['size'])) {
+				$size = explode(',', $attrs['size']);
+				if (count($size) === 1) {
+					$size = $size[0];
+				}
+			} else {
+				$size = 'thumbnail';
+			}
+
+			$image = $this->_event->feature_image_url($size);
+
+			return ! empty($image)
+				? '<img src="' . $image . '" alt="'
+				  . sprintf(
+					  esc_attr__('%s Feature Image', 'event_espresso'),
+					  $this->_event->get('EVT_name')
+				  ) . '"' . $width . $height . '/>'
+				: '';
+		}
+
+		return '';
+	}
+
+
+	/**
+	 * returns the link to the event
+	 *
+	 * @param  boolean $full_link if TRUE (default) we return the html for the name of the event linked to the event.
+	 *                            Otherwise we just return the url of the event.
+	 * @return string
+	 */
+	private function _get_event_link($event, $full_link = true)
+	{
+		$url = get_permalink($event->ID());
+
+		return $full_link ? '<a href="' . $url . '">' . $event->get('EVT_name') . '</a>' : $url;
+	}
 }