eventespresso / event-espresso-core

core/services/payment_methods/gateways/GatewayDataFormatter.php

Indentation +116 added lines, -116 removed lines

@@ -17,122 +17,122 @@
 class GatewayDataFormatter implements GatewayDataFormatterInterface
 {
 
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemName(\EEI_Payment $payment)
-    {
-        return apply_filters(
-            'EEG_Paypal_Pro__do_direct_payment__partial_amount_line_item_name',
-            $payment->get_first_event_name(),
-            $this,
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___partial_payment_desc',
-            sprintf(
-                __("Payment of %s for %s", "event_espresso"),
-                $payment->get_pretty('PAY_amount', 'no_currency_code'),
-                $payment->get_first_event_name()
-            ),
-            $this,
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_gateway___line_item_name',
-            sprintf(
-                _x('%1$s for %2$s', 'Ticket for Event', 'event_espresso'),
-                $line_item->name(),
-                $line_item->ticket_event_name()
-            ),
-            $this,
-            $line_item,
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___line_item_desc',
-            $line_item->desc(),
-            $this,
-            $line_item,
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Gets the order description that should generally be sent to gateways
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatOrderDescription(\EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___order_description',
-            sprintf(
-                __('Event Registrations from %1$s for %2$s', "event_espresso"),
-                get_bloginfo('name'),
-                $payment->get_first_event_name()
-            ),
-            $this,
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     */
-    public function formatCurrency($amount)
-    {
-        return number_format($amount, 2, '.', '');
-    }
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemName(\EEI_Payment $payment)
+	{
+		return apply_filters(
+			'EEG_Paypal_Pro__do_direct_payment__partial_amount_line_item_name',
+			$payment->get_first_event_name(),
+			$this,
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___partial_payment_desc',
+			sprintf(
+				__("Payment of %s for %s", "event_espresso"),
+				$payment->get_pretty('PAY_amount', 'no_currency_code'),
+				$payment->get_first_event_name()
+			),
+			$this,
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_gateway___line_item_name',
+			sprintf(
+				_x('%1$s for %2$s', 'Ticket for Event', 'event_espresso'),
+				$line_item->name(),
+				$line_item->ticket_event_name()
+			),
+			$this,
+			$line_item,
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___line_item_desc',
+			$line_item->desc(),
+			$this,
+			$line_item,
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Gets the order description that should generally be sent to gateways
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatOrderDescription(\EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___order_description',
+			sprintf(
+				__('Event Registrations from %1$s for %2$s', "event_espresso"),
+				get_bloginfo('name'),
+				$payment->get_first_event_name()
+			),
+			$this,
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 */
+	public function formatCurrency($amount)
+	{
+		return number_format($amount, 2, '.', '');
+	}
 }
 // End of file GatewayDataFormatter.php
 // Location: core\services\gateways/GatewayDataFormatter.php
\ No newline at end of file

core/services/payment_methods/gateways/GatewayDataFormatterInterface.php

Indentation +44 added lines, -44 removed lines

@@ -16,65 +16,65 @@
 interface GatewayDataFormatterInterface
 {
 
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemName(\EEI_Payment $payment);
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemName(\EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment);
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment);
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment);
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the order description that should generally be sent to gateways
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatOrderDescription(\EEI_Payment $payment);
+	/**
+	 * Gets the order description that should generally be sent to gateways
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatOrderDescription(\EEI_Payment $payment);
 
 
 
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     */
-    public function formatCurrency($amount);
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 */
+	public function formatCurrency($amount);
 }
 // End of file GatewayDataFormatterInterface.php
 // Location: core\services\payment_methods\gateways/GatewayDataFormatterInterface.php
\ No newline at end of file

core/entities/models/JsonModelSchema.php

Spacing +2 added lines, -2 removed lines

@@ -64,7 +64,7 @@ 
     public function getModelSchemaForFields(array $model_fields, array $schema)
     {
         foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
+            if ( ! $model_field instanceof EE_Model_Field_Base) {
                 continue;
             }
             $schema['properties'][$field] = $model_field->getSchema();
@@ -95,7 +95,7 @@ 
     public function getModelSchemaForRelations(array $relations_on_model, array $schema)
     {
         foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
+            if ( ! $relation instanceof EE_Model_Relation_Base) {
                 continue;
             }
             $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation

Indentation +116 added lines, -116 removed lines

@@ -25,120 +25,120 @@
 class JsonModelSchema
 {
 
-    /**
-     * @var \EEM_Base
-     */
-    protected $model;
-
-    /**
-     * JsonModelSchema constructor.
-     *
-     * @param \EEM_Base $model
-     */
-    public function __construct(EEM_Base $model)
-    {
-        $this->model = $model;
-    }
-
-    /**
-     * Return the schema for a given model from a given model.
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function getModelSchema()
-    {
-        return $this->getModelSchemaForRelations(
-            $this->model->relation_settings(),
-            $this->getModelSchemaForFields(
-                $this->model->field_settings(),
-                $this->getInitialSchemaStructure()
-            )
-        );
-    }
-
-
-    /**
-     * Get the schema for a given set of model fields.
-     * @param \EE_Model_Field_Base[]     $model_fields
-     * @return array
-     */
-    public function getModelSchemaForFields(array $model_fields, array $schema)
-    {
-        foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
-                continue;
-            }
-            $schema['properties'][$field] = $model_field->getSchema();
-
-            //if this is a primary key field add the primary key item
-            if ($model_field instanceof EE_Primary_Key_Field_Base) {
-                $schema['properties'][$field]['primary_key'] = true;
-                if ($model_field instanceof EE_Primary_Key_Int_Field) {
-                    $schema['properties'][$field]['readonly'] = true;
-                }
-            }
-
-            //if this is a foreign key field add the foreign key item
-            if ($model_field instanceof EE_Foreign_Key_Field_Base) {
-                $schema['properties'][$field]['foreign_key'] = array(
-                    'description' => esc_html__('This is a foreign key the points to the given models.', 'event_espresso'),
-                    'type' => 'array',
-                    'enum' => $model_field->get_model_class_names_pointed_to()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Get the schema for a given set of model relations
-     * @param EE_Model_Relation_Base[] $relations_on_model
-     * @return array
-     */
-    public function getModelSchemaForRelations(array $relations_on_model, array $schema)
-    {
-        foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
-                continue;
-            }
-            $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
-                ? strtolower($model_name)
-                : EEH_Inflector::pluralize_and_lower($model_name);
-            $schema['properties'][$model_name_for_schema] = $relation->getSchema();
-            $schema['properties'][$model_name_for_schema]['relation_model'] = $model_name;
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Outputs the schema header for a model.
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function getInitialSchemaStructure()
-    {
-        return array(
-            '$schema' => 'http://json-schema.org/draft-04/schema#',
-            'title' => $this->model->get_this_model_name(),
-            'type' => 'object',
-            'properties' => array()
-        );
-    }
-
-
-    /**
-     * Allows one to just use the object as a string to get the json.
-     * eg.
-     *
-     * $json_schema = new JsonModelSchema(EEM_Event::instance());
-     * echo $json_schema; //outputs the schema as a json formatted string.
-     *
-     * @return bool|false|mixed|string
-     */
-    public function __toString()
-    {
-        return wp_json_encode($this->getModelSchema());
-    }
+	/**
+	 * @var \EEM_Base
+	 */
+	protected $model;
+
+	/**
+	 * JsonModelSchema constructor.
+	 *
+	 * @param \EEM_Base $model
+	 */
+	public function __construct(EEM_Base $model)
+	{
+		$this->model = $model;
+	}
+
+	/**
+	 * Return the schema for a given model from a given model.
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function getModelSchema()
+	{
+		return $this->getModelSchemaForRelations(
+			$this->model->relation_settings(),
+			$this->getModelSchemaForFields(
+				$this->model->field_settings(),
+				$this->getInitialSchemaStructure()
+			)
+		);
+	}
+
+
+	/**
+	 * Get the schema for a given set of model fields.
+	 * @param \EE_Model_Field_Base[]     $model_fields
+	 * @return array
+	 */
+	public function getModelSchemaForFields(array $model_fields, array $schema)
+	{
+		foreach ($model_fields as $field => $model_field) {
+			if (! $model_field instanceof EE_Model_Field_Base) {
+				continue;
+			}
+			$schema['properties'][$field] = $model_field->getSchema();
+
+			//if this is a primary key field add the primary key item
+			if ($model_field instanceof EE_Primary_Key_Field_Base) {
+				$schema['properties'][$field]['primary_key'] = true;
+				if ($model_field instanceof EE_Primary_Key_Int_Field) {
+					$schema['properties'][$field]['readonly'] = true;
+				}
+			}
+
+			//if this is a foreign key field add the foreign key item
+			if ($model_field instanceof EE_Foreign_Key_Field_Base) {
+				$schema['properties'][$field]['foreign_key'] = array(
+					'description' => esc_html__('This is a foreign key the points to the given models.', 'event_espresso'),
+					'type' => 'array',
+					'enum' => $model_field->get_model_class_names_pointed_to()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Get the schema for a given set of model relations
+	 * @param EE_Model_Relation_Base[] $relations_on_model
+	 * @return array
+	 */
+	public function getModelSchemaForRelations(array $relations_on_model, array $schema)
+	{
+		foreach ($relations_on_model as $model_name => $relation) {
+			if (! $relation instanceof EE_Model_Relation_Base) {
+				continue;
+			}
+			$model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
+				? strtolower($model_name)
+				: EEH_Inflector::pluralize_and_lower($model_name);
+			$schema['properties'][$model_name_for_schema] = $relation->getSchema();
+			$schema['properties'][$model_name_for_schema]['relation_model'] = $model_name;
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Outputs the schema header for a model.
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function getInitialSchemaStructure()
+	{
+		return array(
+			'$schema' => 'http://json-schema.org/draft-04/schema#',
+			'title' => $this->model->get_this_model_name(),
+			'type' => 'object',
+			'properties' => array()
+		);
+	}
+
+
+	/**
+	 * Allows one to just use the object as a string to get the json.
+	 * eg.
+	 *
+	 * $json_schema = new JsonModelSchema(EEM_Event::instance());
+	 * echo $json_schema; //outputs the schema as a json formatted string.
+	 *
+	 * @return bool|false|mixed|string
+	 */
+	public function __toString()
+	{
+		return wp_json_encode($this->getModelSchema());
+	}
 }

core/services/formatters/FormatterInterface.php

Indentation +17 added lines, -17 removed lines

@@ -16,23 +16,23 @@
 interface FormatterInterface
 {
 
-    /**
-     * Applies the formatting to all items in the array
-     *
-     * @param array $input accepts a multi-dimensional array, but all "leaf nodes" are easily cast to a string
-     * @return array
-     */
-    public function formatArray($input);
-
-
-
-    /**
-     * Formats the string
-     *
-     * @param string|int|float $input anything easily cast into a string
-     * @return string
-     */
-    public function format($input);
+	/**
+	 * Applies the formatting to all items in the array
+	 *
+	 * @param array $input accepts a multi-dimensional array, but all "leaf nodes" are easily cast to a string
+	 * @return array
+	 */
+	public function formatArray($input);
+
+
+
+	/**
+	 * Formats the string
+	 *
+	 * @param string|int|float $input anything easily cast into a string
+	 * @return string
+	 */
+	public function format($input);
 }
 // End of file FormatterInterface.php
 // Location: core\services\formatters/FormatterInterface.php
\ No newline at end of file

core/services/cache/TransientCacheStorage.php

Doc Comments +1 added lines, -1 removed lines

@@ -234,7 +234,7 @@
     /**
      * delete multiple transients and remove tracking
      *
-     * @param array $transient_keys [required] array of full or partial transient keys to be deleted
+     * @param string[] $transient_keys [required] array of full or partial transient keys to be deleted
      */
     public function deleteMany(array $transient_keys)
     {

Unused Use Statements -4 removed lines

@@ -1,10 +1,6 @@
 <?php
 namespace EventEspresso\core\services\cache;
 
-use EE_Error;
-use WP_Error;
-use wpdb;
-
 defined('EVENT_ESPRESSO_VERSION') || exit;
 
 

Indentation +355 added lines, -355 removed lines

@@ -23,361 +23,361 @@
 class TransientCacheStorage implements CacheStorageInterface
 {
 
-    /**
-     * wp-option option_name for tracking transients
-     *
-     * @type string
-     */
-    const TRANSIENT_SCHEDULE_OPTIONS_KEY = 'ee_transient_schedule';
-
-    /**
-     * @var int $current_time
-     */
-    private $current_time = 0;
-
-    /**
-     * how often to perform transient cleanup
-     *
-     * @var string $transient_cleanup_frequency
-     */
-    private $transient_cleanup_frequency = 'hour';
-
-    /**
-     * options for how often to perform transient cleanup
-     *
-     * @var array $transient_cleanup_frequency_options
-     */
-    private $transient_cleanup_frequency_options = array();
-
-    /**
-     * @var array $transients
-     */
-    private $transients = array();
-
-
-
-    /**
-     * TransientCacheStorage constructor.
-     */
-    public function __construct()
-    {
-        $this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
-        // round current time down to closest 5 minutes to simplify scheduling
-        $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
-        $this->transients = (array)get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
-        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
-            add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
-        }
-    }
-
-
-
-    /**
-     * Sets how often transient cleanup occurs
-     *
-     * @return int
-     */
-    private function setTransientCleanupFrequency()
-    {
-        // sets how often transients are cleaned up
-        $this->transient_cleanup_frequency_options = apply_filters(
-            'FHEE__TransientCacheStorage__transient_cleanup_schedule_options',
-            array(
-                'off',
-                '15-minutes',
-                'hour',
-                '12-hours',
-                'day',
-            )
-        );
-        $transient_cleanup_frequency = apply_filters(
-            'FHEE__TransientCacheStorage__transient_cleanup_schedule',
-            'hour'
-        );
-        return in_array(
-            $transient_cleanup_frequency,
-            $this->transient_cleanup_frequency_options,
-            true
-        )
-            ? $transient_cleanup_frequency
-            : 'hour';
-    }
-
-
-
-    /**
-     * we need to be able to round timestamps off to match the set transient cleanup frequency
-     * so if a transient is set to expire at 1:17 pm for example, and our cleanup schedule is every hour,
-     * then that timestamp needs to be rounded up to 2:00 pm so that it is removed
-     * during the next scheduled cleanup after its expiration.
-     * We also round off the current time timestamp to the closest 5 minutes
-     * just to make the timestamps a little easier to round which helps with debugging.
-     *
-     * @param int    $timestamp [required]
-     * @param string $cleanup_frequency
-     * @param bool   $round_up
-     * @return false|int
-     */
-    private function roundTimestamp($timestamp, $cleanup_frequency = 'hour', $round_up = true)
-    {
-        $cleanup_frequency = $cleanup_frequency ? $cleanup_frequency : $this->transient_cleanup_frequency;
-        // in order to round the time to the closest xx minutes (or hours),
-        // we take the minutes (or hours) portion of the timestamp and divide it by xx,
-        // round down to a whole number, then multiply by xx to bring us almost back up to where we were
-        // why round down ? so the minutes (or hours) don't go over 60 (or 24)
-        // and bump the hour, which could bump the day, which could bump the month, etc,
-        // which would be bad because we don't always want to round up,
-        // but when we do we can easily achieve that by simply adding the desired offset,
-        $minutes = '00';
-        $hours = 'H';
-        switch ($cleanup_frequency) {
-            case '5-minutes' :
-                $minutes = floor((int)date('i', $timestamp) / 5) * 5;
-                $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
-                $offset = MINUTE_IN_SECONDS * 5;
-                break;
-            case '15-minutes' :
-                $minutes = floor((int)date('i', $timestamp) / 15) * 15;
-                $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
-                $offset = MINUTE_IN_SECONDS * 15;
-                break;
-            case '12-hours' :
-                $hours = floor((int)date('H', $timestamp) / 12) * 12;
-                $hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
-                $offset = HOUR_IN_SECONDS * 12;
-                break;
-            case 'day' :
-                $hours = '03'; // run cleanup at 3:00 am (or first site hit after that)
-                $offset = DAY_IN_SECONDS;
-                break;
-            case 'hour' :
-            default :
-                $offset = HOUR_IN_SECONDS;
-                break;
-        }
-        $rounded_timestamp = strtotime(date("Y-m-d {$hours}:{$minutes}:00", $timestamp));
-        $rounded_timestamp += $round_up ? $offset : 0;
-        return apply_filters(
-            'FHEE__TransientCacheStorage__roundTimestamp__timestamp',
-            $rounded_timestamp,
-            $timestamp,
-            $cleanup_frequency,
-            $round_up
-        );
-    }
-
-
-
-    /**
-     * Saves supplied data to a transient
-     * if an expiration is set, then it automatically schedules the transient for cleanup
-     *
-     * @param string $transient_key [required]
-     * @param string $data          [required]
-     * @param int    $expiration    number of seconds until the cache expires
-     * @return bool
-     */
-    public function add($transient_key, $data, $expiration = 0)
-    {
-        $expiration = (int)abs($expiration);
-        $saved = set_transient($transient_key, $data, $expiration);
-        if ($saved && $expiration) {
-            $this->scheduleTransientCleanup($transient_key, $expiration);
-        }
-        return $saved;
-    }
-
-
-
-    /**
-     * retrieves transient data
-     * automatically triggers early cache refresh for standard cache items
-     * in order to avoid cache stampedes on busy sites.
-     * For non-standard cache items like PHP Session data where early refreshing is not wanted,
-     * the $standard_cache parameter should be set to false when retrieving data
-     *
-     * @param string $transient_key [required]
-     * @param bool   $standard_cache
-     * @return mixed|null
-     */
-    public function get($transient_key, $standard_cache = true)
-    {
-        // to avoid cache stampedes (AKA:dogpiles) for standard cache items,
-        // check if known cache expires within the next minute,
-        // and if so, remove it from our tracking and and return nothing.
-        // this should trigger the cache content to be regenerated during this request,
-        // while allowing any following requests to still access the existing cache
-        // until it gets replaced with the refreshed content
-        if (
-            $standard_cache
-            && isset($this->transients[$transient_key])
-            && $this->transients[$transient_key] - time() <= MINUTE_IN_SECONDS
-        ) {
-            unset($this->transients[$transient_key]);
-            $this->updateTransients();
-            return null;
-        }
-        $content = get_transient($transient_key);
-        return $content !== false ? $content : null;
-    }
-
-
-
-    /**
-     * delete a single transient and remove tracking
-     *
-     * @param string $transient_key [required] full or partial transient key to be deleted
-     */
-    public function delete($transient_key)
-    {
-        $this->deleteMany(array($transient_key));
-    }
-
-
-
-    /**
-     * delete multiple transients and remove tracking
-     *
-     * @param array $transient_keys [required] array of full or partial transient keys to be deleted
-     */
-    public function deleteMany(array $transient_keys)
-    {
-        $full_transient_keys = array();
-        foreach ($this->transients as $transient_key => $expiration) {
-            foreach ($transient_keys as $transient_key_to_delete) {
-                if (strpos($transient_key, $transient_key_to_delete) !== false) {
-                    $full_transient_keys[] = $transient_key;
-                }
-            }
-        }
-        if ($this->deleteTransientKeys($full_transient_keys)) {
-            $this->updateTransients();
-        }
-    }
-
-
-
-    /**
-     * sorts transients numerically by timestamp
-     * then saves the transient schedule to a WP option
-     */
-    private function updateTransients()
-    {
-        asort($this->transients, SORT_NUMERIC);
-        update_option(
-            TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY,
-            $this->transients
-        );
-    }
-
-
-
-    /**
-     * schedules a transient for cleanup by adding it to the transient tracking
-     *
-     * @param string $transient_key [required]
-     * @param int    $expiration    [required]
-     */
-    private function scheduleTransientCleanup($transient_key, $expiration)
-    {
-        // make sure a valid future timestamp is set
-        $expiration += $expiration < time() ? time() : 0;
-        // and round to the closest 15 minutes
-        $expiration = $this->roundTimestamp($expiration);
-        // save transients to clear using their ID as the key to avoid duplicates
-        $this->transients[$transient_key] = $expiration;
-        $this->updateTransients();
-    }
-
-
-
-    /**
-     * Since our tracked transients are sorted by their timestamps
-     * we can grab the first transient and see when it is scheduled for cleanup.
-     * If that timestamp is less than or equal to the current time,
-     * then cleanup is triggered
-     */
-    public function checkTransientCleanupSchedule()
-    {
-        if (empty($this->transients)) {
-            return;
-        }
-        // when do we run the next cleanup job?
-        reset($this->transients);
-        $next_scheduled_cleanup = current($this->transients);
-        // if the next cleanup job is scheduled for the current hour
-        if ($next_scheduled_cleanup <= $this->current_time) {
-            if ($this->cleanupExpiredTransients()) {
-                $this->updateTransients();
-            }
-        }
-    }
-
-
-
-    /**
-     * loops through the array of tracked transients,
-     * compiles a list of those that have expired, and sends that list off for deletion.
-     * Also removes any bad records from the transients array
-     *
-     * @return bool
-     */
-    private function cleanupExpiredTransients()
-    {
-        $update = false;
-        // filter the query limit. Set to 0 to turn off garbage collection
-        $limit = (int)abs(
-            apply_filters(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                50
-            )
-        );
-        // non-zero LIMIT means take out the trash
-        if ($limit) {
-            $transient_keys = array();
-            foreach ($this->transients as $transient_key => $expiration) {
-                if ($expiration > $this->current_time) {
-                    continue;
-                }
-                if ( ! $expiration || ! $transient_key) {
-                    unset($this->transients[$transient_key]);
-                    $update = true;
-                    continue;
-                }
-                $transient_keys[] = $transient_key;
-            }
-            // delete expired keys, but maintain value of $update if nothing is deleted
-            $update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
-            do_action( 'FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
-        }
-        return $update;
-    }
-
-
-
-    /**
-     * calls delete_transient() on each transient key provided, up to the specified limit
-     *
-     * @param array $transient_keys [required]
-     * @param int   $limit
-     * @return bool
-     */
-    private function deleteTransientKeys(array $transient_keys, $limit = 50)
-    {
-        if (empty($transient_keys)) {
-            return false;
-        }
-        $counter = 0;
-        foreach ($transient_keys as $transient_key) {
-            if($counter === $limit){
-                break;
-            }
-            delete_transient($transient_key);
-            unset($this->transients[$transient_key]);
-            $counter++;
-        }
-        return $counter > 0;
-    }
+	/**
+	 * wp-option option_name for tracking transients
+	 *
+	 * @type string
+	 */
+	const TRANSIENT_SCHEDULE_OPTIONS_KEY = 'ee_transient_schedule';
+
+	/**
+	 * @var int $current_time
+	 */
+	private $current_time = 0;
+
+	/**
+	 * how often to perform transient cleanup
+	 *
+	 * @var string $transient_cleanup_frequency
+	 */
+	private $transient_cleanup_frequency = 'hour';
+
+	/**
+	 * options for how often to perform transient cleanup
+	 *
+	 * @var array $transient_cleanup_frequency_options
+	 */
+	private $transient_cleanup_frequency_options = array();
+
+	/**
+	 * @var array $transients
+	 */
+	private $transients = array();
+
+
+
+	/**
+	 * TransientCacheStorage constructor.
+	 */
+	public function __construct()
+	{
+		$this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
+		// round current time down to closest 5 minutes to simplify scheduling
+		$this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
+		$this->transients = (array)get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
+		if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
+			add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
+		}
+	}
+
+
+
+	/**
+	 * Sets how often transient cleanup occurs
+	 *
+	 * @return int
+	 */
+	private function setTransientCleanupFrequency()
+	{
+		// sets how often transients are cleaned up
+		$this->transient_cleanup_frequency_options = apply_filters(
+			'FHEE__TransientCacheStorage__transient_cleanup_schedule_options',
+			array(
+				'off',
+				'15-minutes',
+				'hour',
+				'12-hours',
+				'day',
+			)
+		);
+		$transient_cleanup_frequency = apply_filters(
+			'FHEE__TransientCacheStorage__transient_cleanup_schedule',
+			'hour'
+		);
+		return in_array(
+			$transient_cleanup_frequency,
+			$this->transient_cleanup_frequency_options,
+			true
+		)
+			? $transient_cleanup_frequency
+			: 'hour';
+	}
+
+
+
+	/**
+	 * we need to be able to round timestamps off to match the set transient cleanup frequency
+	 * so if a transient is set to expire at 1:17 pm for example, and our cleanup schedule is every hour,
+	 * then that timestamp needs to be rounded up to 2:00 pm so that it is removed
+	 * during the next scheduled cleanup after its expiration.
+	 * We also round off the current time timestamp to the closest 5 minutes
+	 * just to make the timestamps a little easier to round which helps with debugging.
+	 *
+	 * @param int    $timestamp [required]
+	 * @param string $cleanup_frequency
+	 * @param bool   $round_up
+	 * @return false|int
+	 */
+	private function roundTimestamp($timestamp, $cleanup_frequency = 'hour', $round_up = true)
+	{
+		$cleanup_frequency = $cleanup_frequency ? $cleanup_frequency : $this->transient_cleanup_frequency;
+		// in order to round the time to the closest xx minutes (or hours),
+		// we take the minutes (or hours) portion of the timestamp and divide it by xx,
+		// round down to a whole number, then multiply by xx to bring us almost back up to where we were
+		// why round down ? so the minutes (or hours) don't go over 60 (or 24)
+		// and bump the hour, which could bump the day, which could bump the month, etc,
+		// which would be bad because we don't always want to round up,
+		// but when we do we can easily achieve that by simply adding the desired offset,
+		$minutes = '00';
+		$hours = 'H';
+		switch ($cleanup_frequency) {
+			case '5-minutes' :
+				$minutes = floor((int)date('i', $timestamp) / 5) * 5;
+				$minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
+				$offset = MINUTE_IN_SECONDS * 5;
+				break;
+			case '15-minutes' :
+				$minutes = floor((int)date('i', $timestamp) / 15) * 15;
+				$minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
+				$offset = MINUTE_IN_SECONDS * 15;
+				break;
+			case '12-hours' :
+				$hours = floor((int)date('H', $timestamp) / 12) * 12;
+				$hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
+				$offset = HOUR_IN_SECONDS * 12;
+				break;
+			case 'day' :
+				$hours = '03'; // run cleanup at 3:00 am (or first site hit after that)
+				$offset = DAY_IN_SECONDS;
+				break;
+			case 'hour' :
+			default :
+				$offset = HOUR_IN_SECONDS;
+				break;
+		}
+		$rounded_timestamp = strtotime(date("Y-m-d {$hours}:{$minutes}:00", $timestamp));
+		$rounded_timestamp += $round_up ? $offset : 0;
+		return apply_filters(
+			'FHEE__TransientCacheStorage__roundTimestamp__timestamp',
+			$rounded_timestamp,
+			$timestamp,
+			$cleanup_frequency,
+			$round_up
+		);
+	}
+
+
+
+	/**
+	 * Saves supplied data to a transient
+	 * if an expiration is set, then it automatically schedules the transient for cleanup
+	 *
+	 * @param string $transient_key [required]
+	 * @param string $data          [required]
+	 * @param int    $expiration    number of seconds until the cache expires
+	 * @return bool
+	 */
+	public function add($transient_key, $data, $expiration = 0)
+	{
+		$expiration = (int)abs($expiration);
+		$saved = set_transient($transient_key, $data, $expiration);
+		if ($saved && $expiration) {
+			$this->scheduleTransientCleanup($transient_key, $expiration);
+		}
+		return $saved;
+	}
+
+
+
+	/**
+	 * retrieves transient data
+	 * automatically triggers early cache refresh for standard cache items
+	 * in order to avoid cache stampedes on busy sites.
+	 * For non-standard cache items like PHP Session data where early refreshing is not wanted,
+	 * the $standard_cache parameter should be set to false when retrieving data
+	 *
+	 * @param string $transient_key [required]
+	 * @param bool   $standard_cache
+	 * @return mixed|null
+	 */
+	public function get($transient_key, $standard_cache = true)
+	{
+		// to avoid cache stampedes (AKA:dogpiles) for standard cache items,
+		// check if known cache expires within the next minute,
+		// and if so, remove it from our tracking and and return nothing.
+		// this should trigger the cache content to be regenerated during this request,
+		// while allowing any following requests to still access the existing cache
+		// until it gets replaced with the refreshed content
+		if (
+			$standard_cache
+			&& isset($this->transients[$transient_key])
+			&& $this->transients[$transient_key] - time() <= MINUTE_IN_SECONDS
+		) {
+			unset($this->transients[$transient_key]);
+			$this->updateTransients();
+			return null;
+		}
+		$content = get_transient($transient_key);
+		return $content !== false ? $content : null;
+	}
+
+
+
+	/**
+	 * delete a single transient and remove tracking
+	 *
+	 * @param string $transient_key [required] full or partial transient key to be deleted
+	 */
+	public function delete($transient_key)
+	{
+		$this->deleteMany(array($transient_key));
+	}
+
+
+
+	/**
+	 * delete multiple transients and remove tracking
+	 *
+	 * @param array $transient_keys [required] array of full or partial transient keys to be deleted
+	 */
+	public function deleteMany(array $transient_keys)
+	{
+		$full_transient_keys = array();
+		foreach ($this->transients as $transient_key => $expiration) {
+			foreach ($transient_keys as $transient_key_to_delete) {
+				if (strpos($transient_key, $transient_key_to_delete) !== false) {
+					$full_transient_keys[] = $transient_key;
+				}
+			}
+		}
+		if ($this->deleteTransientKeys($full_transient_keys)) {
+			$this->updateTransients();
+		}
+	}
+
+
+
+	/**
+	 * sorts transients numerically by timestamp
+	 * then saves the transient schedule to a WP option
+	 */
+	private function updateTransients()
+	{
+		asort($this->transients, SORT_NUMERIC);
+		update_option(
+			TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY,
+			$this->transients
+		);
+	}
+
+
+
+	/**
+	 * schedules a transient for cleanup by adding it to the transient tracking
+	 *
+	 * @param string $transient_key [required]
+	 * @param int    $expiration    [required]
+	 */
+	private function scheduleTransientCleanup($transient_key, $expiration)
+	{
+		// make sure a valid future timestamp is set
+		$expiration += $expiration < time() ? time() : 0;
+		// and round to the closest 15 minutes
+		$expiration = $this->roundTimestamp($expiration);
+		// save transients to clear using their ID as the key to avoid duplicates
+		$this->transients[$transient_key] = $expiration;
+		$this->updateTransients();
+	}
+
+
+
+	/**
+	 * Since our tracked transients are sorted by their timestamps
+	 * we can grab the first transient and see when it is scheduled for cleanup.
+	 * If that timestamp is less than or equal to the current time,
+	 * then cleanup is triggered
+	 */
+	public function checkTransientCleanupSchedule()
+	{
+		if (empty($this->transients)) {
+			return;
+		}
+		// when do we run the next cleanup job?
+		reset($this->transients);
+		$next_scheduled_cleanup = current($this->transients);
+		// if the next cleanup job is scheduled for the current hour
+		if ($next_scheduled_cleanup <= $this->current_time) {
+			if ($this->cleanupExpiredTransients()) {
+				$this->updateTransients();
+			}
+		}
+	}
+
+
+
+	/**
+	 * loops through the array of tracked transients,
+	 * compiles a list of those that have expired, and sends that list off for deletion.
+	 * Also removes any bad records from the transients array
+	 *
+	 * @return bool
+	 */
+	private function cleanupExpiredTransients()
+	{
+		$update = false;
+		// filter the query limit. Set to 0 to turn off garbage collection
+		$limit = (int)abs(
+			apply_filters(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				50
+			)
+		);
+		// non-zero LIMIT means take out the trash
+		if ($limit) {
+			$transient_keys = array();
+			foreach ($this->transients as $transient_key => $expiration) {
+				if ($expiration > $this->current_time) {
+					continue;
+				}
+				if ( ! $expiration || ! $transient_key) {
+					unset($this->transients[$transient_key]);
+					$update = true;
+					continue;
+				}
+				$transient_keys[] = $transient_key;
+			}
+			// delete expired keys, but maintain value of $update if nothing is deleted
+			$update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
+			do_action( 'FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
+		}
+		return $update;
+	}
+
+
+
+	/**
+	 * calls delete_transient() on each transient key provided, up to the specified limit
+	 *
+	 * @param array $transient_keys [required]
+	 * @param int   $limit
+	 * @return bool
+	 */
+	private function deleteTransientKeys(array $transient_keys, $limit = 50)
+	{
+		if (empty($transient_keys)) {
+			return false;
+		}
+		$counter = 0;
+		foreach ($transient_keys as $transient_key) {
+			if($counter === $limit){
+				break;
+			}
+			delete_transient($transient_key);
+			unset($this->transients[$transient_key]);
+			$counter++;
+		}
+		return $counter > 0;
+	}
 
 
 }

Spacing +8 added lines, -8 removed lines

@@ -64,7 +64,7 @@ 
         $this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
         // round current time down to closest 5 minutes to simplify scheduling
         $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
-        $this->transients = (array)get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
+        $this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
         if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
             add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
         }
@@ -132,17 +132,17 @@ 
         $hours = 'H';
         switch ($cleanup_frequency) {
             case '5-minutes' :
-                $minutes = floor((int)date('i', $timestamp) / 5) * 5;
+                $minutes = floor((int) date('i', $timestamp) / 5) * 5;
                 $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
                 $offset = MINUTE_IN_SECONDS * 5;
                 break;
             case '15-minutes' :
-                $minutes = floor((int)date('i', $timestamp) / 15) * 15;
+                $minutes = floor((int) date('i', $timestamp) / 15) * 15;
                 $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
                 $offset = MINUTE_IN_SECONDS * 15;
                 break;
             case '12-hours' :
-                $hours = floor((int)date('H', $timestamp) / 12) * 12;
+                $hours = floor((int) date('H', $timestamp) / 12) * 12;
                 $hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
                 $offset = HOUR_IN_SECONDS * 12;
                 break;
@@ -179,7 +179,7 @@ 
      */
     public function add($transient_key, $data, $expiration = 0)
     {
-        $expiration = (int)abs($expiration);
+        $expiration = (int) abs($expiration);
         $saved = set_transient($transient_key, $data, $expiration);
         if ($saved && $expiration) {
             $this->scheduleTransientCleanup($transient_key, $expiration);
@@ -326,7 +326,7 @@ 
     {
         $update = false;
         // filter the query limit. Set to 0 to turn off garbage collection
-        $limit = (int)abs(
+        $limit = (int) abs(
             apply_filters(
                 'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
                 50
@@ -348,7 +348,7 @@ 
             }
             // delete expired keys, but maintain value of $update if nothing is deleted
             $update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
-            do_action( 'FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
+            do_action('FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
         }
         return $update;
     }
@@ -369,7 +369,7 @@ 
         }
         $counter = 0;
         foreach ($transient_keys as $transient_key) {
-            if($counter === $limit){
+            if ($counter === $limit) {
                 break;
             }
             delete_transient($transient_key);

core/services/container/CoffeeShop.php

Indentation +497 added lines, -497 removed lines

@@ -13,7 +13,7 @@ 
 use OutOfBoundsException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -32,502 +32,502 @@ 
 {
 
 
-    /**
-     * This was the best coffee related name I could think of to represent class name "aliases"
-     * So classes can be found via an alias identifier,
-     * that is revealed when it is run through... the filters... eh? get it?
-     *
-     * @var array $filters
-     */
-    private $filters = array();
-
-    /**
-     * These are the classes that will actually build the objects (to order of course)
-     *
-     * @var array $coffee_makers
-     */
-    private $coffee_makers = array();
-
-    /**
-     * where the instantiated "singleton" objects are stored
-     *
-     * @var CollectionInterface $carafe
-     */
-    private $carafe;
-
-    /**
-     * collection of Recipes that instruct us how to brew objects
-     *
-     * @var CollectionInterface $recipes
-     */
-    private $recipes;
-
-    /**
-     * collection of closures for brewing objects
-     *
-     * @var CollectionInterface $reservoir
-     */
-    private $reservoir;
-
-
-
-    /**
-     * CoffeeShop constructor
-     */
-    public function __construct()
-    {
-        // array for storing class aliases
-        $this->filters = array();
-        // create collection for storing shared services
-        $this->carafe = new LooseCollection( '' );
-        // create collection for storing recipes that tell how to build services and entities
-        $this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface');
-        // create collection for storing closures for constructing new entities
-        $this->reservoir = new Collection('Closure');
-        // create collection for storing the generators that build our services and entity closures
-        $this->coffee_makers = new Collection('EventEspresso\core\services\container\CoffeeMakerInterface');
-    }
-
-
-
-    /**
-     * Returns true if the container can return an entry for the given identifier.
-     * Returns false otherwise.
-     * `has($identifier)` returning true does not mean that `get($identifier)` will not throw an exception.
-     * It does however mean that `get($identifier)` will not throw a `ServiceNotFoundException`.
-     *
-     * @param string $identifier  Identifier of the entry to look for.
-     *                            Typically a Fully Qualified Class Name
-     * @return boolean
-     */
-    public function has($identifier)
-    {
-        $identifier = $this->filterIdentifier($identifier);
-        return $this->carafe->has($identifier);
-    }
-
-
-
-    /**
-     * finds a previously brewed (SHARED) service and returns it
-     *
-     * @param  string $identifier Identifier for the entity class to be constructed.
-     *                            Typically a Fully Qualified Class Name
-     * @return mixed
-     * @throws ServiceNotFoundException No service was found for this identifier.
-     */
-    public function get($identifier)
-    {
-        $identifier = $this->filterIdentifier($identifier);
-        if ($this->carafe->has($identifier)) {
-            return $this->carafe->get($identifier);
-        }
-        throw new ServiceNotFoundException($identifier);
-    }
-
-
-
-    /**
-     * returns an instance of the requested entity type using the supplied arguments.
-     * If a shared service is requested and an instance is already in the carafe, then it will be returned.
-     * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned
-     * If the request is for a new entity and a closure exists in the reservoir for creating it,
-     * then a new entity will be instantiated from the closure and returned.
-     * If a closure does not exist, then one will be built and added to the reservoir
-     * before instantiating the requested entity.
-     *
-     * @param  string $identifier Identifier for the entity class to be constructed.
-     *                            Typically a Fully Qualified Class Name
-     * @param array   $arguments  an array of arguments to be passed to the entity constructor
-     * @param string  $type
-     * @return mixed
-     * @throws ServiceNotFoundException No service was found for this identifier.
-     */
-    public function brew($identifier, $arguments = array(), $type = '')
-    {
-        // resolve any class aliases that may exist
-        $identifier = $this->filterIdentifier($identifier);
-        try {
-            // is a shared service being requested?
-            if (empty($type) || $type === CoffeeMaker::BREW_SHARED) {
-                // if a shared service was requested and an instance is in the carafe, then return it
-                return $this->get($identifier);
-            }
-        } catch (ServiceNotFoundException $e) {
-            // if not then we'll just catch the ServiceNotFoundException but not do anything just yet,
-            // and instead, attempt to build whatever was requested
-        }
-        $brewed = false;
-        // if the reservoir doesn't have a closure already for the requested identifier,
-        // then neither a shared service nor a closure for making entities has been built yet
-        if ( ! $this->reservoir->has($identifier)) {
-            // so let's brew something up and add it to the proper collection
-            $brewed = $this->makeCoffee($identifier, $arguments, $type);
-        }
-        // was the brewed item a callable factory function ?
-        if (is_callable($brewed)) {
-            // then instantiate a new entity from the cached closure
-            $entity = $brewed($arguments);
-        } else if ($brewed) {
-            // requested object was a shared entity, so attempt to get it from the carafe again
-            // because if it wasn't there before, then it should have just been brewed and added,
-            // but if it still isn't there, then this time
-            // the thrown ServiceNotFoundException will not be caught
-            $entity = $this->get($identifier);
-        } else {
-            // if identifier is for a non-shared entity,
-            // then either a cached closure already existed, or was just brewed
-            $closure = $this->reservoir->get($identifier);
-            $entity = $closure($arguments);
-        }
-        return $entity;
-    }
-
-
-
-    /**
-     * @param CoffeeMakerInterface $coffee_maker
-     * @param string               $type
-     * @return bool
-     */
-    public function addCoffeeMaker(CoffeeMakerInterface $coffee_maker, $type)
-    {
-        $type = CoffeeMaker::validateType($type);
-        return $this->coffee_makers->add($coffee_maker, $type);
-    }
-
-
-
-    /**
-     * @param string   $identifier
-     * @param callable $closure
-     * @return callable|null
-     */
-    public function addClosure($identifier, $closure)
-    {
-        if ( ! is_callable($closure)) {
-            throw new InvalidDataTypeException('$closure', $closure, 'Closure');
-        }
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->reservoir->add($closure, $identifier)) {
-            return $closure;
-        }
-        return null;
-    }
-
-
-
-    /**
-     * @param string   $identifier
-     * @return boolean
-     */
-    public function removeClosure($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->reservoir->has($identifier)) {
-            $this->reservoir->remove($this->reservoir->get($identifier));
-            if ( ! $this->reservoir->has($identifier)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the service applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param mixed  $service
-     * @return bool
-     */
-    public function addService($identifier, $service)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        $service = $this->validateService($identifier, $service);
-        return $this->carafe->add($service, $identifier);
-    }
-
-
-
-    /**
-     * @param string $identifier
-     * @return boolean
-     */
-    public function removeService($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->carafe->has($identifier)) {
-            $this->carafe->remove($this->carafe->get($identifier));
-            if ( ! $this->carafe->has($identifier)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Adds instructions on how to brew objects
-     *
-     * @param RecipeInterface $recipe
-     * @return mixed
-     */
-    public function addRecipe(RecipeInterface $recipe)
-    {
-        $this->addAliases($recipe->identifier(), $recipe->filters());
-        $identifier = $this->processIdentifier($recipe->identifier());
-        return $this->recipes->add($recipe, $identifier);
-    }
-
-
-
-    /**
-     * @param string $identifier The Recipe's identifier
-     * @return boolean
-     */
-    public function removeRecipe($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->recipes->has($identifier)) {
-            $this->recipes->remove(
-                $this->recipes->get($identifier)
-            );
-            if ( ! $this->recipes->has($identifier)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Get instructions on how to brew objects
-     *
-     * @param  string $identifier Identifier for the entity class that the recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param string $type
-     * @return RecipeInterface
-     */
-    public function getRecipe($identifier, $type = '')
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->recipes->has($identifier)) {
-            return $this->recipes->get($identifier);
-        }
-        $default_recipes = $this->getDefaultRecipes();
-        $matches = array();
-        foreach ($default_recipes as $wildcard => $default_recipe) {
-            // is the wildcard recipe prefix in the identifier ?
-            if (strpos($identifier, $wildcard) !== false) {
-                // track matches and use the number of wildcard characters matched for the key
-                $matches[strlen($wildcard)] = $default_recipe;
-            }
-        }
-        if (count($matches) > 0) {
-            // sort our recipes by the number of wildcard characters matched
-            ksort($matches);
-            // then grab the last recipe form the list, since it had the most matching characters
-            $match = array_pop($matches);
-            // since we are using a default recipe, we need to set it's identifier and fqcn
-            return $this->copyDefaultRecipe($match, $identifier, $type);
-        }
-        if ($this->recipes->has(Recipe::DEFAULT_ID)) {
-            // since we are using a default recipe, we need to set it's identifier and fqcn
-            return $this->copyDefaultRecipe($this->recipes->get(Recipe::DEFAULT_ID), $identifier, $type);
-        }
-        throw new OutOfBoundsException(
-            sprintf(
-                __('Could not brew coffee because no recipes were found for class "%1$s".', 'event_espresso'),
-                $identifier
-            )
-        );
-    }
-
-
-
-    /**
-     * adds class name aliases to list of filters
-     *
-     * @param  string       $identifier Identifier for the entity class that the alias applies to
-     *                                  Typically a Fully Qualified Class Name
-     * @param  array|string $aliases
-     * @return void
-     * @throws InvalidIdentifierException
-     */
-    public function addAliases($identifier, $aliases)
-    {
-        if (empty($aliases)) {
-            return;
-        }
-        $identifier = $this->processIdentifier($identifier);
-        foreach ((array)$aliases as $alias) {
-            $this->filters[$this->processIdentifier($alias)] = $identifier;
-        }
-    }
-
-
-
-    /**
-     * Adds a service to one of the internal collections
-     *
-     * @param        $identifier
-     * @param array  $arguments
-     * @param string $type
-     * @return mixed
-     * @throws ServiceExistsException
-     */
-    private function makeCoffee($identifier, $arguments = array(), $type = '')
-    {
-        if ((empty($type) || $type === CoffeeMaker::BREW_SHARED) && $this->has($identifier)) {
-            throw new ServiceExistsException($identifier);
-        }
-        $identifier = $this->filterIdentifier($identifier);
-        $recipe = $this->getRecipe($identifier, $type);
-        $type = ! empty($type) ? $type : $recipe->type();
-        $coffee_maker = $this->getCoffeeMaker($type);
-        return $coffee_maker->brew($recipe, $arguments);
-    }
-
-
-
-    /**
-     * filters alias identifiers to find the real class name
-     *
-     * @param  string $identifier Identifier for the entity class that the filter applies to
-     *                            Typically a Fully Qualified Class Name
-     * @return string
-     * @throws InvalidIdentifierException
-     */
-    private function filterIdentifier($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        return isset($this->filters[$identifier]) && ! empty($this->filters[$identifier])
-            ? $this->filters[$identifier]
-            : $identifier;
-    }
-
-
-
-    /**
-     * verifies and standardizes identifiers
-     *
-     * @param  string $identifier Identifier for the entity class
-     *                            Typically a Fully Qualified Class Name
-     * @return string
-     * @throws InvalidIdentifierException
-     */
-    private function processIdentifier($identifier)
-    {
-        if ( ! is_string($identifier)) {
-            throw new InvalidIdentifierException(
-                is_object($identifier) ? get_class($identifier) : gettype($identifier),
-                '\Fully\Qualified\ClassName'
-            );
-        }
-        return ltrim($identifier, '\\');
-    }
-
-
-
-    /**
-     * @param string $type
-     * @return CoffeeMakerInterface
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    private function getCoffeeMaker($type)
-    {
-        if ( ! $this->coffee_makers->has($type)) {
-            throw new OutOfBoundsException(
-                __('The requested coffee maker is either missing or invalid.', 'event_espresso')
-            );
-        }
-        return $this->coffee_makers->get($type);
-    }
-
-
-
-    /**
-     * Retrieves all recipes that use a wildcard "*" in their identifier
-     * This allows recipes to be set up for handling
-     * legacy classes that do not support PSR-4 autoloading.
-     * for example:
-     * using "EEM_*" for a recipe identifier would target all legacy models like EEM_Attendee
-     *
-     * @return array
-     */
-    private function getDefaultRecipes()
-    {
-        $default_recipes = array();
-        $this->recipes->rewind();
-        while ($this->recipes->valid()) {
-            $identifier = $this->recipes->getInfo();
-            // does this recipe use a wildcard ? (but is NOT the global default)
-            if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) {
-                // strip the wildcard and use identifier as key
-                $default_recipes[str_replace('*', '', $identifier)] = $this->recipes->current();
-            }
-            $this->recipes->next();
-        }
-        return $default_recipes;
-    }
-
-
-
-    /**
-     * clones a default recipe and then copies details
-     * from the incoming request to it so that it can be used
-     *
-     * @param RecipeInterface $default_recipe
-     * @param string          $identifier
-     * @param string          $type
-     * @return RecipeInterface
-     */
-    private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
-    {
-        $recipe = clone $default_recipe;
-        if ( ! empty($type)) {
-            $recipe->setType($type);
-        }
-        // is this the base default recipe ?
-        if ($default_recipe->identifier() === Recipe::DEFAULT_ID) {
-            $recipe->setIdentifier($identifier);
-            $recipe->setFqcn($identifier);
-            return $recipe;
-        }
-        $recipe->setIdentifier($identifier);
-        foreach ($default_recipe->paths() as $path) {
-            $path = str_replace('*', $identifier, $path);
-            if (is_readable($path)) {
-                $recipe->setPaths($path);
-            }
-        }
-        $recipe->setFqcn($identifier);
-        return $recipe;
-    }
-
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the service applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param mixed  $service
-     * @return object
-     * @throws InvalidServiceException
-     */
-    private function validateService($identifier, $service)
-    {
-        if ( ! is_object($service)) {
-            throw new InvalidServiceException(
-                $identifier,
-                $service
-            );
-        }
-        return $service;
-    }
+	/**
+	 * This was the best coffee related name I could think of to represent class name "aliases"
+	 * So classes can be found via an alias identifier,
+	 * that is revealed when it is run through... the filters... eh? get it?
+	 *
+	 * @var array $filters
+	 */
+	private $filters = array();
+
+	/**
+	 * These are the classes that will actually build the objects (to order of course)
+	 *
+	 * @var array $coffee_makers
+	 */
+	private $coffee_makers = array();
+
+	/**
+	 * where the instantiated "singleton" objects are stored
+	 *
+	 * @var CollectionInterface $carafe
+	 */
+	private $carafe;
+
+	/**
+	 * collection of Recipes that instruct us how to brew objects
+	 *
+	 * @var CollectionInterface $recipes
+	 */
+	private $recipes;
+
+	/**
+	 * collection of closures for brewing objects
+	 *
+	 * @var CollectionInterface $reservoir
+	 */
+	private $reservoir;
+
+
+
+	/**
+	 * CoffeeShop constructor
+	 */
+	public function __construct()
+	{
+		// array for storing class aliases
+		$this->filters = array();
+		// create collection for storing shared services
+		$this->carafe = new LooseCollection( '' );
+		// create collection for storing recipes that tell how to build services and entities
+		$this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface');
+		// create collection for storing closures for constructing new entities
+		$this->reservoir = new Collection('Closure');
+		// create collection for storing the generators that build our services and entity closures
+		$this->coffee_makers = new Collection('EventEspresso\core\services\container\CoffeeMakerInterface');
+	}
+
+
+
+	/**
+	 * Returns true if the container can return an entry for the given identifier.
+	 * Returns false otherwise.
+	 * `has($identifier)` returning true does not mean that `get($identifier)` will not throw an exception.
+	 * It does however mean that `get($identifier)` will not throw a `ServiceNotFoundException`.
+	 *
+	 * @param string $identifier  Identifier of the entry to look for.
+	 *                            Typically a Fully Qualified Class Name
+	 * @return boolean
+	 */
+	public function has($identifier)
+	{
+		$identifier = $this->filterIdentifier($identifier);
+		return $this->carafe->has($identifier);
+	}
+
+
+
+	/**
+	 * finds a previously brewed (SHARED) service and returns it
+	 *
+	 * @param  string $identifier Identifier for the entity class to be constructed.
+	 *                            Typically a Fully Qualified Class Name
+	 * @return mixed
+	 * @throws ServiceNotFoundException No service was found for this identifier.
+	 */
+	public function get($identifier)
+	{
+		$identifier = $this->filterIdentifier($identifier);
+		if ($this->carafe->has($identifier)) {
+			return $this->carafe->get($identifier);
+		}
+		throw new ServiceNotFoundException($identifier);
+	}
+
+
+
+	/**
+	 * returns an instance of the requested entity type using the supplied arguments.
+	 * If a shared service is requested and an instance is already in the carafe, then it will be returned.
+	 * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned
+	 * If the request is for a new entity and a closure exists in the reservoir for creating it,
+	 * then a new entity will be instantiated from the closure and returned.
+	 * If a closure does not exist, then one will be built and added to the reservoir
+	 * before instantiating the requested entity.
+	 *
+	 * @param  string $identifier Identifier for the entity class to be constructed.
+	 *                            Typically a Fully Qualified Class Name
+	 * @param array   $arguments  an array of arguments to be passed to the entity constructor
+	 * @param string  $type
+	 * @return mixed
+	 * @throws ServiceNotFoundException No service was found for this identifier.
+	 */
+	public function brew($identifier, $arguments = array(), $type = '')
+	{
+		// resolve any class aliases that may exist
+		$identifier = $this->filterIdentifier($identifier);
+		try {
+			// is a shared service being requested?
+			if (empty($type) || $type === CoffeeMaker::BREW_SHARED) {
+				// if a shared service was requested and an instance is in the carafe, then return it
+				return $this->get($identifier);
+			}
+		} catch (ServiceNotFoundException $e) {
+			// if not then we'll just catch the ServiceNotFoundException but not do anything just yet,
+			// and instead, attempt to build whatever was requested
+		}
+		$brewed = false;
+		// if the reservoir doesn't have a closure already for the requested identifier,
+		// then neither a shared service nor a closure for making entities has been built yet
+		if ( ! $this->reservoir->has($identifier)) {
+			// so let's brew something up and add it to the proper collection
+			$brewed = $this->makeCoffee($identifier, $arguments, $type);
+		}
+		// was the brewed item a callable factory function ?
+		if (is_callable($brewed)) {
+			// then instantiate a new entity from the cached closure
+			$entity = $brewed($arguments);
+		} else if ($brewed) {
+			// requested object was a shared entity, so attempt to get it from the carafe again
+			// because if it wasn't there before, then it should have just been brewed and added,
+			// but if it still isn't there, then this time
+			// the thrown ServiceNotFoundException will not be caught
+			$entity = $this->get($identifier);
+		} else {
+			// if identifier is for a non-shared entity,
+			// then either a cached closure already existed, or was just brewed
+			$closure = $this->reservoir->get($identifier);
+			$entity = $closure($arguments);
+		}
+		return $entity;
+	}
+
+
+
+	/**
+	 * @param CoffeeMakerInterface $coffee_maker
+	 * @param string               $type
+	 * @return bool
+	 */
+	public function addCoffeeMaker(CoffeeMakerInterface $coffee_maker, $type)
+	{
+		$type = CoffeeMaker::validateType($type);
+		return $this->coffee_makers->add($coffee_maker, $type);
+	}
+
+
+
+	/**
+	 * @param string   $identifier
+	 * @param callable $closure
+	 * @return callable|null
+	 */
+	public function addClosure($identifier, $closure)
+	{
+		if ( ! is_callable($closure)) {
+			throw new InvalidDataTypeException('$closure', $closure, 'Closure');
+		}
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->reservoir->add($closure, $identifier)) {
+			return $closure;
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * @param string   $identifier
+	 * @return boolean
+	 */
+	public function removeClosure($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->reservoir->has($identifier)) {
+			$this->reservoir->remove($this->reservoir->get($identifier));
+			if ( ! $this->reservoir->has($identifier)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the service applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param mixed  $service
+	 * @return bool
+	 */
+	public function addService($identifier, $service)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		$service = $this->validateService($identifier, $service);
+		return $this->carafe->add($service, $identifier);
+	}
+
+
+
+	/**
+	 * @param string $identifier
+	 * @return boolean
+	 */
+	public function removeService($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->carafe->has($identifier)) {
+			$this->carafe->remove($this->carafe->get($identifier));
+			if ( ! $this->carafe->has($identifier)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Adds instructions on how to brew objects
+	 *
+	 * @param RecipeInterface $recipe
+	 * @return mixed
+	 */
+	public function addRecipe(RecipeInterface $recipe)
+	{
+		$this->addAliases($recipe->identifier(), $recipe->filters());
+		$identifier = $this->processIdentifier($recipe->identifier());
+		return $this->recipes->add($recipe, $identifier);
+	}
+
+
+
+	/**
+	 * @param string $identifier The Recipe's identifier
+	 * @return boolean
+	 */
+	public function removeRecipe($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->recipes->has($identifier)) {
+			$this->recipes->remove(
+				$this->recipes->get($identifier)
+			);
+			if ( ! $this->recipes->has($identifier)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Get instructions on how to brew objects
+	 *
+	 * @param  string $identifier Identifier for the entity class that the recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param string $type
+	 * @return RecipeInterface
+	 */
+	public function getRecipe($identifier, $type = '')
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->recipes->has($identifier)) {
+			return $this->recipes->get($identifier);
+		}
+		$default_recipes = $this->getDefaultRecipes();
+		$matches = array();
+		foreach ($default_recipes as $wildcard => $default_recipe) {
+			// is the wildcard recipe prefix in the identifier ?
+			if (strpos($identifier, $wildcard) !== false) {
+				// track matches and use the number of wildcard characters matched for the key
+				$matches[strlen($wildcard)] = $default_recipe;
+			}
+		}
+		if (count($matches) > 0) {
+			// sort our recipes by the number of wildcard characters matched
+			ksort($matches);
+			// then grab the last recipe form the list, since it had the most matching characters
+			$match = array_pop($matches);
+			// since we are using a default recipe, we need to set it's identifier and fqcn
+			return $this->copyDefaultRecipe($match, $identifier, $type);
+		}
+		if ($this->recipes->has(Recipe::DEFAULT_ID)) {
+			// since we are using a default recipe, we need to set it's identifier and fqcn
+			return $this->copyDefaultRecipe($this->recipes->get(Recipe::DEFAULT_ID), $identifier, $type);
+		}
+		throw new OutOfBoundsException(
+			sprintf(
+				__('Could not brew coffee because no recipes were found for class "%1$s".', 'event_espresso'),
+				$identifier
+			)
+		);
+	}
+
+
+
+	/**
+	 * adds class name aliases to list of filters
+	 *
+	 * @param  string       $identifier Identifier for the entity class that the alias applies to
+	 *                                  Typically a Fully Qualified Class Name
+	 * @param  array|string $aliases
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 */
+	public function addAliases($identifier, $aliases)
+	{
+		if (empty($aliases)) {
+			return;
+		}
+		$identifier = $this->processIdentifier($identifier);
+		foreach ((array)$aliases as $alias) {
+			$this->filters[$this->processIdentifier($alias)] = $identifier;
+		}
+	}
+
+
+
+	/**
+	 * Adds a service to one of the internal collections
+	 *
+	 * @param        $identifier
+	 * @param array  $arguments
+	 * @param string $type
+	 * @return mixed
+	 * @throws ServiceExistsException
+	 */
+	private function makeCoffee($identifier, $arguments = array(), $type = '')
+	{
+		if ((empty($type) || $type === CoffeeMaker::BREW_SHARED) && $this->has($identifier)) {
+			throw new ServiceExistsException($identifier);
+		}
+		$identifier = $this->filterIdentifier($identifier);
+		$recipe = $this->getRecipe($identifier, $type);
+		$type = ! empty($type) ? $type : $recipe->type();
+		$coffee_maker = $this->getCoffeeMaker($type);
+		return $coffee_maker->brew($recipe, $arguments);
+	}
+
+
+
+	/**
+	 * filters alias identifiers to find the real class name
+	 *
+	 * @param  string $identifier Identifier for the entity class that the filter applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidIdentifierException
+	 */
+	private function filterIdentifier($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		return isset($this->filters[$identifier]) && ! empty($this->filters[$identifier])
+			? $this->filters[$identifier]
+			: $identifier;
+	}
+
+
+
+	/**
+	 * verifies and standardizes identifiers
+	 *
+	 * @param  string $identifier Identifier for the entity class
+	 *                            Typically a Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidIdentifierException
+	 */
+	private function processIdentifier($identifier)
+	{
+		if ( ! is_string($identifier)) {
+			throw new InvalidIdentifierException(
+				is_object($identifier) ? get_class($identifier) : gettype($identifier),
+				'\Fully\Qualified\ClassName'
+			);
+		}
+		return ltrim($identifier, '\\');
+	}
+
+
+
+	/**
+	 * @param string $type
+	 * @return CoffeeMakerInterface
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	private function getCoffeeMaker($type)
+	{
+		if ( ! $this->coffee_makers->has($type)) {
+			throw new OutOfBoundsException(
+				__('The requested coffee maker is either missing or invalid.', 'event_espresso')
+			);
+		}
+		return $this->coffee_makers->get($type);
+	}
+
+
+
+	/**
+	 * Retrieves all recipes that use a wildcard "*" in their identifier
+	 * This allows recipes to be set up for handling
+	 * legacy classes that do not support PSR-4 autoloading.
+	 * for example:
+	 * using "EEM_*" for a recipe identifier would target all legacy models like EEM_Attendee
+	 *
+	 * @return array
+	 */
+	private function getDefaultRecipes()
+	{
+		$default_recipes = array();
+		$this->recipes->rewind();
+		while ($this->recipes->valid()) {
+			$identifier = $this->recipes->getInfo();
+			// does this recipe use a wildcard ? (but is NOT the global default)
+			if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) {
+				// strip the wildcard and use identifier as key
+				$default_recipes[str_replace('*', '', $identifier)] = $this->recipes->current();
+			}
+			$this->recipes->next();
+		}
+		return $default_recipes;
+	}
+
+
+
+	/**
+	 * clones a default recipe and then copies details
+	 * from the incoming request to it so that it can be used
+	 *
+	 * @param RecipeInterface $default_recipe
+	 * @param string          $identifier
+	 * @param string          $type
+	 * @return RecipeInterface
+	 */
+	private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
+	{
+		$recipe = clone $default_recipe;
+		if ( ! empty($type)) {
+			$recipe->setType($type);
+		}
+		// is this the base default recipe ?
+		if ($default_recipe->identifier() === Recipe::DEFAULT_ID) {
+			$recipe->setIdentifier($identifier);
+			$recipe->setFqcn($identifier);
+			return $recipe;
+		}
+		$recipe->setIdentifier($identifier);
+		foreach ($default_recipe->paths() as $path) {
+			$path = str_replace('*', $identifier, $path);
+			if (is_readable($path)) {
+				$recipe->setPaths($path);
+			}
+		}
+		$recipe->setFqcn($identifier);
+		return $recipe;
+	}
+
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the service applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param mixed  $service
+	 * @return object
+	 * @throws InvalidServiceException
+	 */
+	private function validateService($identifier, $service)
+	{
+		if ( ! is_object($service)) {
+			throw new InvalidServiceException(
+				$identifier,
+				$service
+			);
+		}
+		return $service;
+	}
 
 }
 // End of file CoffeeShop.php

core/db_classes/EE_Registration.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -921,7 +921,7 @@ 
 	/**
 	 * Sets deleted
 	 * @param boolean $deleted
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function set_deleted($deleted) {
 	    if ( $deleted ) {
@@ -969,6 +969,7 @@ 
 	 *
 	 * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
 	 * @param bool   $check_approved   This is used to indicate whether the caller wants can_checkin to also consider registration status as well as datetime access.
+	 * @param integer $DTT_OR_ID
 	 *
 	 * @return bool
 	 */
@@ -1107,7 +1108,7 @@ 
      * Returns the latest datetime related to this registration (via the ticket attached to the registration).
      * "Latest" is defined by the `DTT_EVT_start` column.
      *
-     * @return EE_Datetime|null
+     * @return null|EE_Base_Class
      * @throws \EE_Error
      */
 	public function get_latest_related_datetime() {
@@ -1378,7 +1379,7 @@ 
 	 * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
 	 * Note: if there are no payments on the registration there will be no payment method returned.
 	 *
-	 * @return EE_Payment_Method|null
+	 * @return null|EE_Base_Class
 	 */
 	public function payment_method() {
 		return EEM_Payment_Method::instance()->get_last_used_for_registration( $this );

Indentation +242 added lines, -242 removed lines

@@ -35,7 +35,7 @@ 
 
 	/**
 	 * extra meta key for tracking reg status os trashed registrations
-     *
+	 *
 	 * @type string
 	 */
 	const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
@@ -43,7 +43,7 @@ 
 
 	/**
 	 * extra meta key for tracking if registration has reserved ticket
-     *
+	 *
 	 * @type string
 	 */
 	const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
@@ -89,15 +89,15 @@ 
 
 
 
-    /**
-     * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
+	/**
+	 * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
 	public function set( $field_name, $field_value, $use_default = FALSE ) {
 		switch( $field_name ) {
 			case 'REG_code' :
@@ -115,18 +115,18 @@ 
 
 
 
-    /**
-     * Set Status ID
-     * updates the registration status and ALSO...
-     * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
-     * calls release_registration_space() if the reg status changes FROM approved to any other reg status
-     *
-     * @param string  $new_STS_ID
-     * @param boolean $use_default
-     * @return bool
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
+	/**
+	 * Set Status ID
+	 * updates the registration status and ALSO...
+	 * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
+	 * calls release_registration_space() if the reg status changes FROM approved to any other reg status
+	 *
+	 * @param string  $new_STS_ID
+	 * @param boolean $use_default
+	 * @return bool
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
 	public function set_status( $new_STS_ID = NULL, $use_default = FALSE ) {
 		// get current REG_Status
 		$old_STS_ID = $this->status_ID();
@@ -137,7 +137,7 @@ 
 			&& ! empty( $new_STS_ID ) // as well as the new status
 			&& $this->ID() // ensure registration is in the db
 		) {
-            // TO approved
+			// TO approved
 			if ( $new_STS_ID === EEM_Registration::status_id_approved ) {
 				// reserve a space by incrementing ticket and datetime sold values
 				$this->_reserve_registration_space();
@@ -148,12 +148,12 @@ 
 				$this->_release_registration_space();
 				do_action( 'AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID );
 			}
-            // update status
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
-            /** @type EE_Transaction_Payments $transaction_payments */
-            $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-            $transaction_payments->recalculate_transaction_total( $this->transaction(), false );
+			// update status
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			$this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
+			/** @type EE_Transaction_Payments $transaction_payments */
+			$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+			$transaction_payments->recalculate_transaction_total( $this->transaction(), false );
 			$this->transaction()->update_status_based_on_total_paid( true );
 			do_action( 'AHEE__EE_Registration__set_status__after_update', $this );
 			return TRUE;
@@ -167,60 +167,60 @@ 
 
 
 
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param string $new_STS_ID
-     * @param string $old_STS_ID
-     * @throws \EE_Error
-     */
-    private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
-    {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-        // true if registration has been cancelled or declined
-        if (
-            in_array($new_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($old_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // cancelled or declined registration
-            $registration_processor->update_registration_after_being_canceled_or_declined(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_canceled_or_declined_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID);
-            return;
-        }
-        // true if reinstating cancelled or declined registration
-        if (
-            in_array($old_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($new_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // reinstating cancelled or declined registration
-            $registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_reinstating_canceled_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID);
-        }
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param string $new_STS_ID
+	 * @param string $old_STS_ID
+	 * @throws \EE_Error
+	 */
+	private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
+	{
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+		// true if registration has been cancelled or declined
+		if (
+			in_array($new_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($old_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// cancelled or declined registration
+			$registration_processor->update_registration_after_being_canceled_or_declined(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_canceled_or_declined_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID);
+			return;
+		}
+		// true if reinstating cancelled or declined registration
+		if (
+			in_array($old_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($new_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// reinstating cancelled or declined registration
+			$registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_reinstating_canceled_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID);
+		}
 	}
 
 
@@ -233,16 +233,16 @@ 
 
 
 
-    /**
-     * increments this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * increments this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private function _reserve_registration_space() {
-	    // reserved ticket and datetime counts will be decremented as sold counts are incremented
-        // so stop tracking that this reg has a ticket reserved
-	    $this->release_reserved_ticket();
+		// reserved ticket and datetime counts will be decremented as sold counts are incremented
+		// so stop tracking that this reg has a ticket reserved
+		$this->release_reserved_ticket();
 		$ticket = $this->ticket();
 		$ticket->increase_sold();
 		$ticket->save();
@@ -252,13 +252,13 @@ 
 
 
 
-    /**
-     * Gets the ticket this registration is for
-     *
-     * @param boolean $include_archived whether to include archived tickets or not.
-     * @return EE_Ticket|EE_Base_Class
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets the ticket this registration is for
+	 *
+	 * @param boolean $include_archived whether to include archived tickets or not.
+	 * @return EE_Ticket|EE_Base_Class
+	 * @throws \EE_Error
+	 */
 	public function ticket( $include_archived = TRUE ) {
 		$query_params = array();
 		if ( $include_archived ) {
@@ -300,12 +300,12 @@ 
 
 
 
-    /**
-     * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private function _release_registration_space() {
 		$ticket = $this->ticket();
 		$ticket->decrease_sold();
@@ -314,46 +314,46 @@ 
 
 
 
-    /**
-     * tracks this registration's ticket reservation in extra meta
-     * and can increment related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will increment ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * tracks this registration's ticket reservation in extra meta
+	 * and can increment related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will increment ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function reserve_ticket($update_ticket = false) {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call update_extra_meta(), which is why that is done first
-            if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->increase_reserved();
-                $ticket->save();
-            }
-        }
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call update_extra_meta(), which is why that is done first
+			if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->increase_reserved();
+				$ticket->save();
+			}
+		}
 	}
 
 
 
-    /**
-     * stops tracking this registration's ticket reservation in extra meta
-     * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
-    public function release_reserved_ticket($update_ticket = false) {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
-            if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->decrease_reserved();
-                $ticket->save();
-            }
-        }
+	/**
+	 * stops tracking this registration's ticket reservation in extra meta
+	 * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function release_reserved_ticket($update_ticket = false) {
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
+			if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->decrease_reserved();
+				$ticket->save();
+			}
+		}
 	}
 
 
@@ -742,9 +742,9 @@ 
 
 
 	/**
-	*		get  Attendee Number
-	* 		@access		public
-	*/
+	 *		get  Attendee Number
+	 * 		@access		public
+	 */
 	public function count() {
 		return $this->get( 'REG_count' );
 	}
@@ -1021,11 +1021,11 @@ 
 	 * @return boolean
 	 */
 	public function set_deleted($deleted) {
-	    if ( $deleted ) {
-	        $this->delete();
-        } else {
-	        $this->restore();
-        }
+		if ( $deleted ) {
+			$this->delete();
+		} else {
+			$this->restore();
+		}
 	}
 
 
@@ -1130,20 +1130,20 @@ 
 
 
 
-    /**
-     * toggle Check-in status for this registration
-     * Check-ins are toggled in the following order:
-     * never checked in -> checked in
-     * checked in -> checked out
-     * checked out -> checked in
-     *
-     * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
-     *                      If not included or null, then it is assumed latest datetime is being toggled.
-     * @param bool $verify  If true then can_checkin() is used to verify whether the person
-     *                      can be checked in or not.  Otherwise this forces change in checkin status.
-     * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
-     * @throws EE_Error
-     */
+	/**
+	 * toggle Check-in status for this registration
+	 * Check-ins are toggled in the following order:
+	 * never checked in -> checked in
+	 * checked in -> checked out
+	 * checked out -> checked in
+	 *
+	 * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
+	 *                      If not included or null, then it is assumed latest datetime is being toggled.
+	 * @param bool $verify  If true then can_checkin() is used to verify whether the person
+	 *                      can be checked in or not.  Otherwise this forces change in checkin status.
+	 * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
+	 * @throws EE_Error
+	 */
 	public function toggle_checkin_status( $DTT_ID = null, $verify = false ) {
 		if ( empty( $DTT_ID ) ) {
 			$datetime = $this->get_latest_related_datetime();
@@ -1200,13 +1200,13 @@ 
 
 
 
-    /**
-     * Returns the latest datetime related to this registration (via the ticket attached to the registration).
-     * "Latest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Datetime|null
-     * @throws \EE_Error
-     */
+	/**
+	 * Returns the latest datetime related to this registration (via the ticket attached to the registration).
+	 * "Latest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Datetime|null
+	 * @throws \EE_Error
+	 */
 	public function get_latest_related_datetime() {
 		return EEM_Datetime::instance()->get_one(
 			array(
@@ -1220,12 +1220,12 @@ 
 
 
 
-    /**
-     * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
-     * "Earliest" is defined by the `DTT_EVT_start` column.
-     *
-     * @throws \EE_Error
-     */
+	/**
+	 * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
+	 * "Earliest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @throws \EE_Error
+	 */
 	public function get_earliest_related_datetime() {
 		return EEM_Datetime::instance()->get_one(
 			array(
@@ -1239,18 +1239,18 @@ 
 
 
 
-    /**
-     * This method simply returns the check-in status for this registration and the given datetime.
-     * If neither the datetime nor the checkin values are provided as arguments,
-     * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
-     *
-     * @param  int $DTT_ID        The ID of the datetime we're checking against
-     *                            (if empty we'll get the primary datetime for
-     *                            this registration (via event) and use it's ID);
-     * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
-     * @return int                Integer representing Check-in status.
-     * @throws \EE_Error
-     */
+	/**
+	 * This method simply returns the check-in status for this registration and the given datetime.
+	 * If neither the datetime nor the checkin values are provided as arguments,
+	 * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
+	 *
+	 * @param  int $DTT_ID        The ID of the datetime we're checking against
+	 *                            (if empty we'll get the primary datetime for
+	 *                            this registration (via event) and use it's ID);
+	 * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
+	 * @return int                Integer representing Check-in status.
+	 * @throws \EE_Error
+	 */
 	public function check_in_status_for_datetime( $DTT_ID = 0, $checkin = null ) {
 		$checkin_query_params = array(
 			'order_by' => array( 'CHK_timestamp' => 'DESC' )
@@ -1262,8 +1262,8 @@ 
 
 		//get checkin object (if exists)
 		$checkin = $checkin instanceof EE_Checkin
-            ? $checkin
-            : $this->get_first_related( 'Checkin', $checkin_query_params );
+			? $checkin
+			: $this->get_first_related( 'Checkin', $checkin_query_params );
 		if ( $checkin instanceof EE_Checkin ) {
 			if ( $checkin->get( 'CHK_in' ) ) {
 				return EE_Registration::checkin_status_in; //checked in
@@ -1516,46 +1516,46 @@ 
 
 
 
-    /**
-     * Soft Deletes this model object.
-     *
-     * @return boolean | int
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function delete()
-    {
-        if($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
-            $this->set_status(EEM_Registration::status_id_cancelled);
-        }
-        return parent::delete();
-    }
+	/**
+	 * Soft Deletes this model object.
+	 *
+	 * @return boolean | int
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function delete()
+	{
+		if($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+			$this->set_status(EEM_Registration::status_id_cancelled);
+		}
+		return parent::delete();
+	}
 
 
 
-    /**
-     * Restores whatever the previous status was on a registration before it was trashed (if possible)
-     *
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
-    public function restore()
-    {
-        $previous_status = $this->get_extra_meta(
-            EE_Registration::PRE_TRASH_REG_STATUS_KEY,
-            true,
-            EEM_Registration::status_id_cancelled
-        );
-        if ($previous_status) {
-            $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
-            $this->set_status($previous_status);
-        }
-        return parent::restore();
-    }
+	/**
+	 * Restores whatever the previous status was on a registration before it was trashed (if possible)
+	 *
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
+	public function restore()
+	{
+		$previous_status = $this->get_extra_meta(
+			EE_Registration::PRE_TRASH_REG_STATUS_KEY,
+			true,
+			EEM_Registration::status_id_cancelled
+		);
+		if ($previous_status) {
+			$this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
+			$this->set_status($previous_status);
+		}
+		return parent::restore();
+	}
 
 
 
-    /*************************** DEPRECATED ***************************/
+	/*************************** DEPRECATED ***************************/
 
 
 
@@ -1605,24 +1605,24 @@ 
 
 
 
-    /**
-     * Gets the primary datetime related to this registration via the related Event to this registration
-     *
-     * @deprecated 4.9.17
-     * @return EE_Datetime
-     */
-    public function get_related_primary_datetime() {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
-                'event_espresso'
-            ),
-            '4.9.17',
-            '5.0.0'
-        );
-        return $this->event()->primary_datetime();
-    }
+	/**
+	 * Gets the primary datetime related to this registration via the related Event to this registration
+	 *
+	 * @deprecated 4.9.17
+	 * @return EE_Datetime
+	 */
+	public function get_related_primary_datetime() {
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
+				'event_espresso'
+			),
+			'4.9.17',
+			'5.0.0'
+		);
+		return $this->event()->primary_datetime();
+	}
 
 
 

Spacing +186 added lines, -186 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\exceptions\EntityNotFoundException;
 
-if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * EE_Registration class
@@ -59,9 +59,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Registration
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -72,8 +72,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Registration
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -83,8 +83,8 @@ 
 	 *
 	 * @param        int $EVT_ID Event ID
 	 */
-	public function set_event( $EVT_ID = 0 ) {
-		$this->set( 'EVT_ID', $EVT_ID );
+	public function set_event($EVT_ID = 0) {
+		$this->set('EVT_ID', $EVT_ID);
 	}
 
 
@@ -98,18 +98,18 @@ 
      * @throws \EE_Error
      * @throws \RuntimeException
      */
-	public function set( $field_name, $field_value, $use_default = FALSE ) {
-		switch( $field_name ) {
+	public function set($field_name, $field_value, $use_default = FALSE) {
+		switch ($field_name) {
 			case 'REG_code' :
-				if ( ! empty( $field_value ) && $this->reg_code() === null ) {
-					$this->set_reg_code( $field_value, $use_default );
+				if ( ! empty($field_value) && $this->reg_code() === null) {
+					$this->set_reg_code($field_value, $use_default);
 				}
 				break;
 			case 'STS_ID' :
-				$this->set_status( $field_value, $use_default );
+				$this->set_status($field_value, $use_default);
 				break;
 			default :
-				parent::set( $field_name, $field_value, $use_default );
+				parent::set($field_name, $field_value, $use_default);
 		}
 	}
 
@@ -127,40 +127,40 @@ 
      * @throws \RuntimeException
      * @throws \EE_Error
      */
-	public function set_status( $new_STS_ID = NULL, $use_default = FALSE ) {
+	public function set_status($new_STS_ID = NULL, $use_default = FALSE) {
 		// get current REG_Status
 		$old_STS_ID = $this->status_ID();
 		// if status has changed
 		if (
 			$old_STS_ID !== $new_STS_ID // and that status has actually changed
-			&& ! empty( $old_STS_ID ) // and that old status is actually set
-			&& ! empty( $new_STS_ID ) // as well as the new status
+			&& ! empty($old_STS_ID) // and that old status is actually set
+			&& ! empty($new_STS_ID) // as well as the new status
 			&& $this->ID() // ensure registration is in the db
 		) {
             // TO approved
-			if ( $new_STS_ID === EEM_Registration::status_id_approved ) {
+			if ($new_STS_ID === EEM_Registration::status_id_approved) {
 				// reserve a space by incrementing ticket and datetime sold values
 				$this->_reserve_registration_space();
-				do_action( 'AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID );
+				do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID);
 			// OR FROM  approved
-			} else if ( $old_STS_ID === EEM_Registration::status_id_approved ) {
+			} else if ($old_STS_ID === EEM_Registration::status_id_approved) {
 				// release a space by decrementing ticket and datetime sold values
 				$this->_release_registration_space();
-				do_action( 'AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID );
+				do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID);
 			}
             // update status
             parent::set('STS_ID', $new_STS_ID, $use_default);
             $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
             /** @type EE_Transaction_Payments $transaction_payments */
             $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-            $transaction_payments->recalculate_transaction_total( $this->transaction(), false );
-			$this->transaction()->update_status_based_on_total_paid( true );
-			do_action( 'AHEE__EE_Registration__set_status__after_update', $this );
+            $transaction_payments->recalculate_transaction_total($this->transaction(), false);
+			$this->transaction()->update_status_based_on_total_paid(true);
+			do_action('AHEE__EE_Registration__set_status__after_update', $this);
 			return TRUE;
 		} else {
 			//even though the old value matches the new value, it's still good to
 			//allow the parent set method to have a say
-			parent::set( 'STS_ID', $new_STS_ID, $use_default );
+			parent::set('STS_ID', $new_STS_ID, $use_default);
 			return TRUE;
 		}
 	}
@@ -228,7 +228,7 @@ 
 	 *        get Status ID
 	 */
 	public function status_ID() {
-		return $this->get( 'STS_ID' );
+		return $this->get('STS_ID');
 	}
 
 
@@ -259,12 +259,12 @@ 
      * @return EE_Ticket|EE_Base_Class
      * @throws \EE_Error
      */
-	public function ticket( $include_archived = TRUE ) {
+	public function ticket($include_archived = TRUE) {
 		$query_params = array();
-		if ( $include_archived ) {
-			$query_params[ 'default_where_conditions' ] = 'none';
+		if ($include_archived) {
+			$query_params['default_where_conditions'] = 'none';
 		}
-		return $this->get_first_related( 'Ticket', $query_params );
+		return $this->get_first_related('Ticket', $query_params);
 	}
 
 
@@ -292,7 +292,7 @@ 
 	 */
 	public function wp_user() {
 		$event = $this->event();
-		if ( $event instanceof EE_Event ) {
+		if ($event instanceof EE_Event) {
 			return $event->wp_user();
 		}
 		return 0;
@@ -363,8 +363,8 @@ 
 	 *
 	 * @param        int $ATT_ID Attendee ID
 	 */
-	public function set_attendee_id( $ATT_ID = 0 ) {
-		$this->set( 'ATT_ID', $ATT_ID );
+	public function set_attendee_id($ATT_ID = 0) {
+		$this->set('ATT_ID', $ATT_ID);
 	}
 
 
@@ -374,8 +374,8 @@ 
 	 *
 	 * @param        int $TXN_ID Transaction ID
 	 */
-	public function set_transaction_id( $TXN_ID = 0 ) {
-		$this->set( 'TXN_ID', $TXN_ID );
+	public function set_transaction_id($TXN_ID = 0) {
+		$this->set('TXN_ID', $TXN_ID);
 	}
 
 
@@ -385,8 +385,8 @@ 
 	 *
 	 * @param    string $REG_session PHP Session ID
 	 */
-	public function set_session( $REG_session = '' ) {
-		$this->set( 'REG_session', $REG_session );
+	public function set_session($REG_session = '') {
+		$this->set('REG_session', $REG_session);
 	}
 
 
@@ -396,8 +396,8 @@ 
 	 *
 	 * @param    string $REG_url_link Registration URL Link
 	 */
-	public function set_reg_url_link( $REG_url_link = '' ) {
-		$this->set( 'REG_url_link', $REG_url_link );
+	public function set_reg_url_link($REG_url_link = '') {
+		$this->set('REG_url_link', $REG_url_link);
 	}
 
 
@@ -407,8 +407,8 @@ 
 	 *
 	 * @param        int $REG_count Primary Attendee
 	 */
-	public function set_count( $REG_count = 1 ) {
-		$this->set( 'REG_count', $REG_count );
+	public function set_count($REG_count = 1) {
+		$this->set('REG_count', $REG_count);
 	}
 
 
@@ -418,8 +418,8 @@ 
 	 *
 	 * @param        boolean $REG_group_size Group Registration
 	 */
-	public function set_group_size( $REG_group_size = FALSE ) {
-		$this->set( 'REG_group_size', $REG_group_size );
+	public function set_group_size($REG_group_size = FALSE) {
+		$this->set('REG_group_size', $REG_group_size);
 	}
 
 
@@ -495,8 +495,8 @@ 
 	 *
 	 * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of Date
 	 */
-	public function set_reg_date( $REG_date = FALSE ) {
-		$this->set( 'REG_date', $REG_date );
+	public function set_reg_date($REG_date = FALSE) {
+		$this->set('REG_date', $REG_date);
 	}
 
 
@@ -507,8 +507,8 @@ 
 	 * @access    public
 	 * @param    float $REG_final_price
 	 */
-	public function set_final_price( $REG_final_price = 0.00 ) {
-		$this->set( 'REG_final_price', $REG_final_price );
+	public function set_final_price($REG_final_price = 0.00) {
+		$this->set('REG_final_price', $REG_final_price);
 	}
 
 
@@ -519,8 +519,8 @@ 
 	 * @access    public
 	 * @param    float $REG_paid
 	 */
-	public function set_paid( $REG_paid = 0.00 ) {
-		$this->set( 'REG_paid', $REG_paid );
+	public function set_paid($REG_paid = 0.00) {
+		$this->set('REG_paid', $REG_paid);
 	}
 
 
@@ -530,8 +530,8 @@ 
 	 *
 	 * @param        boolean $REG_att_is_going Attendee Is Going
 	 */
-	public function set_att_is_going( $REG_att_is_going = FALSE ) {
-		$this->set( 'REG_att_is_going', $REG_att_is_going );
+	public function set_att_is_going($REG_att_is_going = FALSE) {
+		$this->set('REG_att_is_going', $REG_att_is_going);
 	}
 
 
@@ -541,7 +541,7 @@ 
 	 * @return EE_Attendee
 	 */
 	public function attendee() {
-		return $this->get_first_related( 'Attendee' );
+		return $this->get_first_related('Attendee');
 	}
 
 
@@ -550,7 +550,7 @@ 
 	 *        get Event ID
 	 */
 	public function event_ID() {
-		return $this->get( 'EVT_ID' );
+		return $this->get('EVT_ID');
 	}
 
 
@@ -560,7 +560,7 @@ 
 	 */
 	public function event_name() {
 		$event = $this->event_obj();
-		if ( $event ) {
+		if ($event) {
 			return $event->name();
 		} else {
 			return NULL;
@@ -574,7 +574,7 @@ 
 	 * @return EE_Event
 	 */
 	public function event_obj() {
-		return $this->get_first_related( 'Event' );
+		return $this->get_first_related('Event');
 	}
 
 
@@ -583,7 +583,7 @@ 
 	 *        get Attendee ID
 	 */
 	public function attendee_ID() {
-		return $this->get( 'ATT_ID' );
+		return $this->get('ATT_ID');
 	}
 
 
@@ -592,7 +592,7 @@ 
 	 *        get PHP Session ID
 	 */
 	public function session_ID() {
-		return $this->get( 'REG_session' );
+		return $this->get('REG_session');
 	}
 
 
@@ -602,7 +602,7 @@ 
 	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
 	 * @return string
 	 */
-	public function receipt_url( $messenger = 'html' ) {
+	public function receipt_url($messenger = 'html') {
 
 		/**
 		 * The below will be deprecated one version after this.  We check first if there is a custom receipt template already in use on old system.  If there is then we just return the standard url for it.
@@ -610,12 +610,12 @@ 
 		 * @since 4.5.0
 		 */
 		$template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
-		$has_custom = EEH_Template::locate_template( $template_relative_path , array(), TRUE, TRUE, TRUE );
+		$has_custom = EEH_Template::locate_template($template_relative_path, array(), TRUE, TRUE, TRUE);
 
-		if ( $has_custom ) {
-			return add_query_arg( array( 'receipt' => 'true' ), $this->invoice_url( 'launch' ) );
+		if ($has_custom) {
+			return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
 		}
-		return apply_filters( 'FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt' );
+		return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
 	}
 
 
@@ -626,28 +626,28 @@ 
 	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
 	 * @return string
 	 */
-	public function invoice_url( $messenger = 'html' ) {
+	public function invoice_url($messenger = 'html') {
 		/**
 		 * The below will be deprecated one version after this.  We check first if there is a custom invoice template already in use on old system.  If there is then we just return the standard url for it.
 		 *
 		 * @since 4.5.0
 		 */
 		$template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
-		$has_custom = EEH_Template::locate_template( $template_relative_path , array(), TRUE, TRUE, TRUE );
+		$has_custom = EEH_Template::locate_template($template_relative_path, array(), TRUE, TRUE, TRUE);
 
-		if ( $has_custom ) {
-			if ( $messenger == 'html' ) {
-				return $this->invoice_url( 'launch' );
+		if ($has_custom) {
+			if ($messenger == 'html') {
+				return $this->invoice_url('launch');
 			}
 			$route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
 
-			$query_args = array( 'ee' => $route, 'id' => $this->reg_url_link() );
-			if ( $messenger == 'html' ) {
+			$query_args = array('ee' => $route, 'id' => $this->reg_url_link());
+			if ($messenger == 'html') {
 				$query_args['html'] = TRUE;
 			}
-			return add_query_arg( $query_args, get_permalink( EE_Registry::instance()->CFG->core->thank_you_page_id ) );
+			return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
 		}
-		return apply_filters( 'FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice' );
+		return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
 	}
 
 
@@ -660,7 +660,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function reg_url_link() {
-		return (string)$this->get( 'REG_url_link' );
+		return (string) $this->get('REG_url_link');
 	}
 
 
@@ -670,8 +670,8 @@ 
 	 * @param string $type 'download','launch', or 'html' (default is 'launch')
 	 * @return void
 	 */
-	public function e_invoice_url( $type = 'launch' ) {
-		echo $this->invoice_url( $type );
+	public function e_invoice_url($type = 'launch') {
+		echo $this->invoice_url($type);
 	}
 
 
@@ -691,7 +691,7 @@ 
 	 * @return string
 	 */
 	public function payment_overview_url() {
-		return add_query_arg( array( 'e_reg_url_link' => $this->reg_url_link(), 'step' => 'payment_options', 'revisit' => TRUE ), EE_Registry::instance()->CFG->core->reg_page_url() );
+		return add_query_arg(array('e_reg_url_link' => $this->reg_url_link(), 'step' => 'payment_options', 'revisit' => TRUE), EE_Registry::instance()->CFG->core->reg_page_url());
 	}
 
 
@@ -702,7 +702,7 @@ 
 	 * @return string
 	 */
 	public function edit_attendee_information_url() {
-		return add_query_arg( array( 'e_reg_url_link' => $this->reg_url_link(), 'step' => 'attendee_information', 'revisit' => TRUE ), EE_Registry::instance()->CFG->core->reg_page_url() );
+		return add_query_arg(array('e_reg_url_link' => $this->reg_url_link(), 'step' => 'attendee_information', 'revisit' => TRUE), EE_Registry::instance()->CFG->core->reg_page_url());
 	}
 
 
@@ -712,7 +712,7 @@ 
 	 * @return string
 	 */
 	public function get_admin_edit_url() {
-		return EEH_URL::add_query_args_and_nonce( array( 'page' => 'espresso_registrations', 'action' => 'view_registration', '_REG_ID' => $this->ID() ), admin_url( 'admin.php' ) );
+		return EEH_URL::add_query_args_and_nonce(array('page' => 'espresso_registrations', 'action' => 'view_registration', '_REG_ID' => $this->ID()), admin_url('admin.php'));
 	}
 
 
@@ -721,7 +721,7 @@ 
 	 *    is_primary_registrant?
 	 */
 	public function is_primary_registrant() {
-		return $this->get( 'REG_count' ) == 1 ? TRUE : FALSE;
+		return $this->get('REG_count') == 1 ? TRUE : FALSE;
 	}
 
 
@@ -730,12 +730,12 @@ 
 	 * This returns the primary registration object for this registration group (which may be this object).
 	 * @return EE_Registration
 	 */
-	public function get_primary_registration()  {
-		if ( $this->is_primary_registrant() )
+	public function get_primary_registration() {
+		if ($this->is_primary_registrant())
 			return $this;
 
 		//k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
-		$primary_registrant = EEM_Registration::instance()->get_one( array( array('TXN_ID' => $this->transaction_ID(), 'REG_count' => 1 ) ) );
+		$primary_registrant = EEM_Registration::instance()->get_one(array(array('TXN_ID' => $this->transaction_ID(), 'REG_count' => 1)));
 		return $primary_registrant;
 	}
 
@@ -746,7 +746,7 @@ 
 	* 		@access		public
 	*/
 	public function count() {
-		return $this->get( 'REG_count' );
+		return $this->get('REG_count');
 	}
 
 
@@ -755,7 +755,7 @@ 
 	 *        get Group Size
 	 */
 	public function group_size() {
-		return $this->get( 'REG_group_size' );
+		return $this->get('REG_group_size');
 	}
 
 
@@ -764,7 +764,7 @@ 
 	 *        get Registration Date
 	 */
 	public function date() {
-		return $this->get( 'REG_date' );
+		return $this->get('REG_date');
 	}
 
 
@@ -775,8 +775,8 @@ 
 	 * @param string $time_format
 	 * @return string
 	 */
-	public function pretty_date( $date_format = NULL, $time_format = NULL ) {
-		return $this->get_datetime( 'REG_date', $date_format, $time_format );
+	public function pretty_date($date_format = NULL, $time_format = NULL) {
+		return $this->get_datetime('REG_date', $date_format, $time_format);
 	}
 
 
@@ -788,7 +788,7 @@ 
 	 * @return    float
 	 */
 	public function final_price() {
-		return $this->get( 'REG_final_price' );
+		return $this->get('REG_final_price');
 	}
 
 
@@ -799,7 +799,7 @@ 
 	 * @return string
 	 */
 	public function pretty_final_price() {
-		return $this->get_pretty( 'REG_final_price' );
+		return $this->get_pretty('REG_final_price');
 	}
 
 
@@ -809,7 +809,7 @@ 
 	 * @return 	float
 	 */
 	public function paid() {
-		return $this->get( 'REG_paid' );
+		return $this->get('REG_paid');
 	}
 
 
@@ -819,7 +819,7 @@ 
 	 * @return 	float
 	 */
 	public function pretty_paid() {
-		return $this->get_pretty( 'REG_paid' );
+		return $this->get_pretty('REG_paid');
 	}
 
 
@@ -830,11 +830,11 @@ 
 	 * @param array $requires_payment
 	 * @return bool
 	 */
-	public function owes_monies_and_can_pay( $requires_payment = array()) {
+	public function owes_monies_and_can_pay($requires_payment = array()) {
 		// these reg statuses require payment (if event is not free)
-		$requires_payment = ! empty( $requires_payment ) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
+		$requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
 		if (
-			in_array( $this->status_ID(), $requires_payment ) &&
+			in_array($this->status_ID(), $requires_payment) &&
 			$this->final_price() != 0 &&
 			$this->final_price() != $this->paid()
 		) {
@@ -851,8 +851,8 @@ 
 	 * @param bool $show_icons
 	 * @return void
 	 */
-	public function e_pretty_status( $show_icons = FALSE ) {
-		echo $this->pretty_status( $show_icons );
+	public function e_pretty_status($show_icons = FALSE) {
+		echo $this->pretty_status($show_icons);
 	}
 
 
@@ -863,10 +863,10 @@ 
 	 * @param bool $show_icons
 	 * @return string
 	 */
-	public function pretty_status( $show_icons = FALSE ) {
-		$status = EEM_Status::instance()->localized_status( array( $this->status_ID() => __( 'unknown', 'event_espresso' ) ), FALSE, 'sentence' );
+	public function pretty_status($show_icons = FALSE) {
+		$status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')), FALSE, 'sentence');
 		$icon = '';
-		switch ( $this->status_ID() ) {
+		switch ($this->status_ID()) {
 			case EEM_Registration::status_id_approved:
 				$icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : '';
 				break;
@@ -889,7 +889,7 @@ 
 				$icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : '';
 				break;
 		}
-		return $icon . $status[ $this->status_ID() ];
+		return $icon.$status[$this->status_ID()];
 	}
 
 
@@ -898,7 +898,7 @@ 
 	 *        get Attendee Is Going
 	 */
 	public function att_is_going() {
-		return $this->get( 'REG_att_is_going' );
+		return $this->get('REG_att_is_going');
 	}
 
 
@@ -908,8 +908,8 @@ 
 	 * @param array $query_params like EEM_Base::get_all
 	 * @return EE_Answer[]
 	 */
-	public function answers( $query_params = NULL ) {
-		return $this->get_many_related( 'Answer', $query_params );
+	public function answers($query_params = NULL) {
+		return $this->get_many_related('Answer', $query_params);
 	}
 
 
@@ -923,9 +923,9 @@ 
 	 * (because the answer might be an array of answer values, so passing pretty_value=true
 	 * will convert it into some kind of string)
 	 */
-	public function answer_value_to_question( $question, $pretty_value=true ) {
+	public function answer_value_to_question($question, $pretty_value = true) {
 		$question_id = EEM_Question::instance()->ensure_is_ID($question);
-		return EEM_Answer::instance()->get_answer_value_to_question($this,$question_id,$pretty_value);
+		return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
 	}
 
 
@@ -938,13 +938,13 @@ 
 	 */
 	public function question_groups() {
 		$question_groups = array();
-		if ( $this->event() instanceof EE_Event ) {
+		if ($this->event() instanceof EE_Event) {
 			$question_groups = $this->event()->question_groups(
 				array(
 					array(
 						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false
 					),
-					'order_by' => array( 'QSG_order' => 'ASC' )
+					'order_by' => array('QSG_order' => 'ASC')
 				)
 			);
 		}
@@ -961,7 +961,7 @@ 
 	 */
 	public function count_question_groups() {
 		$qg_count = 0;
-		if ( $this->event() instanceof EE_Event ) {
+		if ($this->event() instanceof EE_Event) {
 			$qg_count = $this->event()->count_related(
 				'Question_Group',
 				array(
@@ -982,7 +982,7 @@ 
 	 * @return string
 	 */
 	public function reg_date() {
-		return $this->get_datetime( 'REG_date' );
+		return $this->get_datetime('REG_date');
 	}
 
 
@@ -994,7 +994,7 @@ 
 	 * @return EE_Datetime_Ticket
 	 */
 	public function datetime_ticket() {
-		return $this->get_first_related( 'Datetime_Ticket' );
+		return $this->get_first_related('Datetime_Ticket');
 	}
 
 
@@ -1004,15 +1004,15 @@ 
 	 * @param EE_Datetime_Ticket $datetime_ticket
 	 * @return EE_Datetime_Ticket
 	 */
-	public function set_datetime_ticket( $datetime_ticket ) {
-		return $this->_add_relation_to( $datetime_ticket, 'Datetime_Ticket' );
+	public function set_datetime_ticket($datetime_ticket) {
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
 	}
 	/**
 	 * Gets deleted
 	 * @return boolean
 	 */
 	public function deleted() {
-		return $this->get( 'REG_deleted' );
+		return $this->get('REG_deleted');
 	}
 
 	/**
@@ -1021,7 +1021,7 @@ 
 	 * @return boolean
 	 */
 	public function set_deleted($deleted) {
-	    if ( $deleted ) {
+	    if ($deleted) {
 	        $this->delete();
         } else {
 	        $this->restore();
@@ -1035,7 +1035,7 @@ 
 	 * @return EE_Status
 	 */
 	public function status_obj() {
-		return $this->get_first_related( 'Status' );
+		return $this->get_first_related('Status');
 	}
 
 
@@ -1046,7 +1046,7 @@ 
 	 * @return int
 	 */
 	public function count_checkins() {
-		return $this->get_model()->count_related( $this, 'Checkin' );
+		return $this->get_model()->count_related($this, 'Checkin');
 	}
 
 
@@ -1056,7 +1056,7 @@ 
 	 * @return int
 	 */
 	public function count_checkins_not_checkedout() {
-		return $this->get_model()->count_related( $this, 'Checkin', array( array( 'CHK_in' => 1 ) ) );
+		return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
 	}
 
 
@@ -1069,20 +1069,20 @@ 
 	 *
 	 * @return bool
 	 */
-	public function can_checkin( $DTT_OR_ID, $check_approved = TRUE ) {
-		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID( $DTT_OR_ID );
+	public function can_checkin($DTT_OR_ID, $check_approved = TRUE) {
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
 		//first check registration status
-		if (  ( $check_approved && ! $this->is_approved() ) || ! $DTT_ID ) {
+		if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
 			return false;
 		}
 		//is there a datetime ticket that matches this dtt_ID?
-		if ( ! ( EEM_Datetime_Ticket::instance()->exists( array( array( 'TKT_ID' => $this->get('TKT_ID' ), 'DTT_ID' => $DTT_ID ) ) ) ) ) {
+		if ( ! (EEM_Datetime_Ticket::instance()->exists(array(array('TKT_ID' => $this->get('TKT_ID'), 'DTT_ID' => $DTT_ID))))) {
 			return false;
 		}
 
 		//final check is against TKT_uses
-		return $this->verify_can_checkin_against_TKT_uses( $DTT_ID );
+		return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
 	}
 
 
@@ -1095,10 +1095,10 @@ 
 	 * @param int | EE_Datetime  $DTT_OR_ID  The datetime the registration is being checked against
 	 * @return bool   true means can checkin.  false means cannot checkin.
 	 */
-	public function verify_can_checkin_against_TKT_uses( $DTT_OR_ID ) {
-		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID( $DTT_OR_ID );
+	public function verify_can_checkin_against_TKT_uses($DTT_OR_ID) {
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
-		if ( ! $DTT_ID ) {
+		if ( ! $DTT_ID) {
 			return false;
 		}
 
@@ -1106,23 +1106,23 @@ 
 
 		// if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in
 		// or not.
-		if ( ! $max_uses || $max_uses === EE_INF ) {
+		if ( ! $max_uses || $max_uses === EE_INF) {
 			return true;
 		}
 
 		//does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
 		//go ahead and toggle.
-		if ( EEM_Checkin::instance()->exists( array( array( 'REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID ) ) ) ) {
+		if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
 			return true;
 		}
 
 		//made it here so the last check is whether the number of checkins per unique datetime on this registration
 		//disallows further check-ins.
-		$count_unique_dtt_checkins = EEM_Checkin::instance()->count( array( array( 'REG_ID' => $this->ID(), 'CHK_in' => true ) ), 'DTT_ID', true );
+		$count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(array('REG_ID' => $this->ID(), 'CHK_in' => true)), 'DTT_ID', true);
 		// checkins have already reached their max number of uses
 		// so registrant can NOT checkin
-		if ( $count_unique_dtt_checkins >= $max_uses ) {
-			EE_Error::add_error( __( 'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ($count_unique_dtt_checkins >= $max_uses) {
+			EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		return true;
@@ -1144,15 +1144,15 @@ 
      * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
      * @throws EE_Error
      */
-	public function toggle_checkin_status( $DTT_ID = null, $verify = false ) {
-		if ( empty( $DTT_ID ) ) {
+	public function toggle_checkin_status($DTT_ID = null, $verify = false) {
+		if (empty($DTT_ID)) {
 			$datetime = $this->get_latest_related_datetime();
 			$DTT_ID = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
 		// verify the registration can checkin for the given DTT_ID
-		} elseif ( ! $this->can_checkin( $DTT_ID, $verify ) ) {
+		} elseif ( ! $this->can_checkin($DTT_ID, $verify)) {
 			EE_Error::add_error(
 					sprintf(
-						__( 'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access', 'event_espresso'),
+						__('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access', 'event_espresso'),
 						$this->ID(),
 						$DTT_ID
 					),
@@ -1166,8 +1166,8 @@ 
 			EE_Registration::checkin_status_out => EE_Registration::checkin_status_in
 		);
 		//start by getting the current status so we know what status we'll be changing to.
-		$cur_status = $this->check_in_status_for_datetime( $DTT_ID, NULL );
-		$status_to = $status_paths[ $cur_status ];
+		$cur_status = $this->check_in_status_for_datetime($DTT_ID, NULL);
+		$status_to = $status_paths[$cur_status];
 		// database only records true for checked IN or false for checked OUT
 		// no record ( null ) means checked in NEVER, but we obviously don't save that
 		$new_status = $status_to === EE_Registration::checkin_status_in ? true : false;
@@ -1175,24 +1175,24 @@ 
 		// because we are keeping track of Check-ins over time.
 		// Eventually we'll probably want to show a list table
 		// for the individual Check-ins so that they can be managed.
-		$checkin = EE_Checkin::new_instance( array(
+		$checkin = EE_Checkin::new_instance(array(
 				'REG_ID' => $this->ID(),
 				'DTT_ID' => $DTT_ID,
 				'CHK_in' => $new_status
-		) );
+		));
 		// if the record could not be saved then return false
-		if ( $checkin->save() === 0 ) {
-			if ( WP_DEBUG ) {
+		if ($checkin->save() === 0) {
+			if (WP_DEBUG) {
 				global $wpdb;
 				$error = sprintf(
-					__( 'Registration check in update failed because of the following database error: %1$s%2$s', 'event_espresso' ),
+					__('Registration check in update failed because of the following database error: %1$s%2$s', 'event_espresso'),
 					'<br />',
 					$wpdb->last_error
 				);
 			} else {
-				$error = __( 'Registration check in update failed because of an unknown database error', 'event_espresso' );
+				$error = __('Registration check in update failed because of an unknown database error', 'event_espresso');
 			}
-			EE_Error::add_error( $error, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		return $status_to;
@@ -1213,7 +1213,7 @@ 
 				array(
 					'Ticket.Registration.REG_ID' => $this->ID()
 				),
-				'order_by' => array( 'DTT_EVT_start' => 'DESC' )
+				'order_by' => array('DTT_EVT_start' => 'DESC')
 			)
 		);
 	}
@@ -1232,7 +1232,7 @@ 
 				array(
 					'Ticket.Registration.REG_ID' => $this->ID()
 				),
-				'order_by' => array( 'DTT_EVT_start' => 'ASC' )
+				'order_by' => array('DTT_EVT_start' => 'ASC')
 			)
 		);
 	}
@@ -1251,21 +1251,21 @@ 
      * @return int                Integer representing Check-in status.
      * @throws \EE_Error
      */
-	public function check_in_status_for_datetime( $DTT_ID = 0, $checkin = null ) {
+	public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null) {
 		$checkin_query_params = array(
-			'order_by' => array( 'CHK_timestamp' => 'DESC' )
+			'order_by' => array('CHK_timestamp' => 'DESC')
 		);
 
-		if ( $DTT_ID > 0 ) {
-			$checkin_query_params[0] = array( 'DTT_ID' => $DTT_ID );
+		if ($DTT_ID > 0) {
+			$checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
 		}
 
 		//get checkin object (if exists)
 		$checkin = $checkin instanceof EE_Checkin
             ? $checkin
-            : $this->get_first_related( 'Checkin', $checkin_query_params );
-		if ( $checkin instanceof EE_Checkin ) {
-			if ( $checkin->get( 'CHK_in' ) ) {
+            : $this->get_first_related('Checkin', $checkin_query_params);
+		if ($checkin instanceof EE_Checkin) {
+			if ($checkin->get('CHK_in')) {
 				return EE_Registration::checkin_status_in; //checked in
 			}
 			return EE_Registration::checkin_status_out; //had checked in but is now checked out.
@@ -1281,28 +1281,28 @@ 
 	 * @param bool $error  This just flags that you want an error message returned. This is put in so that the error message can be customized with the attendee name.
 	 * @return string         internationalized message
 	 */
-	public function get_checkin_msg( $DTT_ID, $error = FALSE ) {
+	public function get_checkin_msg($DTT_ID, $error = FALSE) {
 		//let's get the attendee first so we can include the name of the attendee
-		$attendee = $this->get_first_related( 'Attendee' );
-		if ( $attendee instanceof EE_Attendee ) {
-			if ( $error ) {
-				return sprintf( __( "%s's check-in status was not changed.", "event_espresso" ), $attendee->full_name() );
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			if ($error) {
+				return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
 			}
-			$cur_status = $this->check_in_status_for_datetime( $DTT_ID );
+			$cur_status = $this->check_in_status_for_datetime($DTT_ID);
 			//what is the status message going to be?
-			switch ( $cur_status ) {
+			switch ($cur_status) {
 				case EE_Registration::checkin_status_never :
-					return sprintf( __( "%s has been removed from Check-in records", "event_espresso" ), $attendee->full_name() );
+					return sprintf(__("%s has been removed from Check-in records", "event_espresso"), $attendee->full_name());
 					break;
 				case EE_Registration::checkin_status_in :
-					return sprintf( __( '%s has been checked in', 'event_espresso' ), $attendee->full_name() );
+					return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
 					break;
 				case EE_Registration::checkin_status_out :
-					return sprintf( __( '%s has been checked out', 'event_espresso' ), $attendee->full_name() );
+					return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
 					break;
 			}
 		}
-		return __( "The check-in status could not be determined.", "event_espresso" );
+		return __("The check-in status could not be determined.", "event_espresso");
 	}
 
 
@@ -1326,7 +1326,7 @@ 
 	 *        get Registration Code
 	 */
 	public function reg_code() {
-		return $this->get( 'REG_code' );
+		return $this->get('REG_code');
 	}
 
 
@@ -1335,7 +1335,7 @@ 
 	 *        get Transaction ID
 	 */
 	public function transaction_ID() {
-		return $this->get( 'TXN_ID' );
+		return $this->get('TXN_ID');
 	}
 
 
@@ -1344,7 +1344,7 @@ 
 	 * @return int
 	 */
 	public function ticket_ID() {
-		return $this->get( 'TKT_ID' );
+		return $this->get('TKT_ID');
 	}
 
 
@@ -1356,17 +1356,17 @@ 
 	 * @param    string $REG_code Registration Code
 	 * @param	boolean $use_default
 	 */
-	public function set_reg_code( $REG_code, $use_default = FALSE ) {
-		if ( empty( $REG_code )) {
-			EE_Error::add_error( __( 'REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__ );
+	public function set_reg_code($REG_code, $use_default = FALSE) {
+		if (empty($REG_code)) {
+			EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return;
 		}
-		if ( ! $this->reg_code() ) {
-			parent::set( 'REG_code', $REG_code, $use_default );
+		if ( ! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
 		} else {
 			EE_Error::doing_it_wrong(
-				__CLASS__ . '::' . __FUNCTION__,
-				__( 'Can not change a registration REG_code once it has been set.', 'event_espresso' ),
+				__CLASS__.'::'.__FUNCTION__,
+				__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
 				'4.6.0'
 			);
 		}
@@ -1386,17 +1386,17 @@ 
 	 * @return EE_Registration[]  or empty array if this isn't a group registration.
 	 */
 	public function get_all_other_registrations_in_group() {
-		if ( $this->group_size() < 2 ) {
+		if ($this->group_size() < 2) {
 			return array();
 		}
 
 		$query[0] = array(
 			'TXN_ID' => $this->transaction_ID(),
-			'REG_ID' => array( '!=', $this->ID() ),
+			'REG_ID' => array('!=', $this->ID()),
 			'TKT_ID' => $this->ticket_ID()
 			);
 
-		$registrations = $this->get_model()->get_all( $query );
+		$registrations = $this->get_model()->get_all($query);
 		return $registrations;
 	}
 
@@ -1405,14 +1405,14 @@ 
 	 * @return string
 	 */
 	public function get_admin_details_link() {
-		EE_Registry::instance()->load_helper( 'URL' );
+		EE_Registry::instance()->load_helper('URL');
 		return EEH_URL::add_query_args_and_nonce(
 			array(
 				'page' => 'espresso_registrations',
 				'action' => 'view_registration',
 				'_REG_ID' => $this->ID()
 			),
-			admin_url( 'admin.php' )
+			admin_url('admin.php')
 		);
 	}
 
@@ -1437,12 +1437,12 @@ 
 	 * @return string
 	 */
 	public function get_admin_overview_link() {
-		EE_Registry::instance()->load_helper( 'URL' );
+		EE_Registry::instance()->load_helper('URL');
 		return EEH_URL::add_query_args_and_nonce(
 			array(
 				'page' => 'espresso_registrations'
 			),
-			admin_url( 'admin.php' )
+			admin_url('admin.php')
 		);
 	}
 
@@ -1453,8 +1453,8 @@ 
 	 * @return \EE_Registration[]
 	 * @throws \EE_Error
 	 */
-	public function payments( $query_params = array() ) {
-		return $this->get_many_related( 'Payment', $query_params );
+	public function payments($query_params = array()) {
+		return $this->get_many_related('Payment', $query_params);
 	}
 
 
@@ -1464,8 +1464,8 @@ 
 	 * @return \EE_Registration_Payment[]
 	 * @throws \EE_Error
 	 */
-	public function registration_payments( $query_params = array() ) {
-		return $this->get_many_related( 'Registration_Payment', $query_params );
+	public function registration_payments($query_params = array()) {
+		return $this->get_many_related('Registration_Payment', $query_params);
 	}
 
 
@@ -1478,7 +1478,7 @@ 
 	 * @return EE_Payment_Method|null
 	 */
 	public function payment_method() {
-		return EEM_Payment_Method::instance()->get_last_used_for_registration( $this );
+		return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
 	}
 
 
@@ -1525,7 +1525,7 @@ 
      */
     public function delete()
     {
-        if($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+        if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
             $this->set_status(EEM_Registration::status_id_cancelled);
         }
         return parent::delete();

admin_pages/payments/Payments_Admin_Page.core.php

Doc Comments +4 added lines, -4 removed lines

@@ -470,7 +470,7 @@ 
      *
      * @access protected
      * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
+     * @return EE_Form_Section_HTML
      */
     protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
     {
@@ -506,7 +506,7 @@ 
      *
      * @access protected
      * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
+     * @return EE_Form_Section_HTML
      */
     protected function _currency_support(EE_Payment_Method $payment_method)
     {
@@ -541,7 +541,7 @@ 
      *
      * @access protected
      * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_HTML
+     * @return EE_Payment_Method_Form
      */
     protected function _payment_method_settings(EE_Payment_Method $payment_method)
     {
@@ -615,7 +615,7 @@ 
      *
      * @access protected
      * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
+     * @return EE_Form_Section_HTML
      */
     protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
     {

Indentation +999 added lines, -999 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -27,838 +27,838 @@ 
 class Payments_Admin_Page extends EE_Admin_Page
 {
 
-    /**
-     * Variables used for when we're re-sorting the logs results, in case
-     * we needed to do two queries and we need to resort
-     *
-     * @var string
-     */
-    private $_sort_logs_again_direction;
-
-
-
-    /**
-     * @Constructor
-     * @access public
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @return \Payments_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_PAYMENTS_PG_SLUG;
-        $this->page_label = __('Payment Methods', 'event_espresso');
-        $this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
-        $this->_admin_base_path = EE_PAYMENTS_ADMIN;
-    }
-
-
-
-    protected function _ajax_hooks()
-    {
-        //todo: all hooks for ajax goes here.
-    }
-
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels = array(
-            'publishbox' => __('Update Settings', 'event_espresso'),
-        );
-    }
-
-
-
-    protected function _set_page_routes()
-    {
-        /**
-         * note that with payment method capabilities, although we've implemented
-         * capability mapping which will be used for accessing payment methods owned by
-         * other users.  This is not fully implemented yet in the payment method ui.
-         * Currently only the "plural" caps are in active use.
-         * When cap mapping is implemented, some routes will need to use the singular form of
-         * capability method and also include the $id of the payment method for the route.
-         **/
-        $this->_page_routes = array(
-            'default'                   => array(
-                'func'       => '_payment_methods_list',
-                'capability' => 'ee_edit_payment_methods',
-            ),
-            'payment_settings'          => array(
-                'func'       => '_payment_settings',
-                'capability' => 'ee_manage_gateways',
-            ),
-            'activate_payment_method'   => array(
-                'func'       => '_activate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payment_methods',
-            ),
-            'deactivate_payment_method' => array(
-                'func'       => '_deactivate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_delete_payment_methods',
-            ),
-            'update_payment_method'     => array(
-                'func'               => '_update_payment_method',
-                'noheader'           => true,
-                'headers_sent_route' => 'default',
-                'capability'         => 'ee_edit_payment_methods',
-            ),
-            'update_payment_settings'   => array(
-                'func'       => '_update_payment_settings',
-                'noheader'   => true,
-                'capability' => 'ee_manage_gateways',
-            ),
-            'payment_log'               => array(
-                'func'       => '_payment_log_overview_list_table',
-                'capability' => 'ee_read_payment_methods',
-            ),
-            'payment_log_details'       => array(
-                'func'       => '_payment_log_details',
-                'capability' => 'ee_read_payment_methods',
-            ),
-        );
-    }
-
-
-
-    protected function _set_page_config()
-    {
-        $payment_method_list_config = array(
-            'nav'           => array(
-                'label' => __('Payment Methods', 'event_espresso'),
-                'order' => 10,
-            ),
-            'metaboxes'     => $this->_default_espresso_metaboxes,
-            'help_tabs'     => array_merge(
-                array(
-                    'payment_methods_overview_help_tab' => array(
-                        'title'    => __('Payment Methods Overview', 'event_espresso'),
-                        'filename' => 'payment_methods_overview',
-                    ),
-                ),
-                $this->_add_payment_method_help_tabs()),
-            'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
-            'require_nonce' => false,
-        );
-        $this->_page_config = array(
-            'default'          => $payment_method_list_config,
-            'payment_settings' => array(
-                'nav'           => array(
-                    'label' => __('Settings', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'help_tabs'     => array(
-                    'payment_methods_settings_help_tab' => array(
-                        'title'    => __('Payment Method Settings', 'event_espresso'),
-                        'filename' => 'payment_methods_settings',
-                    ),
-                ),
-                //'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'require_nonce' => false,
-            ),
-            'payment_log'      => array(
-                'nav'           => array(
-                    'label' => __("Logs", 'event_espresso'),
-                    'order' => 30,
-                ),
-                'list_table'    => 'Payment_Log_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-
-    /**
-     * @return array
-     */
-    protected function _add_payment_method_help_tabs()
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
-        $all_pmt_help_tabs_config = array();
-        foreach ($payment_method_types as $payment_method_type) {
-            if (! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(),
-                'specific_payment_method_type_access')
-            ) {
-                continue;
-            }
-            foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
-                $template_args = isset($config['template_args']) ? $config['template_args'] : array();
-                $template_args['admin_page_obj'] = $this;
-                $all_pmt_help_tabs_config[$help_tab_name] = array(
-                    'title'   => $config['title'],
-                    'content' => EEH_Template::display_template(
-                        $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
-                        $template_args,
-                        true),
-                );
-            }
-        }
-        return $all_pmt_help_tabs_config;
-    }
-
-
-
-    //none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-
-    public function admin_init()
-    {
-    }
-
-
-
-    public function admin_notices()
-    {
-    }
-
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-
-    public function load_scripts_styles()
-    {
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee-text-links');
-        wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
-            array('espresso-ui-theme', 'ee-datepicker'), EVENT_ESPRESSO_VERSION, true);
-    }
-
-
-
-    public function load_scripts_styles_default()
-    {
-        //styles
-        wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'ee-payments.css', array(),
-            EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_payments');
-        wp_enqueue_style('ee-text-links');
-        //scripts
-    }
-
-
-
-    protected function _payment_methods_list()
-    {
-        /**
-         * first let's ensure payment methods have been setup. We do this here because when people activate a
-         * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due
-         * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
-         * recheck here.
-         */
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        EEM_Payment_Method::instance()->verify_button_urls();
-        //setup tabs, one for each payment method type
-        $tabs = array();
-        $payment_methods = array();
-        foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
-            // we don't want to show admin-only PMTs for now
-            if ($pmt_obj instanceof EE_PMT_Admin_Only) {
-                continue;
-            }
-            //check access
-            if (! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(),
-                'specific_payment_method_type_access')
-            ) {
-                continue;
-            }
-            //check for any active pms of that type
-            $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
-            if (! $payment_method instanceof EE_Payment_Method) {
-                $payment_method = EE_Payment_Method::new_instance(
-                    array(
-                        'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
-                        'PMD_type'       => $pmt_obj->system_name(),
-                        'PMD_name'       => $pmt_obj->pretty_name(),
-                        'PMD_admin_name' => $pmt_obj->pretty_name(),
-                    )
-                );
-            }
-            $payment_methods[$payment_method->slug()] = $payment_method;
-        }
-        $payment_methods = apply_filters('FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
-            $payment_methods);
-        foreach ($payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                add_meta_box(
-                //html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
-                    //title
-                    sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
-                    //callback
-                    array($this, 'payment_method_settings_meta_box'),
-                    //post type
-                    null,
-                    //context
-                    'normal',
-                    //priority
-                    'default',
-                    //callback args
-                    array('payment_method' => $payment_method)
-                );
-                //setup for tabbed content
-                $tabs[$payment_method->slug()] = array(
-                    'label' => $payment_method->admin_name(),
-                    'class' => $payment_method->active() ? 'gateway-active' : '',
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
-                    'title' => __('Modify this Payment Method', 'event_espresso'),
-                    'slug'  => $payment_method->slug(),
-                );
-            }
-        }
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links($tabs, 'payment_method_links',
-            '|', $this->_get_active_payment_method_slug());
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     *   _get_active_payment_method_slug
-     *
-     * @return string
-     */
-    protected function _get_active_payment_method_slug()
-    {
-        $payment_method_slug = false;
-        //decide which payment method tab to open first, as dictated by the request's 'payment_method'
-        if (isset($this->_req_data['payment_method'])) {
-            // if they provided the current payment method, use it
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-        }
-        $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
-        // if that didn't work or wasn't provided, find another way to select the current pm
-        if (! $this->_verify_payment_method($payment_method)) {
-            // like, looking for an active one
-            $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
-            // test that one as well
-            if ($this->_verify_payment_method($payment_method)) {
-                $payment_method_slug = $payment_method->slug();
-            } else {
-                $payment_method_slug = 'paypal_standard';
-            }
-        }
-        return $payment_method_slug;
-    }
-
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
-     *    capabilities to access it
-     *
-     * @param \EE_Payment_Method $payment_method
-     * @return boolean
-     */
-    protected function _verify_payment_method($payment_method)
-    {
-        if (
-            $payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
-            && EE_Registry::instance()->CAP->current_user_can($payment_method->type_obj()->cap_name(),
-                'specific_payment_method_type_access')
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *
-     * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
-     * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
-     *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
-    {
-        $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
-            ? $metabox['args']['payment_method'] : null;
-        if (! $payment_method instanceof EE_Payment_Method) {
-            throw new EE_Error(sprintf(__('Payment method metabox setup incorrectly. No Payment method object was supplied',
-                'event_espresso')));
-        }
-        $payment_method_scopes = $payment_method->active();
-        // if the payment method really exists show its form, otherwise the activation template
-        if ($payment_method->ID() && ! empty($payment_method_scopes)) {
-            $form = $this->_generate_payment_method_settings_form($payment_method);
-            if ($form->form_data_present_in($this->_req_data)) {
-                $form->receive_form_submission($this->_req_data);
-            }
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
-        } else {
-            echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
-        }
-    }
-
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
-    {
-        if (! $payment_method instanceof EE_Payment_Method) {
-            return new EE_Form_Section_Proper();
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
-                'action'          => EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action'         => 'update_payment_method',
-                        'payment_method' => $payment_method->slug(),
-                    ),
-                    EE_PAYMENTS_ADMIN_URL
-                ),
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
-                    array(
-                        'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
-                        'currency_support'        => $this->_currency_support($payment_method),
-                        'payment_method_settings' => $this->_payment_method_settings($payment_method),
-                        'update'                  => $this->_update_payment_method_button($payment_method),
-                        'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
-                        'fine_print'              => $this->_fine_print(),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * _pci_dss_compliance
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
-    {
-        if ($payment_method->type_obj()->requires_https()) {
-            return new EE_Form_Section_HTML(
-                EEH_HTML::tr(
-                    EEH_HTML::th(
-                        EEH_HTML::label(
-                            EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
-                        )
-                    ) .
-                    EEH_HTML::td(
-                        EEH_HTML::strong(__('You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
-                            'event_espresso'))
-                        .
-                        EEH_HTML::br()
-                        .
-                        __('Learn more about ', 'event_espresso')
-                        . EEH_HTML::link('https://www.pcisecuritystandards.org/merchants/index.php',
-                            __('PCI DSS compliance', 'event_espresso'))
-                    )
-                )
-            );
-        } else {
-            return new EE_Form_Section_HTML('');
-        }
-    }
-
-
-
-    /**
-     * _currency_support
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _currency_support(EE_Payment_Method $payment_method)
-    {
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
-            return new EE_Form_Section_HTML(
-                EEH_HTML::tr(
-                    EEH_HTML::th(
-                        EEH_HTML::label(
-                            EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
-                        )
-                    ) .
-                    EEH_HTML::td(
-                        EEH_HTML::strong(
-                            sprintf(
-                                __('This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
-                                    'event_espresso'),
-                                EE_Config::instance()->currency->code
-                            )
-                        )
-                    )
-                )
-            );
-        } else {
-            return new EE_Form_Section_HTML('');
-        }
-    }
-
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _payment_method_settings(EE_Payment_Method $payment_method)
-    {
-        //modify the form so we only have/show fields that will be implemented for this version
-        return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
-    }
-
-
-
-    /**
-     * Simplifies the form to merely reproduce 4.1's gateway settings functionality
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @param string                 $payment_method_name
-     * @return \EE_Payment_Method_Form
-     * @throws \EE_Error
-     */
-    protected function _simplify_form($form_section, $payment_method_name = '')
-    {
-        if ($form_section instanceof EE_Payment_Method_Form) {
-            $form_section->exclude(
-                array(
-                    'PMD_type', //dont want them changing the type
-                    'PMD_slug', //or the slug (probably never)
-                    'PMD_wp_user', //or the user's ID
-                    'Currency' //or the currency, until the rest of EE supports simultaneous currencies
-                )
-            );
-            return $form_section;
-        } else {
-            throw new EE_Error(sprintf(__('The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
-                'event_espresso'), $payment_method_name));
-        }
-    }
-
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _update_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $update_button = new EE_Submit_Input(
-            array(
-                'name'       => 'submit',
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
-                'default'    => sprintf(__('Update %s Payment Settings', 'event_espresso'),
-                    $payment_method->admin_name()),
-                'html_label' => EEH_HTML::nbsp(),
-            )
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::no_row(EEH_HTML::br(2)) .
-            EEH_HTML::tr(
-                EEH_HTML::th(__('Update Settings', 'event_espresso')) .
-                EEH_HTML::td(
-                    $update_button->get_html_for_input()
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * _deactivate_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(__('Deactivate %1$s Payments?', 'event_espresso'),
-            $payment_method->admin_name());
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
-                EEH_HTML::td(
-                    EEH_HTML::link(
-                        EE_Admin_Page::add_query_args_and_nonce(
-                            array(
-                                'action'         => 'deactivate_payment_method',
-                                'payment_method' => $payment_method->slug(),
-                            ),
-                            EE_PAYMENTS_ADMIN_URL
-                        ),
-                        $link_text_and_title,
-                        $link_text_and_title,
-                        'deactivate_' . $payment_method->slug(),
-                        'espresso-button button-secondary'
-                    )
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * _activate_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(__('Activate %1$s Payment Method?', 'event_espresso'),
-            $payment_method->admin_name());
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
-                'action'          => '#',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
-                    array(
-                        new EE_Form_Section_HTML(
-                            EEH_HTML::tr(
-                                EEH_HTML::td($payment_method->type_obj()->introductory_html(),
-                                    '',
-                                    '',
-                                    '',
-                                    'colspan="2"'
-                                )
-                            ) .
-                            EEH_HTML::tr(
-                                EEH_HTML::th(
-                                    EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
-                                ) .
-                                EEH_HTML::td(
-                                    EEH_HTML::link(
-                                        EE_Admin_Page::add_query_args_and_nonce(
-                                            array(
-                                                'action'              => 'activate_payment_method',
-                                                'payment_method_type' => $payment_method->type(),
-                                            ),
-                                            EE_PAYMENTS_ADMIN_URL
-                                        ),
-                                        $link_text_and_title,
-                                        $link_text_and_title,
-                                        'activate_' . $payment_method->slug(),
-                                        'espresso-button-green button-primary'
-                                    )
-                                )
-                            )
-                        ),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * _fine_print
-     *
-     * @access protected
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _fine_print()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th() .
-                EEH_HTML::td(
-                    EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
-     *
-     * @global WP_User $current_user
-     */
-    protected function _activate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method_type'])) {
-            $payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
-            //see if one exists
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $payment_method = EE_Payment_Method_Manager::instance()
-                                                       ->activate_a_payment_method_of_type($payment_method_type);
-            $this->_redirect_after_action(1, 'Payment Method', 'activated',
-                array('action' => 'default', 'payment_method' => $payment_method->slug()));
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
-        }
-    }
-
-
-
-    /**
-     * Deactivates the payment method with the specified slug, and redirects.
-     */
-    protected function _deactivate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method'])) {
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-            //deactivate it
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
-            $this->_redirect_after_action($count_updated, 'Payment Method', 'deactivated',
-                array('action' => 'default', 'payment_method' => $payment_method_slug));
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
-        }
-    }
-
-
-
-    /**
-     * Processes the payment method form that was submitted. This is slightly trickier than usual form
-     * processing because we first need to identify WHICH form was processed and which payment method
-     * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
-     * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
-     * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
-     * subsequently called 'headers_sent_func' which is _payment_methods_list)
-     *
-     * @return void
-     */
-    protected function _update_payment_method()
-    {
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            //ok let's find which gateway form to use based on the form input
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            /** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
-            $correct_pmt_form_to_use = null;
-            $payment_method = null;
-            foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
-                //get the form and simplify it, like what we do when we display it
-                $pmt_form = $this->_generate_payment_method_settings_form($payment_method);
-                if ($pmt_form->form_data_present_in($this->_req_data)) {
-                    $correct_pmt_form_to_use = $pmt_form;
-                    break;
-                }
-            }
-            //if we couldn't find the correct payment method type...
-            if (! $correct_pmt_form_to_use) {
-                EE_Error::add_error(__("We could not find which payment method type your form submission related to. Please contact support",
-                    'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-                $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
-            }
-            $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
-            if ($correct_pmt_form_to_use->is_valid()) {
-                $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
-                    throw new EE_Error(
-                        sprintf(
-                            __('The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
-                                'event_espresso'),
-                            'payment_method_settings'
-                        )
-                    );
-                }
-                $payment_settings_subform->save();
-                /** @var $pm EE_Payment_Method */
-                $this->_redirect_after_action(true, 'Payment Method', 'updated',
-                    array('action' => 'default', 'payment_method' => $payment_method->slug()));
-            } else {
-                EE_Error::add_error(
-                    sprintf(
-                        __('Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
-                            'event_espresso'),
-                        $payment_method instanceof EE_PMT_Base ? $payment_method->pretty_name()
-                            : __('"(unknown)"', 'event_espresso')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return;
-    }
-
-
-
-    protected function _payment_settings()
-    {
-        $this->_template_args['values'] = $this->_yes_no_values;
-        $this->_template_args['show_pending_payment_options'] = isset(EE_Registry::instance()->CFG->registration->show_pending_payment_options)
-            ? absint(EE_Registry::instance()->CFG->registration->show_pending_payment_options) : false;
-        $this->_set_add_edit_form_tags('update_payment_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(EE_PAYMENTS_TEMPLATE_PATH
-                                                                                     . 'payment_settings.template.php',
-            $this->_template_args, true);
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     *        _update_payment_settings
-     *
-     * @access protected
-     * @return array
-     */
-    protected function _update_payment_settings()
-    {
-        EE_Registry::instance()->CFG->registration->show_pending_payment_options = isset($this->_req_data['show_pending_payment_options'])
-            ? $this->_req_data['show_pending_payment_options'] : false;
-        EE_Registry::instance()->CFG = apply_filters('FHEE__Payments_Admin_Page___update_payment_settings__CFG',
-            EE_Registry::instance()->CFG);
+	/**
+	 * Variables used for when we're re-sorting the logs results, in case
+	 * we needed to do two queries and we need to resort
+	 *
+	 * @var string
+	 */
+	private $_sort_logs_again_direction;
+
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @return \Payments_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_PAYMENTS_PG_SLUG;
+		$this->page_label = __('Payment Methods', 'event_espresso');
+		$this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
+		$this->_admin_base_path = EE_PAYMENTS_ADMIN;
+	}
+
+
+
+	protected function _ajax_hooks()
+	{
+		//todo: all hooks for ajax goes here.
+	}
+
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels = array(
+			'publishbox' => __('Update Settings', 'event_espresso'),
+		);
+	}
+
+
+
+	protected function _set_page_routes()
+	{
+		/**
+		 * note that with payment method capabilities, although we've implemented
+		 * capability mapping which will be used for accessing payment methods owned by
+		 * other users.  This is not fully implemented yet in the payment method ui.
+		 * Currently only the "plural" caps are in active use.
+		 * When cap mapping is implemented, some routes will need to use the singular form of
+		 * capability method and also include the $id of the payment method for the route.
+		 **/
+		$this->_page_routes = array(
+			'default'                   => array(
+				'func'       => '_payment_methods_list',
+				'capability' => 'ee_edit_payment_methods',
+			),
+			'payment_settings'          => array(
+				'func'       => '_payment_settings',
+				'capability' => 'ee_manage_gateways',
+			),
+			'activate_payment_method'   => array(
+				'func'       => '_activate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payment_methods',
+			),
+			'deactivate_payment_method' => array(
+				'func'       => '_deactivate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_delete_payment_methods',
+			),
+			'update_payment_method'     => array(
+				'func'               => '_update_payment_method',
+				'noheader'           => true,
+				'headers_sent_route' => 'default',
+				'capability'         => 'ee_edit_payment_methods',
+			),
+			'update_payment_settings'   => array(
+				'func'       => '_update_payment_settings',
+				'noheader'   => true,
+				'capability' => 'ee_manage_gateways',
+			),
+			'payment_log'               => array(
+				'func'       => '_payment_log_overview_list_table',
+				'capability' => 'ee_read_payment_methods',
+			),
+			'payment_log_details'       => array(
+				'func'       => '_payment_log_details',
+				'capability' => 'ee_read_payment_methods',
+			),
+		);
+	}
+
+
+
+	protected function _set_page_config()
+	{
+		$payment_method_list_config = array(
+			'nav'           => array(
+				'label' => __('Payment Methods', 'event_espresso'),
+				'order' => 10,
+			),
+			'metaboxes'     => $this->_default_espresso_metaboxes,
+			'help_tabs'     => array_merge(
+				array(
+					'payment_methods_overview_help_tab' => array(
+						'title'    => __('Payment Methods Overview', 'event_espresso'),
+						'filename' => 'payment_methods_overview',
+					),
+				),
+				$this->_add_payment_method_help_tabs()),
+			'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
+			'require_nonce' => false,
+		);
+		$this->_page_config = array(
+			'default'          => $payment_method_list_config,
+			'payment_settings' => array(
+				'nav'           => array(
+					'label' => __('Settings', 'event_espresso'),
+					'order' => 20,
+				),
+				'help_tabs'     => array(
+					'payment_methods_settings_help_tab' => array(
+						'title'    => __('Payment Method Settings', 'event_espresso'),
+						'filename' => 'payment_methods_settings',
+					),
+				),
+				//'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'require_nonce' => false,
+			),
+			'payment_log'      => array(
+				'nav'           => array(
+					'label' => __("Logs", 'event_espresso'),
+					'order' => 30,
+				),
+				'list_table'    => 'Payment_Log_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	protected function _add_payment_method_help_tabs()
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
+		$all_pmt_help_tabs_config = array();
+		foreach ($payment_method_types as $payment_method_type) {
+			if (! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(),
+				'specific_payment_method_type_access')
+			) {
+				continue;
+			}
+			foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
+				$template_args = isset($config['template_args']) ? $config['template_args'] : array();
+				$template_args['admin_page_obj'] = $this;
+				$all_pmt_help_tabs_config[$help_tab_name] = array(
+					'title'   => $config['title'],
+					'content' => EEH_Template::display_template(
+						$payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
+						$template_args,
+						true),
+				);
+			}
+		}
+		return $all_pmt_help_tabs_config;
+	}
+
+
+
+	//none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+
+	public function admin_init()
+	{
+	}
+
+
+
+	public function admin_notices()
+	{
+	}
+
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+
+	public function load_scripts_styles()
+	{
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-text-links');
+		wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+			array('espresso-ui-theme', 'ee-datepicker'), EVENT_ESPRESSO_VERSION, true);
+	}
+
+
+
+	public function load_scripts_styles_default()
+	{
+		//styles
+		wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'ee-payments.css', array(),
+			EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_payments');
+		wp_enqueue_style('ee-text-links');
+		//scripts
+	}
+
+
+
+	protected function _payment_methods_list()
+	{
+		/**
+		 * first let's ensure payment methods have been setup. We do this here because when people activate a
+		 * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due
+		 * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
+		 * recheck here.
+		 */
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		EEM_Payment_Method::instance()->verify_button_urls();
+		//setup tabs, one for each payment method type
+		$tabs = array();
+		$payment_methods = array();
+		foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
+			// we don't want to show admin-only PMTs for now
+			if ($pmt_obj instanceof EE_PMT_Admin_Only) {
+				continue;
+			}
+			//check access
+			if (! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(),
+				'specific_payment_method_type_access')
+			) {
+				continue;
+			}
+			//check for any active pms of that type
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
+			if (! $payment_method instanceof EE_Payment_Method) {
+				$payment_method = EE_Payment_Method::new_instance(
+					array(
+						'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
+						'PMD_type'       => $pmt_obj->system_name(),
+						'PMD_name'       => $pmt_obj->pretty_name(),
+						'PMD_admin_name' => $pmt_obj->pretty_name(),
+					)
+				);
+			}
+			$payment_methods[$payment_method->slug()] = $payment_method;
+		}
+		$payment_methods = apply_filters('FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
+			$payment_methods);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				add_meta_box(
+				//html id
+					'espresso_' . $payment_method->slug() . '_payment_settings',
+					//title
+					sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
+					//callback
+					array($this, 'payment_method_settings_meta_box'),
+					//post type
+					null,
+					//context
+					'normal',
+					//priority
+					'default',
+					//callback args
+					array('payment_method' => $payment_method)
+				);
+				//setup for tabbed content
+				$tabs[$payment_method->slug()] = array(
+					'label' => $payment_method->admin_name(),
+					'class' => $payment_method->active() ? 'gateway-active' : '',
+					'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
+					'title' => __('Modify this Payment Method', 'event_espresso'),
+					'slug'  => $payment_method->slug(),
+				);
+			}
+		}
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links($tabs, 'payment_method_links',
+			'|', $this->_get_active_payment_method_slug());
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 *   _get_active_payment_method_slug
+	 *
+	 * @return string
+	 */
+	protected function _get_active_payment_method_slug()
+	{
+		$payment_method_slug = false;
+		//decide which payment method tab to open first, as dictated by the request's 'payment_method'
+		if (isset($this->_req_data['payment_method'])) {
+			// if they provided the current payment method, use it
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+		}
+		$payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
+		// if that didn't work or wasn't provided, find another way to select the current pm
+		if (! $this->_verify_payment_method($payment_method)) {
+			// like, looking for an active one
+			$payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
+			// test that one as well
+			if ($this->_verify_payment_method($payment_method)) {
+				$payment_method_slug = $payment_method->slug();
+			} else {
+				$payment_method_slug = 'paypal_standard';
+			}
+		}
+		return $payment_method_slug;
+	}
+
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
+	 *    capabilities to access it
+	 *
+	 * @param \EE_Payment_Method $payment_method
+	 * @return boolean
+	 */
+	protected function _verify_payment_method($payment_method)
+	{
+		if (
+			$payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
+			&& EE_Registry::instance()->CAP->current_user_can($payment_method->type_obj()->cap_name(),
+				'specific_payment_method_type_access')
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *
+	 * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
+	 * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
+	 *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
+	{
+		$payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
+			? $metabox['args']['payment_method'] : null;
+		if (! $payment_method instanceof EE_Payment_Method) {
+			throw new EE_Error(sprintf(__('Payment method metabox setup incorrectly. No Payment method object was supplied',
+				'event_espresso')));
+		}
+		$payment_method_scopes = $payment_method->active();
+		// if the payment method really exists show its form, otherwise the activation template
+		if ($payment_method->ID() && ! empty($payment_method_scopes)) {
+			$form = $this->_generate_payment_method_settings_form($payment_method);
+			if ($form->form_data_present_in($this->_req_data)) {
+				$form->receive_form_submission($this->_req_data);
+			}
+			echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
+		} else {
+			echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
+		}
+	}
+
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
+	{
+		if (! $payment_method instanceof EE_Payment_Method) {
+			return new EE_Form_Section_Proper();
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $payment_method->slug() . '_settings_form',
+				'html_id'         => $payment_method->slug() . '_settings_form',
+				'action'          => EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action'         => 'update_payment_method',
+						'payment_method' => $payment_method->slug(),
+					),
+					EE_PAYMENTS_ADMIN_URL
+				),
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
+					array(
+						'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
+						'currency_support'        => $this->_currency_support($payment_method),
+						'payment_method_settings' => $this->_payment_method_settings($payment_method),
+						'update'                  => $this->_update_payment_method_button($payment_method),
+						'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
+						'fine_print'              => $this->_fine_print(),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * _pci_dss_compliance
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
+	{
+		if ($payment_method->type_obj()->requires_https()) {
+			return new EE_Form_Section_HTML(
+				EEH_HTML::tr(
+					EEH_HTML::th(
+						EEH_HTML::label(
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
+						)
+					) .
+					EEH_HTML::td(
+						EEH_HTML::strong(__('You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
+							'event_espresso'))
+						.
+						EEH_HTML::br()
+						.
+						__('Learn more about ', 'event_espresso')
+						. EEH_HTML::link('https://www.pcisecuritystandards.org/merchants/index.php',
+							__('PCI DSS compliance', 'event_espresso'))
+					)
+				)
+			);
+		} else {
+			return new EE_Form_Section_HTML('');
+		}
+	}
+
+
+
+	/**
+	 * _currency_support
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _currency_support(EE_Payment_Method $payment_method)
+	{
+		if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+			return new EE_Form_Section_HTML(
+				EEH_HTML::tr(
+					EEH_HTML::th(
+						EEH_HTML::label(
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
+						)
+					) .
+					EEH_HTML::td(
+						EEH_HTML::strong(
+							sprintf(
+								__('This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
+									'event_espresso'),
+								EE_Config::instance()->currency->code
+							)
+						)
+					)
+				)
+			);
+		} else {
+			return new EE_Form_Section_HTML('');
+		}
+	}
+
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _payment_method_settings(EE_Payment_Method $payment_method)
+	{
+		//modify the form so we only have/show fields that will be implemented for this version
+		return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
+	}
+
+
+
+	/**
+	 * Simplifies the form to merely reproduce 4.1's gateway settings functionality
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @param string                 $payment_method_name
+	 * @return \EE_Payment_Method_Form
+	 * @throws \EE_Error
+	 */
+	protected function _simplify_form($form_section, $payment_method_name = '')
+	{
+		if ($form_section instanceof EE_Payment_Method_Form) {
+			$form_section->exclude(
+				array(
+					'PMD_type', //dont want them changing the type
+					'PMD_slug', //or the slug (probably never)
+					'PMD_wp_user', //or the user's ID
+					'Currency' //or the currency, until the rest of EE supports simultaneous currencies
+				)
+			);
+			return $form_section;
+		} else {
+			throw new EE_Error(sprintf(__('The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
+				'event_espresso'), $payment_method_name));
+		}
+	}
+
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _update_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$update_button = new EE_Submit_Input(
+			array(
+				'name'       => 'submit',
+				'html_id'    => 'save_' . $payment_method->slug() . '_settings',
+				'default'    => sprintf(__('Update %s Payment Settings', 'event_espresso'),
+					$payment_method->admin_name()),
+				'html_label' => EEH_HTML::nbsp(),
+			)
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::no_row(EEH_HTML::br(2)) .
+			EEH_HTML::tr(
+				EEH_HTML::th(__('Update Settings', 'event_espresso')) .
+				EEH_HTML::td(
+					$update_button->get_html_for_input()
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * _deactivate_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(__('Deactivate %1$s Payments?', 'event_espresso'),
+			$payment_method->admin_name());
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
+				EEH_HTML::td(
+					EEH_HTML::link(
+						EE_Admin_Page::add_query_args_and_nonce(
+							array(
+								'action'         => 'deactivate_payment_method',
+								'payment_method' => $payment_method->slug(),
+							),
+							EE_PAYMENTS_ADMIN_URL
+						),
+						$link_text_and_title,
+						$link_text_and_title,
+						'deactivate_' . $payment_method->slug(),
+						'espresso-button button-secondary'
+					)
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * _activate_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(__('Activate %1$s Payment Method?', 'event_espresso'),
+			$payment_method->admin_name());
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
+				'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
+				'action'          => '#',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
+					array(
+						new EE_Form_Section_HTML(
+							EEH_HTML::tr(
+								EEH_HTML::td($payment_method->type_obj()->introductory_html(),
+									'',
+									'',
+									'',
+									'colspan="2"'
+								)
+							) .
+							EEH_HTML::tr(
+								EEH_HTML::th(
+									EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
+								) .
+								EEH_HTML::td(
+									EEH_HTML::link(
+										EE_Admin_Page::add_query_args_and_nonce(
+											array(
+												'action'              => 'activate_payment_method',
+												'payment_method_type' => $payment_method->type(),
+											),
+											EE_PAYMENTS_ADMIN_URL
+										),
+										$link_text_and_title,
+										$link_text_and_title,
+										'activate_' . $payment_method->slug(),
+										'espresso-button-green button-primary'
+									)
+								)
+							)
+						),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * _fine_print
+	 *
+	 * @access protected
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _fine_print()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th() .
+				EEH_HTML::td(
+					EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
+	 *
+	 * @global WP_User $current_user
+	 */
+	protected function _activate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method_type'])) {
+			$payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
+			//see if one exists
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$payment_method = EE_Payment_Method_Manager::instance()
+													   ->activate_a_payment_method_of_type($payment_method_type);
+			$this->_redirect_after_action(1, 'Payment Method', 'activated',
+				array('action' => 'default', 'payment_method' => $payment_method->slug()));
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
+		}
+	}
+
+
+
+	/**
+	 * Deactivates the payment method with the specified slug, and redirects.
+	 */
+	protected function _deactivate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method'])) {
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+			//deactivate it
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
+			$this->_redirect_after_action($count_updated, 'Payment Method', 'deactivated',
+				array('action' => 'default', 'payment_method' => $payment_method_slug));
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
+		}
+	}
+
+
+
+	/**
+	 * Processes the payment method form that was submitted. This is slightly trickier than usual form
+	 * processing because we first need to identify WHICH form was processed and which payment method
+	 * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
+	 * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
+	 * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
+	 * subsequently called 'headers_sent_func' which is _payment_methods_list)
+	 *
+	 * @return void
+	 */
+	protected function _update_payment_method()
+	{
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+			//ok let's find which gateway form to use based on the form input
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			/** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
+			$correct_pmt_form_to_use = null;
+			$payment_method = null;
+			foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
+				//get the form and simplify it, like what we do when we display it
+				$pmt_form = $this->_generate_payment_method_settings_form($payment_method);
+				if ($pmt_form->form_data_present_in($this->_req_data)) {
+					$correct_pmt_form_to_use = $pmt_form;
+					break;
+				}
+			}
+			//if we couldn't find the correct payment method type...
+			if (! $correct_pmt_form_to_use) {
+				EE_Error::add_error(__("We could not find which payment method type your form submission related to. Please contact support",
+					'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+				$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
+			}
+			$correct_pmt_form_to_use->receive_form_submission($this->_req_data);
+			if ($correct_pmt_form_to_use->is_valid()) {
+				$payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
+				if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
+					throw new EE_Error(
+						sprintf(
+							__('The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
+								'event_espresso'),
+							'payment_method_settings'
+						)
+					);
+				}
+				$payment_settings_subform->save();
+				/** @var $pm EE_Payment_Method */
+				$this->_redirect_after_action(true, 'Payment Method', 'updated',
+					array('action' => 'default', 'payment_method' => $payment_method->slug()));
+			} else {
+				EE_Error::add_error(
+					sprintf(
+						__('Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
+							'event_espresso'),
+						$payment_method instanceof EE_PMT_Base ? $payment_method->pretty_name()
+							: __('"(unknown)"', 'event_espresso')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return;
+	}
+
+
+
+	protected function _payment_settings()
+	{
+		$this->_template_args['values'] = $this->_yes_no_values;
+		$this->_template_args['show_pending_payment_options'] = isset(EE_Registry::instance()->CFG->registration->show_pending_payment_options)
+			? absint(EE_Registry::instance()->CFG->registration->show_pending_payment_options) : false;
+		$this->_set_add_edit_form_tags('update_payment_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(EE_PAYMENTS_TEMPLATE_PATH
+																					 . 'payment_settings.template.php',
+			$this->_template_args, true);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 *        _update_payment_settings
+	 *
+	 * @access protected
+	 * @return array
+	 */
+	protected function _update_payment_settings()
+	{
+		EE_Registry::instance()->CFG->registration->show_pending_payment_options = isset($this->_req_data['show_pending_payment_options'])
+			? $this->_req_data['show_pending_payment_options'] : false;
+		EE_Registry::instance()->CFG = apply_filters('FHEE__Payments_Admin_Page___update_payment_settings__CFG',
+			EE_Registry::instance()->CFG);
 //		 $superform = new EE_Form_Section_Proper(
 //		 	array(
 //		 		'subsections' => array(
@@ -876,176 +876,176 @@ 
 //		 	);
 //		 	$this->_redirect_after_action( 0, 'settings', 'updated', array( 'action' => 'payment_settings' ) );
 //		 }
-        $what = __('Payment Settings', 'event_espresso');
-        $success = $this->_update_espresso_configuration($what, EE_Registry::instance()->CFG, __FILE__, __FUNCTION__,
-            __LINE__);
-        $this->_redirect_after_action($success, $what, __('updated', 'event_espresso'),
-            array('action' => 'payment_settings'));
-    }
+		$what = __('Payment Settings', 'event_espresso');
+		$success = $this->_update_espresso_configuration($what, EE_Registry::instance()->CFG, __FILE__, __FUNCTION__,
+			__LINE__);
+		$this->_redirect_after_action($success, $what, __('updated', 'event_espresso'),
+			array('action' => 'payment_settings'));
+	}
 
 
 
-    protected function _payment_log_overview_list_table()
-    {
+	protected function _payment_log_overview_list_table()
+	{
 //		$this->_search_btn_label = __('Payment Log', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-
-    protected function _set_list_table_views_payment_log()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'  => 'all',
-                'label' => __('View All Logs', 'event_espresso'),
-                'count' => 0,
-            ),
-        );
-    }
-
-
-
-    /**
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return array
-     */
-    public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        //we may need to do multiple queries (joining differently), so we actually wan tan array of query params
-        $query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
-        //check if they've selected a specific payment method
-        if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
-            $query_params[0]['OR*pm_or_pay_pm'] = array(
-                'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
-                'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
-            );
-        }
-        //take into account search
-        if (isset($this->_req_data['s']) && $this->_req_data['s']) {
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
-        }
-        if (isset($this->_req_data['payment-filter-start-date'])
-            && isset($this->_req_data['payment-filter-end-date'])
-        ) {
-            //add date
-            $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
-            $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
-            //make sure our timestamps start and end right at the boundaries for each day
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
-            //convert to timestamps
-            $start_date = strtotime($start_date);
-            $end_date = strtotime($end_date);
-            //makes sure start date is the lowest value and vice versa
-            $start_date = min($start_date, $end_date);
-            $end_date = max($start_date, $end_date);
-            //convert for query
-            $start_date = EEM_Change_Log::instance()
-                                        ->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $start_date),
-                                            'Y-m-d H:i:s');
-            $end_date = EEM_Change_Log::instance()
-                                      ->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $end_date),
-                                          'Y-m-d H:i:s');
-            $query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
-        }
-        if ($count) {
-            return EEM_Change_Log::instance()->count($query_params);
-        }
-        if (isset($this->_req_data['order'])) {
-            $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
-                : 'DESC';
-            $query_params['order_by'] = array('LOG_time' => $sort);
-        } else {
-            $query_params['order_by'] = array('LOG_time' => 'DESC');
-        }
-        $offset = ($current_page - 1) * $per_page;
-        if (! isset($this->_req_data['download_results'])) {
-            $query_params['limit'] = array($offset, $per_page);
-        }
-        //now they've requested to instead just download the file instead of viewing it.
-        if (isset($this->_req_data['download_results'])) {
-            $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
-            header('Content-Disposition: attachment');
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
-            echo "<h3>Query:</h3>";
-            var_dump($query_params);
-            echo "<h3>Results:</h3>";
-            var_dump($wpdb_results);
-            die;
-        }
-        $results = EEM_Change_Log::instance()->get_all($query_params);
-        return $results;
-    }
-
-
-
-    /**
-     * Used by usort to RE-sort log query results, because we lose the ordering
-     * because we're possibly combining the results from two queries
-     *
-     * @param EE_Change_Log $logA
-     * @param EE_Change_Log $logB
-     * @return int
-     */
-    protected function _sort_logs_again($logA, $logB)
-    {
-        $timeA = $logA->get_raw('LOG_time');
-        $timeB = $logB->get_raw('LOG_time');
-        if ($timeA == $timeB) {
-            return 0;
-        }
-        $comparison = $timeA < $timeB ? -1 : 1;
-        if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
-            return $comparison * -1;
-        } else {
-            return $comparison;
-        }
-    }
-
-
-
-    protected function _payment_log_details()
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        /** @var $payment_log EE_Change_Log */
-        $payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
-        $payment_method = null;
-        $transaction = null;
-        if ($payment_log instanceof EE_Change_Log) {
-            if ($payment_log->object() instanceof EE_Payment) {
-                $payment_method = $payment_log->object()->payment_method();
-                $transaction = $payment_log->object()->transaction();
-            } elseif ($payment_log->object() instanceof EE_Payment_Method) {
-                $payment_method = $payment_log->object();
-            }
-        }
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
-            array(
-                'payment_log'    => $payment_log,
-                'payment_method' => $payment_method,
-                'transaction'    => $transaction,
-            ),
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+
+	protected function _set_list_table_views_payment_log()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'  => 'all',
+				'label' => __('View All Logs', 'event_espresso'),
+				'count' => 0,
+			),
+		);
+	}
+
+
+
+	/**
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return array
+	 */
+	public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		//we may need to do multiple queries (joining differently), so we actually wan tan array of query params
+		$query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
+		//check if they've selected a specific payment method
+		if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
+			$query_params[0]['OR*pm_or_pay_pm'] = array(
+				'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
+				'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
+			);
+		}
+		//take into account search
+		if (isset($this->_req_data['s']) && $this->_req_data['s']) {
+			$similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
+		}
+		if (isset($this->_req_data['payment-filter-start-date'])
+			&& isset($this->_req_data['payment-filter-end-date'])
+		) {
+			//add date
+			$start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
+			$end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
+			//make sure our timestamps start and end right at the boundaries for each day
+			$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
+			$end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+			//convert to timestamps
+			$start_date = strtotime($start_date);
+			$end_date = strtotime($end_date);
+			//makes sure start date is the lowest value and vice versa
+			$start_date = min($start_date, $end_date);
+			$end_date = max($start_date, $end_date);
+			//convert for query
+			$start_date = EEM_Change_Log::instance()
+										->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $start_date),
+											'Y-m-d H:i:s');
+			$end_date = EEM_Change_Log::instance()
+									  ->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $end_date),
+										  'Y-m-d H:i:s');
+			$query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
+		}
+		if ($count) {
+			return EEM_Change_Log::instance()->count($query_params);
+		}
+		if (isset($this->_req_data['order'])) {
+			$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
+				: 'DESC';
+			$query_params['order_by'] = array('LOG_time' => $sort);
+		} else {
+			$query_params['order_by'] = array('LOG_time' => 'DESC');
+		}
+		$offset = ($current_page - 1) * $per_page;
+		if (! isset($this->_req_data['download_results'])) {
+			$query_params['limit'] = array($offset, $per_page);
+		}
+		//now they've requested to instead just download the file instead of viewing it.
+		if (isset($this->_req_data['download_results'])) {
+			$wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
+			header('Content-Disposition: attachment');
+			header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
+			echo "<h1>Payment Logs for " . site_url() . "</h1>";
+			echo "<h3>Query:</h3>";
+			var_dump($query_params);
+			echo "<h3>Results:</h3>";
+			var_dump($wpdb_results);
+			die;
+		}
+		$results = EEM_Change_Log::instance()->get_all($query_params);
+		return $results;
+	}
+
+
+
+	/**
+	 * Used by usort to RE-sort log query results, because we lose the ordering
+	 * because we're possibly combining the results from two queries
+	 *
+	 * @param EE_Change_Log $logA
+	 * @param EE_Change_Log $logB
+	 * @return int
+	 */
+	protected function _sort_logs_again($logA, $logB)
+	{
+		$timeA = $logA->get_raw('LOG_time');
+		$timeB = $logB->get_raw('LOG_time');
+		if ($timeA == $timeB) {
+			return 0;
+		}
+		$comparison = $timeA < $timeB ? -1 : 1;
+		if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
+			return $comparison * -1;
+		} else {
+			return $comparison;
+		}
+	}
+
+
+
+	protected function _payment_log_details()
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		/** @var $payment_log EE_Change_Log */
+		$payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
+		$payment_method = null;
+		$transaction = null;
+		if ($payment_log instanceof EE_Change_Log) {
+			if ($payment_log->object() instanceof EE_Payment) {
+				$payment_method = $payment_log->object()->payment_method();
+				$transaction = $payment_log->object()->transaction();
+			} elseif ($payment_log->object() instanceof EE_Payment_Method) {
+				$payment_method = $payment_log->object();
+			}
+		}
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+			array(
+				'payment_log'    => $payment_log,
+				'payment_method' => $payment_method,
+				'transaction'    => $transaction,
+			),
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
 
 
 } //end Payments_Admin_Page class

Spacing +38 added lines, -38 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -189,7 +189,7 @@ 
         $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
         $all_pmt_help_tabs_config = array();
         foreach ($payment_method_types as $payment_method_type) {
-            if (! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(),
+            if ( ! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(),
                 'specific_payment_method_type_access')
             ) {
                 continue;
@@ -200,7 +200,7 @@ 
                 $all_pmt_help_tabs_config[$help_tab_name] = array(
                     'title'   => $config['title'],
                     'content' => EEH_Template::display_template(
-                        $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
+                        $payment_method_type->file_folder().'help_tabs'.DS.$config['filename'].'.help_tab.php',
                         $template_args,
                         true),
                 );
@@ -246,7 +246,7 @@ 
     {
         wp_enqueue_script('ee_admin_js');
         wp_enqueue_script('ee-text-links');
-        wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+        wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL.'espresso_payments_admin.js',
             array('espresso-ui-theme', 'ee-datepicker'), EVENT_ESPRESSO_VERSION, true);
     }
 
@@ -255,7 +255,7 @@ 
     public function load_scripts_styles_default()
     {
         //styles
-        wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'ee-payments.css', array(),
+        wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL.'ee-payments.css', array(),
             EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso_payments');
         wp_enqueue_style('ee-text-links');
@@ -283,14 +283,14 @@ 
                 continue;
             }
             //check access
-            if (! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(),
+            if ( ! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(),
                 'specific_payment_method_type_access')
             ) {
                 continue;
             }
             //check for any active pms of that type
             $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
-            if (! $payment_method instanceof EE_Payment_Method) {
+            if ( ! $payment_method instanceof EE_Payment_Method) {
                 $payment_method = EE_Payment_Method::new_instance(
                     array(
                         'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
@@ -308,7 +308,7 @@ 
             if ($payment_method instanceof EE_Payment_Method) {
                 add_meta_box(
                 //html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
+                    'espresso_'.$payment_method->slug().'_payment_settings',
                     //title
                     sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
                     //callback
@@ -326,7 +326,7 @@ 
                 $tabs[$payment_method->slug()] = array(
                     'label' => $payment_method->admin_name(),
                     'class' => $payment_method->active() ? 'gateway-active' : '',
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
+                    'href'  => 'espresso_'.$payment_method->slug().'_payment_settings',
                     'title' => __('Modify this Payment Method', 'event_espresso'),
                     'slug'  => $payment_method->slug(),
                 );
@@ -354,7 +354,7 @@ 
         }
         $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
         // if that didn't work or wasn't provided, find another way to select the current pm
-        if (! $this->_verify_payment_method($payment_method)) {
+        if ( ! $this->_verify_payment_method($payment_method)) {
             // like, looking for an active one
             $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
             // test that one as well
@@ -404,7 +404,7 @@ 
     {
         $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
             ? $metabox['args']['payment_method'] : null;
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             throw new EE_Error(sprintf(__('Payment method metabox setup incorrectly. No Payment method object was supplied',
                 'event_espresso')));
         }
@@ -415,7 +415,7 @@ 
             if ($form->form_data_present_in($this->_req_data)) {
                 $form->receive_form_submission($this->_req_data);
             }
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
+            echo $form->form_open().$form->get_html_and_js().$form->form_close();
         } else {
             echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
         }
@@ -432,13 +432,13 @@ 
      */
     protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
     {
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             return new EE_Form_Section_Proper();
         }
         return new EE_Form_Section_Proper(
             array(
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
+                'name'            => $payment_method->slug().'_settings_form',
+                'html_id'         => $payment_method->slug().'_settings_form',
                 'action'          => EE_Admin_Page::add_query_args_and_nonce(
                     array(
                         'action'         => 'update_payment_method',
@@ -481,7 +481,7 @@ 
                         EEH_HTML::label(
                             EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
                         )
-                    ) .
+                    ).
                     EEH_HTML::td(
                         EEH_HTML::strong(__('You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
                             'event_espresso'))
@@ -510,14 +510,14 @@ 
      */
     protected function _currency_support(EE_Payment_Method $payment_method)
     {
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+        if ( ! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
             return new EE_Form_Section_HTML(
                 EEH_HTML::tr(
                     EEH_HTML::th(
                         EEH_HTML::label(
                             EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
                         )
-                    ) .
+                    ).
                     EEH_HTML::td(
                         EEH_HTML::strong(
                             sprintf(
@@ -591,16 +591,16 @@ 
         $update_button = new EE_Submit_Input(
             array(
                 'name'       => 'submit',
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
+                'html_id'    => 'save_'.$payment_method->slug().'_settings',
                 'default'    => sprintf(__('Update %s Payment Settings', 'event_espresso'),
                     $payment_method->admin_name()),
                 'html_label' => EEH_HTML::nbsp(),
             )
         );
         return new EE_Form_Section_HTML(
-            EEH_HTML::no_row(EEH_HTML::br(2)) .
+            EEH_HTML::no_row(EEH_HTML::br(2)).
             EEH_HTML::tr(
-                EEH_HTML::th(__('Update Settings', 'event_espresso')) .
+                EEH_HTML::th(__('Update Settings', 'event_espresso')).
                 EEH_HTML::td(
                     $update_button->get_html_for_input()
                 )
@@ -623,7 +623,7 @@ 
             $payment_method->admin_name());
         return new EE_Form_Section_HTML(
             EEH_HTML::tr(
-                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
+                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')).
                 EEH_HTML::td(
                     EEH_HTML::link(
                         EE_Admin_Page::add_query_args_and_nonce(
@@ -635,7 +635,7 @@ 
                         ),
                         $link_text_and_title,
                         $link_text_and_title,
-                        'deactivate_' . $payment_method->slug(),
+                        'deactivate_'.$payment_method->slug(),
                         'espresso-button button-secondary'
                     )
                 )
@@ -658,8 +658,8 @@ 
             $payment_method->admin_name());
         return new EE_Form_Section_Proper(
             array(
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
+                'name'            => 'activate_'.$payment_method->slug().'_settings_form',
+                'html_id'         => 'activate_'.$payment_method->slug().'_settings_form',
                 'action'          => '#',
                 'layout_strategy' => new EE_Admin_Two_Column_Layout(),
                 'subsections'     => apply_filters(
@@ -673,11 +673,11 @@ 
                                     '',
                                     'colspan="2"'
                                 )
-                            ) .
+                            ).
                             EEH_HTML::tr(
                                 EEH_HTML::th(
                                     EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
-                                ) .
+                                ).
                                 EEH_HTML::td(
                                     EEH_HTML::link(
                                         EE_Admin_Page::add_query_args_and_nonce(
@@ -689,7 +689,7 @@ 
                                         ),
                                         $link_text_and_title,
                                         $link_text_and_title,
-                                        'activate_' . $payment_method->slug(),
+                                        'activate_'.$payment_method->slug(),
                                         'espresso-button-green button-primary'
                                     )
                                 )
@@ -714,7 +714,7 @@ 
     {
         return new EE_Form_Section_HTML(
             EEH_HTML::tr(
-                EEH_HTML::th() .
+                EEH_HTML::th().
                 EEH_HTML::td(
                     EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
                 )
@@ -792,7 +792,7 @@ 
                 }
             }
             //if we couldn't find the correct payment method type...
-            if (! $correct_pmt_form_to_use) {
+            if ( ! $correct_pmt_form_to_use) {
                 EE_Error::add_error(__("We could not find which payment method type your form submission related to. Please contact support",
                     'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
                 $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
@@ -800,7 +800,7 @@ 
             $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
             if ($correct_pmt_form_to_use->is_valid()) {
                 $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
+                if ( ! $payment_settings_subform instanceof EE_Payment_Method_Form) {
                     throw new EE_Error(
                         sprintf(
                             __('The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
@@ -926,7 +926,7 @@ 
         }
         //take into account search
         if (isset($this->_req_data['s']) && $this->_req_data['s']) {
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
+            $similarity_string = array('LIKE', '%'.str_replace("", "%", $this->_req_data['s']).'%');
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
@@ -946,8 +946,8 @@ 
             $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
             $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
             //make sure our timestamps start and end right at the boundaries for each day
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+            $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00';
+            $end_date = date('Y-m-d', strtotime($end_date)).' 23:59:59';
             //convert to timestamps
             $start_date = strtotime($start_date);
             $end_date = strtotime($end_date);
@@ -974,15 +974,15 @@ 
             $query_params['order_by'] = array('LOG_time' => 'DESC');
         }
         $offset = ($current_page - 1) * $per_page;
-        if (! isset($this->_req_data['download_results'])) {
+        if ( ! isset($this->_req_data['download_results'])) {
             $query_params['limit'] = array($offset, $per_page);
         }
         //now they've requested to instead just download the file instead of viewing it.
         if (isset($this->_req_data['download_results'])) {
             $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
             header('Content-Disposition: attachment');
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
+            header("Content-Disposition: attachment; filename=ee_payment_logs_for_".sanitize_key(site_url()));
+            echo "<h1>Payment Logs for ".site_url()."</h1>";
             echo "<h3>Query:</h3>";
             var_dump($query_params);
             echo "<h3>Results:</h3>";
@@ -1036,7 +1036,7 @@ 
             }
         }
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+            EE_PAYMENTS_TEMPLATE_PATH.'payment_log_details.template.php',
             array(
                 'payment_log'    => $payment_log,
                 'payment_method' => $payment_method,

core/libraries/form_sections/base/EE_Model_Form_Section.form.php

Doc Comments +1 added lines

@@ -372,6 +372,7 @@
      * save the relations indicated
      *
      * @type string $relation_name
+     * @param integer $relation_name
      * @return bool
      * @throws EE_Error
      */

Indentation +433 added lines, -433 removed lines

@@ -14,439 +14,439 @@
 class EE_Model_Form_Section extends EE_Form_Section_Proper
 {
 
-    /**
-     * @var EEM_Base
-     */
-    protected $_model = null;
-
-    /**
-     * @var EE_Base_Class
-     */
-    protected $_model_object = null;
-
-
-
-    /**
-     * @param array        $options_array   keys: {
-     * @type EEM_Base      $model
-     * @type EE_Base_Class $model_object
-     * @type array         $subsection_args array keys should be subsection names (that either do or will exist), and
-     *       values are the arrays as you would pass them to that subsection
-     *                                      }
-     * @throws EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
-            $this->_model = $options_array['model'];
-        }
-        if (! $this->_model || ! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(sprintf(__("Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
-                "event_espresso")));
-        }
-        if (isset($options_array['subsection_args'])) {
-            $subsection_args = $options_array['subsection_args'];
-        } else {
-            $subsection_args = array();
-        }
-        //gather fields and relations to convert to inputs
-        //but if they're just going to exclude a field anyways, don't bother converting it to an input
-        $exclude = $this->_subsections;
-        if (isset($options_array['exclude'])) {
-            $exclude = array_merge($exclude, array_flip($options_array['exclude']));
-        }
-        $model_fields = array_diff_key($this->_model->field_settings(), $exclude);
-        $model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
-        //convert fields and relations to inputs
-        $this->_subsections = array_merge(
-            $this->_convert_model_fields_to_inputs($model_fields),
-            $this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
-            $this->_subsections
-        );
-        parent::__construct($options_array);
-        if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
-            $this->populate_model_obj($options_array['model_object']);
-        }
-    }
-
-
-
-    /**
-     * For now, just makes inputs for only HABTM relations
-     *
-     * @param EE_Model_Relation_Base[] $relations
-     * @param array                    $subsection_args keys should be existing or soon-to-be-existing input names, and
-     *                                                  their values are {
-     * @type array {
-     * @type EE_Base_Class[]           $model_objects   if the subsection is an EE_Select_Multi_Model_Input
-     *                                                  }
-     *                                                  }
-     * @return array
-     */
-    protected function _convert_model_relations_to_inputs($relations, $subsection_args = array())
-    {
-        $inputs = array();
-        foreach ($relations as $relation_name => $relation_obj) {
-            $input_constructor_args = array(
-                array_merge(
-                    array(
-                        'required'        => $relation_obj instanceof EE_Belongs_To_Relation,
-                        'html_label_text' => $relation_obj instanceof EE_Belongs_To_Relation
-                            ? $relation_obj->get_other_model()->item_name(1)
-                            : $relation_obj->get_other_model()
-                                           ->item_name(2),
-                    ),
-                    $subsection_args
-                ),
-            );
-            $input = null;
-            switch (get_class($relation_obj)) {
-                case 'EE_HABTM_Relation':
-                    if (isset($subsection_args[$relation_name])
-                        && isset($subsection_args[$relation_name]['model_objects'])
-                    ) {
-                        $model_objects = $subsection_args[$relation_name]['model_objects'];
-                    } else {
-                        $model_objects = $relation_obj->get_other_model()->get_all();
-                    }
-                    $input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
-                    break;
-                default:
-            }
-            if ($input) {
-                $inputs[$relation_name] = $input;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Changes model fields into form section inputs
-     *
-     * @param EE_Model_Field_Base[] $model_fields keys are the model's name
-     * @throws EE_Error
-     * @return EE_Form_Input_Base[]
-     */
-    protected function _convert_model_fields_to_inputs($model_fields = array())
-    {
-        $inputs = array();
-        foreach ($model_fields as $field_name => $model_field) {
-            if ($model_field instanceof EE_Model_Field_Base) {
-                $input_constructor_args = array(
-                    array(
-                        'required'        => ! $model_field->is_nullable()
-                                             && $model_field->get_default_value()
-                                                === null,
-                        'html_label_text' => $model_field->get_nicename(),
-                        'default'         => $model_field->get_default_value(),
-                    ),
-                );
-                switch (get_class($model_field)) {
-                    case 'EE_All_Caps_Text_Field':
-                    case 'EE_Any_Foreign_Model_Name_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Boolean_Field':
-                        $input_class = 'EE_Yes_No_Input';
-                        break;
-                    case 'EE_Datetime_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_Email_Field':
-                        $input_class = 'EE_Email_Input';
-                        break;
-                    case 'EE_Enum_Integer_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_Enum_Text_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_Float_Field':
-                        $input_class = 'EE_Float_Input';
-                        break;
-                    case 'EE_Foreign_Key_Int_Field':
-                    case 'EE_Foreign_Key_String_Field':
-                    case 'EE_WP_User_Field':
-                        $models_pointed_to = $model_field instanceof EE_Field_With_Model_Name
-                            ? $model_field->get_model_class_names_pointed_to() : array();
-                        if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
-                            $input_class = 'EE_Text_Input';
-                        } else {
-                            //so its just one model
-                            $model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
-                            $model = EE_Registry::instance()->load_model($model_name);
-                            $model_names = $model->get_all_names(array('limit' => 10));
-                            if ($model_field->is_nullable()) {
-                                array_unshift($model_names, __("Please Select", 'event_espresso'));
-                            }
-                            $input_constructor_args[1] = $input_constructor_args[0];
-                            $input_constructor_args[0] = $model_names;
-                            $input_class = 'EE_Select_Input';
-                        }
-                        break;
-                    case 'EE_Full_HTML_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Infinite_Integer':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_Integer_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Maybe_Serialized_Text_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        break;
-                    case 'EE_Money_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_Post_Content_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Plain_Text_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Primary_Key_Int_Field':
-                        $input_class = 'EE_Hidden_Input';
-                        $input_constructor_args['normalization_strategy'] = new EE_Int_Normalization();
-                        break;
-                    case 'EE_Primary_Key_String_Field':
-                        $input_class = 'EE_Hidden_Input';
-                        break;
-                    case 'EE_Serialized_Text_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        break;
-                    case 'EE_Simple_HTML_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Slug_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Trashed_Flag_Field':
-                        $input_class = 'EE_Yes_No_Input';
-                        break;
-                    case 'EE_WP_Post_Status_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_WP_Post_Type_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    default:
-                        throw new EE_Error(sprintf(__("Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement",
-                            "event_espresso"), get_class($model_field)));
-                }
-                $reflection = new ReflectionClass($input_class);
-                $input = $reflection->newInstanceArgs($input_constructor_args);
-                $inputs[$field_name] = $input;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Mostly the same as populate_defaults , except takes a model object as input, not an array,
-     * and also sets the form's _model_object
-     *
-     * @param EE_Base_Class $model_obj
-     * @return void
-     */
-    public function populate_model_obj($model_obj)
-    {
-        $model_obj = $this->_model->ensure_is_obj($model_obj);
-        $this->_model_object = $model_obj;
-        $defaults = $model_obj->model_field_array();
-        foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            $subsection = $this->get_subsection($relation_name, false);
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    //then we only expect there to be one
-                    $related_item = $this->_model_object->get_first_related($relation_name);
-                    $defaults[$relation_name] = $related_item->ID();
-                } else {
-                    $related_items = $this->_model_object->get_many_related($relation_name);
-                    $ids = array();
-                    foreach ($related_items as $related_item) {
-                        $ids[] = $related_item->ID();
-                    }
-                    $defaults[$relation_name] = $ids;
-                }
-            }
-        }
-        $defaults = apply_filters(
-            'FHEE__EE_Model_Form_Section__populate_model_obj',
-            $defaults,
-            $this
-        );
-        $this->populate_defaults($defaults);
-    }
-
-
-
-    /**
-     * Gets all the input values that correspond to model fields. Keys are the input/field names,
-     * values are their normalized values
-     *
-     * @return array
-     */
-    public function inputs_values_corresponding_to_model_fields()
-    {
-        return array_intersect_key($this->input_values(), $this->_model->field_settings());
-    }
-
-
-
-    /**
-     * After we've normalized the data as normal, set the corresponding model object
-     * on the form.
-     *
-     * @param array $req_data should usually be $_REQUEST (the default).
-     * @return void
-     */
-    public function _normalize($req_data)
-    {
-        parent::_normalize($req_data);
-        //create or set the model object, if it isn't already
-        if (! $this->_model_object) {
-            //check to see if the form indicates a PK, in which case we want to only retrieve it and update it
-            $pk_name = $this->_model->primary_key_name();
-            $model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
-            if ($model_obj) {
-                $this->_model_object = $model_obj;
-            } else {
-                $this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
-            }
-        }
-    }
-
-
-
-    /**
-     * After this form has been initialized and is verified to be valid,
-     * either creates a model object from its data and saves it, or updates
-     * the model object its data represents
-     *
-     * @throws EE_Error
-     * @return int, 1 on a successful update, the ID of
-     *                    the new entry on insert; 0 on failure
-     */
-    public function save()
-    {
-        if (! $this->_model_object) {
-            throw new EE_Error(sprintf(__("Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
-                "event_espresso"), get_class($this->_model)));
-        }
-        //ok so the model object is set. Just set it with the submitted form data
-        foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name => $field_value) {
-            //only set the non-primary key
-            if ($field_name != $this->_model->primary_key_name()) {
-                $this->_model_object->set($field_name, $field_value);
-            }
-        }
-        $success = $this->_model_object->save();
-        foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            if (isset($this->_subsections[$relation_name])) {
-                $success = $this->_save_related_info($relation_name);
-            }
-        }
-        do_action('AHEE__EE_Model_Form_Section__save__done', $this, $success);
-        return $success;
-    }
-
-
-
-    /**
-     * Automatically finds the related model info from the form, if present, and
-     * save the relations indicated
-     *
-     * @type string $relation_name
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _save_related_info($relation_name)
-    {
-        $relation_obj = $this->_model->related_settings_for($relation_name);
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            //there is just a foreign key on this model pointing to that one
-            $this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
-        } elseif ($relation_obj instanceof EE_Has_Many_Relation) {
-            //then we want to consider all of its currently-related things.
-            //if they're in this list, keep them
-            //if they're not in this list, remove them
-            //and lastly add all the new items
-            throw new EE_Error(sprintf(__('Automatic saving of related info across a "has many" relation is not yet supported',
-                "event_espresso")));
-        } elseif ($relation_obj instanceof EE_HABTM_Relation) {
-            //delete everything NOT in this list
-            $normalized_input_value = $this->get_input_value($relation_name);
-            if ($normalized_input_value && is_array($normalized_input_value)) {
-                $where_query_params = array(
-                    $relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value),
-                );
-            } else {
-                $where_query_params = array();
-            }
-            $this->_model_object->_remove_relations($relation_name, $where_query_params);
-            foreach ($normalized_input_value as $id) {
-                $this->_model_object->_add_relation_to($id, $relation_name);
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Gets the model of this model form
-     *
-     * @return EEM_Base
-     */
-    public function get_model()
-    {
-        return $this->_model;
-    }
-
-
-
-    /**
-     * Gets the model object for this model form, which was either set
-     * upon construction (using the $options_array arg 'model_object'), by using
-     * set_model_object($model_obj), or implicitly
-     * when receive_form_submission($req_data) was called.
-     *
-     * @return EE_Base_Class
-     */
-    public function get_model_object()
-    {
-        return $this->_model_object;
-    }
-
-
-
-    /**
-     * gets teh default name of this form section if none is specified
-     *
-     * @return string
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
-            $this->_name = $default_name;
-        }
-    }
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model = null;
+
+	/**
+	 * @var EE_Base_Class
+	 */
+	protected $_model_object = null;
+
+
+
+	/**
+	 * @param array        $options_array   keys: {
+	 * @type EEM_Base      $model
+	 * @type EE_Base_Class $model_object
+	 * @type array         $subsection_args array keys should be subsection names (that either do or will exist), and
+	 *       values are the arrays as you would pass them to that subsection
+	 *                                      }
+	 * @throws EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
+			$this->_model = $options_array['model'];
+		}
+		if (! $this->_model || ! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(sprintf(__("Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
+				"event_espresso")));
+		}
+		if (isset($options_array['subsection_args'])) {
+			$subsection_args = $options_array['subsection_args'];
+		} else {
+			$subsection_args = array();
+		}
+		//gather fields and relations to convert to inputs
+		//but if they're just going to exclude a field anyways, don't bother converting it to an input
+		$exclude = $this->_subsections;
+		if (isset($options_array['exclude'])) {
+			$exclude = array_merge($exclude, array_flip($options_array['exclude']));
+		}
+		$model_fields = array_diff_key($this->_model->field_settings(), $exclude);
+		$model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
+		//convert fields and relations to inputs
+		$this->_subsections = array_merge(
+			$this->_convert_model_fields_to_inputs($model_fields),
+			$this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
+			$this->_subsections
+		);
+		parent::__construct($options_array);
+		if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
+			$this->populate_model_obj($options_array['model_object']);
+		}
+	}
+
+
+
+	/**
+	 * For now, just makes inputs for only HABTM relations
+	 *
+	 * @param EE_Model_Relation_Base[] $relations
+	 * @param array                    $subsection_args keys should be existing or soon-to-be-existing input names, and
+	 *                                                  their values are {
+	 * @type array {
+	 * @type EE_Base_Class[]           $model_objects   if the subsection is an EE_Select_Multi_Model_Input
+	 *                                                  }
+	 *                                                  }
+	 * @return array
+	 */
+	protected function _convert_model_relations_to_inputs($relations, $subsection_args = array())
+	{
+		$inputs = array();
+		foreach ($relations as $relation_name => $relation_obj) {
+			$input_constructor_args = array(
+				array_merge(
+					array(
+						'required'        => $relation_obj instanceof EE_Belongs_To_Relation,
+						'html_label_text' => $relation_obj instanceof EE_Belongs_To_Relation
+							? $relation_obj->get_other_model()->item_name(1)
+							: $relation_obj->get_other_model()
+										   ->item_name(2),
+					),
+					$subsection_args
+				),
+			);
+			$input = null;
+			switch (get_class($relation_obj)) {
+				case 'EE_HABTM_Relation':
+					if (isset($subsection_args[$relation_name])
+						&& isset($subsection_args[$relation_name]['model_objects'])
+					) {
+						$model_objects = $subsection_args[$relation_name]['model_objects'];
+					} else {
+						$model_objects = $relation_obj->get_other_model()->get_all();
+					}
+					$input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
+					break;
+				default:
+			}
+			if ($input) {
+				$inputs[$relation_name] = $input;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Changes model fields into form section inputs
+	 *
+	 * @param EE_Model_Field_Base[] $model_fields keys are the model's name
+	 * @throws EE_Error
+	 * @return EE_Form_Input_Base[]
+	 */
+	protected function _convert_model_fields_to_inputs($model_fields = array())
+	{
+		$inputs = array();
+		foreach ($model_fields as $field_name => $model_field) {
+			if ($model_field instanceof EE_Model_Field_Base) {
+				$input_constructor_args = array(
+					array(
+						'required'        => ! $model_field->is_nullable()
+											 && $model_field->get_default_value()
+												=== null,
+						'html_label_text' => $model_field->get_nicename(),
+						'default'         => $model_field->get_default_value(),
+					),
+				);
+				switch (get_class($model_field)) {
+					case 'EE_All_Caps_Text_Field':
+					case 'EE_Any_Foreign_Model_Name_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Boolean_Field':
+						$input_class = 'EE_Yes_No_Input';
+						break;
+					case 'EE_Datetime_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_Email_Field':
+						$input_class = 'EE_Email_Input';
+						break;
+					case 'EE_Enum_Integer_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_Enum_Text_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_Float_Field':
+						$input_class = 'EE_Float_Input';
+						break;
+					case 'EE_Foreign_Key_Int_Field':
+					case 'EE_Foreign_Key_String_Field':
+					case 'EE_WP_User_Field':
+						$models_pointed_to = $model_field instanceof EE_Field_With_Model_Name
+							? $model_field->get_model_class_names_pointed_to() : array();
+						if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
+							$input_class = 'EE_Text_Input';
+						} else {
+							//so its just one model
+							$model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
+							$model = EE_Registry::instance()->load_model($model_name);
+							$model_names = $model->get_all_names(array('limit' => 10));
+							if ($model_field->is_nullable()) {
+								array_unshift($model_names, __("Please Select", 'event_espresso'));
+							}
+							$input_constructor_args[1] = $input_constructor_args[0];
+							$input_constructor_args[0] = $model_names;
+							$input_class = 'EE_Select_Input';
+						}
+						break;
+					case 'EE_Full_HTML_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
+						break;
+					case 'EE_Infinite_Integer':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_Integer_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Maybe_Serialized_Text_Field':
+						$input_class = 'EE_Text_Area_Input';
+						break;
+					case 'EE_Money_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_Post_Content_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
+						break;
+					case 'EE_Plain_Text_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Primary_Key_Int_Field':
+						$input_class = 'EE_Hidden_Input';
+						$input_constructor_args['normalization_strategy'] = new EE_Int_Normalization();
+						break;
+					case 'EE_Primary_Key_String_Field':
+						$input_class = 'EE_Hidden_Input';
+						break;
+					case 'EE_Serialized_Text_Field':
+						$input_class = 'EE_Text_Area_Input';
+						break;
+					case 'EE_Simple_HTML_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
+						break;
+					case 'EE_Slug_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Trashed_Flag_Field':
+						$input_class = 'EE_Yes_No_Input';
+						break;
+					case 'EE_WP_Post_Status_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_WP_Post_Type_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					default:
+						throw new EE_Error(sprintf(__("Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement",
+							"event_espresso"), get_class($model_field)));
+				}
+				$reflection = new ReflectionClass($input_class);
+				$input = $reflection->newInstanceArgs($input_constructor_args);
+				$inputs[$field_name] = $input;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Mostly the same as populate_defaults , except takes a model object as input, not an array,
+	 * and also sets the form's _model_object
+	 *
+	 * @param EE_Base_Class $model_obj
+	 * @return void
+	 */
+	public function populate_model_obj($model_obj)
+	{
+		$model_obj = $this->_model->ensure_is_obj($model_obj);
+		$this->_model_object = $model_obj;
+		$defaults = $model_obj->model_field_array();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			$subsection = $this->get_subsection($relation_name, false);
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					//then we only expect there to be one
+					$related_item = $this->_model_object->get_first_related($relation_name);
+					$defaults[$relation_name] = $related_item->ID();
+				} else {
+					$related_items = $this->_model_object->get_many_related($relation_name);
+					$ids = array();
+					foreach ($related_items as $related_item) {
+						$ids[] = $related_item->ID();
+					}
+					$defaults[$relation_name] = $ids;
+				}
+			}
+		}
+		$defaults = apply_filters(
+			'FHEE__EE_Model_Form_Section__populate_model_obj',
+			$defaults,
+			$this
+		);
+		$this->populate_defaults($defaults);
+	}
+
+
+
+	/**
+	 * Gets all the input values that correspond to model fields. Keys are the input/field names,
+	 * values are their normalized values
+	 *
+	 * @return array
+	 */
+	public function inputs_values_corresponding_to_model_fields()
+	{
+		return array_intersect_key($this->input_values(), $this->_model->field_settings());
+	}
+
+
+
+	/**
+	 * After we've normalized the data as normal, set the corresponding model object
+	 * on the form.
+	 *
+	 * @param array $req_data should usually be $_REQUEST (the default).
+	 * @return void
+	 */
+	public function _normalize($req_data)
+	{
+		parent::_normalize($req_data);
+		//create or set the model object, if it isn't already
+		if (! $this->_model_object) {
+			//check to see if the form indicates a PK, in which case we want to only retrieve it and update it
+			$pk_name = $this->_model->primary_key_name();
+			$model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
+			if ($model_obj) {
+				$this->_model_object = $model_obj;
+			} else {
+				$this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
+			}
+		}
+	}
+
+
+
+	/**
+	 * After this form has been initialized and is verified to be valid,
+	 * either creates a model object from its data and saves it, or updates
+	 * the model object its data represents
+	 *
+	 * @throws EE_Error
+	 * @return int, 1 on a successful update, the ID of
+	 *                    the new entry on insert; 0 on failure
+	 */
+	public function save()
+	{
+		if (! $this->_model_object) {
+			throw new EE_Error(sprintf(__("Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
+				"event_espresso"), get_class($this->_model)));
+		}
+		//ok so the model object is set. Just set it with the submitted form data
+		foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name => $field_value) {
+			//only set the non-primary key
+			if ($field_name != $this->_model->primary_key_name()) {
+				$this->_model_object->set($field_name, $field_value);
+			}
+		}
+		$success = $this->_model_object->save();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			if (isset($this->_subsections[$relation_name])) {
+				$success = $this->_save_related_info($relation_name);
+			}
+		}
+		do_action('AHEE__EE_Model_Form_Section__save__done', $this, $success);
+		return $success;
+	}
+
+
+
+	/**
+	 * Automatically finds the related model info from the form, if present, and
+	 * save the relations indicated
+	 *
+	 * @type string $relation_name
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _save_related_info($relation_name)
+	{
+		$relation_obj = $this->_model->related_settings_for($relation_name);
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			//there is just a foreign key on this model pointing to that one
+			$this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
+		} elseif ($relation_obj instanceof EE_Has_Many_Relation) {
+			//then we want to consider all of its currently-related things.
+			//if they're in this list, keep them
+			//if they're not in this list, remove them
+			//and lastly add all the new items
+			throw new EE_Error(sprintf(__('Automatic saving of related info across a "has many" relation is not yet supported',
+				"event_espresso")));
+		} elseif ($relation_obj instanceof EE_HABTM_Relation) {
+			//delete everything NOT in this list
+			$normalized_input_value = $this->get_input_value($relation_name);
+			if ($normalized_input_value && is_array($normalized_input_value)) {
+				$where_query_params = array(
+					$relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value),
+				);
+			} else {
+				$where_query_params = array();
+			}
+			$this->_model_object->_remove_relations($relation_name, $where_query_params);
+			foreach ($normalized_input_value as $id) {
+				$this->_model_object->_add_relation_to($id, $relation_name);
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Gets the model of this model form
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_model()
+	{
+		return $this->_model;
+	}
+
+
+
+	/**
+	 * Gets the model object for this model form, which was either set
+	 * upon construction (using the $options_array arg 'model_object'), by using
+	 * set_model_object($model_obj), or implicitly
+	 * when receive_form_submission($req_data) was called.
+	 *
+	 * @return EE_Base_Class
+	 */
+	public function get_model_object()
+	{
+		return $this->_model_object;
+	}
+
+
+
+	/**
+	 * gets teh default name of this form section if none is specified
+	 *
+	 * @return string
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+			$this->_name = $default_name;
+		}
+	}
 
 
 

Spacing +5 added lines, -5 removed lines

@@ -40,7 +40,7 @@ 
         if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
             $this->_model = $options_array['model'];
         }
-        if (! $this->_model || ! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model || ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(sprintf(__("Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
                 "event_espresso")));
         }
@@ -319,7 +319,7 @@ 
     {
         parent::_normalize($req_data);
         //create or set the model object, if it isn't already
-        if (! $this->_model_object) {
+        if ( ! $this->_model_object) {
             //check to see if the form indicates a PK, in which case we want to only retrieve it and update it
             $pk_name = $this->_model->primary_key_name();
             $model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
@@ -344,7 +344,7 @@ 
      */
     public function save()
     {
-        if (! $this->_model_object) {
+        if ( ! $this->_model_object) {
             throw new EE_Error(sprintf(__("Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
                 "event_espresso"), get_class($this->_model)));
         }
@@ -442,8 +442,8 @@ 
      */
     protected function _set_default_name_if_empty()
     {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+        if ( ! $this->_name) {
+            $default_name = str_replace("EEM_", "", get_class($this->_model))."_Model_Form";
             $this->_name = $default_name;
         }
     }