eventespresso / event-espresso-core

core/helpers/EEH_Template.helper.php

Spacing +212 added lines, -212 removed lines

@@ -15,7 +15,7 @@ 
 
 
 
-if ( ! function_exists( 'espresso_get_template_part' )) {
+if ( ! function_exists('espresso_get_template_part')) {
 	/**
 	 * espresso_get_template_part
 	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
@@ -25,14 +25,14 @@ 
 	 * @param string $name The name of the specialised template.
 	 * @return string        the html output for the formatted money value
 	 */
-	function espresso_get_template_part( $slug = NULL, $name = NULL ) {
-		EEH_Template::get_template_part( $slug, $name );
+	function espresso_get_template_part($slug = NULL, $name = NULL) {
+		EEH_Template::get_template_part($slug, $name);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_get_object_css_class' )) {
+if ( ! function_exists('espresso_get_object_css_class')) {
 	/**
 	 * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
 	 *
@@ -42,8 +42,8 @@ 
 	 * @param  string $suffix added to the end of the generated class
 	 * @return string
 	 */
-	function espresso_get_object_css_class( $object = NULL, $prefix = '', $suffix = '' ) {
-		return EEH_Template::get_object_css_class( $object, $prefix, $suffix );
+	function espresso_get_object_css_class($object = NULL, $prefix = '', $suffix = '') {
+		return EEH_Template::get_object_css_class($object, $prefix, $suffix);
 	}
 }
 
@@ -70,7 +70,7 @@ 
 	 * 	@return boolean
 	 */
 	public static function is_espresso_theme() {
-		return wp_get_theme()->get( 'TextDomain' ) == 'event_espresso' ? TRUE : FALSE;
+		return wp_get_theme()->get('TextDomain') == 'event_espresso' ? TRUE : FALSE;
 	}
 
 	/**
@@ -79,9 +79,9 @@ 
 	 * 	@return void
 	 */
 	public static function load_espresso_theme_functions() {
-		if ( ! defined( 'EE_THEME_FUNCTIONS_LOADED' )) {
-			if ( is_readable( EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php' )) {
-				require_once( EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php' );
+		if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
+			if (is_readable(EE_PUBLIC.EE_Config::get_current_theme().DS.'functions.php')) {
+				require_once(EE_PUBLIC.EE_Config::get_current_theme().DS.'functions.php');
 			}
 		}
 	}
@@ -93,17 +93,17 @@ 
 	 * 	@return array
 	 */
 	public static function get_espresso_themes() {
-		if ( empty( EEH_Template::$_espresso_themes )) {
-			$espresso_themes =  glob( EE_PUBLIC . '*', GLOB_ONLYDIR );
-			if ( empty( $espresso_themes ) ) {
+		if (empty(EEH_Template::$_espresso_themes)) {
+			$espresso_themes = glob(EE_PUBLIC.'*', GLOB_ONLYDIR);
+			if (empty($espresso_themes)) {
 				return array();
 			}
-			if (( $key = array_search( 'global_assets', $espresso_themes )) !== FALSE ) {
-			    unset( $espresso_themes[ $key ] );
+			if (($key = array_search('global_assets', $espresso_themes)) !== FALSE) {
+			    unset($espresso_themes[$key]);
 			}
 			EEH_Template::$_espresso_themes = array();
-			foreach ( $espresso_themes as $espresso_theme ) {
-				EEH_Template::$_espresso_themes[ basename( $espresso_theme ) ] = $espresso_theme;
+			foreach ($espresso_themes as $espresso_theme) {
+				EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme;
 			}
 		}
 		return EEH_Template::$_espresso_themes;
@@ -122,16 +122,16 @@ 
 	 * @param bool   $return_string
 	 * @return string        the html output for the formatted money value
 	 */
-	public static function get_template_part( $slug = NULL, $name = NULL, $template_args = array(), $return_string = FALSE  ) {
-		do_action( "get_template_part_{$slug}-{$name}", $slug, $name );
+	public static function get_template_part($slug = NULL, $name = NULL, $template_args = array(), $return_string = FALSE) {
+		do_action("get_template_part_{$slug}-{$name}", $slug, $name);
 		$templates = array();
 		$name = (string) $name;
-		if ( $name != '' ) {
+		if ($name != '') {
 			$templates[] = "{$slug}-{$name}.php";
 		}
 		// allow template parts to be turned off via something like: add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
-		if ( apply_filters( "FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", TRUE )) {
-			EEH_Template::locate_template( $templates, $template_args, TRUE, $return_string );
+		if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", TRUE)) {
+			EEH_Template::locate_template($templates, $template_args, TRUE, $return_string);
 		}
 	}
 
@@ -182,26 +182,26 @@ 
 	 * 				Used in places where you don't actually load the template, you just want to know if there's a custom version of it.
 	 * @return mixed
 	 */
-	public static function locate_template( $templates = array(), $template_args = array(), $load = TRUE, $return_string = TRUE, $check_if_custom = FALSE ) {
+	public static function locate_template($templates = array(), $template_args = array(), $load = TRUE, $return_string = TRUE, $check_if_custom = FALSE) {
 		// first use WP locate_template to check for template in the current theme folder
-		$template_path = locate_template( $templates );
+		$template_path = locate_template($templates);
 
-		if ( $check_if_custom && !empty( $template_path ) )
+		if ($check_if_custom && ! empty($template_path))
 			return TRUE;
 
 		// not in the theme
-		if ( empty( $template_path )) {
+		if (empty($template_path)) {
 			// not even a template to look for ?
-			if ( empty( $templates )) {
+			if (empty($templates)) {
 				// get post_type
-				$post_type = EE_Registry::instance()->REQ->get( 'post_type' );
+				$post_type = EE_Registry::instance()->REQ->get('post_type');
 				// get array of EE Custom Post Types
 				$EE_CPTs = EE_Register_CPTs::get_CPTs();
 				// build template name based on request
-				if ( isset( $EE_CPTs[ $post_type ] )) {
-					$archive_or_single =  is_archive() ? 'archive' : '';
-					$archive_or_single =  is_single() ? 'single' : $archive_or_single;
-					$templates = $archive_or_single . '-' . $post_type . '.php';
+				if (isset($EE_CPTs[$post_type])) {
+					$archive_or_single = is_archive() ? 'archive' : '';
+					$archive_or_single = is_single() ? 'single' : $archive_or_single;
+					$templates = $archive_or_single.'-'.$post_type.'.php';
 				}
 			}
 			// currently active EE template theme
@@ -210,81 +210,81 @@ 
 			// array of paths to folders that may contain templates
 			$template_folder_paths = array(
 				// first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-				EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+				EVENT_ESPRESSO_TEMPLATE_DIR.$current_theme,
 				// then in the root of the /wp-content/uploads/espresso/templates/ folder
 				EVENT_ESPRESSO_TEMPLATE_DIR
 			);
 
 			//add core plugin folders for checking only if we're not $check_if_custom
-			if ( ! $check_if_custom ) {
+			if ( ! $check_if_custom) {
 				$core_paths = array(
 					// in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-					EE_PUBLIC . $current_theme,
+					EE_PUBLIC.$current_theme,
 					// in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-					EE_TEMPLATES . $current_theme,
+					EE_TEMPLATES.$current_theme,
 					// or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
 					EE_PLUGIN_DIR_PATH
 					);
-				$template_folder_paths = array_merge( $template_folder_paths, $core_paths );
+				$template_folder_paths = array_merge($template_folder_paths, $core_paths);
 			}
 
 			// now filter that array
-			$template_folder_paths = apply_filters( 'FHEE__EEH_Template__locate_template__template_folder_paths', $template_folder_paths );
-			$templates = is_array( $templates ) ? $templates : array( $templates );
-			$template_folder_paths = is_array( $template_folder_paths ) ? $template_folder_paths : array( $template_folder_paths );
+			$template_folder_paths = apply_filters('FHEE__EEH_Template__locate_template__template_folder_paths', $template_folder_paths);
+			$templates = is_array($templates) ? $templates : array($templates);
+			$template_folder_paths = is_array($template_folder_paths) ? $template_folder_paths : array($template_folder_paths);
 			// array to hold all possible template paths
 			$full_template_paths = array();
 
 			// loop through $templates
-			foreach ( $templates as $template ) {
+			foreach ($templates as $template) {
 				// normalize directory separators
-				$template = EEH_File::standardise_directory_separators( $template );
-				$file_name = basename( $template );
-				$template_path_minus_file_name = substr( $template, 0, ( strlen( $file_name ) * -1 ) );
+				$template = EEH_File::standardise_directory_separators($template);
+				$file_name = basename($template);
+				$template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
 				// while looping through all template folder paths
-				foreach ( $template_folder_paths as $template_folder_path ) {
+				foreach ($template_folder_paths as $template_folder_path) {
 					// normalize directory separators
-					$template_folder_path = EEH_File::standardise_directory_separators( $template_folder_path );
+					$template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
 					// determine if any common base path exists between the two paths
 					$common_base_path = EEH_Template::_find_common_base_path(
-						array( $template_folder_path, $template_path_minus_file_name )
+						array($template_folder_path, $template_path_minus_file_name)
 					);
-					if ( $common_base_path !== '' ) {
+					if ($common_base_path !== '') {
 						// both paths have a common base, so just tack the filename onto our search path
-						$resolved_path = EEH_File::end_with_directory_separator( $template_folder_path ) . $file_name;
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$file_name;
 					} else {
 						// no common base path, so let's just concatenate
-						$resolved_path = EEH_File::end_with_directory_separator( $template_folder_path ) . $template;
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$template;
 					}
 					// build up our template locations array by adding our resolved paths
 					$full_template_paths[] = $resolved_path;
 				}
 				// if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
-				array_unshift( $full_template_paths, $template );
+				array_unshift($full_template_paths, $template);
 				// path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-				array_unshift( $full_template_paths, get_stylesheet_directory() . DS . $file_name );
+				array_unshift($full_template_paths, get_stylesheet_directory().DS.$file_name);
 			}
 			// filter final array of full template paths
-			$full_template_paths = apply_filters( 'FHEE__EEH_Template__locate_template__full_template_paths', $full_template_paths, $file_name );
+			$full_template_paths = apply_filters('FHEE__EEH_Template__locate_template__full_template_paths', $full_template_paths, $file_name);
 			// now loop through our final array of template location paths and check each location
-			foreach ( (array)$full_template_paths as $full_template_path ) {
-				if ( is_readable( $full_template_path )) {
-					$template_path = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR, $full_template_path );
+			foreach ((array) $full_template_paths as $full_template_path) {
+				if (is_readable($full_template_path)) {
+					$template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
 					// hook that can be used to display the full template path that will be used
-					do_action( 'AHEE__EEH_Template__locate_template__full_template_path', $template_path );
+					do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
 					break;
 				}
 			}
 		}
 		// if we got it and you want to see it...
-		if ( $template_path && $load && ! $check_if_custom  ) {
-			if ( $return_string ) {
-				return EEH_Template::display_template( $template_path, $template_args, TRUE );
+		if ($template_path && $load && ! $check_if_custom) {
+			if ($return_string) {
+				return EEH_Template::display_template($template_path, $template_args, TRUE);
 			} else {
-				EEH_Template::display_template( $template_path, $template_args, FALSE );
+				EEH_Template::display_template($template_path, $template_args, FALSE);
 			}
 		}
-		return $check_if_custom && ! empty( $template_path ) ? TRUE : $template_path;
+		return $check_if_custom && ! empty($template_path) ? TRUE : $template_path;
 	}
 
 
@@ -297,21 +297,21 @@ 
 	 * @param array $paths
 	 * @return string
 	 */
-	protected static function _find_common_base_path( $paths ) {
+	protected static function _find_common_base_path($paths) {
 		$last_offset = 0;
 		$common_base_path = '';
-		while ( ( $index = strpos( $paths[ 0 ], DS, $last_offset ) ) !== false ) {
+		while (($index = strpos($paths[0], DS, $last_offset)) !== false) {
 			$dir_length = $index - $last_offset + 1;
-			$directory = substr( $paths[ 0 ], $last_offset, $dir_length );
-			foreach ( $paths as $path ) {
-				if ( substr( $path, $last_offset, $dir_length ) != $directory ) {
+			$directory = substr($paths[0], $last_offset, $dir_length);
+			foreach ($paths as $path) {
+				if (substr($path, $last_offset, $dir_length) != $directory) {
 					return $common_base_path;
 				}
 			}
 			$common_base_path .= $directory;
 			$last_offset = $index + 1;
 		}
-		return substr( $common_base_path, 0, -1 );
+		return substr($common_base_path, 0, -1);
 	}
 
 
@@ -323,7 +323,7 @@ 
 	 * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
 	 * @return mixed string
 	 */
-	public static function display_template( $template_path = FALSE, $template_args = array(), $return_string = FALSE ) {
+	public static function display_template($template_path = FALSE, $template_args = array(), $return_string = FALSE) {
 
 		/**
 		 * These two filters are intended for last minute changes to templates being loaded and/or template arg
@@ -334,26 +334,26 @@ 
 		 *
 		 * @since 4.6.0
 		 */
-		$template_path = apply_filters( 'FHEE__EEH_Template__display_template__template_path', $template_path );
-		$template_args = apply_filters( 'FHEE__EEH_Template__display_template__template_args', $template_args );
+		$template_path = apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
+		$template_args = apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
 
 		// you gimme nuttin - YOU GET NUTTIN !!
-		if ( ! $template_path || ! is_readable( $template_path )) {
+		if ( ! $template_path || ! is_readable($template_path)) {
 			return '';
 		}
 		// if $template_args are not in an array, then make it so
-		if ( ! is_array( $template_args ) && ! is_object( $template_args )) {
-			$template_args = array( $template_args );
+		if ( ! is_array($template_args) && ! is_object($template_args)) {
+			$template_args = array($template_args);
 		}
-		extract( (array) $template_args);
+		extract((array) $template_args);
 
-		if ( $return_string ) {
+		if ($return_string) {
 			// because we want to return a string, we are going to capture the output
 			ob_start();
-			include( $template_path );
+			include($template_path);
 			return ob_get_clean();
 		} else {
-			include( $template_path );
+			include($template_path);
 		}
 		return '';
 	}
@@ -371,27 +371,27 @@ 
 	 * @param  string $suffix added to the end of the generated class
 	 * @return string
 	 */
-	public static function get_object_css_class( $object = NULL, $prefix = '', $suffix = '' ) {
+	public static function get_object_css_class($object = NULL, $prefix = '', $suffix = '') {
 		// in the beginning...
-		$prefix = ! empty( $prefix ) ? rtrim( $prefix, '-' ) . '-' : '';
+		$prefix = ! empty($prefix) ? rtrim($prefix, '-').'-' : '';
 		// da muddle
 		$class = '';
 		// the end
-		$suffix = ! empty( $suffix ) ? '-' . ltrim( $suffix, '-' ) : '';
+		$suffix = ! empty($suffix) ? '-'.ltrim($suffix, '-') : '';
 		// is the passed object an EE object ?
-		if ( $object instanceof EE_Base_Class ) {
+		if ($object instanceof EE_Base_Class) {
 			// grab the exact type of object
-			$obj_class = get_class( $object );
+			$obj_class = get_class($object);
 			// depending on the type of object...
-			switch ( $obj_class ) {
+			switch ($obj_class) {
 				// no specifics just yet...
 				default :
-					$class = strtolower( str_replace( '_', '-', $obj_class ));
-					$class .= method_exists( $obj_class, 'name' ) ? '-' . sanitize_title( $object->name() ) : '';
+					$class = strtolower(str_replace('_', '-', $obj_class));
+					$class .= method_exists($obj_class, 'name') ? '-'.sanitize_title($object->name()) : '';
 
 			}
 		}
-		return $prefix . $class . $suffix;
+		return $prefix.$class.$suffix;
 	}
 
 
@@ -407,54 +407,54 @@ 
 	 * @param string      $cur_code_span_class
 	 * @return string        the html output for the formatted money value
 	 */
-	public static function format_currency( $amount = NULL, $return_raw = FALSE, $display_code = TRUE, $CNT_ISO = '', $cur_code_span_class = 'currency-code' ) {
+	public static function format_currency($amount = NULL, $return_raw = FALSE, $display_code = TRUE, $CNT_ISO = '', $cur_code_span_class = 'currency-code') {
 		// ensure amount was received
-		if ( is_null( $amount ) ) {
-			$msg = __( 'In order to format currency, an amount needs to be passed.', 'event_espresso' );
-			EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ );
+		if (is_null($amount)) {
+			$msg = __('In order to format currency, an amount needs to be passed.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
 			return '';
 		}
 		//ensure amount is float
-		$amount = apply_filters( 'FHEE__EEH_Template__format_currency__raw_amount', (float) $amount );
-		$CNT_ISO = apply_filters( 'FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount );
+		$amount = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
+		$CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
 		// filter raw amount (allows 0.00 to be changed to "free" for example)
-		$amount_formatted = apply_filters( 'FHEE__EEH_Template__format_currency__amount', $amount, $return_raw );
+		$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
 		// still a number or was amount converted to a string like "free" ?
-		if ( is_float( $amount_formatted )) {
+		if (is_float($amount_formatted)) {
 			// was a country ISO code passed ? if so generate currency config object for that country
-			$mny = $CNT_ISO !== '' ? new EE_Currency_Config( $CNT_ISO ) : NULL;
+			$mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : NULL;
 			// verify results
-			if ( ! $mny instanceof EE_Currency_Config ) {
+			if ( ! $mny instanceof EE_Currency_Config) {
 				// set default config country currency settings
 				$mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config ? EE_Registry::instance()->CFG->currency : new EE_Currency_Config();
 			}
 			// format float
-			$amount_formatted = number_format( $amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds );
+			$amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
 			// add formatting ?
-			if ( ! $return_raw ) {
+			if ( ! $return_raw) {
 				// add currency sign
-				if( $mny->sign_b4 ){
-					if( $amount >= 0 ){
-						$amount_formatted = $mny->sign . $amount_formatted;
-					}else{
-						$amount_formatted = '-' . $mny->sign . str_replace( '-', '', $amount_formatted );
+				if ($mny->sign_b4) {
+					if ($amount >= 0) {
+						$amount_formatted = $mny->sign.$amount_formatted;
+					} else {
+						$amount_formatted = '-'.$mny->sign.str_replace('-', '', $amount_formatted);
 					}
 
-				}else{
-					$amount_formatted =  $amount_formatted . $mny->sign;
+				} else {
+					$amount_formatted = $amount_formatted.$mny->sign;
 				}
 
 				// filter to allow global setting of display_code
-				$display_code = apply_filters( 'FHEE__EEH_Template__format_currency__display_code', $display_code );
+				$display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
 
 				// add currency code ?
-				$amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
+				$amount_formatted = $display_code ? $amount_formatted.' <span class="'.$cur_code_span_class.'">('.$mny->code.')</span>' : $amount_formatted;
 			}
 			// filter results
-			$amount_formatted = apply_filters( 'FHEE__EEH_Template__format_currency__amount_formatted', $amount_formatted, $mny, $return_raw );
+			$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount_formatted', $amount_formatted, $mny, $return_raw);
 		}
 		// clean up vars
-		unset( $mny );
+		unset($mny);
 		// return formatted currency amount
 		return $amount_formatted;
 	}
@@ -469,11 +469,11 @@ 
 	 * @param  string  $schema    'UPPER', 'lower', or 'Sentence'
 	 * @return string             The localized label for the status id.
 	 */
-	public static function pretty_status( $status_id, $plural = FALSE, $schema = 'upper' ) {
+	public static function pretty_status($status_id, $plural = FALSE, $schema = 'upper') {
 		/** @type EEM_Status $EEM_Status */
-		$EEM_Status = EE_Registry::instance()->load_model( 'Status' );
-		$status = $EEM_Status->localized_status( array( $status_id => __( 'unknown', 'event_espresso' )), $plural, $schema );
-		return $status[ $status_id ];
+		$EEM_Status = EE_Registry::instance()->load_model('Status');
+		$status = $EEM_Status->localized_status(array($status_id => __('unknown', 'event_espresso')), $plural, $schema);
+		return $status[$status_id];
 	}
 
 
@@ -488,21 +488,21 @@ 
 	 * @param string  $title
 	 * @return string the html output for the button
 	 */
-	public static function get_button_or_link( $url, $label, $class = 'button-primary', $icon = '', $title = '' ) {
+	public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '') {
 		$icon_html = '';
-		if ( ! empty( $icon ) ) {
-			$dashicons = preg_split( "(ee-icon |dashicons )", $icon );
-			$dashicons = array_filter( $dashicons );
-			$count = count( $dashicons );
+		if ( ! empty($icon)) {
+			$dashicons = preg_split("(ee-icon |dashicons )", $icon);
+			$dashicons = array_filter($dashicons);
+			$count = count($dashicons);
 			$icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
-			foreach ( $dashicons as $dashicon ) {
-				$type = strpos( $dashicon, 'ee-icon' ) !== false ? 'ee-icon ' : 'dashicons ';
-				$icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+			foreach ($dashicons as $dashicon) {
+				$type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+				$icon_html .= '<span class="'.$type.$dashicon.'"></span>';
 			}
 			$icon_html .= $count > 1 ? '</span>' : '';
 		}
-		$label = ! empty( $icon ) ? $icon_html . $label : $label;
-		$button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . $url . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
+		$label = ! empty($icon) ? $icon_html.$label : $label;
+		$button = '<a id="'.sanitize_title_with_dashes($label).'" href="'.$url.'" class="'.$class.'" title="'.$title.'">'.$label.'</a>';
 		return $button;
 	}
 
@@ -519,21 +519,21 @@ 
 	 * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
 	 * @return string              generated link
 	 */
-	public static function get_help_tab_link( $help_tab_id, $page = FALSE, $action = FALSE, $icon_style = FALSE, $help_text = FALSE ) {
+	public static function get_help_tab_link($help_tab_id, $page = FALSE, $action = FALSE, $icon_style = FALSE, $help_text = FALSE) {
 
-		if ( ! $page )
-			$page = isset( $_REQUEST['page'] ) && ! empty( $_REQUEST['page'] ) ? sanitize_key( $_REQUEST['page'] ) : $page;
+		if ( ! $page)
+			$page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
 
-		if ( ! $action )
-			$action = isset( $_REQUEST['action'] ) && ! empty( $_REQUEST['action'] ) ? sanitize_key( $_REQUEST['action'] ) : $action;
+		if ( ! $action)
+			$action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
 
 		$action = empty($action) ? 'default' : $action;
 
 
-		$help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
-		$icon = !$icon_style ? ' dashicons-editor-help' : $icon_style;
-		$help_text = !$help_text ? '' : $help_text;
-		return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__('Click to open the \'Help\' tab for more information about this feature.', 'event_espresso') . '" > ' . $help_text . ' </a>';
+		$help_tab_lnk = $page.'-'.$action.'-'.$help_tab_id;
+		$icon = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
+		$help_text = ! $help_text ? '' : $help_text;
+		return '<a id="'.$help_tab_lnk.'" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22'.$icon.'" title="'.esc_attr__('Click to open the \'Help\' tab for more information about this feature.', 'event_espresso').'" > '.$help_text.' </a>';
 	}
 
 
@@ -545,31 +545,31 @@ 
 	 * @param EE_Help_Tour
 	 * @return string         html
 	 */
-	public static function help_tour_stops_generator( EE_Help_Tour $tour ) {
+	public static function help_tour_stops_generator(EE_Help_Tour $tour) {
 		$id = $tour->get_slug();
 		$stops = $tour->get_stops();
 
-		$content = '<ol style="display:none" id="' . $id . '">';
+		$content = '<ol style="display:none" id="'.$id.'">';
 
-		foreach ( $stops as $stop ) {
-			$data_id = !empty( $stop['id'] ) ? ' data-id="' . $stop['id'] . '"' : '';
-			$data_class = empty( $data_id ) && !empty( $stop['class'] ) ? ' data-class="' . $stop['class'] . '"' : '';
+		foreach ($stops as $stop) {
+			$data_id = ! empty($stop['id']) ? ' data-id="'.$stop['id'].'"' : '';
+			$data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="'.$stop['class'].'"' : '';
 
 			//if container is set to modal then let's make sure we set the options accordingly
-			if ( empty( $data_id ) && empty( $data_class ) ) {
+			if (empty($data_id) && empty($data_class)) {
 				$stop['options']['modal'] = true;
 				$stop['options']['expose'] = true;
 			}
 
-			$custom_class = !empty( $stop['custom_class'] ) ? ' class="' . $stop['custom_class'] . '"' : '';
-			$button_text = !empty( $stop['button_text'] ) ? ' data-button="' . $stop['button_text'] . '"' : '';
+			$custom_class = ! empty($stop['custom_class']) ? ' class="'.$stop['custom_class'].'"' : '';
+			$button_text = ! empty($stop['button_text']) ? ' data-button="'.$stop['button_text'].'"' : '';
 			$inner_content = isset($stop['content']) ? $stop['content'] : '';
 
 			//options
-			if ( isset( $stop['options'] ) && is_array( $stop['options'] ) ) {
+			if (isset($stop['options']) && is_array($stop['options'])) {
 				$options = ' data-options="';
-				foreach ( $stop['options'] as $option => $value ) {
-					$options .= $option . ':' . $value . ';';
+				foreach ($stop['options'] as $option => $value) {
+					$options .= $option.':'.$value.';';
 				}
 				$options .= '"';
 			} else {
@@ -577,7 +577,7 @@ 
 			}
 
 			//let's put all together
-			$content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
+			$content .= '<li'.$data_id.$data_class.$custom_class.$button_text.$options.'>'.$inner_content.'</li>';
 		}
 
 		$content .= '</ol>';
@@ -598,31 +598,31 @@ 
 	 * @throws EE_Error
 	 * @return string               html structure for status.
 	 */
-	public static function status_legend( $status_array, $active_status = '' ) {
-		if ( !is_array( $status_array ) )
-			throw new EE_Error( __('The EEH_Template::status_legend helper required the incoming status_array argument to be an array!', 'event_espresso') );
+	public static function status_legend($status_array, $active_status = '') {
+		if ( ! is_array($status_array))
+			throw new EE_Error(__('The EEH_Template::status_legend helper required the incoming status_array argument to be an array!', 'event_espresso'));
 
 		$setup_array = array();
-		foreach ( $status_array as $item => $status ) {
+		foreach ($status_array as $item => $status) {
 			$setup_array[$item] = array(
-					'class' => 'ee-status-legend ee-status-legend-' . $status,
-					'desc' => EEH_Template::pretty_status( $status, FALSE, 'sentence' ),
+					'class' => 'ee-status-legend ee-status-legend-'.$status,
+					'desc' => EEH_Template::pretty_status($status, FALSE, 'sentence'),
 					'status' => $status
 				);
 		}
 
-		$content = '<div class="ee-list-table-legend-container">' . "\n";
-		$content .= '<h3>' . __('Status Legend', 'event_espresso') . '</h3>' . "\n";
-		$content .= '<dl class="ee-list-table-legend">' . "\n\t";
-		foreach ( $setup_array as $item => $details ) {
+		$content = '<div class="ee-list-table-legend-container">'."\n";
+		$content .= '<h3>'.__('Status Legend', 'event_espresso').'</h3>'."\n";
+		$content .= '<dl class="ee-list-table-legend">'."\n\t";
+		foreach ($setup_array as $item => $details) {
 			$active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
-			$content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
-			$content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
-			$content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
-			$content .= '</dt>' . "\n";
+			$content .= '<dt id="ee-legend-item-tooltip-'.$item.'"'.$active_class.'>'."\n\t\t";
+			$content .= '<span class="'.$details['class'].'"></span>'."\n\t\t";
+			$content .= '<span class="ee-legend-description">'.$details['desc'].'</span>'."\n\t";
+			$content .= '</dt>'."\n";
 		}
-		$content .= '</dl>' . "\n";
-		$content .= '</div>' . "\n";
+		$content .= '</dl>'."\n";
+		$content .= '</div>'."\n";
 		return $content;
 	}
 
@@ -635,8 +635,8 @@ 
 	 * @return string
 	 */
 	public static function layout_array_as_table($data) {
-	if (is_object($data) || $data instanceof __PHP_Incomplete_Class ) {
-		$data = (array)$data;
+	if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
+		$data = (array) $data;
 	}
 	ob_start();
 	if (is_array($data)) {
@@ -649,10 +649,10 @@ 
 						?>
 						<tr>
 							<td>
-								<?php echo $data_key;?>
+								<?php echo $data_key; ?>
 							</td>
 							<td>
-								<?php echo self::layout_array_as_table($data_values);?>
+								<?php echo self::layout_array_as_table($data_values); ?>
 							</td>
 						</tr>
 						<?php
@@ -666,7 +666,7 @@ 
 			<ul>
 				<?php
 				foreach ($data as $datum) {
-					echo "<li>"; echo self::layout_array_as_table($datum);echo "</li>";
+					echo "<li>"; echo self::layout_array_as_table($datum); echo "</li>";
 				}?>
 			</ul>
 			<?php
@@ -696,8 +696,8 @@ 
 	 *
 	 * @return string
 	 */
-	public static function paging_html( $total_items, $current, $per_page, $url, $show_num_field = TRUE, $paged_arg_name = 'paged', $items_label = array() ) {
-		echo self::get_paging_html( $total_items, $current, $per_page, $url, $show_num_field, $paged_arg_name, $items_label );
+	public static function paging_html($total_items, $current, $per_page, $url, $show_num_field = TRUE, $paged_arg_name = 'paged', $items_label = array()) {
+		echo self::get_paging_html($total_items, $current, $per_page, $url, $show_num_field, $paged_arg_name, $items_label);
 	}
 
 
@@ -721,13 +721,13 @@ 
 	 *                                 )
 	 * @return  string
 	 */
-	public static function get_paging_html( $total_items, $current, $per_page, $url, $show_num_field = TRUE, $paged_arg_name = 'paged', $items_label = array() ) {
+	public static function get_paging_html($total_items, $current, $per_page, $url, $show_num_field = TRUE, $paged_arg_name = 'paged', $items_label = array()) {
 		$page_links = array();
 		$disable_first = $disable_last = '';
 		$total_items = (int) $total_items;
 		$per_page = (int) $per_page;
 		$current = (int) $current;
-		$paged_arg_name = empty( $paged_arg_name ) ? 'paged' : sanitize_key( $paged_arg_name );
+		$paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
 
 		//filter items_label
 		$items_label = apply_filters(
@@ -735,68 +735,68 @@ 
 			$items_label
 		);
 
-		if ( empty( $items_label )
-		     || ! is_array( $items_label )
-		     || ! isset( $items_label['single'] )
-		     || ! isset( $items_label['plural'] ) ) {
+		if (empty($items_label)
+		     || ! is_array($items_label)
+		     || ! isset($items_label['single'])
+		     || ! isset($items_label['plural'])) {
 			$items_label = array(
-				'single' => __( '1 item', 'event_espresso' ),
-				'plural' => __( '%s items', 'event_espresso' )
+				'single' => __('1 item', 'event_espresso'),
+				'plural' => __('%s items', 'event_espresso')
 			);
 		} else {
 			$items_label = array(
-				'single' => '1 ' . esc_html( $items_label['single'] ),
-				'plural' => '%s ' . esc_html( $items_label['plural'] )
+				'single' => '1 '.esc_html($items_label['single']),
+				'plural' => '%s '.esc_html($items_label['plural'])
 			);
 		}
 
-		$total_pages = ceil( $total_items / $per_page );
+		$total_pages = ceil($total_items / $per_page);
 
-		if ( $total_pages <= 1 )
+		if ($total_pages <= 1)
 			return '';
 
-		$item_label = $total_items > 1 ? sprintf( $items_label['plural'], $total_items ) : $items_label['single'];
+		$item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
 
-		$output = '<span class="displaying-num">' . $item_label . '</span>';
+		$output = '<span class="displaying-num">'.$item_label.'</span>';
 
-		if ( $current === 1 ) {
+		if ($current === 1) {
 			$disable_first = ' disabled';
 		}
-		if ( $current == $total_pages ) {
+		if ($current == $total_pages) {
 			$disable_last = ' disabled';
 		}
 
-		$page_links[] = sprintf( "<a class='%s' title='%s' href='%s'>%s</a>",
-			'first-page' . $disable_first,
-			esc_attr__( 'Go to the first page' ),
-			esc_url( remove_query_arg( $paged_arg_name, $url ) ),
+		$page_links[] = sprintf("<a class='%s' title='%s' href='%s'>%s</a>",
+			'first-page'.$disable_first,
+			esc_attr__('Go to the first page'),
+			esc_url(remove_query_arg($paged_arg_name, $url)),
 			'&laquo;'
 		);
 
 		$page_links[] = sprintf(
 			'<a class="%s" title="%s" href="%s">%s</a>',
-			'prev-page' . $disable_first,
-			esc_attr__( 'Go to the previous page' ),
-			esc_url( add_query_arg( $paged_arg_name, max( 1, $current-1 ), $url ) ),
+			'prev-page'.$disable_first,
+			esc_attr__('Go to the previous page'),
+			esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
 			'&lsaquo;'
 		);
 
-		if ( ! $show_num_field ) {
+		if ( ! $show_num_field) {
 			$html_current_page = $current;
 		} else {
-			$html_current_page = sprintf( "<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
-				esc_attr__( 'Current page' ),
+			$html_current_page = sprintf("<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
+				esc_attr__('Current page'),
 				$current,
-				strlen( $total_pages )
+				strlen($total_pages)
 			);
 		}
 
 		$html_total_pages = sprintf(
 			'<span class="total-pages">%s</span>',
-			number_format_i18n( $total_pages )
+			number_format_i18n($total_pages)
 		);
 		$page_links[] = sprintf(
-			_x( '%3$s%1$s of %2$s%4$s', 'paging' ),
+			_x('%3$s%1$s of %2$s%4$s', 'paging'),
 			$html_current_page,
 			$html_total_pages,
 			'<span class="paging-input">',
@@ -805,29 +805,29 @@ 
 
 		$page_links[] = sprintf(
 			'<a class="%s" title="%s" href="%s">%s</a>',
-			'next-page' . $disable_last,
-			esc_attr__( 'Go to the next page' ),
-			esc_url( add_query_arg( $paged_arg_name, min( $total_pages, $current+1 ), $url ) ),
+			'next-page'.$disable_last,
+			esc_attr__('Go to the next page'),
+			esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
 			'&rsaquo;'
 		);
 
 		$page_links[] = sprintf(
 			'<a class="%s" title="%s" href="%s">%s</a>',
-			'last-page' . $disable_last,
-			esc_attr__( 'Go to the last page' ),
-			esc_url( add_query_arg( $paged_arg_name, $total_pages, $url ) ),
+			'last-page'.$disable_last,
+			esc_attr__('Go to the last page'),
+			esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
 			'&raquo;'
 		);
 
-		$output .= "\n" . '<span class="pagination-links">' . join( "\n", $page_links ) . '</span>';
+		$output .= "\n".'<span class="pagination-links">'.join("\n", $page_links).'</span>';
 		// set page class
-		if ( $total_pages ) {
+		if ($total_pages) {
 			$page_class = $total_pages < 2 ? ' one-page' : '';
 		} else {
 			$page_class = ' no-pages';
 		}
 
-		return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+		return '<div class="tablenav"><div class="tablenav-pages'.$page_class.'">'.$output.'</div></div>';
 	}
 
 
@@ -843,7 +843,7 @@ 
 //add_filter( 'FHEE__EEH_Template__format_currency__amount', 'convert_zero_to_free', 10, 2 );
 
 
-if ( ! function_exists( 'espresso_pagination' ) ) {
+if ( ! function_exists('espresso_pagination')) {
 	/**
 	 *    espresso_pagination
 	 *
@@ -855,21 +855,21 @@ 
 		$big = 999999999; // need an unlikely integer
 		$pagination = paginate_links(
 		array(
-		'base'         => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+		'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
 		'format'       => '?paged=%#%',
-		'current'      => max( 1, get_query_var( 'paged' ) ),
+		'current'      => max(1, get_query_var('paged')),
 		'total'        => $wp_query->max_num_pages,
 		'show_all'     => true,
 		'end_size'     => 10,
 		'mid_size'     => 6,
 		'prev_next'    => true,
-		'prev_text'    => __( '&lsaquo; PREV', 'event_espresso' ),
-		'next_text'    => __( 'NEXT &rsaquo;', 'event_espresso' ),
+		'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
+		'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
 		'type'         => 'plain',
 		'add_args'     => false,
 		'add_fragment' => ''
 		)
 		);
-		echo ! empty( $pagination ) ? '<div class="ee-pagination-dv clear">' . $pagination . '</div>' : '';
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv clear">'.$pagination.'</div>' : '';
 	}
 }
\ No newline at end of file

payment_methods/Paypal_Standard/EE_Paypal_Standard_Form.form.php

Spacing +37 added lines, -37 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 /**
@@ -21,35 +21,35 @@ 
 	/**
 	 * @param EE_PMT_Paypal_Standard $payment_method_type
 	 */
-	public function __construct( $payment_method_type ){
+	public function __construct($payment_method_type) {
 		parent::__construct(
 			array(
 				'payment_method_type'          => $payment_method_type,
 				'extra_meta_inputs'            => array(
-					'paypal_id'        => new EE_Text_Input( array(
-						'html_label_text' => sprintf( __( "Paypal Email %s", 'event_espresso' ), $payment_method_type->get_help_tab_link() ),
-						'html_help_text'  => __( "Typically payment@example-domain.com", 'event_espresso' ),
+					'paypal_id'        => new EE_Text_Input(array(
+						'html_label_text' => sprintf(__("Paypal Email %s", 'event_espresso'), $payment_method_type->get_help_tab_link()),
+						'html_help_text'  => __("Typically payment@example-domain.com", 'event_espresso'),
 						'required'        => true
-					) ),
-					'image_url'        => new EE_Admin_File_Uploader_Input( array(
-						'html_help_text'  => __( "Used for your business/personal logo on the PayPal page", 'event_espresso' ),
-						'html_label_text' => __( 'Image URL', 'event_espresso' )
-					) ),
-					'paypal_taxes'     => new EE_Yes_No_Input( array(
-						'html_label_text' => sprintf( __( 'Paypal Calculates Taxes %s', 'event_espresso' ), $payment_method_type->get_help_tab_link() ),
-						'html_help_text'  => __( 'Whether Paypal should add taxes to the order', 'event_espresso' ),
+					)),
+					'image_url'        => new EE_Admin_File_Uploader_Input(array(
+						'html_help_text'  => __("Used for your business/personal logo on the PayPal page", 'event_espresso'),
+						'html_label_text' => __('Image URL', 'event_espresso')
+					)),
+					'paypal_taxes'     => new EE_Yes_No_Input(array(
+						'html_label_text' => sprintf(__('Paypal Calculates Taxes %s', 'event_espresso'), $payment_method_type->get_help_tab_link()),
+						'html_help_text'  => __('Whether Paypal should add taxes to the order', 'event_espresso'),
 						'default'         => false
-					) ),
-					'paypal_shipping'  => new EE_Yes_No_Input( array(
-						'html_label_text' => sprintf( __( 'Paypal Calculates Shipping %s', 'event_espresso' ), $payment_method_type->get_help_tab_link() ),
-						'html_help_text'  => __( 'Whether Paypal should add shipping surcharges', 'event_espresso' ),
+					)),
+					'paypal_shipping'  => new EE_Yes_No_Input(array(
+						'html_label_text' => sprintf(__('Paypal Calculates Shipping %s', 'event_espresso'), $payment_method_type->get_help_tab_link()),
+						'html_help_text'  => __('Whether Paypal should add shipping surcharges', 'event_espresso'),
 						'default'         => false
-					) ),
-					'shipping_details' => new EE_Select_Input( array(
-						EE_PMT_Paypal_Standard::shipping_info_none     => __( "Do not prompt for an address", 'event_espresso' ),
-						EE_PMT_Paypal_Standard::shipping_info_optional => __( "Prompt for an address, but do not require it", 'event_espresso' ),
-						EE_PMT_Paypal_Standard::shipping_info_required => __( "Prompt for an address, and require it", 'event_espresso' )
-					) )
+					)),
+					'shipping_details' => new EE_Select_Input(array(
+						EE_PMT_Paypal_Standard::shipping_info_none     => __("Do not prompt for an address", 'event_espresso'),
+						EE_PMT_Paypal_Standard::shipping_info_optional => __("Prompt for an address, but do not require it", 'event_espresso'),
+						EE_PMT_Paypal_Standard::shipping_info_required => __("Prompt for an address, and require it", 'event_espresso')
+					))
 				)
 			)
 		);
@@ -60,28 +60,28 @@ 
 	/**
 	 * @param array $req_data
 	 */
-	protected function _normalize( $req_data ) {
-		parent::_normalize( $req_data );
-		$paypal_calculates_shipping = $this->get_input_value( 'paypal_shipping' );
-		$paypal_calculates_taxes = $this->get_input_value( 'paypal_taxes' );
-		$paypal_requests_address_info = $this->get_input_value( 'shipping_details' );
+	protected function _normalize($req_data) {
+		parent::_normalize($req_data);
+		$paypal_calculates_shipping = $this->get_input_value('paypal_shipping');
+		$paypal_calculates_taxes = $this->get_input_value('paypal_taxes');
+		$paypal_requests_address_info = $this->get_input_value('shipping_details');
 		if (
-			( $paypal_calculates_shipping || $paypal_calculates_taxes ) &&
+			($paypal_calculates_shipping || $paypal_calculates_taxes) &&
 			$paypal_requests_address_info == EE_PMT_Paypal_Standard::shipping_info_none
 		) {
 			//they want paypal to calculate taxes or shipping. They need to ask for
 			//address info, otherwise paypal can't calculate taxes or shipping
 			/** @type EE_Select_Input $shipping_details_input */
-			$shipping_details_input = $this->get_input( 'shipping_details' );
-			$shipping_details_input->set_default( EE_PMT_Paypal_Standard::shipping_info_optional );
+			$shipping_details_input = $this->get_input('shipping_details');
+			$shipping_details_input->set_default(EE_PMT_Paypal_Standard::shipping_info_optional);
 			$shipping_details_input_options = $shipping_details_input->options();
 			EE_Error::add_attention(
 				sprintf(
-					__( 'Automatically set "%s" to "%s" because Paypal requires address info in order to calculate shipping or taxes.', 'event_espresso' ),
-					strip_tags( $shipping_details_input->html_label_text() ),
-					isset( $shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ] )
-						? $shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ]
-						: __( 'Unknown', 'event_espresso' )
+					__('Automatically set "%s" to "%s" because Paypal requires address info in order to calculate shipping or taxes.', 'event_espresso'),
+					strip_tags($shipping_details_input->html_label_text()),
+					isset($shipping_details_input_options[EE_PMT_Paypal_Standard::shipping_info_optional])
+						? $shipping_details_input_options[EE_PMT_Paypal_Standard::shipping_info_optional]
+						: __('Unknown', 'event_espresso')
 				),
 				__FILE__, __FUNCTION__, __LINE__
 			);

admin_pages/maintenance/Maintenance_Admin_Page.core.php

Spacing +88 added lines, -88 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -30,8 +30,8 @@ 
 class Maintenance_Admin_Page extends EE_Admin_Page {
 
 
-	public function __construct( $routing = TRUE ) {
-		parent::__construct( $routing );
+	public function __construct($routing = TRUE) {
+		parent::__construct($routing);
 	}
 
 
@@ -46,8 +46,8 @@ 
 
 
 	protected function _ajax_hooks() {
-		add_action('wp_ajax_migration_step',array($this,'migration_step'));
-		add_action('wp_ajax_add_error_to_migrations_ran',array($this,'add_error_to_migrations_ran'));
+		add_action('wp_ajax_migration_step', array($this, 'migration_step'));
+		add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran'));
 	}
 
 
@@ -56,7 +56,7 @@ 
 		$this->_admin_page_title = EE_MAINTENANCE_LABEL;
 		$this->_labels = array(
 			'buttons' => array(
-				'reset_capabilities' => __( 'Reset Event Espresso Capabilities', 'event_espresso' )
+				'reset_capabilities' => __('Reset Event Espresso Capabilities', 'event_espresso')
 				)
 			);
 	}
@@ -155,23 +155,23 @@ 
 	 * default maintenance page. If we're in maintenance mode level 2, then we need to show
 	 * the migration scripts and all that UI.
 	 */
-	public function _maintenance(){
+	public function _maintenance() {
 		//it all depends if we're in maintenance model level 1 (frontend-only) or
 		//level 2 (everything except maintenance page)
-		try{
+		try {
 			//get the current maintenance level and check if
 			//we are removed
 			$mm = EE_Maintenance_Mode::instance()->level();
 			$placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-			if( $mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm){
+			if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
 				//we just took the site out of maintenance mode, so notify the user.
 				//unfortunately this message appears to be echoed on the NEXT page load...
 				//oh well, we should really be checking for this on addon deactivation anyways
-				EE_Error::add_attention( __( 'Site taken out of maintenance mode because no data migration scripts are required', 'event_espresso' ) );
-				$this->_process_notices( array( 'page' => 'espresso_maintenance_settings'), false );
+				EE_Error::add_attention(__('Site taken out of maintenance mode because no data migration scripts are required', 'event_espresso'));
+				$this->_process_notices(array('page' => 'espresso_maintenance_settings'), false);
 			}
 			//in case an exception is thrown while trying to handle migrations
-			switch(EE_Maintenance_Mode::instance()->level()){
+			switch (EE_Maintenance_Mode::instance()->level()) {
 				case EE_Maintenance_Mode::level_0_not_in_maintenance:
 				case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
 					$show_maintenance_switch = true;
@@ -183,18 +183,18 @@ 
 				case EE_Maintenance_Mode::level_2_complete_maintenance:
 					$show_maintenance_switch = false;
 					$show_migration_progress = true;
-					if(isset($this->_req_data['continue_migration'])){
+					if (isset($this->_req_data['continue_migration'])) {
 						$show_backup_db_text = false;
-					}else{
+					} else {
 						$show_backup_db_text = true;
 					}
 					$scripts_needing_to_run = EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts();
 					$addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating();
 					$script_names = array();
 					$current_script = NULL;
-					foreach($scripts_needing_to_run as $script){
-						if($script instanceof EE_Data_Migration_Script_Base){
-							if( ! $current_script){
+					foreach ($scripts_needing_to_run as $script) {
+						if ($script instanceof EE_Data_Migration_Script_Base) {
+							if ( ! $current_script) {
 								$current_script = $script;
 								$current_script->migration_page_hooks();
 							}
@@ -205,7 +205,7 @@ 
 			}
 			$most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
 			$exception_thrown = false;
-		}catch(EE_Error $e){
+		} catch (EE_Error $e) {
 
 			EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
 			//now, just so we can display the page correctly, make a error migration script stage object
@@ -215,54 +215,54 @@ 
 			$exception_thrown = true;
 		}
 		$current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set();
-		$current_db_state = str_replace( '.decaf', '', $current_db_state );
-		if($exception_thrown ||
-				(	$most_recent_migration &&
+		$current_db_state = str_replace('.decaf', '', $current_db_state);
+		if ($exception_thrown ||
+				($most_recent_migration &&
 					$most_recent_migration instanceof EE_Data_Migration_Script_Base &&
 					$most_recent_migration->is_broken()
-				)){
-			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
-			$this->_template_args[ 'support_url' ] = 'http://eventespresso.com/support/forums/';
-			$this->_template_args[ 'next_url' ] = EEH_URL::add_query_args_and_nonce(array( 'action' => 'confirm_migration_crash_report_sent', 'success' => '0' ), EE_MAINTENANCE_ADMIN_URL );
-		}elseif($addons_should_be_upgraded_first){
-			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
-		}else{
-			if($most_recent_migration &&
-					$most_recent_migration instanceof EE_Data_Migration_Script_Base  &&
-					$most_recent_migration->can_continue()){
+				)) {
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_migration_was_borked_page.template.php';
+			$this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
+			$this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action' => 'confirm_migration_crash_report_sent', 'success' => '0'), EE_MAINTENANCE_ADMIN_URL);
+		}elseif ($addons_should_be_upgraded_first) {
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_upgrade_addons_before_migrating.template.php';
+		} else {
+			if ($most_recent_migration &&
+					$most_recent_migration instanceof EE_Data_Migration_Script_Base &&
+					$most_recent_migration->can_continue()) {
 				$show_backup_db_text = false;
 				$show_continue_current_migration_script = true;
 				$show_most_recent_migration = true;
-			}elseif(isset($this->_req_data['continue_migration'])){
+			}elseif (isset($this->_req_data['continue_migration'])) {
 				$show_most_recent_migration = true;
 				$show_continue_current_migration_script = false;
-			}else{
+			} else {
 				$show_most_recent_migration = false;
 				$show_continue_current_migration_script = false;
 			}
 
-			if(isset($current_script)){
+			if (isset($current_script)) {
 				$migrates_to = $current_script->migrates_to_version();
-				$plugin_slug = $migrates_to[ 'slug' ];
-				$new_version = $migrates_to[ 'version' ];
-				$this->_template_args = array_merge($this->_template_args,array(
-					'current_db_state'=>  sprintf(__("EE%s (%s)", "event_espresso"), isset($current_db_state[$plugin_slug]) ? $current_db_state[$plugin_slug] : 3,$plugin_slug),
-					'next_db_state'=>isset($current_script) ? sprintf(__("EE%s (%s)", 'event_espresso'),$new_version,$plugin_slug) : NULL));
+				$plugin_slug = $migrates_to['slug'];
+				$new_version = $migrates_to['version'];
+				$this->_template_args = array_merge($this->_template_args, array(
+					'current_db_state'=>  sprintf(__("EE%s (%s)", "event_espresso"), isset($current_db_state[$plugin_slug]) ? $current_db_state[$plugin_slug] : 3, $plugin_slug),
+					'next_db_state'=>isset($current_script) ? sprintf(__("EE%s (%s)", 'event_espresso'), $new_version, $plugin_slug) : NULL));
 			}
 
-			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_migration_page.template.php';
 			$this->_template_args = array_merge(
 				$this->_template_args,
 				array(
-					'show_most_recent_migration' => $show_most_recent_migration,//flag for showing the most recent migration's status and/or errors
-					'show_migration_progress' => $show_migration_progress,//flag for showing the option to run migrations and see their progress
-					'show_backup_db_text' => $show_backup_db_text,//flag for showing text telling the user to backup their DB
-					'show_maintenance_switch'=> $show_maintenance_switch,//flag for showing the option to change maintenance mode between levels 0 and 1
-					'script_names'=>$script_names,//array of names of scripts that have run
-					'show_continue_current_migration_script'=>$show_continue_current_migration_script,//flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
+					'show_most_recent_migration' => $show_most_recent_migration, //flag for showing the most recent migration's status and/or errors
+					'show_migration_progress' => $show_migration_progress, //flag for showing the option to run migrations and see their progress
+					'show_backup_db_text' => $show_backup_db_text, //flag for showing text telling the user to backup their DB
+					'show_maintenance_switch'=> $show_maintenance_switch, //flag for showing the option to change maintenance mode between levels 0 and 1
+					'script_names'=>$script_names, //array of names of scripts that have run
+					'show_continue_current_migration_script'=>$show_continue_current_migration_script, //flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
 					'reset_db_page_link' => EE_Admin_Page::add_query_args_and_nonce(array('action'=>'reset_db'), EE_MAINTENANCE_ADMIN_URL),
-					'update_migration_script_page_link' => EE_Admin_Page::add_query_args_and_nonce(array('action'=>'change_maintenance_level'),EE_MAINTENANCE_ADMIN_URL),
-					'ultimate_db_state'=>  sprintf(__("EE%s", 'event_espresso'),espresso_version()),
+					'update_migration_script_page_link' => EE_Admin_Page::add_query_args_and_nonce(array('action'=>'change_maintenance_level'), EE_MAINTENANCE_ADMIN_URL),
+					'ultimate_db_state'=>  sprintf(__("EE%s", 'event_espresso'), espresso_version()),
 				)
 			);
 		//make sure we have the form fields helper available. It usually is, but sometimes it isn't
@@ -276,7 +276,7 @@ 
 			'status_fatal_error'=>  EE_Data_Migration_Manager::status_fatal_error,
 			'status_completed'=>  EE_Data_Migration_Manager::status_completed));
 		}
-		$this->_template_args['most_recent_migration'] = $most_recent_migration;//the actual most recently ran migration
+		$this->_template_args['most_recent_migration'] = $most_recent_migration; //the actual most recently ran migration
 		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path, $this->_template_args, TRUE);
 		$this->display_admin_page_with_sidebar();
 	}
@@ -286,7 +286,7 @@ 
 	/**
 	 * returns JSON and executes another step of the currently-executing data migration (called via ajax)
 	 */
-	public function migration_step(){
+	public function migration_step() {
 		$this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request();
 		$this->_return_json();
 	}
@@ -297,7 +297,7 @@ 
 	 * Can be used by js when it notices a response with HTML in it in order
 	 * to log the malformed response
 	 */
-	public function add_error_to_migrations_ran(){
+	public function add_error_to_migrations_ran() {
 		EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']);
 		$this->_template_args['data'] = array('ok'=>true);
 		$this->_return_json();
@@ -308,14 +308,14 @@ 
 	/**
 	 * changes the maintenance level, provided there are still no migration scripts that shoudl run
 	 */
-	public function _change_maintenance_level(){
+	public function _change_maintenance_level() {
 		$new_level = intval($this->_req_data['maintenance_mode_level']);
-		if( ! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()){
+		if ( ! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
 			EE_Maintenance_Mode::instance()->set_maintenance_level($new_level);
 			$success = true;
-		}else{
+		} else {
 			EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-			$success= false;
+			$success = false;
 		}
 		$this->_redirect_after_action($success, 'Maintenance Mode', __("Updated", "event_espresso"));
 	}
@@ -325,9 +325,9 @@ 
 	/**
 	 * a tab with options for reseting and/or deleting EE data
 	 */
-	public function _data_reset_and_delete(){
-		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
-		$this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button( 'reset_capabilities', 'reset_capabilities', array(),  'button button-primary' );
+	public function _data_reset_and_delete() {
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_data_reset_and_delete.template.php';
+		$this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button('reset_capabilities', 'reset_capabilities', array(), 'button button-primary');
 		$this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'delete_db'), EE_MAINTENANCE_ADMIN_URL);
 		$this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'reset_db'), EE_MAINTENANCE_ADMIN_URL);
 		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path, $this->_template_args, TRUE);
@@ -337,9 +337,9 @@ 
 
 
 	protected function _reset_capabilities() {
-		EE_Registry::instance()->CAP->init_caps( true );
-		EE_Error::add_success( __('Default Event Espresso capabilities have been restored for all current roles.', 'event_espresso' ) );
-		$this->_redirect_after_action( FALSE, '', '', array( 'action' => 'data_reset' ), TRUE );
+		EE_Registry::instance()->CAP->init_caps(true);
+		EE_Error::add_success(__('Default Event Espresso capabilities have been restored for all current roles.', 'event_espresso'));
+		$this->_redirect_after_action(FALSE, '', '', array('action' => 'data_reset'), TRUE);
 	}
 
 	/**
@@ -349,7 +349,7 @@ 
 	 */
 	protected function _reattempt_migration() {
 		EE_Data_Migration_Manager::instance()->reattempt();
-		$this->_redirect_after_action( FALSE, '', '', array( 'action' => 'default' ), TRUE );
+		$this->_redirect_after_action(FALSE, '', '', array('action' => 'default'), TRUE);
 	}
 
 
@@ -358,8 +358,8 @@ 
 	/**
 	 * shows the big ol' System Information page
 	 */
-	public function _system_status(){
-		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
+	public function _system_status() {
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_system_stati_page.template.php';
 		$this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
 		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path, $this->_template_args, TRUE);
 		$this->display_admin_page_with_sidebar();
@@ -367,30 +367,30 @@ 
 
 
 
-	public function _send_migration_crash_report(){
+	public function _send_migration_crash_report() {
 		$from = $this->_req_data['from'];
 		$from_name = $this->_req_data['from_name'];
 		$body = $this->_req_data['body'];
-		try{
+		try {
 		$success = wp_mail(EE_SUPPORT_EMAIL,
 				'Migration Crash Report',
-				$body."/r/n<br>".  print_r(EEM_System_Status::instance()->get_system_stati(),true),
+				$body."/r/n<br>".print_r(EEM_System_Status::instance()->get_system_stati(), true),
 				array(
 					"from:$from_name<$from>",
 //					'content-type:text/html charset=UTF-8'
 					));
-		}catch( Exception $e ){
+		} catch (Exception $e) {
 			$success = FALSE;
 		}
-		$this->_redirect_after_action($success, __("Migration Crash Report", "event_espresso"), __("sent", "event_espresso"),array('success'=>$success,'action'=>'confirm_migration_crash_report_sent'));
+		$this->_redirect_after_action($success, __("Migration Crash Report", "event_espresso"), __("sent", "event_espresso"), array('success'=>$success, 'action'=>'confirm_migration_crash_report_sent'));
 	}
 
 
 
-	public function _confirm_migration_crash_report_sent(){
-		try{
+	public function _confirm_migration_crash_report_sent() {
+		try {
 			$most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
-		}catch(EE_Error $e){
+		} catch (EE_Error $e) {
 
 			EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
 			//now, just so we can display the page correctly, make a error migration script stage object
@@ -398,14 +398,14 @@ 
 			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
 			$most_recent_migration->add_error($e->getMessage());
 		}
-		$success = $this->_req_data['success']=='1' ? true : false;
+		$success = $this->_req_data['success'] == '1' ? true : false;
 		$this->_template_args['success'] = $success;
-		$this->_template_args[ 'most_recent_migration' ] = $most_recent_migration;
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;
 		$this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'reset_db'), EE_MAINTENANCE_ADMIN_URL);
-		$this->_template_args[ 'reset_db_page_url' ] = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'data_reset'), EE_MAINTENANCE_ADMIN_URL);
-		$this->_template_args[ 'reattempt_action_url' ] = EE_Admin_Page::add_query_args_and_nonce( array( 'action' => 'reattempt_migration'), EE_MAINTENANCE_ADMIN_URL );
-		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
-		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,$this->_template_args,TRUE);
+		$this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'data_reset'), EE_MAINTENANCE_ADMIN_URL);
+		$this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reattempt_migration'), EE_MAINTENANCE_ADMIN_URL);
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_confirm_migration_crash_report_sent.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path, $this->_template_args, TRUE);
 		$this->display_admin_page_with_sidebar();
 	}
 
@@ -418,18 +418,18 @@ 
 	 * @param boolean $nuke_old_ee4_data controls whether or not we
 	 * destroy the old ee4 data, or just try initializing ee4 default data
 	 */
-	public function _reset_db( $nuke_old_ee4_data = TRUE ){
+	public function _reset_db($nuke_old_ee4_data = TRUE) {
 		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
 
-		if( $nuke_old_ee4_data ){
+		if ($nuke_old_ee4_data) {
 			EEH_Activation::delete_all_espresso_cpt_data();
-			EEH_Activation::delete_all_espresso_tables_and_data( FALSE );
+			EEH_Activation::delete_all_espresso_tables_and_data(FALSE);
 			EEH_Activation::remove_cron_tasks();
 		}
 		//make sure when we reset the registry's config that it
 		//switches to using the new singleton
-		EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset( TRUE );
-		EE_System::instance()->initialize_db_if_no_migrations_required( TRUE );
+		EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(TRUE);
+		EE_System::instance()->initialize_db_if_no_migrations_required(TRUE);
 		EE_System::instance()->redirect_to_about_ee();
 	}
 
@@ -438,20 +438,20 @@ 
 	/**
 	 * Deletes ALL EE tables, Records, and Options from the database.
 	 */
-	public function _delete_db(){
+	public function _delete_db() {
 		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
 		EEH_Activation::delete_all_espresso_cpt_data();
 		EEH_Activation::delete_all_espresso_tables_and_data();
 		EEH_Activation::remove_cron_tasks();
 		EEH_Activation::deactivate_event_espresso();
-		wp_safe_redirect( admin_url( 'plugins.php' ));
+		wp_safe_redirect(admin_url('plugins.php'));
 		exit;
 	}
 
 	/**
 	 * sets up EE4 to rerun the migrations from ee3 to ee4
 	 */
-	public function _rerun_migration_from_ee3(){
+	public function _rerun_migration_from_ee3() {
 		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
 		EEH_Activation::delete_all_espresso_cpt_data();
 		EEH_Activation::delete_all_espresso_tables_and_data(false);
@@ -478,9 +478,9 @@ 
 		wp_enqueue_script('ee_admin_js');
 //		wp_enqueue_media();
 //		wp_enqueue_script('media-upload');
-		wp_enqueue_script('ee-maintenance',EE_MAINTENANCE_ASSETS_URL.'/ee-maintenance.js',array('jquery'),EVENT_ESPRESSO_VERSION,true);
+		wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL.'/ee-maintenance.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
 
-		wp_register_style( 'espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(), EVENT_ESPRESSO_VERSION );
+		wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL.'ee-maintenance.css', array(), EVENT_ESPRESSO_VERSION);
 		wp_enqueue_style('espresso_maintenance');
 	}
 

core/helpers/EEH_Debug_Tools.helper.php

Doc Comments +3 added lines, -2 removed lines

@@ -187,7 +187,7 @@ 
 
 	/**
 	 * 	start_timer
-	 * @param null $timer_name
+	 * @param string $timer_name
 	 */
 	public function start_timer( $timer_name = NULL ){
 		$this->_start_times[$timer_name] = microtime( TRUE );
@@ -468,12 +468,13 @@ 
 
 
 	/**
-	 * @param mixed  $var
+	 * @param string  $var
 	 * @param string $var_name
 	 * @param string $file
 	 * @param int    $line
 	 * @param int $heading_tag
 	 * @param bool   $die
+	 * @param string $margin
 	 */
 	public static function printv( $var, $var_name = '', $file = __FILE__, $line = __LINE__, $heading_tag = 5, $die = false, $margin ) {
 		$var_name = ! $var_name ? 'string' : $var_name;

Indentation +83 added lines, -83 removed lines

@@ -480,9 +480,9 @@ 
 		$var_name = ucwords( str_replace( '$', '', $var_name ) );
 		$is_method = method_exists( $var_name, $var );
 		$var_name = ucwords( str_replace( '_', ' ', $var_name ) );
-        $heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : "h5";
-        $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin);
-        $result .= $is_method
+		$heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : "h5";
+		$result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin);
+		$result .= $is_method
 			? \EEH_Debug_Tools::grey_span('::') . \EEH_Debug_Tools::orange_span($var . "()")
 			: \EEH_Debug_Tools::grey_span(' : ') . \EEH_Debug_Tools::orange_span($var);
 		$result .= \EEH_Debug_Tools::file_and_line($file, $line);
@@ -496,93 +496,93 @@ 
 
 
 
-    /**
-     * @param string $var_name
-     * @param string $heading_tag
-     * @param string $margin
-     * @return string
-     */
+	/**
+	 * @param string $var_name
+	 * @param string $heading_tag
+	 * @param string $margin
+	 * @return string
+	 */
 	protected static function heading( $var_name = '', $heading_tag = 'h5', $margin = '' ) {
-        if (defined('EE_TESTS_DIR')) {
-            return "\n\n{$var_name}";
-        }
-        return '<'.$heading_tag.' style="color:#2EA2CC; margin:25px 0 0'.$margin.';"><b>'.$var_name.'</b>';
-    }
+		if (defined('EE_TESTS_DIR')) {
+			return "\n\n{$var_name}";
+		}
+		return '<'.$heading_tag.' style="color:#2EA2CC; margin:25px 0 0'.$margin.';"><b>'.$var_name.'</b>';
+	}
 
 
 
-    /**
-     * @param string $heading_tag
-     * @return string
-     */
+	/**
+	 * @param string $heading_tag
+	 * @return string
+	 */
 	protected static function headingx( $heading_tag = 'h5' ) {
-        if (defined('EE_TESTS_DIR')) {
-            return "\n";
-        }
-        return '</' . $heading_tag . '>';
-    }
+		if (defined('EE_TESTS_DIR')) {
+			return "\n";
+		}
+		return '</' . $heading_tag . '>';
+	}
 
 
 
-    /**
-     * @param string $content
-     * @return string
-     */
+	/**
+	 * @param string $content
+	 * @return string
+	 */
 	protected static function grey_span( $content = '' ) {
-        if (defined('EE_TESTS_DIR')) {
-            return $content;
-        }
-        return '<span style="color:#999">' . $content . '</span>';
-    }
+		if (defined('EE_TESTS_DIR')) {
+			return $content;
+		}
+		return '<span style="color:#999">' . $content . '</span>';
+	}
 
 
 
-    /**
-     * @param string $file
-     * @param int    $line
-     * @return string
-     */
+	/**
+	 * @param string $file
+	 * @param int    $line
+	 * @return string
+	 */
 	protected static function file_and_line($file, $line) {
-        if (defined('EE_TESTS_DIR')) {
-            return "\n (" . $file . ' line no: ' . $line . ' ) ';
-        }
-        return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">' . $file . '<br />line no: ' . $line . '</span>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function orange_span($content = '')
-    {
-        if (defined('EE_TESTS_DIR')) {
-            return $content;
-        }
-        return '<span style="color:#E76700">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param mixed $var
-     * @return string
-     */
-    protected static function pre_span($var)
-    {
-        ob_start();
-        var_dump($var);
-        $var = ob_get_clean();
-        if (defined('EE_TESTS_DIR')) {
-            return "\n" . $var;
-        }
-        return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
-    }
-
-
-
-    /**
+		if (defined('EE_TESTS_DIR')) {
+			return "\n (" . $file . ' line no: ' . $line . ' ) ';
+		}
+		return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">' . $file . '<br />line no: ' . $line . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function orange_span($content = '')
+	{
+		if (defined('EE_TESTS_DIR')) {
+			return $content;
+		}
+		return '<span style="color:#E76700">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param mixed $var
+	 * @return string
+	 */
+	protected static function pre_span($var)
+	{
+		ob_start();
+		var_dump($var);
+		$var = ob_get_clean();
+		if (defined('EE_TESTS_DIR')) {
+			return "\n" . $var;
+		}
+		return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
+	}
+
+
+
+	/**
 	 * @param mixed $var
 	 * @param string $var_name
 	 * @param string $file
@@ -593,8 +593,8 @@ 
 	public static function printr( $var, $var_name = '', $file = __FILE__, $line = __LINE__, $heading_tag = 5, $die = false ) {
 		// return;
 		$file = str_replace( rtrim( ABSPATH, '\\/' ), '', $file );
-        $margin = is_admin() ? ' 180px' : '0';
-        //$print_r = false;
+		$margin = is_admin() ? ' 180px' : '0';
+		//$print_r = false;
 		if ( is_string( $var ) ) {
 			EEH_Debug_Tools::printv( $var, $var_name, $file, $line, $heading_tag, $die, $margin );
 			return;
@@ -610,11 +610,11 @@ 
 			$var_name = ! $var_name ? 'null' : $var_name;
 		}
 		$var_name = ucwords( str_replace( array( '$', '_' ), array( '', ' ' ), $var_name ) );
-        $heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : "h5";
-        $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin);
+		$heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : "h5";
+		$result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin);
 		$result .= \EEH_Debug_Tools::grey_span(' : ') . \EEH_Debug_Tools::orange_span(
-		    \EEH_Debug_Tools::pre_span($var)
-            );
+			\EEH_Debug_Tools::pre_span($var)
+			);
 		$result .= \EEH_Debug_Tools::file_and_line($file, $line);
 		$result .= \EEH_Debug_Tools::headingx($heading_tag);
 		if ( $die ) {

Spacing +153 added lines, -153 removed lines

@@ -1,4 +1,4 @@ 
-<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed');}
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed'); }
 /**
  * Class EEH_Debug_Tools
  *
@@ -8,7 +8,7 @@ 
  * @since 				4.0
  *
  */
-class EEH_Debug_Tools{
+class EEH_Debug_Tools {
 
 	/**
 	 * 	instance of the EEH_Autoloader object
@@ -41,7 +41,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated, and instantiated properly
-		if ( ! self::$_instance instanceof EEH_Debug_Tools ) {
+		if ( ! self::$_instance instanceof EEH_Debug_Tools) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -57,21 +57,21 @@ 
 	 */
 	private function __construct() {
 		// load Kint PHP debugging library
-		if ( ! class_exists( 'Kint' ) &&  file_exists( EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php' )){
+		if ( ! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH.'tests'.DS.'kint'.DS.'Kint.class.php')) {
 			// despite EE4 having a check for an existing copy of the Kint debugging class,
 			// if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
 			// then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
 			// so we've moved it to our test folder so that it is not included with production releases
 			// plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-			require_once( EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php' );
+			require_once(EE_PLUGIN_DIR_PATH.'tests'.DS.'kint'.DS.'Kint.class.php');
 		}
 		// if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) {
 			//add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
 		// }
-		$plugin = basename( EE_PLUGIN_DIR_PATH );
-		add_action( "activate_{$plugin}", array( 'EEH_Debug_Tools', 'ee_plugin_activation_errors' ));
-		add_action( 'activated_plugin', array( 'EEH_Debug_Tools', 'ee_plugin_activation_errors' ));
-		add_action( 'shutdown', array( 'EEH_Debug_Tools', 'show_db_name' ));
+		$plugin = basename(EE_PLUGIN_DIR_PATH);
+		add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
 	}
 
 
@@ -82,10 +82,10 @@ 
 	 * 	@return void
 	 */
 	public static function show_db_name() {
-		if ( ! defined( 'DOING_AJAX' ) && ( defined( 'EE_ERROR_EMAILS' ) && EE_ERROR_EMAILS )) {
-			echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '. DB_NAME .'</p>';
+		if ( ! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+			echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '.DB_NAME.'</p>';
 		}
-		if ( EE_DEBUG ) {
+		if (EE_DEBUG) {
 			EEH_Debug_Tools::instance()->show_times();
 		}
 	}
@@ -99,15 +99,15 @@ 
 	 */
 	public function espresso_session_footer_dump() {
 		if (
-			( defined( 'WP_DEBUG' ) && WP_DEBUG )
-			&& ! defined( 'DOING_AJAX' )
-			&& class_exists( 'Kint' )
-			&& function_exists( 'wp_get_current_user' )
-			&& current_user_can( 'update_core' )
-			&& class_exists( 'EE_Registry' )
+			(defined('WP_DEBUG') && WP_DEBUG)
+			&& ! defined('DOING_AJAX')
+			&& class_exists('Kint')
+			&& function_exists('wp_get_current_user')
+			&& current_user_can('update_core')
+			&& class_exists('EE_Registry')
 		) {
-			Kint::dump(  EE_Registry::instance()->SSN->id() );
-			Kint::dump( EE_Registry::instance()->SSN );
+			Kint::dump(EE_Registry::instance()->SSN->id());
+			Kint::dump(EE_Registry::instance()->SSN);
 			//			Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
 			$this->espresso_list_hooked_functions();
 			$this->show_times();
@@ -124,27 +124,27 @@ 
 	 * @param string $tag
 	 * @return void
 	 */
-	public function espresso_list_hooked_functions( $tag='' ){
+	public function espresso_list_hooked_functions($tag = '') {
 		global $wp_filter;
 		echo '<br/><br/><br/><h3>Hooked Functions</h3>';
-		if ( $tag ) {
-			$hook[$tag]=$wp_filter[$tag];
-			if ( ! is_array( $hook[$tag] )) {
-				trigger_error( "Nothing found for '$tag' hook", E_USER_WARNING );
+		if ($tag) {
+			$hook[$tag] = $wp_filter[$tag];
+			if ( ! is_array($hook[$tag])) {
+				trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
 				return;
 			}
-			echo '<h5>For Tag: '. $tag .'</h5>';
+			echo '<h5>For Tag: '.$tag.'</h5>';
 		}
 		else {
-			$hook=$wp_filter;
-			ksort( $hook );
+			$hook = $wp_filter;
+			ksort($hook);
 		}
-		foreach( $hook as $tag_name => $priorities ) {
+		foreach ($hook as $tag_name => $priorities) {
 			echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>$tag_name</strong><br />";
-			ksort( $priorities );
-			foreach( $priorities as $priority => $function ){
+			ksort($priorities);
+			foreach ($priorities as $priority => $function) {
 				echo $priority;
-				foreach( $function as $name => $properties ) {
+				foreach ($function as $name => $properties) {
 					echo "\t$name<br />";
 				}
 			}
@@ -159,15 +159,15 @@ 
 	 * @param string $hook_name
 	 * @return array
 	 */
-	public static function registered_filter_callbacks( $hook_name = '' ) {
+	public static function registered_filter_callbacks($hook_name = '') {
 		$filters = array();
 		global $wp_filter;
-		if ( isset( $wp_filter[ $hook_name ] ) ) {
-			$filters[ $hook_name ] = array();
-			foreach ( $wp_filter[ $hook_name ] as $priority => $callbacks ) {
-				$filters[ $hook_name ][ $priority ] = array();
-				foreach ( $callbacks as $callback ) {
-					$filters[ $hook_name ][ $priority ][] = $callback['function'];
+		if (isset($wp_filter[$hook_name])) {
+			$filters[$hook_name] = array();
+			foreach ($wp_filter[$hook_name] as $priority => $callbacks) {
+				$filters[$hook_name][$priority] = array();
+				foreach ($callbacks as $callback) {
+					$filters[$hook_name][$priority][] = $callback['function'];
 				}
 			}
 		}
@@ -179,7 +179,7 @@ 
 	/**
 	 * reset_times
 	 */
-	public function reset_times(){
+	public function reset_times() {
 		$this->_times = array();
 	}
 
@@ -189,8 +189,8 @@ 
 	 * 	start_timer
 	 * @param null $timer_name
 	 */
-	public function start_timer( $timer_name = NULL ){
-		$this->_start_times[$timer_name] = microtime( TRUE );
+	public function start_timer($timer_name = NULL) {
+		$this->_start_times[$timer_name] = microtime(TRUE);
 	}
 
 
@@ -199,15 +199,15 @@ 
 	 * stop_timer
 	 * @param string $timer_name
 	 */
-	public function stop_timer( $timer_name = '' ){
+	public function stop_timer($timer_name = '') {
 		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-		if( isset( $this->_start_times[ $timer_name ] ) ){
-			$start_time = $this->_start_times[ $timer_name ];
-			unset( $this->_start_times[ $timer_name ] );
-		}else{
-			$start_time = array_pop( $this->_start_times );
+		if (isset($this->_start_times[$timer_name])) {
+			$start_time = $this->_start_times[$timer_name];
+			unset($this->_start_times[$timer_name]);
+		} else {
+			$start_time = array_pop($this->_start_times);
 		}
-		$this->_times[ $timer_name ] =  number_format( microtime( true ) - $start_time, 8 );
+		$this->_times[$timer_name] = number_format(microtime(true) - $start_time, 8);
 	}
 
 
@@ -217,10 +217,10 @@ 
 	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
 	 * @return void
 	 */
-	public function measure_memory( $label, $output_now = false ) {
-		$memory_used = $this->convert( memory_get_peak_usage( true ) );
-		$this->_memory_usage_points[ $label ] = $memory_used;
-		if( $output_now ) {
+	public function measure_memory($label, $output_now = false) {
+		$memory_used = $this->convert(memory_get_peak_usage(true));
+		$this->_memory_usage_points[$label] = $memory_used;
+		if ($output_now) {
 			echo "\r\n<br>$label : $memory_used";
 		}
 	}
@@ -230,9 +230,9 @@ 
 	 * @param int $size
 	 * @return string
 	 */
-	public function convert( $size ) {
-		$unit=array('b','kb','mb','gb','tb','pb');
-		return @round( $size / pow( 1024, $i = floor( log( $size, 1024 ) ) ), 2 ) . ' ' . $unit[ absint( $i ) ];
+	public function convert($size) {
+		$unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
+		return @round($size / pow(1024, $i = floor(log($size, 1024))), 2).' '.$unit[absint($i)];
 	}
 
 
@@ -242,25 +242,25 @@ 
 	 * @param bool $output_now
 	 * @return string
 	 */
-	public function show_times($output_now=true){
+	public function show_times($output_now = true) {
 		$output = '';
-		if ( ! empty( $this->_times )) {
+		if ( ! empty($this->_times)) {
 			$total = 0;
 			$output .= '<h2 style="margin:1em .5em 0;">Times:</h2>';
 			$output .= '<span style="color:#9999CC; font-size:.8em; margin:0 1.5em 0;">( in milliseconds )</span><br />';
-			foreach( $this->_times as $timer_name => $total_time ) {
-				$output .= $this->format_time( $timer_name, $total_time );
+			foreach ($this->_times as $timer_name => $total_time) {
+				$output .= $this->format_time($timer_name, $total_time);
 				$total += $total_time;
 			}
 			$output .= '<br />';
 			$output .= '<h4 style="margin:1em .5em 0;">TOTAL TIME</h4>';
-			$output .= $this->format_time( '', $total );
+			$output .= $this->format_time('', $total);
 			$output .= '<br />';
 		}
-		if ( ! empty( $this->_memory_usage_points )) {
-			$output .= '<h2 style="margin:1em .5em 0;">Memory</h2>' . implode( '<br />', $this->_memory_usage_points );
+		if ( ! empty($this->_memory_usage_points)) {
+			$output .= '<h2 style="margin:1em .5em 0;">Memory</h2>'.implode('<br />', $this->_memory_usage_points);
 		}
-		if( $output_now ){
+		if ($output_now) {
 			echo $output;
 			return '';
 		}
@@ -274,9 +274,9 @@ 
 	 * @param float $total_time
 	 * @return string
 	 */
-	public function format_time( $timer_name, $total_time ) {
+	public function format_time($timer_name, $total_time) {
 		$total_time = $total_time * 1000;
-		switch ( $total_time ) {
+		switch ($total_time) {
 			case $total_time < 0.01 :
 				$color = '#8A549A';
 				$bold = 'normal';
@@ -307,7 +307,7 @@ 
 			. '; font-weight:'
 			. $bold
 			. '; font-size:1.2em;">'
-			. str_pad( number_format( $total_time, 5 ), 11, '0', STR_PAD_LEFT )
+			. str_pad(number_format($total_time, 5), 11, '0', STR_PAD_LEFT)
 			. '</span> '
 			. $timer_name
 			. '<br />';
@@ -321,25 +321,25 @@ 
 	 * 	@return void
 	 */
 	public static function ee_plugin_activation_errors() {
-		if ( WP_DEBUG ) {
+		if (WP_DEBUG) {
 			$activation_errors = ob_get_contents();
-			if ( ! empty( $activation_errors ) ) {
-				$activation_errors = date( 'Y-m-d H:i:s' ) . "\n" . $activation_errors;
+			if ( ! empty($activation_errors)) {
+				$activation_errors = date('Y-m-d H:i:s')."\n".$activation_errors;
 			}
-			espresso_load_required( 'EEH_File', EE_HELPERS . 'EEH_File.helper.php' );
-			if ( class_exists( 'EEH_File' )) {
+			espresso_load_required('EEH_File', EE_HELPERS.'EEH_File.helper.php');
+			if (class_exists('EEH_File')) {
 				try {
-					EEH_File::ensure_file_exists_and_is_writable( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html' );
-					EEH_File::write_to_file( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html', $activation_errors );
-				} catch( EE_Error $e ){
-					EE_Error::add_error( sprintf( __(  'The Event Espresso activation errors file could not be setup because: %s', 'event_espresso' ), $e->getMessage() ), __FILE__, __FUNCTION__, __LINE__ );
+					EEH_File::ensure_file_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html');
+					EEH_File::write_to_file(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html', $activation_errors);
+				} catch (EE_Error $e) {
+					EE_Error::add_error(sprintf(__('The Event Espresso activation errors file could not be setup because: %s', 'event_espresso'), $e->getMessage()), __FILE__, __FUNCTION__, __LINE__);
 				}
 			} else {
 				// old school attempt
-				file_put_contents( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html', $activation_errors );
+				file_put_contents(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html', $activation_errors);
 			}
-			$activation_errors = get_option( 'ee_plugin_activation_errors', '' ) . $activation_errors;
-			update_option( 'ee_plugin_activation_errors', $activation_errors );
+			$activation_errors = get_option('ee_plugin_activation_errors', '').$activation_errors;
+			update_option('ee_plugin_activation_errors', $activation_errors);
 		}
 	}
 
@@ -368,33 +368,33 @@ 
 		$applies_when = '',
 		$error_type = null
 	) {
-		$applies_when = ! empty( $applies_when ) ? $applies_when : espresso_version();
+		$applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
 		$error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
 		// because we swapped the parameter order around for the last two params,
 		// let's verify that some third party isn't still passing an error type value for the third param
-		if ( is_int( $applies_when ) ) {
+		if (is_int($applies_when)) {
 			$error_type = $applies_when;
 			$applies_when = espresso_version();
 		}
 		// if not displaying notices yet, then just leave
-		if ( version_compare( espresso_version(), $applies_when, '<' ) ) {
+		if (version_compare(espresso_version(), $applies_when, '<')) {
 			return;
 		}
-		do_action( 'AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
-		$version = $version === null ? '' : sprintf( __('(This message was added in version %s of Event Espresso)', 'event_espresso' ), $version );
-		$error_message = sprintf( esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s','event_espresso' ), $function, '<strong>', '</strong>', $message, $version );
+		do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
+		$version = $version === null ? '' : sprintf(__('(This message was added in version %s of Event Espresso)', 'event_espresso'), $version);
+		$error_message = sprintf(esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'), $function, '<strong>', '</strong>', $message, $version);
 
 		//don't trigger error if doing ajax, instead we'll add a transient EE_Error notice that in theory should show on the next request.
-		if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
-			$error_message .= ' ' . esc_html__( 'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ', 'event_espresso' );
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$error_message .= ' '.esc_html__('This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ', 'event_espresso');
 			$error_message .= '<ul><li>';
-			$error_message .= implode( '</li><li>', EE_Registry::instance()->REQ->params() );
+			$error_message .= implode('</li><li>', EE_Registry::instance()->REQ->params());
 			$error_message .= '</ul>';
-			EE_Error::add_error( $error_message, 'debug::doing_it_wrong', $function, '42' );
+			EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
 			//now we set this on the transient so it shows up on the next request.
-			EE_Error::get_notices( false, true );
+			EE_Error::get_notices(false, true);
 		} else {
-			trigger_error( $error_message, $error_type );
+			trigger_error($error_message, $error_type);
 		}
 	}
 
@@ -416,22 +416,22 @@ 
 	 * @param string $debug_index
 	 * @param string $debug_key
 	 */
-	public static function log( $class='', $func = '', $line = '', $info = array(), $display_request = false,  $debug_index = '', $debug_key = 'EE_DEBUG_SPCO' ) {
-		if ( WP_DEBUG && false ) {
-			$debug_key = $debug_key . '_' . EE_Session::instance()->id();
-			$debug_data = get_option( $debug_key, array() );
+	public static function log($class = '', $func = '', $line = '', $info = array(), $display_request = false, $debug_index = '', $debug_key = 'EE_DEBUG_SPCO') {
+		if (WP_DEBUG && false) {
+			$debug_key = $debug_key.'_'.EE_Session::instance()->id();
+			$debug_data = get_option($debug_key, array());
 			$default_data = array(
-				$class => $func . '() : ' . $line,
+				$class => $func.'() : '.$line,
 				'REQ'  => $display_request ? $_REQUEST : '',
 			);
 			// don't serialize objects
-			$info = self::strip_objects( $info );
-			$index = ! empty( $debug_index ) ? $debug_index : 0;
-			if ( ! isset( $debug_data[$index] ) ) {
+			$info = self::strip_objects($info);
+			$index = ! empty($debug_index) ? $debug_index : 0;
+			if ( ! isset($debug_data[$index])) {
 				$debug_data[$index] = array();
 			}
-			$debug_data[$index][microtime()] = array_merge( $default_data, $info );
-			update_option( $debug_key, $debug_data );
+			$debug_data[$index][microtime()] = array_merge($default_data, $info);
+			update_option($debug_key, $debug_data);
 		}
 	}
 
@@ -443,26 +443,26 @@ 
 	 * @param array $info
 	 * @return array
 	 */
-	public static function strip_objects( $info = array() ) {
-		foreach ( $info as $key => $value ) {
-			if ( is_array( $value ) ) {
-				$info[ $key ] = self::strip_objects( $value );
-			} else if ( is_object( $value ) ) {
-				$object_class = get_class( $value );
-				$info[ $object_class ] = array();
-				$info[ $object_class ][ 'ID' ] = method_exists( $value, 'ID' ) ? $value->ID() : spl_object_hash( $value );
-				if ( method_exists( $value, 'ID' ) ) {
-					$info[ $object_class ][ 'ID' ] = $value->ID();
+	public static function strip_objects($info = array()) {
+		foreach ($info as $key => $value) {
+			if (is_array($value)) {
+				$info[$key] = self::strip_objects($value);
+			} else if (is_object($value)) {
+				$object_class = get_class($value);
+				$info[$object_class] = array();
+				$info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+				if (method_exists($value, 'ID')) {
+					$info[$object_class]['ID'] = $value->ID();
 				}
-				if ( method_exists( $value, 'status' ) ) {
-					$info[ $object_class ][ 'status' ] = $value->status();
-				} else if ( method_exists( $value, 'status_ID' ) ) {
-					$info[ $object_class ][ 'status' ] = $value->status_ID();
+				if (method_exists($value, 'status')) {
+					$info[$object_class]['status'] = $value->status();
+				} else if (method_exists($value, 'status_ID')) {
+					$info[$object_class]['status'] = $value->status_ID();
 				}
-				unset( $info[ $key ] );
+				unset($info[$key]);
 			}
 		}
-		return (array)$info;
+		return (array) $info;
 	}
 
 
@@ -475,20 +475,20 @@ 
 	 * @param int $heading_tag
 	 * @param bool   $die
 	 */
-	public static function printv( $var, $var_name = '', $file = __FILE__, $line = __LINE__, $heading_tag = 5, $die = false, $margin ) {
+	public static function printv($var, $var_name = '', $file = __FILE__, $line = __LINE__, $heading_tag = 5, $die = false, $margin) {
 		$var_name = ! $var_name ? 'string' : $var_name;
-		$var_name = ucwords( str_replace( '$', '', $var_name ) );
-		$is_method = method_exists( $var_name, $var );
-		$var_name = ucwords( str_replace( '_', ' ', $var_name ) );
+		$var_name = ucwords(str_replace('$', '', $var_name));
+		$is_method = method_exists($var_name, $var);
+		$var_name = ucwords(str_replace('_', ' ', $var_name));
         $heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : "h5";
         $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin);
         $result .= $is_method
-			? \EEH_Debug_Tools::grey_span('::') . \EEH_Debug_Tools::orange_span($var . "()")
-			: \EEH_Debug_Tools::grey_span(' : ') . \EEH_Debug_Tools::orange_span($var);
+			? \EEH_Debug_Tools::grey_span('::').\EEH_Debug_Tools::orange_span($var."()")
+			: \EEH_Debug_Tools::grey_span(' : ').\EEH_Debug_Tools::orange_span($var);
 		$result .= \EEH_Debug_Tools::file_and_line($file, $line);
 		$result .= \EEH_Debug_Tools::headingx($heading_tag);
-		if ( $die ) {
-			die( $result );
+		if ($die) {
+			die($result);
 		} else {
 			echo $result;
 		}
@@ -502,7 +502,7 @@ 
      * @param string $margin
      * @return string
      */
-	protected static function heading( $var_name = '', $heading_tag = 'h5', $margin = '' ) {
+	protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '') {
         if (defined('EE_TESTS_DIR')) {
             return "\n\n{$var_name}";
         }
@@ -515,11 +515,11 @@ 
      * @param string $heading_tag
      * @return string
      */
-	protected static function headingx( $heading_tag = 'h5' ) {
+	protected static function headingx($heading_tag = 'h5') {
         if (defined('EE_TESTS_DIR')) {
             return "\n";
         }
-        return '</' . $heading_tag . '>';
+        return '</'.$heading_tag.'>';
     }
 
 
@@ -528,11 +528,11 @@ 
      * @param string $content
      * @return string
      */
-	protected static function grey_span( $content = '' ) {
+	protected static function grey_span($content = '') {
         if (defined('EE_TESTS_DIR')) {
             return $content;
         }
-        return '<span style="color:#999">' . $content . '</span>';
+        return '<span style="color:#999">'.$content.'</span>';
     }
 
 
@@ -544,9 +544,9 @@ 
      */
 	protected static function file_and_line($file, $line) {
         if (defined('EE_TESTS_DIR')) {
-            return "\n (" . $file . ' line no: ' . $line . ' ) ';
+            return "\n (".$file.' line no: '.$line.' ) ';
         }
-        return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">' . $file . '<br />line no: ' . $line . '</span>';
+        return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'.$file.'<br />line no: '.$line.'</span>';
     }
 
 
@@ -560,7 +560,7 @@ 
         if (defined('EE_TESTS_DIR')) {
             return $content;
         }
-        return '<span style="color:#E76700">' . $content . '</span>';
+        return '<span style="color:#E76700">'.$content.'</span>';
     }
 
 
@@ -575,9 +575,9 @@ 
         var_dump($var);
         $var = ob_get_clean();
         if (defined('EE_TESTS_DIR')) {
-            return "\n" . $var;
+            return "\n".$var;
         }
-        return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
+        return '<pre style="color:#999; padding:1em; background: #fff">'.$var.'</pre>';
     }
 
 
@@ -590,35 +590,35 @@ 
 	 * @param int $heading_tag
 	 * @param bool $die
 	 */
-	public static function printr( $var, $var_name = '', $file = __FILE__, $line = __LINE__, $heading_tag = 5, $die = false ) {
+	public static function printr($var, $var_name = '', $file = __FILE__, $line = __LINE__, $heading_tag = 5, $die = false) {
 		// return;
-		$file = str_replace( rtrim( ABSPATH, '\\/' ), '', $file );
+		$file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
         $margin = is_admin() ? ' 180px' : '0';
         //$print_r = false;
-		if ( is_string( $var ) ) {
-			EEH_Debug_Tools::printv( $var, $var_name, $file, $line, $heading_tag, $die, $margin );
+		if (is_string($var)) {
+			EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
 			return;
-		} else if ( is_object( $var ) ) {
+		} else if (is_object($var)) {
 			$var_name = ! $var_name ? 'object' : $var_name;
 			//$print_r = true;
-		} else if ( is_array( $var ) ) {
+		} else if (is_array($var)) {
 			$var_name = ! $var_name ? 'array' : $var_name;
 			//$print_r = true;
-		} else if ( is_numeric( $var ) ) {
+		} else if (is_numeric($var)) {
 			$var_name = ! $var_name ? 'numeric' : $var_name;
-		} else if ( is_null( $var ) ) {
+		} else if (is_null($var)) {
 			$var_name = ! $var_name ? 'null' : $var_name;
 		}
-		$var_name = ucwords( str_replace( array( '$', '_' ), array( '', ' ' ), $var_name ) );
+		$var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
         $heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : "h5";
         $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin);
-		$result .= \EEH_Debug_Tools::grey_span(' : ') . \EEH_Debug_Tools::orange_span(
+		$result .= \EEH_Debug_Tools::grey_span(' : ').\EEH_Debug_Tools::orange_span(
 		    \EEH_Debug_Tools::pre_span($var)
             );
 		$result .= \EEH_Debug_Tools::file_and_line($file, $line);
 		$result .= \EEH_Debug_Tools::headingx($heading_tag);
-		if ( $die ) {
-			die( $result );
+		if ($die) {
+			die($result);
 		} else {
 			echo $result;
 		}
@@ -635,8 +635,8 @@ 
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
-if ( class_exists('Kint') && ! function_exists( 'dump_wp_query' ) ) {
-	function dump_wp_query(){
+if (class_exists('Kint') && ! function_exists('dump_wp_query')) {
+	function dump_wp_query() {
 		global $wp_query;
 		d($wp_query);
 	}
@@ -646,8 +646,8 @@ 
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
-if ( class_exists('Kint') && ! function_exists( 'dump_wp' ) ) {
-	function dump_wp(){
+if (class_exists('Kint') && ! function_exists('dump_wp')) {
+	function dump_wp() {
 		global $wp;
 		d($wp);
 	}
@@ -657,8 +657,8 @@ 
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
-if ( class_exists('Kint') && ! function_exists( 'dump_post' ) ) {
-	function dump_post(){
+if (class_exists('Kint') && ! function_exists('dump_post')) {
+	function dump_post() {
 		global $post;
 		d($post);
 	}

core/services/container/OpenCoffeeShop.php

Indentation +32 added lines, -32 removed lines

@@ -33,7 +33,7 @@ 
 	 * OpenCoffeeShop constructor.
 	 */
 	public function __construct()
-    {
+	{
 		// instantiate the container
 		$this->CoffeeShop = new CoffeeShop();
 		// create a dependency injector class for resolving class constructor arguments
@@ -83,11 +83,11 @@ 
 			new Recipe(
 				'CommandHandlerManager',
 				'EventEspresso\core\services\commands\CommandHandlerManager',
-                array(
-                    'CommandHandlerManagerInterface',
-                    'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
-                ),
-                array(),
+				array(
+					'CommandHandlerManagerInterface',
+					'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
+				),
+				array(),
 				CoffeeMaker::BREW_SHARED
 			)
 		);
@@ -96,11 +96,11 @@ 
 			new Recipe(
 				'CommandBus',
 				'EventEspresso\core\services\commands\CommandBus',
-                array(
-                    'CommandBusInterface',
-                    'EventEspresso\core\services\commands\CommandBusInterface',
-                ),
-                array(),
+				array(
+					'CommandBusInterface',
+					'EventEspresso\core\services\commands\CommandBusInterface',
+				),
+				array(),
 				CoffeeMaker::BREW_SHARED
 			)
 		);
@@ -110,22 +110,22 @@ 
 			new Recipe(
 				'EEI_*',
 				'',
-                array(),
-                array(),
+				array(),
+				array(),
 				CoffeeMaker::BREW_LOAD_ONLY,
-                array(
-                    EE_INTERFACES . '*.php',
-                    EE_INTERFACES . '*.interfaces.php',
-                )
+				array(
+					EE_INTERFACES . '*.php',
+					EE_INTERFACES . '*.interfaces.php',
+				)
 			)
 		);
 		// add a wildcard recipe for loading models
 		$this->CoffeeShop->addRecipe(
 			new Recipe(
 				'EEM_*',
-                '',
-                array(),
-                array(),
+				'',
+				array(),
+				array(),
 				CoffeeMaker::BREW_SHARED,
 				EE_MODELS . '*.model.php'
 			)
@@ -134,10 +134,10 @@ 
 		$this->CoffeeShop->addRecipe(
 			new Recipe(
 				'EE_*',
-                '',
-                array(),
-                array(),
-                CoffeeMaker::BREW_SHARED,
+				'',
+				array(),
+				array(),
+				CoffeeMaker::BREW_SHARED,
 				array(
 					EE_CORE . '*.core.php',
 					EE_ADMIN . '*.core.php',
@@ -152,10 +152,10 @@ 
 		$this->CoffeeShop->addRecipe(
 			new Recipe(
 				'EE_Admin_Page*',
-                '',
-                array(),
-                array(),
-                CoffeeMaker::BREW_LOAD_ONLY,
+				'',
+				array(),
+				array(),
+				CoffeeMaker::BREW_LOAD_ONLY,
 				array( EE_ADMIN . '*.core.php' )
 			)
 		);
@@ -163,10 +163,10 @@ 
 		// $this->CoffeeShop->addRecipe(
 		// 	new Recipe(
 		// 		'*_Admin_Page',
-        //      '',
-        //      array(),
-        // 		array(),
-        // 		CoffeeMaker::BREW_SHARED,
+		//      '',
+		//      array(),
+		// 		array(),
+		// 		CoffeeMaker::BREW_SHARED,
 		// 		array(
 		// 			EE_ADMIN_PAGES . 'transactions' . DS . '*.core.php',
 		// 		)

Spacing +15 added lines, -15 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 namespace EventEspresso\core\services\container;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -43,17 +43,17 @@ 
 		);
 		// and some coffeemakers, one for creating new instances
 		$this->CoffeeShop->addCoffeeMaker(
-			new NewCoffeeMaker( $this->CoffeeShop, $this->DependencyInjector ),
+			new NewCoffeeMaker($this->CoffeeShop, $this->DependencyInjector),
 			CoffeeMaker::BREW_NEW
 		);
 		// one for shared services
 		$this->CoffeeShop->addCoffeeMaker(
-			new SharedCoffeeMaker( $this->CoffeeShop, $this->DependencyInjector ),
+			new SharedCoffeeMaker($this->CoffeeShop, $this->DependencyInjector),
 			CoffeeMaker::BREW_SHARED
 		);
 		// and one for classes that only get loaded
 		$this->CoffeeShop->addCoffeeMaker(
-			new LoadOnlyCoffeeMaker( $this->CoffeeShop, $this->DependencyInjector ),
+			new LoadOnlyCoffeeMaker($this->CoffeeShop, $this->DependencyInjector),
 			CoffeeMaker::BREW_LOAD_ONLY
 		);
 		// add default recipe, which should handle loading for most PSR-4 compatible classes
@@ -114,8 +114,8 @@ 
                 array(),
 				CoffeeMaker::BREW_LOAD_ONLY,
                 array(
-                    EE_INTERFACES . '*.php',
-                    EE_INTERFACES . '*.interfaces.php',
+                    EE_INTERFACES.'*.php',
+                    EE_INTERFACES.'*.interfaces.php',
                 )
 			)
 		);
@@ -127,7 +127,7 @@ 
                 array(),
                 array(),
 				CoffeeMaker::BREW_SHARED,
-				EE_MODELS . '*.model.php'
+				EE_MODELS.'*.model.php'
 			)
 		);
 		// add a wildcard recipe for loading core classes
@@ -139,12 +139,12 @@ 
                 array(),
                 CoffeeMaker::BREW_SHARED,
 				array(
-					EE_CORE . '*.core.php',
-					EE_ADMIN . '*.core.php',
-					EE_CPTS . '*.core.php',
-					EE_CORE . 'data_migration_scripts' . DS . '*.core.php',
-					EE_CORE . 'request_stack' . DS . '*.core.php',
-					EE_CORE . 'middleware' . DS . '*.core.php',
+					EE_CORE.'*.core.php',
+					EE_ADMIN.'*.core.php',
+					EE_CPTS.'*.core.php',
+					EE_CORE.'data_migration_scripts'.DS.'*.core.php',
+					EE_CORE.'request_stack'.DS.'*.core.php',
+					EE_CORE.'middleware'.DS.'*.core.php',
 				)
 			)
 		);
@@ -156,7 +156,7 @@ 
                 array(),
                 array(),
                 CoffeeMaker::BREW_LOAD_ONLY,
-				array( EE_ADMIN . '*.core.php' )
+				array(EE_ADMIN.'*.core.php')
 			)
 		);
 		// add a wildcard recipe for loading core classes

core/services/container/Recipe.php

Indentation +308 added lines, -308 removed lines

@@ -7,7 +7,7 @@ 
 use RuntimeException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -23,313 +23,313 @@ 
 class Recipe implements RecipeInterface
 {
 
-    /**
-     * A default Recipe to use if none is specified for a class
-     */
-    const DEFAULT_ID = '*';
-
-    /**
-     * Identifier for the entity class to be constructed.
-     * Typically a Fully Qualified Class Name
-     *
-     * @var string $identifier
-     */
-    private $identifier;
-
-    /**
-     * Fully Qualified Class Name
-     *
-     * @var string $fqcn
-     */
-    private $fqcn;
-
-    /**
-     * a dependency class map array
-     * If a Recipe is for a single class (or group of classes that shares the EXACT SAME constructor arguments),
-     * and that class type hints for an interface, then this property allows you to configure what dependencies
-     * get used when instantiating the class.
-     * For example:
-     *  There's a class called Coffee, and one of its constructor arguments is BeanInterface
-     *  There are two implementations of BeanInterface: HonduranBean, and KenyanBean
-     *  We want one Coffee object to use HonduranBean for its BeanInterface,
-     *  and the 2nd Coffee object to use KenyanBean for its BeanInterface.
-     *  To do this, we need to create two Recipes:
-     *      one with an identifier of 'HonduranCoffee' using the following ingredients :
-     *          array('BeanInterface' => 'HonduranBean')
-     *      and the other with an identifier of 'KenyanCoffee' using the following ingredients :
-     *          array('BeanInterface' => 'KenyanBean')
-     *  Then, whenever the CoffeeShop brews an instance of HonduranCoffee,
-     *  an instance of HonduranBean will get injected for the BeanInterface dependency,
-     *  and whenever the CoffeeShop brews an instance of KenyanCoffee,
-     *  an instance of KenyanBean will get injected for the BeanInterface dependency
-     *
-     * @var array $ingredients
-     */
-    private $ingredients = array();
-
-    /**
-     * one of the class constants from CoffeeShop:
-     *  CoffeeMaker::BREW_NEW - creates a new instance
-     *  CoffeeMaker::BREW_SHARED - creates a shared instance
-     *  CoffeeMaker::BREW_LOAD_ONLY - loads but does not instantiate
-     *
-     * @var string $type
-     */
-    private $type;
-
-    /**
-     * class name aliases - typically a Fully Qualified Interface that the class implements
-     * identifiers passed to the CoffeeShop will be run through the filters to find the correct class name
-     *
-     * @var array $filters
-     */
-    private $filters = array();
-
-    /**
-     * array of full server filepaths to files that may contain the class
-     *
-     * @var array $paths
-     */
-    private $paths = array();
-
-
-
-    /**
-     * Recipe constructor.
-     *
-     * @param string $identifier    class identifier, can be an alias, or FQCN, or whatever
-     * @param string $fqcn          \Fully\Qualified\ClassName, optional if $identifier is FQCN
-     * @param array  $ingredients   array of dependencies that can not be resolved automatically,
-     *                              used for resolving concrete classes for type hinted interfaces
-     *                              for the dependencies of THIS class
-     * @param string $type          recipe type: one of the class constants on
-     *                              \EventEspresso\core\services\container\CoffeeMaker
-     * @param array  $filters       array of class aliases, or class interfaces
-     *                              this works somewhat opposite to the $ingredients array above,
-     *                              in that this array specifies interfaces or aliases
-     *                              that this Recipe can be used for when resolving OTHER class's dependencies
-     * @param array  $paths         if class can not be loaded via PSR-4 autoloading,
-     *                              then supply a filepath, or array of filepaths, so that it can be included
-     */
-    public function __construct(
-	    $identifier,
-        $fqcn = '',
-        $filters = array(),
-        $ingredients = array(),
-	    $type = CoffeeMaker::BREW_NEW,
-	    $paths = array()
-    )
-    {
-        $this->setIdentifier($identifier);
-        $this->setFilters((array)$filters);
-        $this->setIngredients((array)$ingredients);
-        $this->setType($type);
-        $this->setPaths($paths);
-        $this->setFqcn($fqcn);
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function fqcn()
-    {
-        return $this->fqcn;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function filters()
-    {
-        return (array)$this->filters;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function ingredients()
-    {
-        return $this->ingredients;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function paths()
-    {
-        return (array)$this->paths;
-    }
-
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the Recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     */
-    public function setIdentifier($identifier)
-    {
-        if ( ! is_string($identifier) || empty($identifier)) {
-            throw new InvalidIdentifierException(
-                is_object($identifier) ? get_class($identifier) : gettype($identifier),
-                __('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
-            );
-        }
-        $this->identifier = $identifier;
-    }
-
-
-
-    /**
-     * Ensures incoming string is a valid Fully Qualified Class Name,
-     * except if this is the default wildcard Recipe ( * ),
-     * or it's NOT an actual FQCN because the Recipe is using filepaths
-     * for classes that are not PSR-4 compatible
-     * PLZ NOTE:
-     *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
-     *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
-     *
-     * @param string $fqcn
-     */
-    public function setFqcn($fqcn)
-    {
-	    $fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
-        if ( ! is_string($fqcn)) {
-            throw new InvalidDataTypeException(
-                '$fqcn',
-                is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
-                __('string (Fully\Qualified\ClassName)', 'event_espresso')
-            );
-        }
-        $fqcn = ltrim($fqcn, '\\');
-        if (
-            $fqcn !== Recipe::DEFAULT_ID
-            && ! empty($fqcn)
-            && empty($this->paths)
-            && ! class_exists($fqcn)
-        ) {
-            throw new InvalidClassException($fqcn);
-        }
-        $this->fqcn = $fqcn;
-    }
-
-
-
-    /**
-     * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
-     *                              example:
-     *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
-     */
-    public function setIngredients(array $ingredients)
-    {
-        if (empty($ingredients)) {
-            return;
-        }
-        if ( ! is_array($ingredients)) {
-            throw new InvalidDataTypeException(
-                '$ingredients',
-                is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
-                __('array of class dependencies', 'event_espresso')
-            );
-        }
-        $this->ingredients = array_merge($this->ingredients, $ingredients);
-    }
-
-
-    /**
-     * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
-     */
-    public function setType($type = CoffeeMaker::BREW_NEW)
-    {
-        $this->type = CoffeeMaker::validateType($type);
-    }
-
-
-
-    /**
-     * @param array $filters an array of filters where keys are the aliases and values are the FQCNs
-     *                          example:
-     *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
-     */
-    public function setFilters(array $filters)
-    {
-        if (empty($filters)) {
-            return;
-        }
-        if ( ! is_array($filters)) {
-            throw new InvalidDataTypeException(
-                '$filters',
-                is_object($filters) ? get_class($filters) : gettype($filters),
-                __('array of class aliases', 'event_espresso')
-            );
-        }
-        $this->filters = array_merge($this->filters, $filters);
-    }
-
-
-
-    /**
-     * Ensures incoming paths is a valid filepath, or array of valid filepaths,
-     * and merges them in with any existing filepaths
-     *
-     * PLZ NOTE:
-     *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
-     *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
-     *
-     * @param string|array $paths
-     */
-    public function setPaths($paths = array())
-    {
-        if (empty($paths)) {
-            return;
-        }
-        if ( ! (is_string($paths) || is_array($paths))) {
-            throw new InvalidDataTypeException(
-                '$path',
-                is_object($paths) ? get_class($paths) : gettype($paths),
-                __('string or array of strings (full server filepath(s))', 'event_espresso')
-            );
-        }
-        $paths = (array)$paths;
-        foreach ($paths as $path) {
-            if (strpos($path, '*') === false && ! is_readable($path)) {
-                throw new RuntimeException(
-                    sprintf(
-                        __('The following filepath is not readable: "%1$s"', 'event_espresso'),
-                        $path
-                    )
-                );
-            }
-        }
-        $this->paths = array_merge($this->paths, $paths);
-    }
+	/**
+	 * A default Recipe to use if none is specified for a class
+	 */
+	const DEFAULT_ID = '*';
+
+	/**
+	 * Identifier for the entity class to be constructed.
+	 * Typically a Fully Qualified Class Name
+	 *
+	 * @var string $identifier
+	 */
+	private $identifier;
+
+	/**
+	 * Fully Qualified Class Name
+	 *
+	 * @var string $fqcn
+	 */
+	private $fqcn;
+
+	/**
+	 * a dependency class map array
+	 * If a Recipe is for a single class (or group of classes that shares the EXACT SAME constructor arguments),
+	 * and that class type hints for an interface, then this property allows you to configure what dependencies
+	 * get used when instantiating the class.
+	 * For example:
+	 *  There's a class called Coffee, and one of its constructor arguments is BeanInterface
+	 *  There are two implementations of BeanInterface: HonduranBean, and KenyanBean
+	 *  We want one Coffee object to use HonduranBean for its BeanInterface,
+	 *  and the 2nd Coffee object to use KenyanBean for its BeanInterface.
+	 *  To do this, we need to create two Recipes:
+	 *      one with an identifier of 'HonduranCoffee' using the following ingredients :
+	 *          array('BeanInterface' => 'HonduranBean')
+	 *      and the other with an identifier of 'KenyanCoffee' using the following ingredients :
+	 *          array('BeanInterface' => 'KenyanBean')
+	 *  Then, whenever the CoffeeShop brews an instance of HonduranCoffee,
+	 *  an instance of HonduranBean will get injected for the BeanInterface dependency,
+	 *  and whenever the CoffeeShop brews an instance of KenyanCoffee,
+	 *  an instance of KenyanBean will get injected for the BeanInterface dependency
+	 *
+	 * @var array $ingredients
+	 */
+	private $ingredients = array();
+
+	/**
+	 * one of the class constants from CoffeeShop:
+	 *  CoffeeMaker::BREW_NEW - creates a new instance
+	 *  CoffeeMaker::BREW_SHARED - creates a shared instance
+	 *  CoffeeMaker::BREW_LOAD_ONLY - loads but does not instantiate
+	 *
+	 * @var string $type
+	 */
+	private $type;
+
+	/**
+	 * class name aliases - typically a Fully Qualified Interface that the class implements
+	 * identifiers passed to the CoffeeShop will be run through the filters to find the correct class name
+	 *
+	 * @var array $filters
+	 */
+	private $filters = array();
+
+	/**
+	 * array of full server filepaths to files that may contain the class
+	 *
+	 * @var array $paths
+	 */
+	private $paths = array();
+
+
+
+	/**
+	 * Recipe constructor.
+	 *
+	 * @param string $identifier    class identifier, can be an alias, or FQCN, or whatever
+	 * @param string $fqcn          \Fully\Qualified\ClassName, optional if $identifier is FQCN
+	 * @param array  $ingredients   array of dependencies that can not be resolved automatically,
+	 *                              used for resolving concrete classes for type hinted interfaces
+	 *                              for the dependencies of THIS class
+	 * @param string $type          recipe type: one of the class constants on
+	 *                              \EventEspresso\core\services\container\CoffeeMaker
+	 * @param array  $filters       array of class aliases, or class interfaces
+	 *                              this works somewhat opposite to the $ingredients array above,
+	 *                              in that this array specifies interfaces or aliases
+	 *                              that this Recipe can be used for when resolving OTHER class's dependencies
+	 * @param array  $paths         if class can not be loaded via PSR-4 autoloading,
+	 *                              then supply a filepath, or array of filepaths, so that it can be included
+	 */
+	public function __construct(
+		$identifier,
+		$fqcn = '',
+		$filters = array(),
+		$ingredients = array(),
+		$type = CoffeeMaker::BREW_NEW,
+		$paths = array()
+	)
+	{
+		$this->setIdentifier($identifier);
+		$this->setFilters((array)$filters);
+		$this->setIngredients((array)$ingredients);
+		$this->setType($type);
+		$this->setPaths($paths);
+		$this->setFqcn($fqcn);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function fqcn()
+	{
+		return $this->fqcn;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function filters()
+	{
+		return (array)$this->filters;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function ingredients()
+	{
+		return $this->ingredients;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function paths()
+	{
+		return (array)$this->paths;
+	}
+
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the Recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 */
+	public function setIdentifier($identifier)
+	{
+		if ( ! is_string($identifier) || empty($identifier)) {
+			throw new InvalidIdentifierException(
+				is_object($identifier) ? get_class($identifier) : gettype($identifier),
+				__('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
+			);
+		}
+		$this->identifier = $identifier;
+	}
+
+
+
+	/**
+	 * Ensures incoming string is a valid Fully Qualified Class Name,
+	 * except if this is the default wildcard Recipe ( * ),
+	 * or it's NOT an actual FQCN because the Recipe is using filepaths
+	 * for classes that are not PSR-4 compatible
+	 * PLZ NOTE:
+	 *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
+	 *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
+	 *
+	 * @param string $fqcn
+	 */
+	public function setFqcn($fqcn)
+	{
+		$fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
+		if ( ! is_string($fqcn)) {
+			throw new InvalidDataTypeException(
+				'$fqcn',
+				is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
+				__('string (Fully\Qualified\ClassName)', 'event_espresso')
+			);
+		}
+		$fqcn = ltrim($fqcn, '\\');
+		if (
+			$fqcn !== Recipe::DEFAULT_ID
+			&& ! empty($fqcn)
+			&& empty($this->paths)
+			&& ! class_exists($fqcn)
+		) {
+			throw new InvalidClassException($fqcn);
+		}
+		$this->fqcn = $fqcn;
+	}
+
+
+
+	/**
+	 * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
+	 *                              example:
+	 *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
+	 */
+	public function setIngredients(array $ingredients)
+	{
+		if (empty($ingredients)) {
+			return;
+		}
+		if ( ! is_array($ingredients)) {
+			throw new InvalidDataTypeException(
+				'$ingredients',
+				is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
+				__('array of class dependencies', 'event_espresso')
+			);
+		}
+		$this->ingredients = array_merge($this->ingredients, $ingredients);
+	}
+
+
+	/**
+	 * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
+	 */
+	public function setType($type = CoffeeMaker::BREW_NEW)
+	{
+		$this->type = CoffeeMaker::validateType($type);
+	}
+
+
+
+	/**
+	 * @param array $filters an array of filters where keys are the aliases and values are the FQCNs
+	 *                          example:
+	 *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
+	 */
+	public function setFilters(array $filters)
+	{
+		if (empty($filters)) {
+			return;
+		}
+		if ( ! is_array($filters)) {
+			throw new InvalidDataTypeException(
+				'$filters',
+				is_object($filters) ? get_class($filters) : gettype($filters),
+				__('array of class aliases', 'event_espresso')
+			);
+		}
+		$this->filters = array_merge($this->filters, $filters);
+	}
+
+
+
+	/**
+	 * Ensures incoming paths is a valid filepath, or array of valid filepaths,
+	 * and merges them in with any existing filepaths
+	 *
+	 * PLZ NOTE:
+	 *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
+	 *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
+	 *
+	 * @param string|array $paths
+	 */
+	public function setPaths($paths = array())
+	{
+		if (empty($paths)) {
+			return;
+		}
+		if ( ! (is_string($paths) || is_array($paths))) {
+			throw new InvalidDataTypeException(
+				'$path',
+				is_object($paths) ? get_class($paths) : gettype($paths),
+				__('string or array of strings (full server filepath(s))', 'event_espresso')
+			);
+		}
+		$paths = (array)$paths;
+		foreach ($paths as $path) {
+			if (strpos($path, '*') === false && ! is_readable($path)) {
+				throw new RuntimeException(
+					sprintf(
+						__('The following filepath is not readable: "%1$s"', 'event_espresso'),
+						$path
+					)
+				);
+			}
+		}
+		$this->paths = array_merge($this->paths, $paths);
+	}
 
 
 

Spacing +5 added lines, -5 removed lines

@@ -121,8 +121,8 @@ 
     )
     {
         $this->setIdentifier($identifier);
-        $this->setFilters((array)$filters);
-        $this->setIngredients((array)$ingredients);
+        $this->setFilters((array) $filters);
+        $this->setIngredients((array) $ingredients);
         $this->setType($type);
         $this->setPaths($paths);
         $this->setFqcn($fqcn);
@@ -155,7 +155,7 @@ 
      */
     public function filters()
     {
-        return (array)$this->filters;
+        return (array) $this->filters;
     }
 
 
@@ -185,7 +185,7 @@ 
      */
     public function paths()
     {
-        return (array)$this->paths;
+        return (array) $this->paths;
     }
 
 
@@ -317,7 +317,7 @@ 
                 __('string or array of strings (full server filepath(s))', 'event_espresso')
             );
         }
-        $paths = (array)$paths;
+        $paths = (array) $paths;
         foreach ($paths as $path) {
             if (strpos($path, '*') === false && ! is_readable($path)) {
                 throw new RuntimeException(

core/services/container/DependencyInjector.php

Indentation +209 added lines, -209 removed lines

@@ -4,7 +4,7 @@ 
 use UnexpectedValueException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -22,214 +22,214 @@ 
 class DependencyInjector implements InjectorInterface
 {
 
-    /**
-     * @var CoffeePotInterface $coffee_pot
-     */
-    private $coffee_pot;
-
-    /**
-     * @var \EEH_Array $array_helper
-     */
-    private $array_helper;
-
-    /**
-     * @var \ReflectionClass[] $reflectors
-     */
-    private $reflectors;
-
-    /**
-     * @var \ReflectionMethod[] $constructors
-     */
-    private $constructors;
-
-    /**
-     * @var \ReflectionParameter[] $parameters
-     */
-    private $parameters;
-
-
-
-    /**
-     * DependencyInjector constructor
-     *
-     * @param CoffeePotInterface $coffee_pot
-     * @param \EEH_Array         $array_helper
-     */
-    public function __construct(CoffeePotInterface $coffee_pot, \EEH_Array $array_helper)
-    {
-        $this->coffee_pot = $coffee_pot;
-        $this->array_helper = $array_helper;
-    }
-
-
-
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @param string $class_name
-     * @return \ReflectionClass
-     */
-    public function getReflectionClass($class_name)
-    {
-        if (
-            ! isset($this->reflectors[$class_name])
-            || ! $this->reflectors[$class_name] instanceof \ReflectionClass
-        ) {
-            $this->reflectors[$class_name] = new \ReflectionClass($class_name);
-        }
-        return $this->reflectors[$class_name];
-    }
-
-
-
-    /**
-     * getConstructor
-     * checks if a ReflectionMethod object has already been generated for the class constructor
-     * and returns that instead of creating a new one
-     *
-     * @param \ReflectionClass $reflector
-     * @return \ReflectionMethod
-     */
-    protected function getConstructor(\ReflectionClass $reflector)
-    {
-        if (
-            ! isset($this->constructors[$reflector->getName()])
-            || ! $this->constructors[$reflector->getName()] instanceof \ReflectionMethod
-        ) {
-            $this->constructors[$reflector->getName()] = $reflector->getConstructor();
-        }
-        return $this->constructors[$reflector->getName()];
-    }
-
-
-
-    /**
-     * getParameters
-     * checks if an array of ReflectionParameter objects has already been generated for the class constructor
-     * and returns that instead of creating a new one
-     *
-     * @param \ReflectionMethod $constructor
-     * @return \ReflectionParameter[]
-     */
-    protected function getParameters(\ReflectionMethod $constructor)
-    {
-        if ( ! isset($this->parameters[$constructor->class])) {
-            $this->parameters[$constructor->class] = $constructor->getParameters();
-        }
-        return $this->parameters[$constructor->class];
-    }
-
-
-
-    /**
-     * resolveDependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param RecipeInterface   $recipe
-     * @param \ReflectionClass  $reflector
-     * @param array             $arguments
-     * @return array
-     */
-    public function resolveDependencies(RecipeInterface $recipe, \ReflectionClass $reflector, $arguments = array())
-    {
-        // if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : array($arguments);
-        $resolved_parameters = array();
-        // let's examine the constructor
-        // let's examine the constructor
-        $constructor = $this->getConstructor($reflector);
-        // whu? huh? nothing?
-        if ( ! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $this->getParameters($constructor);
-        if (empty($params)) {
-            return $resolved_parameters;
-        }
-        $ingredients = $recipe->ingredients();
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            if ( ! $param instanceof \ReflectionParameter) {
-                continue;
-            }
-            // is this a dependency for a specific class ?
-            $param_class = $param->getClass() ? $param->getClass()->name : null;
-            if (
-                // param is specified in the list of ingredients for this Recipe
-                isset($ingredients[$param_class])
-            ) {
-                // attempt to inject the dependency
-                $resolved_parameters[$index] = $this->injectDependency($ingredients[$param_class]);
-            } else if (
-                // param is not even a class
-                empty($param_class)
-                // and something already exists in the incoming arguments for this param
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-            ) {
-                // add parameter from incoming arguments
-                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
-            } else if (
-                // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                ! empty($param_class)
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-                && $arguments[$argument_keys[$index]] instanceof $param_class
-            ) {
-                // add parameter from incoming arguments
-                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
-            } else if (
-                // parameter is type hinted as a class, and should be injected
-            ! empty($param_class)
-            ) {
-                // attempt to inject the dependency
-                $resolved_parameters[$index] = $this->injectDependency($param_class);
-            } else if ($param->isOptional()) {
-                $resolved_parameters[$index] = $param->getDefaultValue();
-            } else {
-                $resolved_parameters[$index] = null;
-            }
-        }
-        return $resolved_parameters;
-    }
-
-
-
-    /**
-     * @param string $param_class
-     * @return mixed
-     */
-    private function injectDependency($param_class)
-    {
-        $dependency = $this->coffee_pot->brew($param_class);
-        if ( ! $dependency instanceof $param_class) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    __(
-                        'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
-                        'event_espresso'
-                    ),
-                    $param_class
-                )
-            );
-        }
-        return $dependency;
-    }
+	/**
+	 * @var CoffeePotInterface $coffee_pot
+	 */
+	private $coffee_pot;
+
+	/**
+	 * @var \EEH_Array $array_helper
+	 */
+	private $array_helper;
+
+	/**
+	 * @var \ReflectionClass[] $reflectors
+	 */
+	private $reflectors;
+
+	/**
+	 * @var \ReflectionMethod[] $constructors
+	 */
+	private $constructors;
+
+	/**
+	 * @var \ReflectionParameter[] $parameters
+	 */
+	private $parameters;
+
+
+
+	/**
+	 * DependencyInjector constructor
+	 *
+	 * @param CoffeePotInterface $coffee_pot
+	 * @param \EEH_Array         $array_helper
+	 */
+	public function __construct(CoffeePotInterface $coffee_pot, \EEH_Array $array_helper)
+	{
+		$this->coffee_pot = $coffee_pot;
+		$this->array_helper = $array_helper;
+	}
+
+
+
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @param string $class_name
+	 * @return \ReflectionClass
+	 */
+	public function getReflectionClass($class_name)
+	{
+		if (
+			! isset($this->reflectors[$class_name])
+			|| ! $this->reflectors[$class_name] instanceof \ReflectionClass
+		) {
+			$this->reflectors[$class_name] = new \ReflectionClass($class_name);
+		}
+		return $this->reflectors[$class_name];
+	}
+
+
+
+	/**
+	 * getConstructor
+	 * checks if a ReflectionMethod object has already been generated for the class constructor
+	 * and returns that instead of creating a new one
+	 *
+	 * @param \ReflectionClass $reflector
+	 * @return \ReflectionMethod
+	 */
+	protected function getConstructor(\ReflectionClass $reflector)
+	{
+		if (
+			! isset($this->constructors[$reflector->getName()])
+			|| ! $this->constructors[$reflector->getName()] instanceof \ReflectionMethod
+		) {
+			$this->constructors[$reflector->getName()] = $reflector->getConstructor();
+		}
+		return $this->constructors[$reflector->getName()];
+	}
+
+
+
+	/**
+	 * getParameters
+	 * checks if an array of ReflectionParameter objects has already been generated for the class constructor
+	 * and returns that instead of creating a new one
+	 *
+	 * @param \ReflectionMethod $constructor
+	 * @return \ReflectionParameter[]
+	 */
+	protected function getParameters(\ReflectionMethod $constructor)
+	{
+		if ( ! isset($this->parameters[$constructor->class])) {
+			$this->parameters[$constructor->class] = $constructor->getParameters();
+		}
+		return $this->parameters[$constructor->class];
+	}
+
+
+
+	/**
+	 * resolveDependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param RecipeInterface   $recipe
+	 * @param \ReflectionClass  $reflector
+	 * @param array             $arguments
+	 * @return array
+	 */
+	public function resolveDependencies(RecipeInterface $recipe, \ReflectionClass $reflector, $arguments = array())
+	{
+		// if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: array($arguments);
+		$resolved_parameters = array();
+		// let's examine the constructor
+		// let's examine the constructor
+		$constructor = $this->getConstructor($reflector);
+		// whu? huh? nothing?
+		if ( ! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $this->getParameters($constructor);
+		if (empty($params)) {
+			return $resolved_parameters;
+		}
+		$ingredients = $recipe->ingredients();
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			if ( ! $param instanceof \ReflectionParameter) {
+				continue;
+			}
+			// is this a dependency for a specific class ?
+			$param_class = $param->getClass() ? $param->getClass()->name : null;
+			if (
+				// param is specified in the list of ingredients for this Recipe
+				isset($ingredients[$param_class])
+			) {
+				// attempt to inject the dependency
+				$resolved_parameters[$index] = $this->injectDependency($ingredients[$param_class]);
+			} else if (
+				// param is not even a class
+				empty($param_class)
+				// and something already exists in the incoming arguments for this param
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+			) {
+				// add parameter from incoming arguments
+				$resolved_parameters[$index] = $arguments[$argument_keys[$index]];
+			} else if (
+				// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
+				! empty($param_class)
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+				&& $arguments[$argument_keys[$index]] instanceof $param_class
+			) {
+				// add parameter from incoming arguments
+				$resolved_parameters[$index] = $arguments[$argument_keys[$index]];
+			} else if (
+				// parameter is type hinted as a class, and should be injected
+			! empty($param_class)
+			) {
+				// attempt to inject the dependency
+				$resolved_parameters[$index] = $this->injectDependency($param_class);
+			} else if ($param->isOptional()) {
+				$resolved_parameters[$index] = $param->getDefaultValue();
+			} else {
+				$resolved_parameters[$index] = null;
+			}
+		}
+		return $resolved_parameters;
+	}
+
+
+
+	/**
+	 * @param string $param_class
+	 * @return mixed
+	 */
+	private function injectDependency($param_class)
+	{
+		$dependency = $this->coffee_pot->brew($param_class);
+		if ( ! $dependency instanceof $param_class) {
+			throw new UnexpectedValueException(
+				sprintf(
+					__(
+						'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
+						'event_espresso'
+					),
+					$param_class
+				)
+			);
+		}
+		return $dependency;
+	}
 
 }
 // End of file DependencyInjector.php

core/services/container/InjectorInterface.php

Indentation +34 added lines, -34 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\services\container;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -17,39 +17,39 @@ 
 interface InjectorInterface
 {
 
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @access public
-     * @param string $class_name
-     * @return \ReflectionClass
-     */
-    public function getReflectionClass($class_name);
-
-
-
-    /**
-     * resolveDependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @access public
-     * @param \EventEspresso\core\services\container\RecipeInterface $recipe
-     * @param \ReflectionClass                                       $reflector
-     * @param array                                                  $arguments
-     * @return array
-     */
-    public function resolveDependencies(RecipeInterface $recipe, \ReflectionClass $reflector, $arguments = array());
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @access public
+	 * @param string $class_name
+	 * @return \ReflectionClass
+	 */
+	public function getReflectionClass($class_name);
+
+
+
+	/**
+	 * resolveDependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @access public
+	 * @param \EventEspresso\core\services\container\RecipeInterface $recipe
+	 * @param \ReflectionClass                                       $reflector
+	 * @param array                                                  $arguments
+	 * @return array
+	 */
+	public function resolveDependencies(RecipeInterface $recipe, \ReflectionClass $reflector, $arguments = array());
 
 }
 // End of file InjectorInterface.php

core/services/container/SharedCoffeeMaker.php

Indentation +38 added lines, -38 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\services\container;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,46 +24,46 @@ 
 
 
 
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return CoffeeMaker::BREW_SHARED;
-    }
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return CoffeeMaker::BREW_SHARED;
+	}
 
 
 
-    /**
-     * @param RecipeInterface $recipe
-     * @param array           $arguments
-     * @return mixed
-     */
-    public function brew(RecipeInterface $recipe, $arguments = array())
-    {
-        $this->resolveClassAndFilepath($recipe);
-        $reflector = $this->injector()->getReflectionClass($recipe->fqcn());
-        $method = $this->resolveInstantiationMethod($reflector);
-        switch ($method) {
-            case 'instance' :
-            case 'new_instance' :
-            case 'new_instance_from_db';
-                $service = call_user_func_array(
-                    array($reflector->getName(), $method),
-                    $this->injector()->resolveDependencies($recipe, $reflector, $arguments)
-                );
-                break;
-            case 'newInstance' :
-                $service = $reflector->newInstance();
-                break;
-            case 'newInstanceArgs' :
-            default :
-                $service = $reflector->newInstanceArgs(
-                    $this->injector()->resolveDependencies($recipe, $reflector, $arguments)
-                );
-        }
-        return $this->coffeePot()->addService($recipe->identifier(), $service);
-    }
+	/**
+	 * @param RecipeInterface $recipe
+	 * @param array           $arguments
+	 * @return mixed
+	 */
+	public function brew(RecipeInterface $recipe, $arguments = array())
+	{
+		$this->resolveClassAndFilepath($recipe);
+		$reflector = $this->injector()->getReflectionClass($recipe->fqcn());
+		$method = $this->resolveInstantiationMethod($reflector);
+		switch ($method) {
+			case 'instance' :
+			case 'new_instance' :
+			case 'new_instance_from_db';
+				$service = call_user_func_array(
+					array($reflector->getName(), $method),
+					$this->injector()->resolveDependencies($recipe, $reflector, $arguments)
+				);
+				break;
+			case 'newInstance' :
+				$service = $reflector->newInstance();
+				break;
+			case 'newInstanceArgs' :
+			default :
+				$service = $reflector->newInstanceArgs(
+					$this->injector()->resolveDependencies($recipe, $reflector, $arguments)
+				);
+		}
+		return $this->coffeePot()->addService($recipe->identifier(), $service);
+	}
 
 }
 // End of file SharedCoffeeMaker.php