eventespresso / event-espresso-core

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_state_system_question.dmsstage.php

Spacing +6 added lines, -6 removed lines

@@ -23,7 +23,7 @@ 
     {
         global $wpdb;
         $this->_pretty_name = esc_html__('State - System Question', 'event_espresso');
-        $this->_old_table = $wpdb->prefix . 'esp_question';
+        $this->_old_table = $wpdb->prefix.'esp_question';
         $this->_extra_where_sql = "WHERE QST_system = 'state'";
         parent::__construct();
     }
@@ -41,12 +41,12 @@ 
             global $wpdb;
             $success = $wpdb->update(
                 $this->_old_table,
-                array( 'QST_type' => 'STATE' ),  // data
-                array( 'QST_ID' => $question['QST_ID'] ),  // where
-                array( '%s' ),   // data format
-                array( '%d' )  // where format
+                array('QST_type' => 'STATE'), // data
+                array('QST_ID' => $question['QST_ID']), // where
+                array('%s'), // data format
+                array('%d')  // where format
             );
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error(
                     sprintf(
                         esc_html__('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),

Indentation +41 added lines, -41 removed lines

@@ -11,48 +11,48 @@
  */
 class EE_DMS_4_6_0_state_system_question extends EE_Data_Migration_Script_Stage_Table
 {
-    /**
-     * Just initializes the status of the migration
-     *
-     * @return EE_DMS_4_6_0_state_system_question
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = esc_html__('State - System Question', 'event_espresso');
-        $this->_old_table = $wpdb->prefix . 'esp_question';
-        $this->_extra_where_sql = "WHERE QST_system = 'state'";
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @return EE_DMS_4_6_0_state_system_question
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = esc_html__('State - System Question', 'event_espresso');
+		$this->_old_table = $wpdb->prefix . 'esp_question';
+		$this->_extra_where_sql = "WHERE QST_system = 'state'";
+		parent::__construct();
+	}
 
 
 
-    /**
-     * updates the question with the new question type
-     * @param array $question an associative array where keys are column names and values are their values.
-     * @return null
-     */
-    protected function _migrate_old_row($question)
-    {
-        if ($question['QST_ID'] && $question['QST_system'] == 'state') {
-            global $wpdb;
-            $success = $wpdb->update(
-                $this->_old_table,
-                array( 'QST_type' => 'STATE' ),  // data
-                array( 'QST_ID' => $question['QST_ID'] ),  // where
-                array( '%s' ),   // data format
-                array( '%d' )  // where format
-            );
-            if (! $success) {
-                $this->add_error(
-                    sprintf(
-                        esc_html__('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),
-                        wp_json_encode($question['QST_system']),
-                        $question['QST_ID'],
-                        $wpdb->last_error
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 * updates the question with the new question type
+	 * @param array $question an associative array where keys are column names and values are their values.
+	 * @return null
+	 */
+	protected function _migrate_old_row($question)
+	{
+		if ($question['QST_ID'] && $question['QST_system'] == 'state') {
+			global $wpdb;
+			$success = $wpdb->update(
+				$this->_old_table,
+				array( 'QST_type' => 'STATE' ),  // data
+				array( 'QST_ID' => $question['QST_ID'] ),  // where
+				array( '%s' ),   // data format
+				array( '%d' )  // where format
+			);
+			if (! $success) {
+				$this->add_error(
+					sprintf(
+						esc_html__('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),
+						wp_json_encode($question['QST_system']),
+						$question['QST_ID'],
+						$wpdb->last_error
+					)
+				);
+			}
+		}
+	}
 }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_payments.dmsstage.php

Indentation +78 added lines, -78 removed lines

@@ -11,44 +11,44 @@ 
  */
 class EE_DMS_4_6_0_payments extends EE_Data_Migration_Script_Stage_Table
 {
-    protected $_payment_method_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_payment';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
-        $this->_pretty_name = esc_html__('Payment-Payment Method Relations', 'event_espresso');
-        parent::__construct();
-    }
-    protected function _migrate_old_row($payment_row)
-    {
-        global $wpdb;
-        // get the payment method's ID
-        $PMD_ID = apply_filters('FHEE__EE_DMS_4_6_0_payments__migrate_old_row__PMD_ID', $this->_get_payment_method_id_by_gateway_name($payment_row['PAY_gateway'], $payment_row['PAY_method']));
-        if (! $PMD_ID) {
-            $this->add_error(sprintf(esc_html__('Could not find payment method with PMD_type = \'%1$s\' when migrating payment row %2$s so just assigned it an unknown payment method', 'event_espresso'), $payment_row['PAY_gateway'], $this->_json_encode($payment_row)));
-            $PMD_ID = 0;
-        }
-        $new_values = array(
-            'PMD_ID' => $PMD_ID,
-            'PAY_source' => ( $payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART' ) );
-        $wheres = array( 'PAY_ID' => $payment_row['PAY_ID'] );
-        $new_value_datatypes = array( '%d', '%s' );
-        $where_datatypes = array( '%d' );
-        $success = $wpdb->update(
-            $this->_old_table,
-            $new_values,
-            $wheres,
-            $new_value_datatypes,
-            $where_datatypes
-        );
-        if (! $success) {
-            $this->add_error(sprintf(esc_html__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_old_table, $this->_json_encode($wheres)));
-        }
-    }
-    /**
-     *
-     *  array(
+	protected $_payment_method_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix . 'esp_payment';
+		$this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+		$this->_pretty_name = esc_html__('Payment-Payment Method Relations', 'event_espresso');
+		parent::__construct();
+	}
+	protected function _migrate_old_row($payment_row)
+	{
+		global $wpdb;
+		// get the payment method's ID
+		$PMD_ID = apply_filters('FHEE__EE_DMS_4_6_0_payments__migrate_old_row__PMD_ID', $this->_get_payment_method_id_by_gateway_name($payment_row['PAY_gateway'], $payment_row['PAY_method']));
+		if (! $PMD_ID) {
+			$this->add_error(sprintf(esc_html__('Could not find payment method with PMD_type = \'%1$s\' when migrating payment row %2$s so just assigned it an unknown payment method', 'event_espresso'), $payment_row['PAY_gateway'], $this->_json_encode($payment_row)));
+			$PMD_ID = 0;
+		}
+		$new_values = array(
+			'PMD_ID' => $PMD_ID,
+			'PAY_source' => ( $payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART' ) );
+		$wheres = array( 'PAY_ID' => $payment_row['PAY_ID'] );
+		$new_value_datatypes = array( '%d', '%s' );
+		$where_datatypes = array( '%d' );
+		$success = $wpdb->update(
+			$this->_old_table,
+			$new_values,
+			$wheres,
+			$new_value_datatypes,
+			$where_datatypes
+		);
+		if (! $success) {
+			$this->add_error(sprintf(esc_html__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_old_table, $this->_json_encode($wheres)));
+		}
+	}
+	/**
+	 *
+	 *  array(
             'PP' => esc_html__( 'PayPal', 'event_espresso' ),
             'CC' => esc_html__( 'Credit Card', 'event_espresso' ),
             'DB'=>  esc_html__("Debit Card", 'event_espresso'),
@@ -57,44 +57,44 @@ 
             'BK'=>  esc_html__("Bank", 'event_espresso'),
             'IV'=>  esc_html__("Invoice", 'event_espresso'),
             'MO'=>  esc_html__("Money Order", 'event_espresso'),
-     * @global type $wpdb
-     * @param int $id
-     * @return string
-     */
-    protected function _get_payment_method_id_by_gateway_name($gateway_name, $old_pay_method_column)
-    {
-        global $wpdb;
-        // convert from old known PAY_method values to their corresponding
-        // PMD_type or default PMD_name
-        switch ($old_pay_method_column) {
-            case 'PP':
-                $pmd_type = 'Paypal_Standard';
-                break;
-            case 'CC':
-                $pmd_type = 'Credit_Card';
-                break;
-            case 'DB':
-                $pmd_type = 'Debit_Card';
-                break;
-            case 'CHQ':
-                $pmd_type = 'Check';
-                break;
-            case 'CSH':
-                $pmd_type = 'Cash';
-                break;
-            case 'BK':
-                $pmd_type = 'Bank';
-                break;
-            case 'IV':
-                $pmd_type = 'Invoice';
-                break;
-            case 'MO':
-                $pmd_type = 'Money_Order';
-                break;
-            default:
-                $pmd_type = $gateway_name;
-        }
-        $pmd_name = str_replace("_", " ", $pmd_type);
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
-    }
+	 * @global type $wpdb
+	 * @param int $id
+	 * @return string
+	 */
+	protected function _get_payment_method_id_by_gateway_name($gateway_name, $old_pay_method_column)
+	{
+		global $wpdb;
+		// convert from old known PAY_method values to their corresponding
+		// PMD_type or default PMD_name
+		switch ($old_pay_method_column) {
+			case 'PP':
+				$pmd_type = 'Paypal_Standard';
+				break;
+			case 'CC':
+				$pmd_type = 'Credit_Card';
+				break;
+			case 'DB':
+				$pmd_type = 'Debit_Card';
+				break;
+			case 'CHQ':
+				$pmd_type = 'Check';
+				break;
+			case 'CSH':
+				$pmd_type = 'Cash';
+				break;
+			case 'BK':
+				$pmd_type = 'Bank';
+				break;
+			case 'IV':
+				$pmd_type = 'Invoice';
+				break;
+			case 'MO':
+				$pmd_type = 'Money_Order';
+				break;
+			default:
+				$pmd_type = $gateway_name;
+		}
+		$pmd_name = str_replace("_", " ", $pmd_type);
+		return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -15,8 +15,8 @@ 
     public function __construct()
     {
         global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_payment';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+        $this->_old_table = $wpdb->prefix.'esp_payment';
+        $this->_payment_method_table = $wpdb->prefix.'esp_payment_method';
         $this->_pretty_name = esc_html__('Payment-Payment Method Relations', 'event_espresso');
         parent::__construct();
     }
@@ -25,16 +25,16 @@ 
         global $wpdb;
         // get the payment method's ID
         $PMD_ID = apply_filters('FHEE__EE_DMS_4_6_0_payments__migrate_old_row__PMD_ID', $this->_get_payment_method_id_by_gateway_name($payment_row['PAY_gateway'], $payment_row['PAY_method']));
-        if (! $PMD_ID) {
+        if ( ! $PMD_ID) {
             $this->add_error(sprintf(esc_html__('Could not find payment method with PMD_type = \'%1$s\' when migrating payment row %2$s so just assigned it an unknown payment method', 'event_espresso'), $payment_row['PAY_gateway'], $this->_json_encode($payment_row)));
             $PMD_ID = 0;
         }
         $new_values = array(
             'PMD_ID' => $PMD_ID,
-            'PAY_source' => ( $payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART' ) );
-        $wheres = array( 'PAY_ID' => $payment_row['PAY_ID'] );
-        $new_value_datatypes = array( '%d', '%s' );
-        $where_datatypes = array( '%d' );
+            'PAY_source' => ($payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART') );
+        $wheres = array('PAY_ID' => $payment_row['PAY_ID']);
+        $new_value_datatypes = array('%d', '%s');
+        $where_datatypes = array('%d');
         $success = $wpdb->update(
             $this->_old_table,
             $new_values,
@@ -42,7 +42,7 @@ 
             $new_value_datatypes,
             $where_datatypes
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(sprintf(esc_html__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_old_table, $this->_json_encode($wheres)));
         }
     }
@@ -95,6 +95,6 @@ 
                 $pmd_type = $gateway_name;
         }
         $pmd_name = str_replace("_", " ", $pmd_type);
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
+        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM ".$wpdb->prefix."esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
     }
 }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_transactions.dmsstage.php

Indentation +47 added lines, -47 removed lines

@@ -11,51 +11,51 @@
  */
 class EE_DMS_4_6_0_transactions extends EE_Data_Migration_Script_Stage_Table
 {
-    protected $_transaction_table;
-    protected $_payment_method_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_extra_meta';
-        $this->_transaction_table = $wpdb->prefix . 'esp_transaction';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
-        $this->_pretty_name = esc_html__('Transaction Payment Method Relations', 'event_espresso');
-        $this->_extra_where_sql = "WHERE EXM_key = 'gateway' AND EXM_type = 'Transaction'";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($extra_meta_row)
-    {
-        global $wpdb;
-        // get the payment method's ID
-        $PMD_ID = $this->_get_payment_method_id_by_gateway_name($extra_meta_row['EXM_value']);
-        if (! $PMD_ID) {
-            $this->add_error(sprintf(esc_html__('Could not find payment method with PMD_type = \'%1$s\' when migrating extra meta row %2$s', 'event_espresso'), $extra_meta_row['EXM_value'], $this->_json_encode($extra_meta_row)));
-            return;
-        }
-        $new_values = array( 'PMD_ID' => $PMD_ID );
-        $wheres = array( 'TXN_ID' => $extra_meta_row['OBJ_ID'] );
-        $new_value_datatypes = array( '%d' );
-        $where_datatypes = array( '%d' );
-        $success = $wpdb->update(
-            $this->_transaction_table,
-            $new_values,
-            $wheres,
-            $new_value_datatypes,
-            $where_datatypes
-        );
-        if (! $success) {
-            $this->add_error(sprintf(esc_html__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_transaction_table, $this->_json_encode($wheres)));
-        }
-    }
-    /**
-     *
-     * @global type $wpdb
-     * @param int $id
-     * @return string
-     */
-    protected function _get_payment_method_id_by_gateway_name($gateway_name)
-    {
-        global $wpdb;
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s", $gateway_name));
-    }
+	protected $_transaction_table;
+	protected $_payment_method_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix . 'esp_extra_meta';
+		$this->_transaction_table = $wpdb->prefix . 'esp_transaction';
+		$this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+		$this->_pretty_name = esc_html__('Transaction Payment Method Relations', 'event_espresso');
+		$this->_extra_where_sql = "WHERE EXM_key = 'gateway' AND EXM_type = 'Transaction'";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($extra_meta_row)
+	{
+		global $wpdb;
+		// get the payment method's ID
+		$PMD_ID = $this->_get_payment_method_id_by_gateway_name($extra_meta_row['EXM_value']);
+		if (! $PMD_ID) {
+			$this->add_error(sprintf(esc_html__('Could not find payment method with PMD_type = \'%1$s\' when migrating extra meta row %2$s', 'event_espresso'), $extra_meta_row['EXM_value'], $this->_json_encode($extra_meta_row)));
+			return;
+		}
+		$new_values = array( 'PMD_ID' => $PMD_ID );
+		$wheres = array( 'TXN_ID' => $extra_meta_row['OBJ_ID'] );
+		$new_value_datatypes = array( '%d' );
+		$where_datatypes = array( '%d' );
+		$success = $wpdb->update(
+			$this->_transaction_table,
+			$new_values,
+			$wheres,
+			$new_value_datatypes,
+			$where_datatypes
+		);
+		if (! $success) {
+			$this->add_error(sprintf(esc_html__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_transaction_table, $this->_json_encode($wheres)));
+		}
+	}
+	/**
+	 *
+	 * @global type $wpdb
+	 * @param int $id
+	 * @return string
+	 */
+	protected function _get_payment_method_id_by_gateway_name($gateway_name)
+	{
+		global $wpdb;
+		return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s", $gateway_name));
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -16,9 +16,9 @@ 
     public function __construct()
     {
         global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_extra_meta';
-        $this->_transaction_table = $wpdb->prefix . 'esp_transaction';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+        $this->_old_table = $wpdb->prefix.'esp_extra_meta';
+        $this->_transaction_table = $wpdb->prefix.'esp_transaction';
+        $this->_payment_method_table = $wpdb->prefix.'esp_payment_method';
         $this->_pretty_name = esc_html__('Transaction Payment Method Relations', 'event_espresso');
         $this->_extra_where_sql = "WHERE EXM_key = 'gateway' AND EXM_type = 'Transaction'";
         parent::__construct();
@@ -28,14 +28,14 @@ 
         global $wpdb;
         // get the payment method's ID
         $PMD_ID = $this->_get_payment_method_id_by_gateway_name($extra_meta_row['EXM_value']);
-        if (! $PMD_ID) {
+        if ( ! $PMD_ID) {
             $this->add_error(sprintf(esc_html__('Could not find payment method with PMD_type = \'%1$s\' when migrating extra meta row %2$s', 'event_espresso'), $extra_meta_row['EXM_value'], $this->_json_encode($extra_meta_row)));
             return;
         }
-        $new_values = array( 'PMD_ID' => $PMD_ID );
-        $wheres = array( 'TXN_ID' => $extra_meta_row['OBJ_ID'] );
-        $new_value_datatypes = array( '%d' );
-        $where_datatypes = array( '%d' );
+        $new_values = array('PMD_ID' => $PMD_ID);
+        $wheres = array('TXN_ID' => $extra_meta_row['OBJ_ID']);
+        $new_value_datatypes = array('%d');
+        $where_datatypes = array('%d');
         $success = $wpdb->update(
             $this->_transaction_table,
             $new_values,
@@ -43,7 +43,7 @@ 
             $new_value_datatypes,
             $where_datatypes
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(sprintf(esc_html__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_transaction_table, $this->_json_encode($wheres)));
         }
     }
@@ -56,6 +56,6 @@ 
     protected function _get_payment_method_id_by_gateway_name($gateway_name)
     {
         global $wpdb;
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s", $gateway_name));
+        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM ".$wpdb->prefix."esp_payment_method WHERE PMD_type = %s", $gateway_name));
     }
 }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_country_system_question.dmsstage.php

Spacing +6 added lines, -6 removed lines

@@ -23,7 +23,7 @@ 
     {
         global $wpdb;
         $this->_pretty_name = esc_html__('Country - System Question', 'event_espresso');
-        $this->_old_table = $wpdb->prefix . 'esp_question';
+        $this->_old_table = $wpdb->prefix.'esp_question';
         $this->_extra_where_sql = "WHERE QST_system = 'country'";
         parent::__construct();
     }
@@ -41,12 +41,12 @@ 
             global $wpdb;
             $success = $wpdb->update(
                 $this->_old_table,
-                array( 'QST_type' => 'COUNTRY' ),  // data
-                array( 'QST_ID' => $question['QST_ID'] ),  // where
-                array( '%s' ),   // data format
-                array( '%d' )  // where format
+                array('QST_type' => 'COUNTRY'), // data
+                array('QST_ID' => $question['QST_ID']), // where
+                array('%s'), // data format
+                array('%d')  // where format
             );
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error(
                     sprintf(
                         esc_html__('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),

Indentation +41 added lines, -41 removed lines

@@ -11,48 +11,48 @@
  */
 class EE_DMS_4_6_0_country_system_question extends EE_Data_Migration_Script_Stage_Table
 {
-    /**
-     * Just initializes the status of the migration
-     *
-     * @return EE_DMS_4_6_0_country_system_question
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = esc_html__('Country - System Question', 'event_espresso');
-        $this->_old_table = $wpdb->prefix . 'esp_question';
-        $this->_extra_where_sql = "WHERE QST_system = 'country'";
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @return EE_DMS_4_6_0_country_system_question
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = esc_html__('Country - System Question', 'event_espresso');
+		$this->_old_table = $wpdb->prefix . 'esp_question';
+		$this->_extra_where_sql = "WHERE QST_system = 'country'";
+		parent::__construct();
+	}
 
 
 
-    /**
-     * updates the question with the new question type
-     * @param array $question an associative array where keys are column names and values are their values.
-     * @return null
-     */
-    protected function _migrate_old_row($question)
-    {
-        if ($question['QST_ID'] && $question['QST_system'] == 'country') {
-            global $wpdb;
-            $success = $wpdb->update(
-                $this->_old_table,
-                array( 'QST_type' => 'COUNTRY' ),  // data
-                array( 'QST_ID' => $question['QST_ID'] ),  // where
-                array( '%s' ),   // data format
-                array( '%d' )  // where format
-            );
-            if (! $success) {
-                $this->add_error(
-                    sprintf(
-                        esc_html__('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),
-                        wp_json_encode($question['QST_system']),
-                        $question['QST_ID'],
-                        $wpdb->last_error
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 * updates the question with the new question type
+	 * @param array $question an associative array where keys are column names and values are their values.
+	 * @return null
+	 */
+	protected function _migrate_old_row($question)
+	{
+		if ($question['QST_ID'] && $question['QST_system'] == 'country') {
+			global $wpdb;
+			$success = $wpdb->update(
+				$this->_old_table,
+				array( 'QST_type' => 'COUNTRY' ),  // data
+				array( 'QST_ID' => $question['QST_ID'] ),  // where
+				array( '%s' ),   // data format
+				array( '%d' )  // where format
+			);
+			if (! $success) {
+				$this->add_error(
+					sprintf(
+						esc_html__('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),
+						wp_json_encode($question['QST_system']),
+						$question['QST_ID'],
+						$wpdb->last_error
+					)
+				);
+			}
+		}
+	}
 }

core/data_migration_scripts/4_5_0_stages/EE_DMS_4_5_0_invoice_settings.dmsstage.php

Spacing +4 added lines, -4 removed lines

@@ -54,11 +54,11 @@ 
     protected function _migration_step($num_items = 1)
     {
         // if this isn't set then something is really wrong
-        if (! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
+        if ( ! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
             throw new EE_Error(esc_html__('It appears the Event Espresso Core Configuration is not setup correctly.', 'event_espresso'));
         }
         $invoice_settings = isset(EE_Config::instance()->gateway->payment_settings['Invoice']) ? EE_Config::instance()->gateway->payment_settings['Invoice'] : null;
-        if (! $invoice_settings) {
+        if ( ! $invoice_settings) {
             $this->add_error(esc_html__('Could not migrate EE4.4 invoice settings to EE4.5 because they didnt exist', 'event_espresso'));
         } else {
             $invoice_settings['template_payment_instructions'] = $invoice_settings['pdf_instructions'];
@@ -93,8 +93,8 @@ 
                 );
             }
             $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-            $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
-            $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
+            $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path.'invoice_body.template.php', null, false, false, true);
+            $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path.'receipt_body.template.php', null, false, false, true);
             if ($overridden_invoice_body || $overridden_receipt_body) {
                 new PersistentAdminNotice(
                     'invoice_overriding_templates',

Indentation +86 added lines, -86 removed lines

@@ -16,97 +16,97 @@
  */
 class EE_DMS_4_5_0_invoice_settings extends EE_Data_Migration_Script_Stage
 {
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        $this->_pretty_name = esc_html__('Update Invoice Gateway Settings', 'event_espresso');
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		$this->_pretty_name = esc_html__('Update Invoice Gateway Settings', 'event_espresso');
+		parent::__construct();
+	}
 
 
 
-    /**
-     * _count_records_to_migrate
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @access protected
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        return 1;
-    }
+	/**
+	 * _count_records_to_migrate
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @access protected
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		return 1;
+	}
 
 
 
-    /**
-     *    _migration_step
-     *
-     * @access protected
-     * @param int $num_items
-     * @throws EE_Error
-     * @return int number of items ACTUALLY migrated
-     * @throws InvalidDataTypeException
-     */
-    protected function _migration_step($num_items = 1)
-    {
-        // if this isn't set then something is really wrong
-        if (! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
-            throw new EE_Error(esc_html__('It appears the Event Espresso Core Configuration is not setup correctly.', 'event_espresso'));
-        }
-        $invoice_settings = isset(EE_Config::instance()->gateway->payment_settings['Invoice']) ? EE_Config::instance()->gateway->payment_settings['Invoice'] : null;
-        if (! $invoice_settings) {
-            $this->add_error(esc_html__('Could not migrate EE4.4 invoice settings to EE4.5 because they didnt exist', 'event_espresso'));
-        } else {
-            $invoice_settings['template_payment_instructions'] = $invoice_settings['pdf_instructions'];
-            $invoice_settings['template_invoice_payee_name'] = $invoice_settings['payable_to'];
-            $invoice_settings['template_invoice_address'] = $invoice_settings['payment_address'];
-            $invoice_settings['template_invoice_email'] = '';
-            $invoice_settings['template_invoice_tax_number'] = '';
-            unset($invoice_settings['pdf_instructions']);
-            unset($invoice_settings['payable_to']);
-            unset($invoice_settings['payment_address']);
-            EE_Config::instance()->gateway->payment_settings['Invoice'] = $invoice_settings;
-            EE_Config::instance()->update_espresso_config(false, false);
+	/**
+	 *    _migration_step
+	 *
+	 * @access protected
+	 * @param int $num_items
+	 * @throws EE_Error
+	 * @return int number of items ACTUALLY migrated
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _migration_step($num_items = 1)
+	{
+		// if this isn't set then something is really wrong
+		if (! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
+			throw new EE_Error(esc_html__('It appears the Event Espresso Core Configuration is not setup correctly.', 'event_espresso'));
+		}
+		$invoice_settings = isset(EE_Config::instance()->gateway->payment_settings['Invoice']) ? EE_Config::instance()->gateway->payment_settings['Invoice'] : null;
+		if (! $invoice_settings) {
+			$this->add_error(esc_html__('Could not migrate EE4.4 invoice settings to EE4.5 because they didnt exist', 'event_espresso'));
+		} else {
+			$invoice_settings['template_payment_instructions'] = $invoice_settings['pdf_instructions'];
+			$invoice_settings['template_invoice_payee_name'] = $invoice_settings['payable_to'];
+			$invoice_settings['template_invoice_address'] = $invoice_settings['payment_address'];
+			$invoice_settings['template_invoice_email'] = '';
+			$invoice_settings['template_invoice_tax_number'] = '';
+			unset($invoice_settings['pdf_instructions']);
+			unset($invoice_settings['payable_to']);
+			unset($invoice_settings['payment_address']);
+			EE_Config::instance()->gateway->payment_settings['Invoice'] = $invoice_settings;
+			EE_Config::instance()->update_espresso_config(false, false);
 
-            // @todo: check 'invoice_css' too because we can't easily affect that so we might need to set a persistent notice
-            // (why is it tough to change? because we want to update the receipt and invoice message template, but
-            // message templates are only initialized AFTER migrations and those two are new in 4.5. So if we wanted to
-            // update them from a DMS, we'd need to have the DMS create the message templates which is quite a lot of code;
-            // also we don't want to build a dependency on the messages code because it is likely to change soon
-            if (
-                isset($invoice_settings['invoice_css'])
-                && ! in_array($invoice_settings['invoice_css'], ['', 'simple.css'])
-            ) {
-                new PersistentAdminNotice(
-                    'invoice_css_not_updated',
-                    sprintf(
-                        esc_html__(
-                            'You had previously set your Invoice Payment Method\'s stylesheet to be %1$s, but that setting has moved. PDF and HTML Invoices and Receipts are now Messages, which means you can easily modify them from your Wordpress Dashboard instead of using filters or uploading template files. Please visit Messages -> Receipt and Messages -> Invoice to change their stylesheets.',
-                            'event_espresso'
-                        ),
-                        $invoice_settings['invoice_css']
-                    )
-                );
-            }
-            $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-            $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
-            $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
-            if ($overridden_invoice_body || $overridden_receipt_body) {
-                new PersistentAdminNotice(
-                    'invoice_overriding_templates',
-                    esc_html__(
-                        'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents. We recommend deleting your old Invoice/Receipt templates and modifying the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
-                        'event_espresso'
-                    ),
-                    true
-                );
-            }
-        }
-        // regardless of whether it worked or not, we ought to continue the migration
-        $this->set_completed();
-        return 1;
-    }
+			// @todo: check 'invoice_css' too because we can't easily affect that so we might need to set a persistent notice
+			// (why is it tough to change? because we want to update the receipt and invoice message template, but
+			// message templates are only initialized AFTER migrations and those two are new in 4.5. So if we wanted to
+			// update them from a DMS, we'd need to have the DMS create the message templates which is quite a lot of code;
+			// also we don't want to build a dependency on the messages code because it is likely to change soon
+			if (
+				isset($invoice_settings['invoice_css'])
+				&& ! in_array($invoice_settings['invoice_css'], ['', 'simple.css'])
+			) {
+				new PersistentAdminNotice(
+					'invoice_css_not_updated',
+					sprintf(
+						esc_html__(
+							'You had previously set your Invoice Payment Method\'s stylesheet to be %1$s, but that setting has moved. PDF and HTML Invoices and Receipts are now Messages, which means you can easily modify them from your Wordpress Dashboard instead of using filters or uploading template files. Please visit Messages -> Receipt and Messages -> Invoice to change their stylesheets.',
+							'event_espresso'
+						),
+						$invoice_settings['invoice_css']
+					)
+				);
+			}
+			$templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
+			$overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
+			$overridden_receipt_body = EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
+			if ($overridden_invoice_body || $overridden_receipt_body) {
+				new PersistentAdminNotice(
+					'invoice_overriding_templates',
+					esc_html__(
+						'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents. We recommend deleting your old Invoice/Receipt templates and modifying the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
+						'event_espresso'
+					),
+					true
+				);
+			}
+		}
+		// regardless of whether it worked or not, we ought to continue the migration
+		$this->set_completed();
+		return 1;
+	}
 }

core/data_migration_scripts/4_9_0_stages/EE_DMS_4_9_0_Email_System_Question.dmsstage.php

Spacing +6 added lines, -6 removed lines

@@ -23,7 +23,7 @@ 
     {
         global $wpdb;
         $this->_pretty_name = esc_html__('Email - System Question', 'event_espresso');
-        $this->_old_table = $wpdb->prefix . 'esp_question';
+        $this->_old_table = $wpdb->prefix.'esp_question';
         $this->_extra_where_sql = "WHERE QST_system = 'email'";
         parent::__construct();
     }
@@ -41,12 +41,12 @@ 
             global $wpdb;
             $success = $wpdb->update(
                 $this->_old_table,
-                array( 'QST_type' => 'EMAIL' ),  // data
-                array( 'QST_ID' => $question['QST_ID'] ),  // where
-                array( '%s' ),   // data format
-                array( '%d' )  // where format
+                array('QST_type' => 'EMAIL'), // data
+                array('QST_ID' => $question['QST_ID']), // where
+                array('%s'), // data format
+                array('%d')  // where format
             );
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error(
                     sprintf(
                         esc_html__('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),

Indentation +41 added lines, -41 removed lines

@@ -11,48 +11,48 @@
  */
 class EE_DMS_4_9_0_Email_System_Question extends EE_Data_Migration_Script_Stage_Table
 {
-    /**
-     * Just initializes the status of the migration
-     *
-     * @return EE_DMS_4_9_0_Email_System_Question
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = esc_html__('Email - System Question', 'event_espresso');
-        $this->_old_table = $wpdb->prefix . 'esp_question';
-        $this->_extra_where_sql = "WHERE QST_system = 'email'";
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @return EE_DMS_4_9_0_Email_System_Question
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = esc_html__('Email - System Question', 'event_espresso');
+		$this->_old_table = $wpdb->prefix . 'esp_question';
+		$this->_extra_where_sql = "WHERE QST_system = 'email'";
+		parent::__construct();
+	}
 
 
 
-    /**
-     * updates the question with the new question type
-     * @param array $question an associative array where keys are column names and values are their values.
-     * @return null
-     */
-    protected function _migrate_old_row($question)
-    {
-        if ($question['QST_ID'] && $question['QST_system'] == 'email') {
-            global $wpdb;
-            $success = $wpdb->update(
-                $this->_old_table,
-                array( 'QST_type' => 'EMAIL' ),  // data
-                array( 'QST_ID' => $question['QST_ID'] ),  // where
-                array( '%s' ),   // data format
-                array( '%d' )  // where format
-            );
-            if (! $success) {
-                $this->add_error(
-                    sprintf(
-                        esc_html__('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),
-                        wp_json_encode($question['QST_system']),
-                        $question['QST_ID'],
-                        $wpdb->last_error
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 * updates the question with the new question type
+	 * @param array $question an associative array where keys are column names and values are their values.
+	 * @return null
+	 */
+	protected function _migrate_old_row($question)
+	{
+		if ($question['QST_ID'] && $question['QST_system'] == 'email') {
+			global $wpdb;
+			$success = $wpdb->update(
+				$this->_old_table,
+				array( 'QST_type' => 'EMAIL' ),  // data
+				array( 'QST_ID' => $question['QST_ID'] ),  // where
+				array( '%s' ),   // data format
+				array( '%d' )  // where format
+			);
+			if (! $success) {
+				$this->add_error(
+					sprintf(
+						esc_html__('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),
+						wp_json_encode($question['QST_system']),
+						$question['QST_ID'],
+						$wpdb->last_error
+					)
+				);
+			}
+		}
+	}
 }

core/db_classes/EE_Message_Template.class.php

Spacing +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
      */
     public function set_group_template_id($GRP_ID = false)
     {
-        if (! $GRP_ID) {
+        if ( ! $GRP_ID) {
             throw new EE_Error(esc_html__('Missing required value for the message template group id', 'event_espresso'));
         }
         $this->set('GRP_ID', $GRP_ID);

Indentation +169 added lines, -169 removed lines

@@ -12,173 +12,173 @@
  */
 class EE_Message_Template extends EE_Base_Class
 {
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param bool $GRP_ID
-     * @throws EE_Error
-     */
-    public function set_group_template_id($GRP_ID = false)
-    {
-        if (! $GRP_ID) {
-            throw new EE_Error(esc_html__('Missing required value for the message template group id', 'event_espresso'));
-        }
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * get Group ID
-     *
-     * @access public
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * get User ID
-     *
-     * @access public
-     * @return int
-     */
-    public function user()
-    {
-        return $this->get_first_related('Message_Template_Group')->get('MTP_user_id');
-    }
-
-
-    /**
-     * get Message Messenger
-     *
-     * @access public
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get_first_related('Message_Template_Group')->messenger();
-    }
-
-
-    /**
-     * get Message Messenger OBJECT
-     *
-     * @access public
-     * @return object Messenger Object for the given messenger
-     */
-    public function messenger_obj()
-    {
-        return $this->get_first_related('Message_Template_Group')->messenger_obj();
-    }
-
-
-    /**
-     * get Message Type
-     *
-     * @access public
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get_first_related('Message_Template_Group')->message_type();
-    }
-
-
-    /**
-     * get Message type OBJECT
-     *
-     * @access public
-     * @return object  Message Type object for the given message type
-     */
-    public function message_type_obj()
-    {
-        return $this->get_first_related('Message_Template_Group')->message_type_obj();
-    }
-
-
-    /**
-     * This returns the set context array configured in the message type object
-     *
-     * @access public
-     * @return array array of contexts and their configuration.
-     */
-    public function contexts_config()
-    {
-        return $this->get_first_related('Message_Template_Group')->contexts_config();
-    }
-
-
-    /**
-     * This returns the context_label for contexts as set in the message type object
-     *
-     * @access public
-     * @return string label for "context"
-     */
-    public function context_label()
-    {
-        return $this->get_first_related('Message_Template_Group')->context_label();
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is global
-     *
-     * @return boolean true if it is, false if it isn't
-     */
-    public function is_global()
-    {
-        return $this->get_first_related('Message_Template_Group')->is_global();
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
-     *
-     * @return boolean true if it is, false if it isn't
-     */
-    public function is_active()
-    {
-        return $this->get_first_related('Message_Template_Group')->is_active();
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
-     * this template.
-     *
-     * @access public
-     * @param string $context what context we're going to return shortcodes for
-     * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
-     *                        to be merged and returned.
-     * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
-     *               shortcodes found.
-     */
-    public function get_shortcodes($context, $fields = array())
-    {
-        return $this->get_first_related('Message_Template_Group')->get_shortcodes($context, $fields);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param bool $GRP_ID
+	 * @throws EE_Error
+	 */
+	public function set_group_template_id($GRP_ID = false)
+	{
+		if (! $GRP_ID) {
+			throw new EE_Error(esc_html__('Missing required value for the message template group id', 'event_espresso'));
+		}
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * get Group ID
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * get User ID
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function user()
+	{
+		return $this->get_first_related('Message_Template_Group')->get('MTP_user_id');
+	}
+
+
+	/**
+	 * get Message Messenger
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get_first_related('Message_Template_Group')->messenger();
+	}
+
+
+	/**
+	 * get Message Messenger OBJECT
+	 *
+	 * @access public
+	 * @return object Messenger Object for the given messenger
+	 */
+	public function messenger_obj()
+	{
+		return $this->get_first_related('Message_Template_Group')->messenger_obj();
+	}
+
+
+	/**
+	 * get Message Type
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get_first_related('Message_Template_Group')->message_type();
+	}
+
+
+	/**
+	 * get Message type OBJECT
+	 *
+	 * @access public
+	 * @return object  Message Type object for the given message type
+	 */
+	public function message_type_obj()
+	{
+		return $this->get_first_related('Message_Template_Group')->message_type_obj();
+	}
+
+
+	/**
+	 * This returns the set context array configured in the message type object
+	 *
+	 * @access public
+	 * @return array array of contexts and their configuration.
+	 */
+	public function contexts_config()
+	{
+		return $this->get_first_related('Message_Template_Group')->contexts_config();
+	}
+
+
+	/**
+	 * This returns the context_label for contexts as set in the message type object
+	 *
+	 * @access public
+	 * @return string label for "context"
+	 */
+	public function context_label()
+	{
+		return $this->get_first_related('Message_Template_Group')->context_label();
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is global
+	 *
+	 * @return boolean true if it is, false if it isn't
+	 */
+	public function is_global()
+	{
+		return $this->get_first_related('Message_Template_Group')->is_global();
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
+	 *
+	 * @return boolean true if it is, false if it isn't
+	 */
+	public function is_active()
+	{
+		return $this->get_first_related('Message_Template_Group')->is_active();
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
+	 * this template.
+	 *
+	 * @access public
+	 * @param string $context what context we're going to return shortcodes for
+	 * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
+	 *                        to be merged and returned.
+	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
+	 *               shortcodes found.
+	 */
+	public function get_shortcodes($context, $fields = array())
+	{
+		return $this->get_first_related('Message_Template_Group')->get_shortcodes($context, $fields);
+	}
 }

core/services/container/CoffeeMaker.php

Spacing +2 added lines, -2 removed lines

@@ -68,7 +68,7 @@ 
     public static function validateType($type)
     {
         $types = CoffeeMaker::getTypes();
-        if (! in_array($type, $types, true)) {
+        if ( ! in_array($type, $types, true)) {
             throw new InvalidIdentifierException(
                 is_object($type) ? get_class($type) : gettype($type),
                 esc_html__(
@@ -151,7 +151,7 @@ 
     protected function resolveClassAndFilepath(RecipeInterface $recipe)
     {
         $paths = $recipe->paths();
-        if (! empty($paths)) {
+        if ( ! empty($paths)) {
             foreach ($paths as $path) {
                 if (strpos($path, '*') === false && is_readable($path)) {
                     require_once($path);

Indentation +152 added lines, -152 removed lines

@@ -17,156 +17,156 @@
  */
 abstract class CoffeeMaker implements CoffeeMakerInterface
 {
-    /**
-     * Indicates that CoffeeMaker should construct a NEW entity instance from the provided arguments (if given)
-     */
-    const BREW_NEW = 'new';
-
-    /**
-     * Indicates that CoffeeMaker should always return a SHARED instance
-     */
-    const BREW_SHARED = 'shared';
-
-    /**
-     * Indicates that CoffeeMaker should only load the file/class/interface but NOT instantiate
-     */
-    const BREW_LOAD_ONLY = 'load_only';
-
-
-    /**
-     * @var CoffeePotInterface $coffee_pot
-     */
-    private $coffee_pot;
-
-    /**
-     * @var DependencyInjector $injector
-     */
-    private $injector;
-
-
-    /**
-     * @return array
-     */
-    public static function getTypes()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso\core\services\container\CoffeeMaker__getTypes',
-            array(
-                CoffeeMaker::BREW_NEW,
-                CoffeeMaker::BREW_SHARED,
-                CoffeeMaker::BREW_LOAD_ONLY,
-            )
-        );
-    }
-
-
-    /**
-     * @param $type
-     * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-     */
-    public static function validateType($type)
-    {
-        $types = CoffeeMaker::getTypes();
-        if (! in_array($type, $types, true)) {
-            throw new InvalidIdentifierException(
-                is_object($type) ? get_class($type) : gettype($type),
-                esc_html__(
-                    'recipe type (one of the class constants on \EventEspresso\core\services\container\CoffeeMaker)',
-                    'event_espresso'
-                )
-            );
-        }
-        return $type;
-    }
-
-
-    /**
-     * CoffeeMaker constructor.
-     *
-     * @param CoffeePotInterface $coffee_pot
-     * @param InjectorInterface  $injector
-     */
-    public function __construct(CoffeePotInterface $coffee_pot, InjectorInterface $injector)
-    {
-        $this->coffee_pot = $coffee_pot;
-        $this->injector = $injector;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\container\CoffeePotInterface
-     */
-    protected function coffeePot()
-    {
-        return $this->coffee_pot;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\container\DependencyInjector
-     */
-    protected function injector()
-    {
-        return $this->injector;
-    }
-
-
-    /**
-     * Examines the constructor to determine which method should be used for instantiation
-     *
-     * @param \ReflectionClass $reflector
-     * @return mixed
-     * @throws InstantiationException
-     */
-    protected function resolveInstantiationMethod(\ReflectionClass $reflector)
-    {
-        if ($reflector->getConstructor() === null) {
-            return 'NewInstance';
-        }
-        if ($reflector->isInstantiable()) {
-            return 'NewInstanceArgs';
-        }
-        if (method_exists($reflector->getName(), 'instance')) {
-            return 'instance';
-        }
-        if (method_exists($reflector->getName(), 'new_instance')) {
-            return 'new_instance';
-        }
-        if (method_exists($reflector->getName(), 'new_instance_from_db')) {
-            return 'new_instance_from_db';
-        }
-        throw new InstantiationException($reflector->getName());
-    }
-
-
-    /**
-     * Ensures files for classes that are not PSR-4 compatible are loaded
-     * and then verifies that classes exist where applicable
-     *
-     * @param RecipeInterface $recipe
-     * @return bool
-     * @throws InvalidClassException
-     */
-    protected function resolveClassAndFilepath(RecipeInterface $recipe)
-    {
-        $paths = $recipe->paths();
-        if (! empty($paths)) {
-            foreach ($paths as $path) {
-                if (strpos($path, '*') === false && is_readable($path)) {
-                    require_once($path);
-                }
-            }
-        }
-        // re: using "false" for class_exists() second param:
-        // if a class name is not already known to PHP, then class_exists() will run through
-        // all of the registered spl_autoload functions until it either finds the class,
-        // or gets to the end of the registered spl_autoload functions.
-        // When the second parameter is true, it will also attempt to load the class file,
-        // but it will also trigger an error if the class can not be loaded.
-        // We don't want that extra error in the mix, so we have set the second param to "false"
-        if ($recipe->type() !== CoffeeMaker::BREW_LOAD_ONLY && ! class_exists($recipe->fqcn(), false)) {
-            throw new InvalidClassException($recipe->identifier());
-        }
-        return true;
-    }
+	/**
+	 * Indicates that CoffeeMaker should construct a NEW entity instance from the provided arguments (if given)
+	 */
+	const BREW_NEW = 'new';
+
+	/**
+	 * Indicates that CoffeeMaker should always return a SHARED instance
+	 */
+	const BREW_SHARED = 'shared';
+
+	/**
+	 * Indicates that CoffeeMaker should only load the file/class/interface but NOT instantiate
+	 */
+	const BREW_LOAD_ONLY = 'load_only';
+
+
+	/**
+	 * @var CoffeePotInterface $coffee_pot
+	 */
+	private $coffee_pot;
+
+	/**
+	 * @var DependencyInjector $injector
+	 */
+	private $injector;
+
+
+	/**
+	 * @return array
+	 */
+	public static function getTypes()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso\core\services\container\CoffeeMaker__getTypes',
+			array(
+				CoffeeMaker::BREW_NEW,
+				CoffeeMaker::BREW_SHARED,
+				CoffeeMaker::BREW_LOAD_ONLY,
+			)
+		);
+	}
+
+
+	/**
+	 * @param $type
+	 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+	 */
+	public static function validateType($type)
+	{
+		$types = CoffeeMaker::getTypes();
+		if (! in_array($type, $types, true)) {
+			throw new InvalidIdentifierException(
+				is_object($type) ? get_class($type) : gettype($type),
+				esc_html__(
+					'recipe type (one of the class constants on \EventEspresso\core\services\container\CoffeeMaker)',
+					'event_espresso'
+				)
+			);
+		}
+		return $type;
+	}
+
+
+	/**
+	 * CoffeeMaker constructor.
+	 *
+	 * @param CoffeePotInterface $coffee_pot
+	 * @param InjectorInterface  $injector
+	 */
+	public function __construct(CoffeePotInterface $coffee_pot, InjectorInterface $injector)
+	{
+		$this->coffee_pot = $coffee_pot;
+		$this->injector = $injector;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\container\CoffeePotInterface
+	 */
+	protected function coffeePot()
+	{
+		return $this->coffee_pot;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\container\DependencyInjector
+	 */
+	protected function injector()
+	{
+		return $this->injector;
+	}
+
+
+	/**
+	 * Examines the constructor to determine which method should be used for instantiation
+	 *
+	 * @param \ReflectionClass $reflector
+	 * @return mixed
+	 * @throws InstantiationException
+	 */
+	protected function resolveInstantiationMethod(\ReflectionClass $reflector)
+	{
+		if ($reflector->getConstructor() === null) {
+			return 'NewInstance';
+		}
+		if ($reflector->isInstantiable()) {
+			return 'NewInstanceArgs';
+		}
+		if (method_exists($reflector->getName(), 'instance')) {
+			return 'instance';
+		}
+		if (method_exists($reflector->getName(), 'new_instance')) {
+			return 'new_instance';
+		}
+		if (method_exists($reflector->getName(), 'new_instance_from_db')) {
+			return 'new_instance_from_db';
+		}
+		throw new InstantiationException($reflector->getName());
+	}
+
+
+	/**
+	 * Ensures files for classes that are not PSR-4 compatible are loaded
+	 * and then verifies that classes exist where applicable
+	 *
+	 * @param RecipeInterface $recipe
+	 * @return bool
+	 * @throws InvalidClassException
+	 */
+	protected function resolveClassAndFilepath(RecipeInterface $recipe)
+	{
+		$paths = $recipe->paths();
+		if (! empty($paths)) {
+			foreach ($paths as $path) {
+				if (strpos($path, '*') === false && is_readable($path)) {
+					require_once($path);
+				}
+			}
+		}
+		// re: using "false" for class_exists() second param:
+		// if a class name is not already known to PHP, then class_exists() will run through
+		// all of the registered spl_autoload functions until it either finds the class,
+		// or gets to the end of the registered spl_autoload functions.
+		// When the second parameter is true, it will also attempt to load the class file,
+		// but it will also trigger an error if the class can not be loaded.
+		// We don't want that extra error in the mix, so we have set the second param to "false"
+		if ($recipe->type() !== CoffeeMaker::BREW_LOAD_ONLY && ! class_exists($recipe->fqcn(), false)) {
+			throw new InvalidClassException($recipe->identifier());
+		}
+		return true;
+	}
 }

core/services/container/Recipe.php

Spacing +5 added lines, -5 removed lines

@@ -189,7 +189,7 @@ 
      */
     public function setIdentifier($identifier)
     {
-        if (! is_string($identifier) || empty($identifier)) {
+        if ( ! is_string($identifier) || empty($identifier)) {
             throw new InvalidIdentifierException(
                 is_object($identifier) ? get_class($identifier) : gettype($identifier),
                 esc_html__('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
@@ -216,7 +216,7 @@ 
     public function setFqcn($fqcn)
     {
         $fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
-        if (! is_string($fqcn)) {
+        if ( ! is_string($fqcn)) {
             throw new InvalidDataTypeException(
                 '$fqcn',
                 is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
@@ -247,7 +247,7 @@ 
         if (empty($ingredients)) {
             return;
         }
-        if (! is_array($ingredients)) {
+        if ( ! is_array($ingredients)) {
             throw new InvalidDataTypeException(
                 '$ingredients',
                 is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
@@ -279,7 +279,7 @@ 
         if (empty($filters)) {
             return;
         }
-        if (! is_array($filters)) {
+        if ( ! is_array($filters)) {
             throw new InvalidDataTypeException(
                 '$filters',
                 is_object($filters) ? get_class($filters) : gettype($filters),
@@ -306,7 +306,7 @@ 
         if (empty($paths)) {
             return;
         }
-        if (! (is_string($paths) || is_array($paths))) {
+        if ( ! (is_string($paths) || is_array($paths))) {
             throw new InvalidDataTypeException(
                 '$path',
                 is_object($paths) ? get_class($paths) : gettype($paths),

Indentation +307 added lines, -307 removed lines

@@ -18,311 +18,311 @@
  */
 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
-     * @throws InvalidIdentifierException
-     * @throws RuntimeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        $identifier,
-        $fqcn = '',
-        array $filters = array(),
-        array $ingredients = array(),
-        $type = CoffeeMaker::BREW_NEW,
-        array $paths = array()
-    ) {
-        $this->setIdentifier($identifier);
-        $this->setFilters($filters);
-        $this->setIngredients($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 $this->filters;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function ingredients()
-    {
-        return $this->ingredients;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function paths()
-    {
-        return $this->paths;
-    }
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the Recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     * @throws InvalidIdentifierException
-     */
-    public function setIdentifier($identifier)
-    {
-        if (! is_string($identifier) || empty($identifier)) {
-            throw new InvalidIdentifierException(
-                is_object($identifier) ? get_class($identifier) : gettype($identifier),
-                esc_html__('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
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidInterfaceException
-     */
-    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),
-                esc_html__('string (Fully\Qualified\ClassName)', 'event_espresso')
-            );
-        }
-        $fqcn = ltrim($fqcn, '\\');
-        if (
-            $fqcn !== Recipe::DEFAULT_ID
-            && ! empty($fqcn)
-            && empty($this->paths)
-            && ! (class_exists($fqcn) || interface_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' )
-     * @throws InvalidDataTypeException
-     */
-    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),
-                esc_html__('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()
-     * @throws InvalidIdentifierException
-     */
-    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' )
-     * @throws InvalidDataTypeException
-     */
-    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),
-                esc_html__('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
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     */
-    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),
-                esc_html__('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(
-                        esc_html__('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
+	 * @throws InvalidIdentifierException
+	 * @throws RuntimeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		$identifier,
+		$fqcn = '',
+		array $filters = array(),
+		array $ingredients = array(),
+		$type = CoffeeMaker::BREW_NEW,
+		array $paths = array()
+	) {
+		$this->setIdentifier($identifier);
+		$this->setFilters($filters);
+		$this->setIngredients($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 $this->filters;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function ingredients()
+	{
+		return $this->ingredients;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function paths()
+	{
+		return $this->paths;
+	}
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the Recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @throws InvalidIdentifierException
+	 */
+	public function setIdentifier($identifier)
+	{
+		if (! is_string($identifier) || empty($identifier)) {
+			throw new InvalidIdentifierException(
+				is_object($identifier) ? get_class($identifier) : gettype($identifier),
+				esc_html__('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
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidInterfaceException
+	 */
+	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),
+				esc_html__('string (Fully\Qualified\ClassName)', 'event_espresso')
+			);
+		}
+		$fqcn = ltrim($fqcn, '\\');
+		if (
+			$fqcn !== Recipe::DEFAULT_ID
+			&& ! empty($fqcn)
+			&& empty($this->paths)
+			&& ! (class_exists($fqcn) || interface_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' )
+	 * @throws InvalidDataTypeException
+	 */
+	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),
+				esc_html__('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()
+	 * @throws InvalidIdentifierException
+	 */
+	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' )
+	 * @throws InvalidDataTypeException
+	 */
+	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),
+				esc_html__('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
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 */
+	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),
+				esc_html__('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(
+						esc_html__('The following filepath is not readable: "%1$s"', 'event_espresso'),
+						$path
+					)
+				);
+			}
+		}
+		$this->paths = array_merge($this->paths, $paths);
+	}
 }