EEH_Schema - Code Metrics - Inspection of "Daily Inspection: make sure "is_espresso_page" is..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — BUG-10381-asset-loading (2dbb93)

unknown

created 2017-03-20 21:57 UTC

EEH_Schema B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	248
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	7

Importance

Changes

Metric	Value
dl	0
loc	248
rs	8.8
c	0
b	0
f	0
wmc	36
lcom	0
cbo	7

11 Methods

Rating	Name	Size	Complexity
B	add_json_linked_data_for_event()	56	5
A	location()	5	2
A	name()	3	2
A	streetAddress()	4	3
A	postOfficeBoxNumber()	12	4
A	addressLocality()	4	3
A	addressRegion()	8	2
A	addressCountry()	8	2
A	postalCode()	5	3
A	telephone()	4	3
B	url()	15	7

<?php

if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
	exit( 'No direct script access allowed' );
}



/**
 * Class EEH_Schema
 * This class is a collection of static methods for applying schema.org formatting to passed items
 *
 * @package       Event Espresso
 * @subpackage    /core/helpers/
 * @author        Brent Christensen
 */
class EEH_Schema {


    /**
     * generates JSON-based linked data for an event
     *
     * @param \EE_Event $event
     */
    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' => '',
            '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));
        $template_args['event_start'] = $event->primary_datetime()->start_date(DateTime::ATOM);
        $template_args['event_end'] = $event->primary_datetime()->end_date(DateTime::ATOM);
        $template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
        foreach ($event->tickets() as $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,
                EE_Registry::instance()->CFG->currency->thsnds
            );
        }
        $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['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() !== ''
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
			? '<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() !== ''
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
				? '<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() !== ''
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
			? '<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();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
		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();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
		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">'
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
		                                                                              . $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>'
			: '';
	}



}
// End of file EEH_Schema.helper.php
// Location: /EEH_Schema.helper.php

