eventespresso / event-espresso-core

core/domain/services/admin/ajax/ThankYouPageIpnMonitor.php

Spacing +25 added lines, -25 removed lines

@@ -67,12 +67,12 @@ 
     public function heartbeatResponse($response = array(), $data = array())
     {
         // does this heartbeat contain our data ?
-        if (! isset($data[ $this->heartbeat ])) {
+        if ( ! isset($data[$this->heartbeat])) {
             return $response;
         }
         // check for reg_url_link in the incoming heartbeat data
-        if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
-            $response[ $this->heartbeat ] = array(
+        if ( ! isset($data[$this->heartbeat]['e_reg_url_link'])) {
+            $response[$this->heartbeat] = array(
                 'errors' => ! empty($notices['errors'])
                     ? $notices['errors']
                     : esc_html__(
@@ -85,22 +85,22 @@ 
         // kk heartbeat has our data
         $response = $this->initializeThankYouPageAndTransaction($response, $data);
         // if something went wrong...
-        if (isset($response[ $this->heartbeat ]['errors'])) {
+        if (isset($response[$this->heartbeat]['errors'])) {
             return $response;
         }
         // grab transient of Transaction's status
-        $txn_status = isset($data[ $this->heartbeat ]['txn_status'])
-            ? $data[ $this->heartbeat ]['txn_status']
+        $txn_status = isset($data[$this->heartbeat]['txn_status'])
+            ? $data[$this->heartbeat]['txn_status']
             : null;
         $response = $this->getTransactionDetails($txn_status, $response, $data);
         // no payment data yet?
-        if (isset($response[ $this->heartbeat ]['still_waiting'])) {
+        if (isset($response[$this->heartbeat]['still_waiting'])) {
             return $response;
         }
         // TXN is happening so let's get the payments now
         // if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
-        $since = isset($data[ $this->heartbeat ]['get_payments_since'])
-            ? $data[ $this->heartbeat ]['get_payments_since']
+        $since = isset($data[$this->heartbeat]['get_payments_since'])
+            ? $data[$this->heartbeat]['get_payments_since']
             : 0;
         return $this->paymentDetails($response, $since);
     }
@@ -117,18 +117,18 @@ 
      */
     private function initializeThankYouPageAndTransaction($response, $data)
     {
-        require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
+        require_once EE_MODULES.'thank_you_page/EED_Thank_You_Page.module.php';
         // set_definitions, instantiate the thank you page class, and get the ball rolling
         EED_Thank_You_Page::set_definitions();
         $this->thank_you_page = EED_Thank_You_Page::instance();
-        $this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
+        $this->thank_you_page->set_reg_url_link($data[$this->heartbeat]['e_reg_url_link']);
         $this->thank_you_page->init();
         // get TXN
         $transaction = $this->thank_you_page->get_txn();
         // no TXN? then get out
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             $notices = EE_Error::get_notices();
-            $response[ $this->heartbeat ] = array(
+            $response[$this->heartbeat] = array(
                 'errors' => ! empty($notices['errors'])
                     ? $notices['errors']
                     : sprintf(
@@ -173,12 +173,12 @@ 
                 case EEM_Transaction::failed_status_code:
                 default:
                     // keep on waiting...
-                    return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+                    return $this->updateServerWaitTime($data[$this->heartbeat]);
             }
             // or is the TXN still failed (never been updated) ???
         } elseif ($this->transaction->failed()) {
             // keep on waiting...
-            return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+            return $this->updateServerWaitTime($data[$this->heartbeat]);
         }
         return $response;
     }
@@ -196,11 +196,11 @@ 
      */
     private function setTransactionDetails($response, $status_only = false)
     {
-        if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
-            $response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
+        if ( ! $status_only && ! isset($response[$this->heartbeat]['transaction_details'])) {
+            $response[$this->heartbeat]['transaction_details'] = $this->thank_you_page->get_transaction_details();
         }
-        if (! isset($response[ $this->heartbeat ]['txn_status'])) {
-            $response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
+        if ( ! isset($response[$this->heartbeat]['txn_status'])) {
+            $response[$this->heartbeat]['txn_status'] = $this->transaction->status_ID();
         }
         return $response;
     }
@@ -221,19 +221,19 @@ 
         // then check for payments
         $payments = $this->thank_you_page->get_txn_payments($since);
         // has a payment been processed ?
-        if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
+        if ( ! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
             if ($since) {
-                $response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
+                $response[$this->heartbeat]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
                 $response = $this->setTransactionDetails($response);
             } else {
-                $response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
+                $response[$this->heartbeat]['payment_details'] = $this->thank_you_page->get_payment_details(
                     $payments
                 );
             }
             // reset time to check for payments
-            $response[ $this->heartbeat ]['get_payments_since'] = time();
+            $response[$this->heartbeat]['get_payments_since'] = time();
         } else {
-            $response[ $this->heartbeat ]['get_payments_since'] = $since;
+            $response[$this->heartbeat]['get_payments_since'] = $since;
         }
         return $response;
     }
@@ -251,7 +251,7 @@ 
      */
     private function updateServerWaitTime($thank_you_page_data)
     {
-        $response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
+        $response[$this->heartbeat]['still_waiting'] = isset($thank_you_page_data['initial_access'])
             ? time() - $thank_you_page_data['initial_access']
             : 0;
         $response = $this->setTransactionDetails($response, true);

Indentation +219 added lines, -219 removed lines

@@ -21,239 +21,239 @@
  */
 class ThankYouPageIpnMonitor
 {
-    /**
-     * @var string $heartbeat
-     */
-    private $heartbeat;
+	/**
+	 * @var string $heartbeat
+	 */
+	private $heartbeat;
 
-    /**
-     * @var EED_Thank_You_Page $thank_you_page
-     */
-    private $thank_you_page;
+	/**
+	 * @var EED_Thank_You_Page $thank_you_page
+	 */
+	private $thank_you_page;
 
-    /**
-     * @var EE_Transaction $transaction
-     */
-    private $transaction;
+	/**
+	 * @var EE_Transaction $transaction
+	 */
+	private $transaction;
 
 
-    /**
-     * EventEditorHeartbeat constructor.
-     */
-    public function __construct()
-    {
-        $this->heartbeat = WordpressHeartbeat::RESPONSE_KEY_THANK_YOU_PAGE;
-        add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 3);
-        add_filter('heartbeat_nopriv_received', array($this, 'heartbeatResponse'), 10, 3);
-    }
+	/**
+	 * EventEditorHeartbeat constructor.
+	 */
+	public function __construct()
+	{
+		$this->heartbeat = WordpressHeartbeat::RESPONSE_KEY_THANK_YOU_PAGE;
+		add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 3);
+		add_filter('heartbeat_nopriv_received', array($this, 'heartbeatResponse'), 10, 3);
+	}
 
 
-    /**
-     * thank_you_page_IPN_monitor
-     * this basically just pulls the TXN based on the reg_url_link sent from the server,
-     * then checks that the TXN status is not failed, and that no other errors have been generated.
-     * it also calculates the IPN wait time since the Thank You page was first loaded
-     *
-     * @param array $response
-     * @param array $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function heartbeatResponse($response = array(), $data = array())
-    {
-        // does this heartbeat contain our data ?
-        if (! isset($data[ $this->heartbeat ])) {
-            return $response;
-        }
-        // check for reg_url_link in the incoming heartbeat data
-        if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
-            $response[ $this->heartbeat ] = array(
-                'errors' => ! empty($notices['errors'])
-                    ? $notices['errors']
-                    : esc_html__(
-                        'No transaction information could be retrieved because the registration URL link is missing or invalid.',
-                        'event_espresso'
-                    ),
-            );
-            return $response;
-        }
-        // kk heartbeat has our data
-        $response = $this->initializeThankYouPageAndTransaction($response, $data);
-        // if something went wrong...
-        if (isset($response[ $this->heartbeat ]['errors'])) {
-            return $response;
-        }
-        // grab transient of Transaction's status
-        $txn_status = isset($data[ $this->heartbeat ]['txn_status'])
-            ? $data[ $this->heartbeat ]['txn_status']
-            : null;
-        $response = $this->getTransactionDetails($txn_status, $response, $data);
-        // no payment data yet?
-        if (isset($response[ $this->heartbeat ]['still_waiting'])) {
-            return $response;
-        }
-        // TXN is happening so let's get the payments now
-        // if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
-        $since = isset($data[ $this->heartbeat ]['get_payments_since'])
-            ? $data[ $this->heartbeat ]['get_payments_since']
-            : 0;
-        return $this->paymentDetails($response, $since);
-    }
+	/**
+	 * thank_you_page_IPN_monitor
+	 * this basically just pulls the TXN based on the reg_url_link sent from the server,
+	 * then checks that the TXN status is not failed, and that no other errors have been generated.
+	 * it also calculates the IPN wait time since the Thank You page was first loaded
+	 *
+	 * @param array $response
+	 * @param array $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function heartbeatResponse($response = array(), $data = array())
+	{
+		// does this heartbeat contain our data ?
+		if (! isset($data[ $this->heartbeat ])) {
+			return $response;
+		}
+		// check for reg_url_link in the incoming heartbeat data
+		if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
+			$response[ $this->heartbeat ] = array(
+				'errors' => ! empty($notices['errors'])
+					? $notices['errors']
+					: esc_html__(
+						'No transaction information could be retrieved because the registration URL link is missing or invalid.',
+						'event_espresso'
+					),
+			);
+			return $response;
+		}
+		// kk heartbeat has our data
+		$response = $this->initializeThankYouPageAndTransaction($response, $data);
+		// if something went wrong...
+		if (isset($response[ $this->heartbeat ]['errors'])) {
+			return $response;
+		}
+		// grab transient of Transaction's status
+		$txn_status = isset($data[ $this->heartbeat ]['txn_status'])
+			? $data[ $this->heartbeat ]['txn_status']
+			: null;
+		$response = $this->getTransactionDetails($txn_status, $response, $data);
+		// no payment data yet?
+		if (isset($response[ $this->heartbeat ]['still_waiting'])) {
+			return $response;
+		}
+		// TXN is happening so let's get the payments now
+		// if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
+		$since = isset($data[ $this->heartbeat ]['get_payments_since'])
+			? $data[ $this->heartbeat ]['get_payments_since']
+			: 0;
+		return $this->paymentDetails($response, $since);
+	}
 
 
-    /**
-     * @param array $response
-     * @param array $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function initializeThankYouPageAndTransaction($response, $data)
-    {
-        require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
-        // set_definitions, instantiate the thank you page class, and get the ball rolling
-        EED_Thank_You_Page::set_definitions();
-        $this->thank_you_page = EED_Thank_You_Page::instance();
-        $this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
-        $this->thank_you_page->init();
-        // get TXN
-        $transaction = $this->thank_you_page->get_txn();
-        // no TXN? then get out
-        if (! $transaction instanceof EE_Transaction) {
-            $notices = EE_Error::get_notices();
-            $response[ $this->heartbeat ] = array(
-                'errors' => ! empty($notices['errors'])
-                    ? $notices['errors']
-                    : sprintf(
-                        esc_html__(
-                            'The information for your transaction could not be retrieved from the server or the transaction data received was invalid because of a technical reason. (%s)',
-                            'event_espresso'
-                        ),
-                        __LINE__
-                    ),
-            );
-            return $response;
-        }
-        $this->transaction = $transaction;
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param array $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function initializeThankYouPageAndTransaction($response, $data)
+	{
+		require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
+		// set_definitions, instantiate the thank you page class, and get the ball rolling
+		EED_Thank_You_Page::set_definitions();
+		$this->thank_you_page = EED_Thank_You_Page::instance();
+		$this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
+		$this->thank_you_page->init();
+		// get TXN
+		$transaction = $this->thank_you_page->get_txn();
+		// no TXN? then get out
+		if (! $transaction instanceof EE_Transaction) {
+			$notices = EE_Error::get_notices();
+			$response[ $this->heartbeat ] = array(
+				'errors' => ! empty($notices['errors'])
+					? $notices['errors']
+					: sprintf(
+						esc_html__(
+							'The information for your transaction could not be retrieved from the server or the transaction data received was invalid because of a technical reason. (%s)',
+							'event_espresso'
+						),
+						__LINE__
+					),
+			);
+			return $response;
+		}
+		$this->transaction = $transaction;
+		return $response;
+	}
 
 
-    /**
-     * @param string $txn_status
-     * @param array  $response
-     * @param array  $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function getTransactionDetails($txn_status, $response, $data)
-    {
-        // has the TXN status changed since we last checked (or empty because this is the first time running through this code)?
-        if ($txn_status !== $this->transaction->status_ID()) {
-            // switch between two possible basic outcomes
-            switch ($this->transaction->status_ID()) {
-                // TXN has been updated in some way
-                case EEM_Transaction::overpaid_status_code:
-                case EEM_Transaction::complete_status_code:
-                case EEM_Transaction::incomplete_status_code:
-                    // send updated TXN results back to client,
-                    return $this->setTransactionDetails($response);
-                // or we have a bad TXN, or really slow IPN, so calculate the wait time and send that back...
-                case EEM_Transaction::failed_status_code:
-                default:
-                    // keep on waiting...
-                    return $this->updateServerWaitTime($data[ $this->heartbeat ]);
-            }
-            // or is the TXN still failed (never been updated) ???
-        } elseif ($this->transaction->failed()) {
-            // keep on waiting...
-            return $this->updateServerWaitTime($data[ $this->heartbeat ]);
-        }
-        return $response;
-    }
+	/**
+	 * @param string $txn_status
+	 * @param array  $response
+	 * @param array  $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function getTransactionDetails($txn_status, $response, $data)
+	{
+		// has the TXN status changed since we last checked (or empty because this is the first time running through this code)?
+		if ($txn_status !== $this->transaction->status_ID()) {
+			// switch between two possible basic outcomes
+			switch ($this->transaction->status_ID()) {
+				// TXN has been updated in some way
+				case EEM_Transaction::overpaid_status_code:
+				case EEM_Transaction::complete_status_code:
+				case EEM_Transaction::incomplete_status_code:
+					// send updated TXN results back to client,
+					return $this->setTransactionDetails($response);
+				// or we have a bad TXN, or really slow IPN, so calculate the wait time and send that back...
+				case EEM_Transaction::failed_status_code:
+				default:
+					// keep on waiting...
+					return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+			}
+			// or is the TXN still failed (never been updated) ???
+		} elseif ($this->transaction->failed()) {
+			// keep on waiting...
+			return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $response
-     * @param boolean $status_only
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function setTransactionDetails($response, $status_only = false)
-    {
-        if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
-            $response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
-        }
-        if (! isset($response[ $this->heartbeat ]['txn_status'])) {
-            $response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
-        }
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param boolean $status_only
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function setTransactionDetails($response, $status_only = false)
+	{
+		if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
+			$response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
+		}
+		if (! isset($response[ $this->heartbeat ]['txn_status'])) {
+			$response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $response
-     * @param int $since
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function paymentDetails($response, $since)
-    {
-        // then check for payments
-        $payments = $this->thank_you_page->get_txn_payments($since);
-        // has a payment been processed ?
-        if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
-            if ($since) {
-                $response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
-                $response = $this->setTransactionDetails($response);
-            } else {
-                $response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
-                    $payments
-                );
-            }
-            // reset time to check for payments
-            $response[ $this->heartbeat ]['get_payments_since'] = time();
-        } else {
-            $response[ $this->heartbeat ]['get_payments_since'] = $since;
-        }
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param int $since
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function paymentDetails($response, $since)
+	{
+		// then check for payments
+		$payments = $this->thank_you_page->get_txn_payments($since);
+		// has a payment been processed ?
+		if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
+			if ($since) {
+				$response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
+				$response = $this->setTransactionDetails($response);
+			} else {
+				$response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
+					$payments
+				);
+			}
+			// reset time to check for payments
+			$response[ $this->heartbeat ]['get_payments_since'] = time();
+		} else {
+			$response[ $this->heartbeat ]['get_payments_since'] = $since;
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $thank_you_page_data    thank you page portion of the incoming JSON array
-     *                                      from the WP heartbeat data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function updateServerWaitTime($thank_you_page_data)
-    {
-        $response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
-            ? time() - $thank_you_page_data['initial_access']
-            : 0;
-        $response = $this->setTransactionDetails($response, true);
-        return $response;
-    }
+	/**
+	 * @param array $thank_you_page_data    thank you page portion of the incoming JSON array
+	 *                                      from the WP heartbeat data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function updateServerWaitTime($thank_you_page_data)
+	{
+		$response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
+			? time() - $thank_you_page_data['initial_access']
+			: 0;
+		$response = $this->setTransactionDetails($response, true);
+		return $response;
+	}
 }

core/domain/services/ticket/CancelTicketLineItemService.php

Spacing +2 added lines, -2 removed lines

@@ -88,7 +88,7 @@ 
             );
             $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new \RuntimeException(
                 sprintf(
                     esc_html__('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
@@ -125,7 +125,7 @@ 
                 break;
             }
         }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+        if ( ! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
             throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
         }
         return $line_item;

Indentation +106 added lines, -106 removed lines

@@ -18,114 +18,114 @@
  */
 class CancelTicketLineItemService extends DomainService
 {
-    /**
-     * @param \EE_Registration $registration
-     * @param int              $quantity
-     * @return bool|int
-     */
-    public function forRegistration(\EE_Registration $registration, $quantity = 1)
-    {
-        return $this->cancel(
-            $registration->transaction(),
-            $registration->ticket(),
-            $quantity,
-            $registration->ticket_line_item()
-        );
-    }
+	/**
+	 * @param \EE_Registration $registration
+	 * @param int              $quantity
+	 * @return bool|int
+	 */
+	public function forRegistration(\EE_Registration $registration, $quantity = 1)
+	{
+		return $this->cancel(
+			$registration->transaction(),
+			$registration->ticket(),
+			$quantity,
+			$registration->ticket_line_item()
+		);
+	}
 
 
-    /**
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     * @param int             $quantity
-     * @param \EE_Line_Item   $ticket_line_item
-     * @return bool|int
-     */
-    public function cancel(
-        \EE_Transaction $transaction,
-        \EE_Ticket $ticket,
-        $quantity = 1,
-        \EE_Line_Item $ticket_line_item = null
-    ) {
-        $ticket_line_item = $ticket_line_item instanceof \EE_Line_Item
-            ? $ticket_line_item
-            : $this->getTicketLineItem($transaction, $ticket);
-        // first we need to decrement the ticket quantity
-        \EEH_Line_Item::decrement_quantity($ticket_line_item, $quantity);
-        // no tickets left for this line item ?
-        if ((int) $ticket_line_item->quantity() === 0) {
-            // then just set this line item as cancelled, save, and get out
-            $ticket_line_item->set_type(\EEM_Line_Item::type_cancellation);
-            $success = $ticket_line_item->save();
-        } else {
-            // otherwise create a new cancelled line item, so that we have a record of the cancellation
-            $items_subtotal = \EEH_Line_Item::get_pre_tax_subtotal(
-                \EEH_Line_Item::get_event_line_item_for_ticket(
-                    $transaction->total_line_item(),
-                    $ticket
-                )
-            );
-            $cancelled_line_item = \EE_Line_Item::new_instance(
-                array(
-                    'LIN_name'       => $ticket_line_item->name(),
-                    'LIN_desc'       => sprintf(
-                        esc_html__('%1$s Cancelled: %2$s', 'event_espresso'),
-                        $ticket_line_item->desc(),
-                        date('Y-m-d h:i a')
-                    ),
-                    'LIN_unit_price' => (float) $ticket_line_item->unit_price(),
-                    'LIN_quantity'   => $quantity,
-                    'LIN_percent'    => null,
-                    'LIN_is_taxable' => false,
-                    'LIN_order'      => $items_subtotal instanceof \EE_Line_Item
-                        ? count($items_subtotal->children())
-                        : 0,
-                    'LIN_total'      => (float) $ticket_line_item->unit_price(),
-                    'LIN_type'       => \EEM_Line_Item::type_cancellation,
-                )
-            );
-            $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
-        }
-        if (! $success) {
-            throw new \RuntimeException(
-                sprintf(
-                    esc_html__('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
-                    $ticket_line_item->ID()
-                )
-            );
-        }
-        return $success;
-    }
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 * @param int             $quantity
+	 * @param \EE_Line_Item   $ticket_line_item
+	 * @return bool|int
+	 */
+	public function cancel(
+		\EE_Transaction $transaction,
+		\EE_Ticket $ticket,
+		$quantity = 1,
+		\EE_Line_Item $ticket_line_item = null
+	) {
+		$ticket_line_item = $ticket_line_item instanceof \EE_Line_Item
+			? $ticket_line_item
+			: $this->getTicketLineItem($transaction, $ticket);
+		// first we need to decrement the ticket quantity
+		\EEH_Line_Item::decrement_quantity($ticket_line_item, $quantity);
+		// no tickets left for this line item ?
+		if ((int) $ticket_line_item->quantity() === 0) {
+			// then just set this line item as cancelled, save, and get out
+			$ticket_line_item->set_type(\EEM_Line_Item::type_cancellation);
+			$success = $ticket_line_item->save();
+		} else {
+			// otherwise create a new cancelled line item, so that we have a record of the cancellation
+			$items_subtotal = \EEH_Line_Item::get_pre_tax_subtotal(
+				\EEH_Line_Item::get_event_line_item_for_ticket(
+					$transaction->total_line_item(),
+					$ticket
+				)
+			);
+			$cancelled_line_item = \EE_Line_Item::new_instance(
+				array(
+					'LIN_name'       => $ticket_line_item->name(),
+					'LIN_desc'       => sprintf(
+						esc_html__('%1$s Cancelled: %2$s', 'event_espresso'),
+						$ticket_line_item->desc(),
+						date('Y-m-d h:i a')
+					),
+					'LIN_unit_price' => (float) $ticket_line_item->unit_price(),
+					'LIN_quantity'   => $quantity,
+					'LIN_percent'    => null,
+					'LIN_is_taxable' => false,
+					'LIN_order'      => $items_subtotal instanceof \EE_Line_Item
+						? count($items_subtotal->children())
+						: 0,
+					'LIN_total'      => (float) $ticket_line_item->unit_price(),
+					'LIN_type'       => \EEM_Line_Item::type_cancellation,
+				)
+			);
+			$success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
+		}
+		if (! $success) {
+			throw new \RuntimeException(
+				sprintf(
+					esc_html__('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
+					$ticket_line_item->ID()
+				)
+			);
+		}
+		return $success;
+	}
 
 
-    /**
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     * @return \EE_Line_Item
-     * @throws EntityNotFoundException
-     * @throws \EE_Error
-     */
-    protected static function getTicketLineItem(\EE_Transaction $transaction, \EE_Ticket $ticket)
-    {
-        $line_item = null;
-        $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $transaction->total_line_item(),
-            'Ticket',
-            array($ticket->ID())
-        );
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof \EE_Line_Item
-                && $ticket_line_item->OBJ_type() === 'Ticket'
-                && $ticket_line_item->OBJ_ID() === $ticket->ID()
-            ) {
-                $line_item = $ticket_line_item;
-                break;
-            }
-        }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
-            throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
-        }
-        return $line_item;
-    }
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 * @return \EE_Line_Item
+	 * @throws EntityNotFoundException
+	 * @throws \EE_Error
+	 */
+	protected static function getTicketLineItem(\EE_Transaction $transaction, \EE_Ticket $ticket)
+	{
+		$line_item = null;
+		$ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$transaction->total_line_item(),
+			'Ticket',
+			array($ticket->ID())
+		);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof \EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === 'Ticket'
+				&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+			) {
+				$line_item = $ticket_line_item;
+				break;
+			}
+		}
+		if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+			throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
+		}
+		return $line_item;
+	}
 }

core/EE_Module_Request_Router.core.php

Spacing +10 added lines, -10 removed lines

@@ -60,7 +60,7 @@ 
         // assume this if first route being called
         $previous_route = false;
         // but is it really ???
-        if (! empty(self::$_previous_routes)) {
+        if ( ! empty(self::$_previous_routes)) {
             // get last run route
             $previous_routes = array_values(self::$_previous_routes);
             $previous_route = array_pop($previous_routes);
@@ -71,7 +71,7 @@ 
             $current_route = $this->get_forward($previous_route);
             try {
                 // check for recursive forwarding
-                if (isset(self::$_previous_routes[ $current_route ])) {
+                if (isset(self::$_previous_routes[$current_route])) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -144,38 +144,38 @@ 
             return false;
         }
         // verify that result is an array
-        if (! is_array($module_method)) {
+        if ( ! is_array($module_method)) {
             $msg = sprintf(esc_html__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // grab module name
         $module_name = $module_method[0];
         // verify that a class method was registered properly
-        if (! isset($module_method[1])) {
+        if ( ! isset($module_method[1])) {
             $msg = sprintf(
                 esc_html__('A class method for the %s  route has not been properly registered.', 'event_espresso'),
                 $current_route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // grab method
         $method = $module_method[1];
         // verify that class exists
-        if (! class_exists($module_name)) {
+        if ( ! class_exists($module_name)) {
             $msg = sprintf(esc_html__('The requested %s class could not be found.', 'event_espresso'), $module_name);
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // verify that method exists
-        if (! method_exists($module_name, $method)) {
+        if ( ! method_exists($module_name, $method)) {
             $msg = sprintf(
                 esc_html__('The class method %s for the %s route is in invalid.', 'event_espresso'),
                 $method,
                 $current_route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // instantiate module and call route method
@@ -209,7 +209,7 @@ 
         // instantiate module class
         $module = new $module_name();
         // ensure that class is actually a module
-        if (! $module instanceof EED_Module) {
+        if ( ! $module instanceof EED_Module) {
             EE_Error::add_error(
                 sprintf(esc_html__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
                 __FILE__,

Indentation +234 added lines, -234 removed lines

@@ -15,254 +15,254 @@
  */
 final class EE_Module_Request_Router implements InterminableInterface
 {
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
 
-    /**
-     * @var array $_previous_routes
-     */
-    private static $_previous_routes = array();
+	/**
+	 * @var array $_previous_routes
+	 */
+	private static $_previous_routes = array();
 
-    /**
-     * @var WP_Query $WP_Query
-     */
-    public $WP_Query;
+	/**
+	 * @var WP_Query $WP_Query
+	 */
+	public $WP_Query;
 
 
-    /**
-     * EE_Module_Request_Router constructor.
-     *
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * EE_Module_Request_Router constructor.
+	 *
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
 
 
-    /**
-     * on the first call  to this method, it checks the Request for a "route"
-     * on subsequent calls to this method,
-     * instead of checking the Request for a route, it checks the previous routes array,
-     * and checks if the last called route has any forwarding routes registered for it
-     *
-     * @param WP_Query $WP_Query
-     * @return NULL|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_route(WP_Query $WP_Query)
-    {
-        $this->WP_Query = $WP_Query;
-        // assume this if first route being called
-        $previous_route = false;
-        // but is it really ???
-        if (! empty(self::$_previous_routes)) {
-            // get last run route
-            $previous_routes = array_values(self::$_previous_routes);
-            $previous_route = array_pop($previous_routes);
-        }
-        //  has another route already been run ?
-        if ($previous_route) {
-            // check if  forwarding has been set
-            $current_route = $this->get_forward($previous_route);
-            try {
-                // check for recursive forwarding
-                if (isset(self::$_previous_routes[ $current_route ])) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'An error occurred. The %s route has already been called, and therefore can not be forwarded to, because an infinite loop would be created and break the interweb.',
-                                'event_espresso'
-                            ),
-                            $current_route
-                        )
-                    );
-                }
-            } catch (EE_Error $e) {
-                $e->get_error();
-                return null;
-            }
-        } else {
-            // first route called
-            $current_route = null;
-            // grab all routes
-            $routes = EE_Config::get_routes();
-            foreach ($routes as $key => $route) {
-                // first determine if route key uses w?ldc*rds
-                $uses_wildcards = strpos($key, '?') !== false
-                                  || strpos($key, '*') !== false;
-                // check request for module route
-                $route_found = $uses_wildcards
-                    ? $this->request->matches($key)
-                    : $this->request->requestParamIsSet($key);
-                if ($route_found) {
-                    $current_route = $uses_wildcards
-                        ? $this->request->getMatch($key)
-                        : $this->request->getRequestParam($key);
-                    $current_route = sanitize_text_field($current_route);
-                    if ($current_route) {
-                        $current_route = array($key, $current_route);
-                        break;
-                    }
-                }
-            }
-        }
-        // sorry, but I can't read what you route !
-        if (empty($current_route)) {
-            return null;
-        }
-        // add route to previous routes array
-        self::$_previous_routes[] = $current_route;
-        return $current_route;
-    }
+	/**
+	 * on the first call  to this method, it checks the Request for a "route"
+	 * on subsequent calls to this method,
+	 * instead of checking the Request for a route, it checks the previous routes array,
+	 * and checks if the last called route has any forwarding routes registered for it
+	 *
+	 * @param WP_Query $WP_Query
+	 * @return NULL|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_route(WP_Query $WP_Query)
+	{
+		$this->WP_Query = $WP_Query;
+		// assume this if first route being called
+		$previous_route = false;
+		// but is it really ???
+		if (! empty(self::$_previous_routes)) {
+			// get last run route
+			$previous_routes = array_values(self::$_previous_routes);
+			$previous_route = array_pop($previous_routes);
+		}
+		//  has another route already been run ?
+		if ($previous_route) {
+			// check if  forwarding has been set
+			$current_route = $this->get_forward($previous_route);
+			try {
+				// check for recursive forwarding
+				if (isset(self::$_previous_routes[ $current_route ])) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'An error occurred. The %s route has already been called, and therefore can not be forwarded to, because an infinite loop would be created and break the interweb.',
+								'event_espresso'
+							),
+							$current_route
+						)
+					);
+				}
+			} catch (EE_Error $e) {
+				$e->get_error();
+				return null;
+			}
+		} else {
+			// first route called
+			$current_route = null;
+			// grab all routes
+			$routes = EE_Config::get_routes();
+			foreach ($routes as $key => $route) {
+				// first determine if route key uses w?ldc*rds
+				$uses_wildcards = strpos($key, '?') !== false
+								  || strpos($key, '*') !== false;
+				// check request for module route
+				$route_found = $uses_wildcards
+					? $this->request->matches($key)
+					: $this->request->requestParamIsSet($key);
+				if ($route_found) {
+					$current_route = $uses_wildcards
+						? $this->request->getMatch($key)
+						: $this->request->getRequestParam($key);
+					$current_route = sanitize_text_field($current_route);
+					if ($current_route) {
+						$current_route = array($key, $current_route);
+						break;
+					}
+				}
+			}
+		}
+		// sorry, but I can't read what you route !
+		if (empty($current_route)) {
+			return null;
+		}
+		// add route to previous routes array
+		self::$_previous_routes[] = $current_route;
+		return $current_route;
+	}
 
 
-    /**
-     * this method simply takes a valid route, and resolves what module class method the route points to
-     *
-     * @param string $key
-     * @param string $current_route
-     * @return EED_Module|object|boolean|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function resolve_route($key, $current_route)
-    {
-        // get module method that route has been mapped to
-        $module_method = EE_Config::get_route($current_route, $key);
-        // verify result was returned
-        if (empty($module_method)) {
-            $msg = sprintf(
-                esc_html__('The requested route %s could not be mapped to any registered modules.', 'event_espresso'),
-                $current_route
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // verify that result is an array
-        if (! is_array($module_method)) {
-            $msg = sprintf(esc_html__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // grab module name
-        $module_name = $module_method[0];
-        // verify that a class method was registered properly
-        if (! isset($module_method[1])) {
-            $msg = sprintf(
-                esc_html__('A class method for the %s  route has not been properly registered.', 'event_espresso'),
-                $current_route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // grab method
-        $method = $module_method[1];
-        // verify that class exists
-        if (! class_exists($module_name)) {
-            $msg = sprintf(esc_html__('The requested %s class could not be found.', 'event_espresso'), $module_name);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // verify that method exists
-        if (! method_exists($module_name, $method)) {
-            $msg = sprintf(
-                esc_html__('The class method %s for the %s route is in invalid.', 'event_espresso'),
-                $method,
-                $current_route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // instantiate module and call route method
-        return $this->_module_router($module_name, $method);
-    }
+	/**
+	 * this method simply takes a valid route, and resolves what module class method the route points to
+	 *
+	 * @param string $key
+	 * @param string $current_route
+	 * @return EED_Module|object|boolean|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function resolve_route($key, $current_route)
+	{
+		// get module method that route has been mapped to
+		$module_method = EE_Config::get_route($current_route, $key);
+		// verify result was returned
+		if (empty($module_method)) {
+			$msg = sprintf(
+				esc_html__('The requested route %s could not be mapped to any registered modules.', 'event_espresso'),
+				$current_route
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// verify that result is an array
+		if (! is_array($module_method)) {
+			$msg = sprintf(esc_html__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// grab module name
+		$module_name = $module_method[0];
+		// verify that a class method was registered properly
+		if (! isset($module_method[1])) {
+			$msg = sprintf(
+				esc_html__('A class method for the %s  route has not been properly registered.', 'event_espresso'),
+				$current_route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// grab method
+		$method = $module_method[1];
+		// verify that class exists
+		if (! class_exists($module_name)) {
+			$msg = sprintf(esc_html__('The requested %s class could not be found.', 'event_espresso'), $module_name);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// verify that method exists
+		if (! method_exists($module_name, $method)) {
+			$msg = sprintf(
+				esc_html__('The class method %s for the %s route is in invalid.', 'event_espresso'),
+				$method,
+				$current_route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// instantiate module and call route method
+		return $this->_module_router($module_name, $method);
+	}
 
 
-    /**
-     * this method instantiates modules and calls the method that was defined when the route was registered
-     *
-     * @param string $module_name
-     * @return EED_Module|object|null
-     */
-    public static function module_factory($module_name)
-    {
-        if ($module_name === 'EED_Module') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'EED_Module is an abstract parent class an can not be instantiated. Please provide a proper module name.',
-                        'event_espresso'
-                    ),
-                    $module_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        // instantiate module class
-        $module = new $module_name();
-        // ensure that class is actually a module
-        if (! $module instanceof EED_Module) {
-            EE_Error::add_error(
-                sprintf(esc_html__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $module;
-    }
+	/**
+	 * this method instantiates modules and calls the method that was defined when the route was registered
+	 *
+	 * @param string $module_name
+	 * @return EED_Module|object|null
+	 */
+	public static function module_factory($module_name)
+	{
+		if ($module_name === 'EED_Module') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'EED_Module is an abstract parent class an can not be instantiated. Please provide a proper module name.',
+						'event_espresso'
+					),
+					$module_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		// instantiate module class
+		$module = new $module_name();
+		// ensure that class is actually a module
+		if (! $module instanceof EED_Module) {
+			EE_Error::add_error(
+				sprintf(esc_html__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $module;
+	}
 
 
-    /**
-     * this method instantiates modules and calls the method that was defined when the route was registered
-     *
-     * @param string $module_name
-     * @param string $method
-     * @return EED_Module|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _module_router($module_name, $method)
-    {
-        // instantiate module class
-        $module = EE_Module_Request_Router::module_factory($module_name);
-        if ($module instanceof EED_Module) {
-            // and call whatever action the route was for
-            try {
-                $module->{$method}($this->WP_Query);
-            } catch (EE_Error $e) {
-                $e->get_error();
-                return null;
-            }
-        }
-        return $module;
-    }
+	/**
+	 * this method instantiates modules and calls the method that was defined when the route was registered
+	 *
+	 * @param string $module_name
+	 * @param string $method
+	 * @return EED_Module|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _module_router($module_name, $method)
+	{
+		// instantiate module class
+		$module = EE_Module_Request_Router::module_factory($module_name);
+		if ($module instanceof EED_Module) {
+			// and call whatever action the route was for
+			try {
+				$module->{$method}($this->WP_Query);
+			} catch (EE_Error $e) {
+				$e->get_error();
+				return null;
+			}
+		}
+		return $module;
+	}
 
 
-    /**
-     * @param $current_route
-     * @return string
-     */
-    public function get_forward($current_route)
-    {
-        return EE_Config::get_forward($current_route);
-    }
+	/**
+	 * @param $current_route
+	 * @return string
+	 */
+	public function get_forward($current_route)
+	{
+		return EE_Config::get_forward($current_route);
+	}
 
 
-    /**
-     * @param $current_route
-     * @return string
-     */
-    public function get_view($current_route)
-    {
-        return EE_Config::get_view($current_route);
-    }
+	/**
+	 * @param $current_route
+	 * @return string
+	 */
+	public function get_view($current_route)
+	{
+		return EE_Config::get_view($current_route);
+	}
 }

core/db_classes/EE_Message_Template.class.php

Spacing +1 added lines, -1 removed lines

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

Indentation +169 added lines, -169 removed lines

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

core/services/container/CoffeeMaker.php

Spacing +2 added lines, -2 removed lines

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

Indentation +152 added lines, -152 removed lines

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

core/services/container/Recipe.php

Spacing +5 added lines, -5 removed lines

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

Indentation +307 added lines, -307 removed lines

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

core/services/container/CoffeeShop.php

Spacing +11 added lines, -11 removed lines

@@ -159,7 +159,7 @@ 
         }
         // 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)) {
+        if ( ! $this->reservoir->has($identifier)) {
             // so let's brew something up and add it to the proper collection
             $brewed = $this->makeCoffee($identifier, $arguments, $type);
         }
@@ -284,7 +284,7 @@ 
      */
     public function addClosure($identifier, $closure)
     {
-        if (! is_callable($closure)) {
+        if ( ! is_callable($closure)) {
             throw new InvalidDataTypeException('$closure', $closure, 'Closure');
         }
         $identifier = $this->processIdentifier($identifier);
@@ -393,7 +393,7 @@ 
             // 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;
+                $matches[strlen($wildcard)] = $default_recipe;
             }
         }
         if (count($matches) > 0) {
@@ -433,7 +433,7 @@ 
         }
         $identifier = $this->processIdentifier($identifier);
         foreach ((array) $aliases as $alias) {
-            $this->filters[ $this->processIdentifier($alias) ] = $identifier;
+            $this->filters[$this->processIdentifier($alias)] = $identifier;
         }
     }
 
@@ -475,8 +475,8 @@ 
     private function filterIdentifier($identifier)
     {
         $identifier = $this->processIdentifier($identifier);
-        return isset($this->filters[ $identifier ]) && ! empty($this->filters[ $identifier ])
-            ? $this->filters[ $identifier ]
+        return isset($this->filters[$identifier]) && ! empty($this->filters[$identifier])
+            ? $this->filters[$identifier]
             : $identifier;
     }
 
@@ -491,7 +491,7 @@ 
      */
     private function processIdentifier($identifier)
     {
-        if (! is_string($identifier)) {
+        if ( ! is_string($identifier)) {
             throw new InvalidIdentifierException(
                 is_object($identifier) ? get_class($identifier) : gettype($identifier),
                 '\Fully\Qualified\ClassName'
@@ -510,7 +510,7 @@ 
      */
     private function getCoffeeMaker($type)
     {
-        if (! $this->coffee_makers->has($type)) {
+        if ( ! $this->coffee_makers->has($type)) {
             throw new OutOfBoundsException(
                 esc_html__('The requested coffee maker is either missing or invalid.', 'event_espresso')
             );
@@ -537,7 +537,7 @@ 
             // 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();
+                $default_recipes[str_replace('*', '', $identifier)] = $this->recipes->current();
             }
             $this->recipes->next();
         }
@@ -557,7 +557,7 @@ 
     private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
     {
         $recipe = clone $default_recipe;
-        if (! empty($type)) {
+        if ( ! empty($type)) {
             $recipe->setType($type);
         }
         // is this the base default recipe ?
@@ -587,7 +587,7 @@ 
      */
     private function validateService($identifier, $service)
     {
-        if (! is_object($service)) {
+        if ( ! is_object($service)) {
             throw new InvalidServiceException(
                 $identifier,
                 $service

Indentation +565 added lines, -565 removed lines

@@ -28,569 +28,569 @@
  */
 class CoffeeShop implements CoffeePotInterface
 {
-    /**
-     * 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;
-
-    /**
-     * These are the classes that will actually build the objects (to order of course)
-     *
-     * @var array $coffee_makers
-     */
-    private $coffee_makers;
-
-    /**
-     * 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
-     *
-     * @throws InvalidInterfaceException
-     */
-    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 us 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
-     * @throws InvalidIdentifierException
-     */
-    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 InvalidIdentifierException
-     * @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 OutOfBoundsException
-     * @throws InstantiationException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidIdentifierException
-     * @throws ServiceExistsException
-     * @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);
-        // is a shared service being requested and already exists in the carafe?
-        $brewed = $this->getShared($identifier, $type);
-        // then return whatever was found
-        if ($brewed !== false) {
-            return $brewed;
-        }
-        // 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);
-        }
-        // did the requested class only require loading, and if so, was that successful?
-        if ($this->brewedLoadOnly($brewed, $identifier, $type) === true) {
-            return true;
-        }
-        // was the brewed item a callable factory function ?
-        if (is_callable($brewed)) {
-            // then instantiate a new entity from the cached closure
-            return $brewed($arguments);
-        }
-        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
-            return $this->get($identifier);
-        }
-        // if identifier is for a non-shared entity,
-        // then either a cached closure already existed, or was just brewed
-        return $this->brewedClosure($identifier, $arguments);
-    }
-
-
-    /**
-     * @param string $identifier
-     * @param string $type
-     * @return bool|mixed
-     * @throws InvalidIdentifierException
-     */
-    protected function getShared($identifier, $type)
-    {
-        try {
-            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
-        }
-        return false;
-    }
-
-
-    /**
-     * @param mixed  $brewed
-     * @param string $identifier
-     * @param string $type
-     * @return bool
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidIdentifierException
-     * @throws OutOfBoundsException
-     * @throws ServiceExistsException
-     * @throws ServiceNotFoundException
-     */
-    protected function brewedLoadOnly($brewed, $identifier, $type)
-    {
-        if ($type === CoffeeMaker::BREW_LOAD_ONLY) {
-            if ($brewed !== true) {
-                throw new ServiceNotFoundException(
-                    sprintf(
-                        esc_html__(
-                            'The "%1$s" class could not be loaded.',
-                            'event_espresso'
-                        ),
-                        $identifier
-                    )
-                );
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * @param string $identifier
-     * @param array  $arguments
-     * @return mixed
-     * @throws InstantiationException
-     */
-    protected function brewedClosure($identifier, array $arguments)
-    {
-        $closure = $this->reservoir->get($identifier);
-        if (empty($closure)) {
-            throw new InstantiationException(
-                sprintf(
-                    esc_html__(
-                        'Could not brew an instance of "%1$s".',
-                        'event_espresso'
-                    ),
-                    $identifier
-                )
-            );
-        }
-        return $closure($arguments);
-    }
-
-
-    /**
-     * @param CoffeeMakerInterface $coffee_maker
-     * @param string               $type
-     * @return bool
-     * @throws InvalidIdentifierException
-     * @throws InvalidEntityException
-     */
-    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
-     * @throws InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     */
-    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
-     * @throws InvalidIdentifierException
-     */
-    public function removeClosure($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->reservoir->has($identifier)) {
-            return $this->reservoir->remove($this->reservoir->get($identifier));
-        }
-        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
-     * @throws \EventEspresso\core\services\container\exceptions\InvalidServiceException
-     * @throws InvalidIdentifierException
-     */
-    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
-     * @throws InvalidIdentifierException
-     */
-    public function removeService($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->carafe->has($identifier)) {
-            return $this->carafe->remove($this->carafe->get($identifier));
-        }
-        return false;
-    }
-
-
-    /**
-     * Adds instructions on how to brew objects
-     *
-     * @param RecipeInterface $recipe
-     * @return mixed
-     * @throws InvalidIdentifierException
-     */
-    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
-     * @throws InvalidIdentifierException
-     */
-    public function removeRecipe($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->recipes->has($identifier)) {
-            return $this->recipes->remove($this->recipes->get($identifier));
-        }
-        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
-     * @throws OutOfBoundsException
-     * @throws InvalidIdentifierException
-     */
-    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(
-                esc_html__('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 InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws OutOfBoundsException
-     * @throws InvalidIdentifierException
-     * @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 OutOfBoundsException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    private function getCoffeeMaker($type)
-    {
-        if (! $this->coffee_makers->has($type)) {
-            throw new OutOfBoundsException(
-                esc_html__('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 mixed
-     * @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;
+
+	/**
+	 * These are the classes that will actually build the objects (to order of course)
+	 *
+	 * @var array $coffee_makers
+	 */
+	private $coffee_makers;
+
+	/**
+	 * 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
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	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 us 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
+	 * @throws InvalidIdentifierException
+	 */
+	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 InvalidIdentifierException
+	 * @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 OutOfBoundsException
+	 * @throws InstantiationException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidIdentifierException
+	 * @throws ServiceExistsException
+	 * @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);
+		// is a shared service being requested and already exists in the carafe?
+		$brewed = $this->getShared($identifier, $type);
+		// then return whatever was found
+		if ($brewed !== false) {
+			return $brewed;
+		}
+		// 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);
+		}
+		// did the requested class only require loading, and if so, was that successful?
+		if ($this->brewedLoadOnly($brewed, $identifier, $type) === true) {
+			return true;
+		}
+		// was the brewed item a callable factory function ?
+		if (is_callable($brewed)) {
+			// then instantiate a new entity from the cached closure
+			return $brewed($arguments);
+		}
+		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
+			return $this->get($identifier);
+		}
+		// if identifier is for a non-shared entity,
+		// then either a cached closure already existed, or was just brewed
+		return $this->brewedClosure($identifier, $arguments);
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @param string $type
+	 * @return bool|mixed
+	 * @throws InvalidIdentifierException
+	 */
+	protected function getShared($identifier, $type)
+	{
+		try {
+			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
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param mixed  $brewed
+	 * @param string $identifier
+	 * @param string $type
+	 * @return bool
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidIdentifierException
+	 * @throws OutOfBoundsException
+	 * @throws ServiceExistsException
+	 * @throws ServiceNotFoundException
+	 */
+	protected function brewedLoadOnly($brewed, $identifier, $type)
+	{
+		if ($type === CoffeeMaker::BREW_LOAD_ONLY) {
+			if ($brewed !== true) {
+				throw new ServiceNotFoundException(
+					sprintf(
+						esc_html__(
+							'The "%1$s" class could not be loaded.',
+							'event_espresso'
+						),
+						$identifier
+					)
+				);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws InstantiationException
+	 */
+	protected function brewedClosure($identifier, array $arguments)
+	{
+		$closure = $this->reservoir->get($identifier);
+		if (empty($closure)) {
+			throw new InstantiationException(
+				sprintf(
+					esc_html__(
+						'Could not brew an instance of "%1$s".',
+						'event_espresso'
+					),
+					$identifier
+				)
+			);
+		}
+		return $closure($arguments);
+	}
+
+
+	/**
+	 * @param CoffeeMakerInterface $coffee_maker
+	 * @param string               $type
+	 * @return bool
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidEntityException
+	 */
+	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
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 */
+	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
+	 * @throws InvalidIdentifierException
+	 */
+	public function removeClosure($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->reservoir->has($identifier)) {
+			return $this->reservoir->remove($this->reservoir->get($identifier));
+		}
+		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
+	 * @throws \EventEspresso\core\services\container\exceptions\InvalidServiceException
+	 * @throws InvalidIdentifierException
+	 */
+	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
+	 * @throws InvalidIdentifierException
+	 */
+	public function removeService($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->carafe->has($identifier)) {
+			return $this->carafe->remove($this->carafe->get($identifier));
+		}
+		return false;
+	}
+
+
+	/**
+	 * Adds instructions on how to brew objects
+	 *
+	 * @param RecipeInterface $recipe
+	 * @return mixed
+	 * @throws InvalidIdentifierException
+	 */
+	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
+	 * @throws InvalidIdentifierException
+	 */
+	public function removeRecipe($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->recipes->has($identifier)) {
+			return $this->recipes->remove($this->recipes->get($identifier));
+		}
+		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
+	 * @throws OutOfBoundsException
+	 * @throws InvalidIdentifierException
+	 */
+	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(
+				esc_html__('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 InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws OutOfBoundsException
+	 * @throws InvalidIdentifierException
+	 * @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 OutOfBoundsException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	private function getCoffeeMaker($type)
+	{
+		if (! $this->coffee_makers->has($type)) {
+			throw new OutOfBoundsException(
+				esc_html__('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 mixed
+	 * @throws InvalidServiceException
+	 */
+	private function validateService($identifier, $service)
+	{
+		if (! is_object($service)) {
+			throw new InvalidServiceException(
+				$identifier,
+				$service
+			);
+		}
+		return $service;
+	}
 }

core/helpers/EEH_Template_Validator.helper.php

Spacing +13 added lines, -13 removed lines

@@ -40,10 +40,10 @@ 
      */
     public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ('allow_null' == $allow_null && is_null($variable_to_test)) {
             return;
         }
@@ -66,7 +66,7 @@ 
      */
     public static function verify_isnt_null($variable_to_test, $name_of_variable)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
         if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
@@ -86,10 +86,10 @@ 
      */
     public static function verify_is_true($expression_to_test, $expression_string_representation)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!$expression_to_test) {
+        if ( ! $expression_to_test) {
             $error[] = esc_html__('Template error.', 'event_espresso');
             $error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
@@ -110,14 +110,14 @@ 
      */
     public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
             return;
         }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
+        if ($variable_to_test == null || ! ($variable_to_test instanceof $class_name)) {
             $msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
             $msg[] = esc_html__("It should be of type %s", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
@@ -138,14 +138,14 @@ 
      */
     public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
+        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty', 'do_not_allow_empty'));
         if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
             return;
         }
-        if (!is_array($variable_to_test)) {
+        if ( ! is_array($variable_to_test)) {
             $error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
             $error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
@@ -168,10 +168,10 @@ 
      */
     public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!in_array($variable_to_test, $string_options)) {
+        if ( ! in_array($variable_to_test, $string_options)) {
             $msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
             $msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));

Indentation +148 added lines, -148 removed lines

@@ -24,152 +24,152 @@
  */
 class EEH_Template_Validator
 {
-    /**
-     * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful in throwing intelligent errors
-     * @param string $class_name eg EE_Answer, EE_Transaction, etc.
-     * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
-     * @return void
-     * @throws EE_Error (indirectly)
-     */
-    public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ('allow_null' == $allow_null && is_null($variable_to_test)) {
-            return;
-        }
-        self::verify_is_array($variable_to_test, $name_of_variable);
-        foreach ($variable_to_test as $key => $array_element) {
-            self::verify_instanceof($array_element, $key, $class_name);
-        }
-    }
-
-
-
-
-
-    /**
-     * throws an EE_Error if $variable_to_test is null
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful for throwing intelligent errors
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_isnt_null($variable_to_test, $name_of_variable)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
-            $error[] = esc_html__('Variable named %s is null.', 'event_espresso');
-            $error[] = esc_html__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
-        }
-    }
-
-    /**
-     * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
-     * @param boolean $expression_to_test
-     * @param string $expression_string_representation a string representation of your expression
-     * for example, if your expression were $var1==23, then this should be '$var1==23'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_true($expression_to_test, $expression_string_representation)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!$expression_to_test) {
-            $error[] = esc_html__('Template error.', 'event_espresso');
-            $error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
-        }
-    }
-
-
-
-
-
-    /**
-     * For verifying that a variable is indeed an object of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful when throwing errors
-     * @param string $class_name eg, EE_Answer,
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
-            return;
-        }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
-            $msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
-            $msg[] = esc_html__("It should be of type %s", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
-        }
-    }
-
-
-
-
-
-    /**
-     * For verifying that a variable is indeed an array, else throw an EE_Error
-     * @param type $variable_to_test
-     * @param type $variable_name
-     * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
-        if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
-            return;
-        }
-        if (!is_array($variable_to_test)) {
-            $error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
-            $error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
-        }
-    }
-
-
-
-
-
-
-
-    /**
-     * for verifying that a variable is one of the string optiosn supplied
-     * @param mixed $variable_to_test
-     * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
-     * @param array $string_options an array of acceptable values
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!in_array($variable_to_test, $string_options)) {
-            $msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
-            $msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
-        }
-    }
+	/**
+	 * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful in throwing intelligent errors
+	 * @param string $class_name eg EE_Answer, EE_Transaction, etc.
+	 * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
+	 * @return void
+	 * @throws EE_Error (indirectly)
+	 */
+	public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ('allow_null' == $allow_null && is_null($variable_to_test)) {
+			return;
+		}
+		self::verify_is_array($variable_to_test, $name_of_variable);
+		foreach ($variable_to_test as $key => $array_element) {
+			self::verify_instanceof($array_element, $key, $class_name);
+		}
+	}
+
+
+
+
+
+	/**
+	 * throws an EE_Error if $variable_to_test is null
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful for throwing intelligent errors
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_isnt_null($variable_to_test, $name_of_variable)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
+			$error[] = esc_html__('Variable named %s is null.', 'event_espresso');
+			$error[] = esc_html__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
+		}
+	}
+
+	/**
+	 * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
+	 * @param boolean $expression_to_test
+	 * @param string $expression_string_representation a string representation of your expression
+	 * for example, if your expression were $var1==23, then this should be '$var1==23'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_true($expression_to_test, $expression_string_representation)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!$expression_to_test) {
+			$error[] = esc_html__('Template error.', 'event_espresso');
+			$error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
+		}
+	}
+
+
+
+
+
+	/**
+	 * For verifying that a variable is indeed an object of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful when throwing errors
+	 * @param string $class_name eg, EE_Answer,
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
+			return;
+		}
+		if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
+			$msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
+			$msg[] = esc_html__("It should be of type %s", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
+		}
+	}
+
+
+
+
+
+	/**
+	 * For verifying that a variable is indeed an array, else throw an EE_Error
+	 * @param type $variable_to_test
+	 * @param type $variable_name
+	 * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
+		if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
+			return;
+		}
+		if (!is_array($variable_to_test)) {
+			$error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
+			$error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
+		}
+	}
+
+
+
+
+
+
+
+	/**
+	 * for verifying that a variable is one of the string optiosn supplied
+	 * @param mixed $variable_to_test
+	 * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
+	 * @param array $string_options an array of acceptable values
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!in_array($variable_to_test, $string_options)) {
+			$msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
+			$msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
+		}
+	}
 }

core/exceptions/InvalidStatusException.php

Indentation +22 added lines, -22 removed lines

@@ -7,26 +7,26 @@
 
 class InvalidStatusException extends InvalidArgumentException
 {
-    /**
-     * InvalidStatusException constructor.
-     * @param string $status the invalid status id that was supplied
-     * @param string $domain the name of the domain, model, or class that the status belongs to
-     * @param string $message custom message
-     * @param int $code
-     * @param Exception|null $previous
-     */
-    public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    '"%1$s" is not a valid %2$s status',
-                    'event_espresso'
-                ),
-                $status,
-                $domain
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidStatusException constructor.
+	 * @param string $status the invalid status id that was supplied
+	 * @param string $domain the name of the domain, model, or class that the status belongs to
+	 * @param string $message custom message
+	 * @param int $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'"%1$s" is not a valid %2$s status',
+					'event_espresso'
+				),
+				$status,
+				$domain
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }