eventespresso / event-espresso-core

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);
 	}

Braces +2 added lines, -3 removed lines

@@ -134,8 +134,7 @@ 
 				return;
 			}
 			echo '<h5>For Tag: '. $tag .'</h5>';
-		}
-		else {
+		} else {
 			$hook=$wp_filter;
 			ksort( $hook );
 		}
@@ -204,7 +203,7 @@ 
 		if( isset( $this->_start_times[ $timer_name ] ) ){
 			$start_time = $this->_start_times[ $timer_name ];
 			unset( $this->_start_times[ $timer_name ] );
-		}else{
+		} else{
 			$start_time = array_pop( $this->_start_times );
 		}
 		$this->_times[ $timer_name ] =  number_format( microtime( true ) - $start_time, 8 );

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

core/services/container/NewCoffeeMaker.php

Indentation +46 added lines, -46 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');
 }
 
 
@@ -25,54 +25,54 @@ 
 {
 
 
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return CoffeeMaker::BREW_NEW;
-    }
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return CoffeeMaker::BREW_NEW;
+	}
 
 
 
-    /**
-     * @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';
-                $injector = $this->injector();
-                $closure = function ($arguments) use ($recipe, $reflector, $method, $injector) {
-                    return call_user_func_array(
-                        array($reflector->getName(), $method),
-                        $injector->resolveDependencies($recipe, $reflector, $arguments)
-                    );
-                };
-                break;
-            case 'newInstance' :
-                $closure = function () use ($reflector) {
-                    return $reflector->newInstance();
-                };
-                break;
-            case 'newInstanceArgs' :
-            default :
-                $injector = $this->injector();
-                $closure = function ($arguments) use ($recipe, $reflector, $injector) {
-                    return $reflector->newInstanceArgs(
-                        $injector->resolveDependencies($recipe, $reflector, $arguments)
-                    );
-                };
-        }
-        return $this->coffeePot()->addClosure($recipe->identifier(), $closure);
-    }
+	/**
+	 * @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';
+				$injector = $this->injector();
+				$closure = function ($arguments) use ($recipe, $reflector, $method, $injector) {
+					return call_user_func_array(
+						array($reflector->getName(), $method),
+						$injector->resolveDependencies($recipe, $reflector, $arguments)
+					);
+				};
+				break;
+			case 'newInstance' :
+				$closure = function () use ($reflector) {
+					return $reflector->newInstance();
+				};
+				break;
+			case 'newInstanceArgs' :
+			default :
+				$injector = $this->injector();
+				$closure = function ($arguments) use ($recipe, $reflector, $injector) {
+					return $reflector->newInstanceArgs(
+						$injector->resolveDependencies($recipe, $reflector, $arguments)
+					);
+				};
+		}
+		return $this->coffeePot()->addClosure($recipe->identifier(), $closure);
+	}
 
 
 }

Spacing +3 added lines, -3 removed lines

@@ -50,7 +50,7 @@ 
             case 'new_instance' :
             case 'new_instance_from_db';
                 $injector = $this->injector();
-                $closure = function ($arguments) use ($recipe, $reflector, $method, $injector) {
+                $closure = function($arguments) use ($recipe, $reflector, $method, $injector) {
                     return call_user_func_array(
                         array($reflector->getName(), $method),
                         $injector->resolveDependencies($recipe, $reflector, $arguments)
@@ -58,14 +58,14 @@ 
                 };
                 break;
             case 'newInstance' :
-                $closure = function () use ($reflector) {
+                $closure = function() use ($reflector) {
                     return $reflector->newInstance();
                 };
                 break;
             case 'newInstanceArgs' :
             default :
                 $injector = $this->injector();
-                $closure = function ($arguments) use ($recipe, $reflector, $injector) {
+                $closure = function($arguments) use ($recipe, $reflector, $injector) {
                     return $reflector->newInstanceArgs(
                         $injector->resolveDependencies($recipe, $reflector, $arguments)
                     );

core/services/container/RecipeInterface.php

Indentation +79 added lines, -79 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,84 +17,84 @@ 
 interface RecipeInterface
 {
 
-    /**
-     * @return string
-     */
-    public function identifier();
-
-    /**
-     * @return string
-     */
-    public function fqcn();
-
-    /**
-     * @return array
-     */
-    public function ingredients();
-
-    /**
-     * @return string
-     */
-    public function type();
-
-    /**
-     * @return array
-     */
-    public function filters();
-
-    /**
-     * @return array
-     */
-    public function paths();
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the Recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     */
-    public function setIdentifier($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);
-
-    /**
-     * @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);
-
-    /**
-     * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
-     */
-    public function setType($type = CoffeeMaker::BREW_NEW);
-
-    /**
-     * @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);
-
-    /**
-     * 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());
+	/**
+	 * @return string
+	 */
+	public function identifier();
+
+	/**
+	 * @return string
+	 */
+	public function fqcn();
+
+	/**
+	 * @return array
+	 */
+	public function ingredients();
+
+	/**
+	 * @return string
+	 */
+	public function type();
+
+	/**
+	 * @return array
+	 */
+	public function filters();
+
+	/**
+	 * @return array
+	 */
+	public function paths();
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the Recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 */
+	public function setIdentifier($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);
+
+	/**
+	 * @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);
+
+	/**
+	 * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
+	 */
+	public function setType($type = CoffeeMaker::BREW_NEW);
+
+	/**
+	 * @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);
+
+	/**
+	 * 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());
 
 }
 // End of file RecipeInterface.php

core/EE_Network_Config.core.php

Spacing +32 added lines, -32 removed lines

@@ -58,7 +58,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated, and instantiated properly
-		if ( self::$_instance === NULL  or ! is_object( self::$_instance ) or ! ( self::$_instance instanceof EE_Network_Config )) {
+		if (self::$_instance === NULL or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Network_Config)) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -73,15 +73,15 @@ 
 	 *  @access 	private
 	 */
 	private function __construct() {
-		do_action( 'AHEE__EE_Network_Config__construct__begin',$this );
+		do_action('AHEE__EE_Network_Config__construct__begin', $this);
 		//set defaults
-		$this->core = apply_filters( 'FHEE__EE_Network_Config___construct__core', new EE_Network_Core_Config() );
+		$this->core = apply_filters('FHEE__EE_Network_Config___construct__core', new EE_Network_Core_Config());
 		$this->addons = array();
 
 		$this->_load_config();
 
 		// construct__end hook
-		do_action( 'AHEE__EE_Network_Config__construct__end',$this );
+		do_action('AHEE__EE_Network_Config__construct__end', $this);
 	}
 
 
@@ -94,25 +94,25 @@ 
 	 */
 	private function _load_config() {
 		//load network config start hook
-		do_action( 'AHEE__EE_Network_Config___load_config__start', $this );
+		do_action('AHEE__EE_Network_Config___load_config__start', $this);
 		$config = $this->get_config();
-		foreach ( $config as $config_prop => $settings ) {
-			if ( is_object( $settings ) && property_exists( $this, $config_prop ) ) {
-				$this->{$config_prop} = apply_filters( 'FHEE__EE_Network_Config___load_config__config_settings', $settings, $config_prop, $this );
-				if ( method_exists( $settings, 'populate' ) ) {
+		foreach ($config as $config_prop => $settings) {
+			if (is_object($settings) && property_exists($this, $config_prop)) {
+				$this->{$config_prop} = apply_filters('FHEE__EE_Network_Config___load_config__config_settings', $settings, $config_prop, $this);
+				if (method_exists($settings, 'populate')) {
 					$this->{$config_prop}->populate();
 				}
-				if ( method_exists( $settings, 'do_hooks' ) ) {
+				if (method_exists($settings, 'do_hooks')) {
 					$this->{$config_prop}->do_hooks();
 				}
 			}
 		}
-		if ( apply_filters( 'FHEE__EE_Network_Config___load_config__update_network_config', false ) ) {
+		if (apply_filters('FHEE__EE_Network_Config___load_config__update_network_config', false)) {
 			$this->update_config();
 		}
 
 		//load network config end hook
-		do_action( 'AHEE__EE_Network_Config___load_config__end', $this );
+		do_action('AHEE__EE_Network_Config___load_config__end', $this);
 	}
 
 
@@ -126,8 +126,8 @@ 
 	 */
 	public function get_config() {
 		// grab network configuration
-		$CFG = get_site_option( 'ee_network_config', array() );
-		$CFG = apply_filters( 'FHEE__EE_Network_Config__get_config__CFG', $CFG );
+		$CFG = get_site_option('ee_network_config', array());
+		$CFG = apply_filters('FHEE__EE_Network_Config__get_config__CFG', $CFG);
 		return $CFG;
 	}
 
@@ -141,39 +141,39 @@ 
 	 * @param bool $add_error
 	 * @return bool success
 	 */
-	public function update_config( $add_success = FALSE, $add_error = TRUE ) {
-		do_action( 'AHEE__EE_Network_Config__update_config__begin',$this );
+	public function update_config($add_success = FALSE, $add_error = TRUE) {
+		do_action('AHEE__EE_Network_Config__update_config__begin', $this);
 
 		//need to bust cache for comparing original if this is a multisite install
-		if ( is_multisite() ) {
+		if (is_multisite()) {
 			global $current_site;
-			$cache_key = $current_site->id . ':ee_network_config';
-			wp_cache_delete( $cache_key, 'site-options' );
+			$cache_key = $current_site->id.':ee_network_config';
+			wp_cache_delete($cache_key, 'site-options');
 		}
 
 		//we have to compare existing saved config with config in memory because if there is no difference that means
 		//that the method executed fine but there just was no update.  WordPress doesn't distinguish between false because
 		//there were 0 records updated because of no change vs false because some error produced problems with the update.
-		$original = get_site_option( 'ee_network_config' );
+		$original = get_site_option('ee_network_config');
 
-		if ( $original == $this ) {
+		if ($original == $this) {
 			return true;
 		}
 		// update
-		$saved = update_site_option( 'ee_network_config', $this );
+		$saved = update_site_option('ee_network_config', $this);
 
-		do_action( 'AHEE__EE_Network_Config__update_config__end', $this, $saved );
+		do_action('AHEE__EE_Network_Config__update_config__end', $this, $saved);
 		// if config remains the same or was updated successfully
-		if ( $saved ) {
-			if ( $add_success ) {
-				$msg = is_multisite() ? __( 'The Event Espresso Network Configuration Settings have been successfully updated.', 'event_espresso' ) : __( 'Extra Event Espresso Configuration settings were successfully updated.', 'event_espresso' );
-				EE_Error::add_success( $msg );
+		if ($saved) {
+			if ($add_success) {
+				$msg = is_multisite() ? __('The Event Espresso Network Configuration Settings have been successfully updated.', 'event_espresso') : __('Extra Event Espresso Configuration settings were successfully updated.', 'event_espresso');
+				EE_Error::add_success($msg);
 			}
 			return true;
 		} else {
-			if ( $add_error ) {
-				$msg = is_multisite() ? __( 'The Event Espresso Network Configuration Settings were not updated.', 'event_espresso' ) : __( 'Extra Event Espresso Network Configuration settings were not updated.', 'event_espresso' );
-				EE_Error::add_error( $msg , __FILE__, __FUNCTION__, __LINE__ );
+			if ($add_error) {
+				$msg = is_multisite() ? __('The Event Espresso Network Configuration Settings were not updated.', 'event_espresso') : __('Extra Event Espresso Network Configuration settings were not updated.', 'event_espresso');
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
 			}
 			return false;
 		}
@@ -187,9 +187,9 @@ 
 	 *  @return 	array
 	 */
 	public function __sleep() {
-		return apply_filters( 'FHEE__EE_Network_Config__sleep',array(
+		return apply_filters('FHEE__EE_Network_Config__sleep', array(
 			'core',
-		) );
+		));
 	}
 
 } //end EE_Network_Config.

Braces +3 added lines, -1 removed lines

@@ -1,4 +1,6 @@
-<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 /**
  * Event Espresso
  *