eventespresso / event-espresso-core

core/helpers/EEH_Schema.helper.php

Indentation +272 added lines, -272 removed lines

@@ -12,276 +12,276 @@
 {
 
 
-    /**
-     * generates JSON-based linked data for an event
-     *
-     * @param EE_Event $event
-     * @throws EE_Error
-     */
-    public static function add_json_linked_data_for_event(EE_Event $event)
-    {
-        // Check we have a valid datetime for the event
-        if (! $event->primary_datetime() instanceof EE_Datetime) {
-            return;
-        }
-
-        $template_args = array(
-            'event_permalink' => '',
-            'event_name' => '',
-            'event_description' => '',
-            'event_start' => '',
-            'event_end' => '',
-            'currency' => '',
-            'event_tickets' => array(),
-            'venue_name' => '',
-            'venue_url' => '',
-            'venue_locality' => '',
-            'venue_region' => '',
-            'venue_address' => '',
-            'event_image' => '',
-        );
-        $template_args['event_permalink'] = $event->get_permalink();
-        $template_args['event_name'] = $event->name();
-        $template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
-        // clone datetime so that date formats don't override those for the original datetime
-        $primary_datetime = clone $event->primary_datetime();
-        $template_args['event_start'] = $primary_datetime->start_date(DateTime::ATOM);
-        $template_args['event_end'] = $primary_datetime->end_date(DateTime::ATOM);
-        unset($primary_datetime);
-        $template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
-        foreach ($event->tickets() as $original_ticket) {
-            // clone tickets so that date formats don't override those for the original ticket
-            $ticket= clone $original_ticket;
-            $ID = $ticket->ID();
-            $template_args['event_tickets'][ $ID ]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][ $ID ]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][ $ID ]['price'] = number_format(
-                $ticket->price(),
-                EE_Registry::instance()->CFG->currency->dec_plc,
-                EE_Registry::instance()->CFG->currency->dec_mrk,
-                ''
-            );
-            switch ($ticket->ticket_status()) {
-                case 'TKO':
-                    $availability = 'InStock';
-                    break;
-                case 'TKS':
-                    $availability = 'SoldOut';
-                    break;
-                default:
-                    $availability = null;
-                    break;
-            }
-            $template_args['event_tickets'][ $ID ]['availability'] = $availability;
-            unset($ticket);
-        }
-        $VNU_ID = espresso_venue_id();
-        if (! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
-            $venue = EEH_Venue_View::get_venue($VNU_ID);
-            $template_args['venue_name'] = get_the_title($VNU_ID);
-            $template_args['venue_url'] = get_permalink($VNU_ID);
-            $template_args['venue_locality'] = $venue->city();
-            $template_args['venue_region'] = $venue->state_name();
-            $template_args['venue_address'] = $venue->address();
-        }
-        $template_args['event_image'] = $event->feature_image_url();
-        $template_args = apply_filters(
-            'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
-            $template_args,
-            $event,
-            $VNU_ID
-        );
-        extract($template_args, EXTR_OVERWRITE);
-        include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
-    }
-
-
-    /**
-     *    location
-     *    The location of the event, organization or action.
-     *    Should include the Venue name AND schema formatted address info
-     *
-     * @access public
-     * @param string $location
-     * @return string
-     */
-    public static function location($location = null)
-    {
-        return ! empty($location) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
-                                      . $location
-                                      . '</div>' : '';
-    }
-
-
-
-    /**
-     *    name
-     *    The name of the Event or Venue.
-     *
-     * @access public
-     * @param string $name
-     * @return string
-     */
-    public static function name($name = null)
-    {
-        return ! empty($name) ? '<span itemprop="name">' . $name . '</span>' : '';
-    }
-
-
-
-    /**
-     *    streetAddress
-     *    The street address. For example, 1600 Amphitheatre Pkwy.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function streetAddress(EEI_Address $obj_with_address = null)
-    {
-        return $obj_with_address->address() !== null && $obj_with_address->address() !== ''
-            ? '<span itemprop="streetAddress">' . $obj_with_address->address() . '</span>' : '';
-    }
-
-
-
-    /**
-     *    postOfficeBoxNumber
-     *    The post office box number for PO box addresses.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function postOfficeBoxNumber(EEI_Address $obj_with_address = null)
-    {
-        // regex check for some form of PO Box or P.O. Box, etc, etc, etc
-        if (preg_match(
-            "/^\s*((P(OST)?.?\s*(O(FF(ICE)?)?)?.?\s+(B(IN|OX))?)|B(IN|OX))/i",
-            $obj_with_address->address2()
-        ) ) {
-            return $obj_with_address->address2() !== null && $obj_with_address->address2() !== ''
-                ? '<span itemprop="postOfficeBoxNumber">' . $obj_with_address->address2() . '</span>' : '';
-        } else {
-            return $obj_with_address->address2();
-        }
-    }
-
-
-
-    /**
-     *    addressLocality
-     *    The locality (city, town, etc). For example, Mountain View.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function addressLocality(EEI_Address $obj_with_address = null)
-    {
-        return $obj_with_address->city() !== null && $obj_with_address->city() !== ''
-            ? '<span itemprop="addressLocality">' . $obj_with_address->city() . '</span>' : '';
-    }
-
-
-
-    /**
-     *    addressRegion
-     *    The region (state, province, etc). For example, CA.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function addressRegion(EEI_Address $obj_with_address = null)
-    {
-        $state = $obj_with_address->state_name();
-        if (! empty($state)) {
-            return '<span itemprop="addressRegion">' . $state . '</span>';
-        } else {
-            return '';
-        }
-    }
-
-
-
-    /**
-     *    addressCountry
-     *    The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function addressCountry(EEI_Address $obj_with_address = null)
-    {
-        $country = $obj_with_address->country_name();
-        if (! empty($country)) {
-            return '<span itemprop="addressCountry">' . $country . '</span>';
-        } else {
-            return '';
-        }
-    }
-
-
-
-    /**
-     *    postalCode
-     *    The postal code. For example, 94043.
-     *
-     * @access public
-     * @param EEI_Address $obj_with_address
-     * @return string
-     */
-    public static function postalCode(EEI_Address $obj_with_address = null)
-    {
-        return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
-                                                                                      . $obj_with_address->zip()
-                                                                                      . '</span>' : '';
-    }
-
-
-
-    /**
-     *    telephone
-     *    The telephone number.
-     *
-     * @access public
-     * @param string $phone_nmbr
-     * @return string
-     */
-    public static function telephone($phone_nmbr = null)
-    {
-        return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">' . $phone_nmbr . '</span>'
-            : '';
-    }
-
-
-
-    /**
-     *    URL
-     *    URL of the item as a clickable link
-     *
-     * @access public
-     * @param string $url        - the URL that the link will resolve to
-     * @param string $text       - the text that will be used for the visible link
-     * @param array  $attributes - array of additional link attributes in  attribute_name => value pairs. ie: array( 'title' => 'click here', 'class' => 'link-class' )
-     * @return string (link)
-     */
-    public static function url($url = null, $text = null, $attributes = array())
-    {
-        // Check the URL includes a scheme
-        $parsed_url = parse_url($url);
-        if (empty($parsed_url['scheme'])) {
-            $url = 'http://' . ltrim($url, '/');
-        }
-
-        $atts = '';
-        foreach ($attributes as $attribute => $value) {
-            $atts .= ' ' . $attribute . '="' . $value . '"';
-        }
-        $text = $text !== null && $text !== '' ? $text : $url;
-        return $url !== null && $url !== '' ? '<a itemprop="url" href="' . $url . '"' . $atts . '>' . $text . '</a>'
-            : '';
-    }
+	/**
+	 * generates JSON-based linked data for an event
+	 *
+	 * @param EE_Event $event
+	 * @throws EE_Error
+	 */
+	public static function add_json_linked_data_for_event(EE_Event $event)
+	{
+		// Check we have a valid datetime for the event
+		if (! $event->primary_datetime() instanceof EE_Datetime) {
+			return;
+		}
+
+		$template_args = array(
+			'event_permalink' => '',
+			'event_name' => '',
+			'event_description' => '',
+			'event_start' => '',
+			'event_end' => '',
+			'currency' => '',
+			'event_tickets' => array(),
+			'venue_name' => '',
+			'venue_url' => '',
+			'venue_locality' => '',
+			'venue_region' => '',
+			'venue_address' => '',
+			'event_image' => '',
+		);
+		$template_args['event_permalink'] = $event->get_permalink();
+		$template_args['event_name'] = $event->name();
+		$template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
+		// clone datetime so that date formats don't override those for the original datetime
+		$primary_datetime = clone $event->primary_datetime();
+		$template_args['event_start'] = $primary_datetime->start_date(DateTime::ATOM);
+		$template_args['event_end'] = $primary_datetime->end_date(DateTime::ATOM);
+		unset($primary_datetime);
+		$template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
+		foreach ($event->tickets() as $original_ticket) {
+			// clone tickets so that date formats don't override those for the original ticket
+			$ticket= clone $original_ticket;
+			$ID = $ticket->ID();
+			$template_args['event_tickets'][ $ID ]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
+			$template_args['event_tickets'][ $ID ]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
+			$template_args['event_tickets'][ $ID ]['price'] = number_format(
+				$ticket->price(),
+				EE_Registry::instance()->CFG->currency->dec_plc,
+				EE_Registry::instance()->CFG->currency->dec_mrk,
+				''
+			);
+			switch ($ticket->ticket_status()) {
+				case 'TKO':
+					$availability = 'InStock';
+					break;
+				case 'TKS':
+					$availability = 'SoldOut';
+					break;
+				default:
+					$availability = null;
+					break;
+			}
+			$template_args['event_tickets'][ $ID ]['availability'] = $availability;
+			unset($ticket);
+		}
+		$VNU_ID = espresso_venue_id();
+		if (! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
+			$venue = EEH_Venue_View::get_venue($VNU_ID);
+			$template_args['venue_name'] = get_the_title($VNU_ID);
+			$template_args['venue_url'] = get_permalink($VNU_ID);
+			$template_args['venue_locality'] = $venue->city();
+			$template_args['venue_region'] = $venue->state_name();
+			$template_args['venue_address'] = $venue->address();
+		}
+		$template_args['event_image'] = $event->feature_image_url();
+		$template_args = apply_filters(
+			'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
+			$template_args,
+			$event,
+			$VNU_ID
+		);
+		extract($template_args, EXTR_OVERWRITE);
+		include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
+	}
+
+
+	/**
+	 *    location
+	 *    The location of the event, organization or action.
+	 *    Should include the Venue name AND schema formatted address info
+	 *
+	 * @access public
+	 * @param string $location
+	 * @return string
+	 */
+	public static function location($location = null)
+	{
+		return ! empty($location) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
+									  . $location
+									  . '</div>' : '';
+	}
+
+
+
+	/**
+	 *    name
+	 *    The name of the Event or Venue.
+	 *
+	 * @access public
+	 * @param string $name
+	 * @return string
+	 */
+	public static function name($name = null)
+	{
+		return ! empty($name) ? '<span itemprop="name">' . $name . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    streetAddress
+	 *    The street address. For example, 1600 Amphitheatre Pkwy.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function streetAddress(EEI_Address $obj_with_address = null)
+	{
+		return $obj_with_address->address() !== null && $obj_with_address->address() !== ''
+			? '<span itemprop="streetAddress">' . $obj_with_address->address() . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    postOfficeBoxNumber
+	 *    The post office box number for PO box addresses.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function postOfficeBoxNumber(EEI_Address $obj_with_address = null)
+	{
+		// regex check for some form of PO Box or P.O. Box, etc, etc, etc
+		if (preg_match(
+			"/^\s*((P(OST)?.?\s*(O(FF(ICE)?)?)?.?\s+(B(IN|OX))?)|B(IN|OX))/i",
+			$obj_with_address->address2()
+		) ) {
+			return $obj_with_address->address2() !== null && $obj_with_address->address2() !== ''
+				? '<span itemprop="postOfficeBoxNumber">' . $obj_with_address->address2() . '</span>' : '';
+		} else {
+			return $obj_with_address->address2();
+		}
+	}
+
+
+
+	/**
+	 *    addressLocality
+	 *    The locality (city, town, etc). For example, Mountain View.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function addressLocality(EEI_Address $obj_with_address = null)
+	{
+		return $obj_with_address->city() !== null && $obj_with_address->city() !== ''
+			? '<span itemprop="addressLocality">' . $obj_with_address->city() . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    addressRegion
+	 *    The region (state, province, etc). For example, CA.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function addressRegion(EEI_Address $obj_with_address = null)
+	{
+		$state = $obj_with_address->state_name();
+		if (! empty($state)) {
+			return '<span itemprop="addressRegion">' . $state . '</span>';
+		} else {
+			return '';
+		}
+	}
+
+
+
+	/**
+	 *    addressCountry
+	 *    The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function addressCountry(EEI_Address $obj_with_address = null)
+	{
+		$country = $obj_with_address->country_name();
+		if (! empty($country)) {
+			return '<span itemprop="addressCountry">' . $country . '</span>';
+		} else {
+			return '';
+		}
+	}
+
+
+
+	/**
+	 *    postalCode
+	 *    The postal code. For example, 94043.
+	 *
+	 * @access public
+	 * @param EEI_Address $obj_with_address
+	 * @return string
+	 */
+	public static function postalCode(EEI_Address $obj_with_address = null)
+	{
+		return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
+																					  . $obj_with_address->zip()
+																					  . '</span>' : '';
+	}
+
+
+
+	/**
+	 *    telephone
+	 *    The telephone number.
+	 *
+	 * @access public
+	 * @param string $phone_nmbr
+	 * @return string
+	 */
+	public static function telephone($phone_nmbr = null)
+	{
+		return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">' . $phone_nmbr . '</span>'
+			: '';
+	}
+
+
+
+	/**
+	 *    URL
+	 *    URL of the item as a clickable link
+	 *
+	 * @access public
+	 * @param string $url        - the URL that the link will resolve to
+	 * @param string $text       - the text that will be used for the visible link
+	 * @param array  $attributes - array of additional link attributes in  attribute_name => value pairs. ie: array( 'title' => 'click here', 'class' => 'link-class' )
+	 * @return string (link)
+	 */
+	public static function url($url = null, $text = null, $attributes = array())
+	{
+		// Check the URL includes a scheme
+		$parsed_url = parse_url($url);
+		if (empty($parsed_url['scheme'])) {
+			$url = 'http://' . ltrim($url, '/');
+		}
+
+		$atts = '';
+		foreach ($attributes as $attribute => $value) {
+			$atts .= ' ' . $attribute . '="' . $value . '"';
+		}
+		$text = $text !== null && $text !== '' ? $text : $url;
+		return $url !== null && $url !== '' ? '<a itemprop="url" href="' . $url . '"' . $atts . '>' . $text . '</a>'
+			: '';
+	}
 }