1			<?php
2
3			if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
4			exit( 'No direct script access allowed' );
5			}
6
7
8
9			/**
10			* Class EEH_Schema
11			* This class is a collection of static methods for applying schema.org formatting to passed items
12			*
13			* @package Event Espresso
14			* @subpackage /core/helpers/
15			* @author Brent Christensen
16			*/
17			class EEH_Schema {
18
19
20			/**
21			* generates JSON-based linked data for an event
22			*
23			* @param \EE_Event $event
24			*/
25			public static function add_json_linked_data_for_event(\EE_Event $event)
26			{
27			//Check we have a valid datetime for the event
28			if(! $event->primary_datetime() instanceof EE_Datetime) {
29			return;
30			}
31
32			$template_args = array(
33			'event_permalink' => '',
34			'event_name' => '',
35			'event_description' => '',
36			'event_start' => '',
37			'event_end' => '',
38			'currency' => '',
39			'event_tickets' => array(),
40			'venue_name' => '',
41			'venue_url' => '',
42			'venue_locality' => '',
43			'venue_region' => '',
44			'event_image' => '',
45			);
46			$template_args['event_permalink'] = $event->get_permalink();
47			$template_args['event_name'] = $event->name();
48			$template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
49			$template_args['event_start'] = $event->primary_datetime()->start_date(DateTime::ATOM);
50			$template_args['event_end'] = $event->primary_datetime()->end_date(DateTime::ATOM);
51			$template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
52			foreach ($event->tickets() as $ticket) {
53			$ID = $ticket->ID();
54			$template_args['event_tickets'][$ID]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
55			$template_args['event_tickets'][$ID]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
56			$template_args['event_tickets'][$ID]['price'] = number_format(
57			$ticket->price(),
58			EE_Registry::instance()->CFG->currency->dec_plc,
59			EE_Registry::instance()->CFG->currency->dec_mrk,
60			EE_Registry::instance()->CFG->currency->thsnds
61			);
62			}
63			$VNU_ID = espresso_venue_id();
64			if ( ! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
65			$venue = EEH_Venue_View::get_venue($VNU_ID);
66			$template_args['venue_name'] = get_the_title($VNU_ID);
67			$template_args['venue_url'] = get_permalink($VNU_ID);
68			$template_args['venue_locality'] = $venue->city();
69			$template_args['venue_region'] = $venue->state_name();
70			}
71			$template_args['event_image'] = $event->feature_image_url();
72			$template_args = apply_filters(
73			'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
74			$template_args,
75			$event,
76			$VNU_ID
77			);
78			extract($template_args, EXTR_OVERWRITE);
79			include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
80			}
81
82
83			/**
84			* location
85			* The location of the event, organization or action.
86			* Should include the Venue name AND schema formatted address info
87			*
88			* @access public
89			* @param string $location
90			* @return string
91			*/
92			public static function location( $location = null ) {
93			return ! empty( $location ) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
94			. $location
95			. '</div>' : '';
96			}
97
98
99
100			/**
101			* name
102			* The name of the Event or Venue.
103			*
104			* @access public
105			* @param string $name
106			* @return string
107			*/
108			public static function name( $name = null ) {
109			return ! empty( $name ) ? '<span itemprop="name">' . $name . '</span>' : '';
110			}
111
112
113
114			/**
115			* streetAddress
116			* The street address. For example, 1600 Amphitheatre Pkwy.
117			*
118			* @access public
119			* @param EEI_Address $obj_with_address
120			* @return string
121			*/
122			public static function streetAddress( EEI_Address $obj_with_address = null ) {
123			return $obj_with_address->address() !== null && $obj_with_address->address() !== ''
			0 ignored issues – show Bug introduced 2016-04-07 05:45 UTC by Report Bug Copy Issue Report It seems like `$obj_with_address` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
124			? '<span itemprop="streetAddress">' . $obj_with_address->address() . '</span>' : '';
125			}
126
127
128
129			/**
130			* postOfficeBoxNumber
131			* The post office box number for PO box addresses.
132			*
133			* @access public
134			* @param EEI_Address $obj_with_address
135			* @return string
136			*/
137			public static function postOfficeBoxNumber( EEI_Address $obj_with_address = null ) {
138			// regex check for some form of PO Box or P.O. Box, etc, etc, etc
139			if ( preg_match(
140			"/^\s((P(OST)?.?\s(O(FF(ICE)?)?)?.?\s+(B(IN\|OX))?)\|B(IN\|OX))/i",
141			$obj_with_address->address2()
142			) ) {
143			return $obj_with_address->address2() !== null && $obj_with_address->address2() !== ''
			0 ignored issues – show Bug introduced 2016-04-07 05:45 UTC by Report Bug Copy Issue Report It seems like `$obj_with_address` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
144			? '<span itemprop="postOfficeBoxNumber">' . $obj_with_address->address2() . '</span>' : '';
145			} else {
146			return $obj_with_address->address2();
147			}
148			}
149
150
151
152			/**
153			* addressLocality
154			* The locality (city, town, etc). For example, Mountain View.
155			*
156			* @access public
157			* @param EEI_Address $obj_with_address
158			* @return string
159			*/
160			public static function addressLocality( EEI_Address $obj_with_address = null ) {
161			return $obj_with_address->city() !== null && $obj_with_address->city() !== ''
			0 ignored issues – show Bug introduced 2016-04-07 05:45 UTC by Report Bug Copy Issue Report It seems like `$obj_with_address` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
162			? '<span itemprop="addressLocality">' . $obj_with_address->city() . '</span>' : '';
163			}
164
165
166
167			/**
168			* addressRegion
169			* The region (state, province, etc). For example, CA.
170			*
171			* @access public
172			* @param EEI_Address $obj_with_address
173			* @return string
174			*/
175			public static function addressRegion( EEI_Address $obj_with_address = null ) {
176			$state = $obj_with_address->state_name();
			0 ignored issues – show Bug introduced 2015-11-23 01:20 UTC by Report Bug Copy Issue Report It seems like `$obj_with_address` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
177			if ( ! empty( $state ) ) {
178			return '<span itemprop="addressRegion">' . $state . '</span>';
179			} else {
180			return '';
181			}
182			}
183
184
185
186			/**
187			* addressCountry
188			* The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
189			*
190			* @access public
191			* @param EEI_Address $obj_with_address
192			* @return string
193			*/
194			public static function addressCountry( EEI_Address $obj_with_address = null ) {
195			$country = $obj_with_address->country_name();
			0 ignored issues – show Bug introduced 2015-11-23 01:20 UTC by Report Bug Copy Issue Report It seems like `$obj_with_address` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
196			if ( ! empty( $country ) ) {
197			return '<span itemprop="addressCountry">' . $country . '</span>';
198			} else {
199			return '';
200			}
201			}
202
203
204
205			/**
206			* postalCode
207			* The postal code. For example, 94043.
208			*
209			* @access public
210			* @param EEI_Address $obj_with_address
211			* @return string
212			*/
213			public static function postalCode( EEI_Address $obj_with_address = null ) {
214			return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
			0 ignored issues – show Bug introduced 2015-11-23 01:20 UTC by Report Bug Copy Issue Report It seems like `$obj_with_address` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
215			. $obj_with_address->zip()
216			. '</span>' : '';
217			}
218
219
220
221			/**
222			* telephone
223			* The telephone number.
224			*
225			* @access public
226			* @param string $phone_nmbr
227			* @return string
228			*/
229			public static function telephone( $phone_nmbr = null ) {
230			return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">' . $phone_nmbr . '</span>'
231			: '';
232			}
233
234
235
236			/**
237			* URL
238			* URL of the item as a clickable link
239			*
240			* @access public
241			* @param string $url - the URL that the link will resolve to
242			* @param string $text - the text that will be used for the visible link
243			* @param array $attributes - array of additional link attributes in attribute_name => value pairs. ie: array( 'title' => 'click here', 'class' => 'link-class' )
244			* @return string (link)
245			*/
246			public static function url( $url = null, $text = null, $attributes = array() ) {
247			//Check the URL includes a scheme
248			$parsed_url = parse_url($url);
249			if ( empty($parsed_url['scheme']) ) {
250			$url = 'http://' . ltrim($url, '/');
251			}
252
253			$atts = '';
254			foreach ( $attributes as $attribute => $value ) {
255			$atts .= ' ' . $attribute . '="' . $value . '"';
256			}
257			$text = $text !== null && $text !== '' ? $text : $url;
258			return $url !== null && $url !== '' ? '<a itemprop="url" href="' . $url . '"' . $atts . '>' . $text . '</a>'
259			: '';
260			}
261
262
263
264			}
265			// End of file EEH_Schema.helper.php
266			// Location: /EEH_Schema.helper.php

eventespresso / event-espresso-core

Branch — BUG-10381-asset-loading (2dbb93)

EEH_Schema B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

Duplication Side-by-Side

Filter issues like