eventespresso / event-espresso-core

core/services/commands/transaction/CreateTransactionCommand.php

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
     public function getCapCheck()
     {
         // need cap for non-AJAX admin requests
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
             // there's no specific caps for editing/creating transactions,
             // so that's why we are using ee_edit_registrations
             return new CapCheck('ee_edit_registrations', 'create_new_transaction');

Indentation +47 added lines, -47 removed lines

@@ -20,60 +20,60 @@
 class CreateTransactionCommand extends Command implements CommandRequiresCapCheckInterface
 {
 
-    /**
-     * @var EE_Checkout $checkout
-     */
-    protected $checkout;
+	/**
+	 * @var EE_Checkout $checkout
+	 */
+	protected $checkout;
 
-    /**
-     * @var array $transaction_details
-     */
-    protected $transaction_details;
+	/**
+	 * @var array $transaction_details
+	 */
+	protected $transaction_details;
 
 
-    /**
-     * CreateTransactionCommand constructor.
-     *
-     * @param EE_Checkout $checkout
-     * @param array       $transaction_details
-     */
-    public function __construct(EE_Checkout $checkout = null, array $transaction_details = array())
-    {
-        $this->checkout = $checkout;
-        $this->transaction_details = $transaction_details;
-    }
+	/**
+	 * CreateTransactionCommand constructor.
+	 *
+	 * @param EE_Checkout $checkout
+	 * @param array       $transaction_details
+	 */
+	public function __construct(EE_Checkout $checkout = null, array $transaction_details = array())
+	{
+		$this->checkout = $checkout;
+		$this->transaction_details = $transaction_details;
+	}
 
 
-    /**
-     * @return CapCheckInterface
-     * @throws InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        // need cap for non-AJAX admin requests
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-            // there's no specific caps for editing/creating transactions,
-            // so that's why we are using ee_edit_registrations
-            return new CapCheck('ee_edit_registrations', 'create_new_transaction');
-        }
-        return new PublicCapabilities('', 'create_new_transaction');
-    }
+	/**
+	 * @return CapCheckInterface
+	 * @throws InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		// need cap for non-AJAX admin requests
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+			// there's no specific caps for editing/creating transactions,
+			// so that's why we are using ee_edit_registrations
+			return new CapCheck('ee_edit_registrations', 'create_new_transaction');
+		}
+		return new PublicCapabilities('', 'create_new_transaction');
+	}
 
 
-    /**
-     * @return EE_Checkout
-     */
-    public function checkout()
-    {
-        return $this->checkout;
-    }
+	/**
+	 * @return EE_Checkout
+	 */
+	public function checkout()
+	{
+		return $this->checkout;
+	}
 
 
-    /**
-     * @return array
-     */
-    public function transactionDetails()
-    {
-        return $this->transaction_details;
-    }
+	/**
+	 * @return array
+	 */
+	public function transactionDetails()
+	{
+		return $this->transaction_details;
+	}
 }

core/services/commands/transaction/CreateTransactionCommandHandler.php

Indentation +38 added lines, -38 removed lines

@@ -26,44 +26,44 @@
 {
 
 
-    /**
-     * @param CommandInterface $command
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidEntityException
-     */
-    public function handle(CommandInterface $command)
-    {
-        /** @var CreateTransactionCommand $command */
-        if (! $command instanceof CreateTransactionCommand) {
-            throw new InvalidEntityException(get_class($command), 'CreateTransactionCommand');
-        }
-        $transaction_details = $command->transactionDetails();
-        $cart_total = null;
-        if ($command->checkout() instanceof EE_Checkout) {
-            // ensure cart totals have been calculated
-            $command->checkout()->cart->get_grand_total()->recalculate_total_including_taxes();
-            // grab the cart grand total
-            $cart_total = $command->checkout()->cart->get_cart_grand_total();
-            $transaction_details['TXN_reg_steps'] = $command->checkout()->initialize_txn_reg_steps_array();
-            $transaction_details['TXN_total'] = $cart_total > 0 ? $cart_total : 0;
-        }
-        // create new TXN and save it so it has an ID
-        $transaction = EE_Transaction::new_instance($transaction_details);
-        if (! $transaction instanceof EE_Transaction) {
-            throw new InvalidEntityException(get_class($transaction), 'EE_Transaction');
-        }
-        $transaction->save();
-        // ensure grand total line item created
-        $cart_total = $cart_total instanceof EE_Line_Item
-            ? $cart_total
-            : EEH_Line_Item::create_total_line_item($transaction);
-        if (! $cart_total instanceof EE_Line_Item) {
-            throw new InvalidEntityException(get_class($cart_total), 'EE_Line_Item');
-        }
-        $cart_total->save_this_and_descendants_to_txn($transaction->ID());
-        return $transaction;
-    }
+	/**
+	 * @param CommandInterface $command
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidEntityException
+	 */
+	public function handle(CommandInterface $command)
+	{
+		/** @var CreateTransactionCommand $command */
+		if (! $command instanceof CreateTransactionCommand) {
+			throw new InvalidEntityException(get_class($command), 'CreateTransactionCommand');
+		}
+		$transaction_details = $command->transactionDetails();
+		$cart_total = null;
+		if ($command->checkout() instanceof EE_Checkout) {
+			// ensure cart totals have been calculated
+			$command->checkout()->cart->get_grand_total()->recalculate_total_including_taxes();
+			// grab the cart grand total
+			$cart_total = $command->checkout()->cart->get_cart_grand_total();
+			$transaction_details['TXN_reg_steps'] = $command->checkout()->initialize_txn_reg_steps_array();
+			$transaction_details['TXN_total'] = $cart_total > 0 ? $cart_total : 0;
+		}
+		// create new TXN and save it so it has an ID
+		$transaction = EE_Transaction::new_instance($transaction_details);
+		if (! $transaction instanceof EE_Transaction) {
+			throw new InvalidEntityException(get_class($transaction), 'EE_Transaction');
+		}
+		$transaction->save();
+		// ensure grand total line item created
+		$cart_total = $cart_total instanceof EE_Line_Item
+			? $cart_total
+			: EEH_Line_Item::create_total_line_item($transaction);
+		if (! $cart_total instanceof EE_Line_Item) {
+			throw new InvalidEntityException(get_class($cart_total), 'EE_Line_Item');
+		}
+		$cart_total->save_this_and_descendants_to_txn($transaction->ID());
+		return $transaction;
+	}
 
 
 }

Spacing +3 added lines, -3 removed lines

@@ -35,7 +35,7 @@ 
     public function handle(CommandInterface $command)
     {
         /** @var CreateTransactionCommand $command */
-        if (! $command instanceof CreateTransactionCommand) {
+        if ( ! $command instanceof CreateTransactionCommand) {
             throw new InvalidEntityException(get_class($command), 'CreateTransactionCommand');
         }
         $transaction_details = $command->transactionDetails();
@@ -50,7 +50,7 @@ 
         }
         // create new TXN and save it so it has an ID
         $transaction = EE_Transaction::new_instance($transaction_details);
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             throw new InvalidEntityException(get_class($transaction), 'EE_Transaction');
         }
         $transaction->save();
@@ -58,7 +58,7 @@ 
         $cart_total = $cart_total instanceof EE_Line_Item
             ? $cart_total
             : EEH_Line_Item::create_total_line_item($transaction);
-        if (! $cart_total instanceof EE_Line_Item) {
+        if ( ! $cart_total instanceof EE_Line_Item) {
             throw new InvalidEntityException(get_class($cart_total), 'EE_Line_Item');
         }
         $cart_total->save_this_and_descendants_to_txn($transaction->ID());

core/services/commands/attendee/CreateAttendeeCommand.php

Spacing +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
     public function getCapCheck()
     {
         // need cap for non-AJAX admin requests
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
             return new CapCheck('ee_edit_contacts', 'create_new_contact');
         }
         return new PublicCapabilities('', 'create_new_contact');

Indentation +49 added lines, -49 removed lines

@@ -20,62 +20,62 @@
 class CreateAttendeeCommand extends Command implements CommandRequiresCapCheckInterface
 {
 
-    /**
-     * array of details where keys are names of EEM_Attendee model fields
-     *
-     * @var array $attendee_details
-     */
-    protected $attendee_details;
+	/**
+	 * array of details where keys are names of EEM_Attendee model fields
+	 *
+	 * @var array $attendee_details
+	 */
+	protected $attendee_details;
 
-    /**
-     * an existing registration to associate this attendee with
-     *
-     * @var EE_Registration $registration
-     */
-    protected $registration;
+	/**
+	 * an existing registration to associate this attendee with
+	 *
+	 * @var EE_Registration $registration
+	 */
+	protected $registration;
 
 
-    /**
-     * CreateAttendeeCommand constructor.
-     *
-     * @param array           $attendee_details
-     * @param EE_Registration $registration
-     */
-    public function __construct(array $attendee_details, EE_Registration $registration)
-    {
-        $this->attendee_details = $attendee_details;
-        $this->registration = $registration;
-    }
+	/**
+	 * CreateAttendeeCommand constructor.
+	 *
+	 * @param array           $attendee_details
+	 * @param EE_Registration $registration
+	 */
+	public function __construct(array $attendee_details, EE_Registration $registration)
+	{
+		$this->attendee_details = $attendee_details;
+		$this->registration = $registration;
+	}
 
 
-    /**
-     * @return array
-     */
-    public function attendeeDetails()
-    {
-        return $this->attendee_details;
-    }
+	/**
+	 * @return array
+	 */
+	public function attendeeDetails()
+	{
+		return $this->attendee_details;
+	}
 
 
-    /**
-     * @return EE_Registration
-     */
-    public function registration()
-    {
-        return $this->registration;
-    }
+	/**
+	 * @return EE_Registration
+	 */
+	public function registration()
+	{
+		return $this->registration;
+	}
 
 
-    /**
-     * @return CapCheckInterface
-     * @throws InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        // need cap for non-AJAX admin requests
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-            return new CapCheck('ee_edit_contacts', 'create_new_contact');
-        }
-        return new PublicCapabilities('', 'create_new_contact');
-    }
+	/**
+	 * @return CapCheckInterface
+	 * @throws InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		// need cap for non-AJAX admin requests
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+			return new CapCheck('ee_edit_contacts', 'create_new_contact');
+		}
+		return new PublicCapabilities('', 'create_new_contact');
+	}
 }

core/libraries/rest_api/controllers/Base.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use WP_Error;
 use WP_REST_Response;
 use EventEspresso\core\libraries\rest_api\RestException;
-
 use EE_Error;
 use EED_Core_Rest_Api;
 use EEH_Inflector;

Spacing +12 added lines, -12 removed lines

@@ -96,7 +96,7 @@ 
      */
     protected function setDebugInfo($key, $info)
     {
-        $this->debug_info[ $key ] = $info;
+        $this->debug_info[$key] = $info;
     }
 
 
@@ -113,11 +113,11 @@ 
     {
         if (is_array($value)) {
             foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+                $this->setResponseHeader($header_key.'['.$value_key.']', $value_value);
             }
         } else {
             $prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[ $prefix . $header_key ] = $value;
+            $this->response_headers[$prefix.$header_key] = $value;
         }
     }
 
@@ -147,7 +147,7 @@ 
     protected function addEeErrorsToResponse(WP_Error $wp_error_response)
     {
         $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
+        if ( ! empty($notices_during_checkin['errors'])) {
             foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
                 $wp_error_response->add(
                     sanitize_key($error_code),
@@ -190,7 +190,7 @@ 
                 if (is_array($debug_info)) {
                     $debug_info = wp_json_encode($debug_info);
                 }
-                $headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
+                $headers['X-EE4-Debug-'.ucwords($debug_key)] = $debug_info;
             }
         }
         $headers = array_merge(
@@ -249,15 +249,15 @@ 
         $headers = array();
         $notices = EE_Error::get_raw_notices();
         foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
+            if ( ! is_array($sub_notices)) {
                 continue;
             }
             foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers[ 'X-EE4-Notices-'
+                $headers['X-EE4-Notices-'
                           . EEH_Inflector::humanize($notice_type)
                           . '['
                           . $notice_code
-                          . ']' ] = strip_tags($sub_notice);
+                          . ']'] = strip_tags($sub_notice);
             }
         }
         return apply_filters(
@@ -286,7 +286,7 @@ 
         }
         $matches = $this->parseRoute(
             $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+            '~'.EED_Core_Rest_Api::ee_api_namespace_for_regex.'~',
             array('version')
         );
         if (isset($matches['version'])) {
@@ -320,14 +320,14 @@ 
         if (is_array($matches)) {
             // skip the overall regex match. Who cares
             for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[ $i ])) {
+                if ( ! isset($matches[$i])) {
                     $success = false;
                 } else {
-                    $indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
+                    $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
                 }
             }
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new EE_Error(
                 __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
                 'endpoint_parsing_error'

Indentation +334 added lines, -334 removed lines

@@ -22,338 +22,338 @@
 class Base
 {
 
-    /**
-     * @deprecated use all-caps version
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_ee = 'X-EE-';
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_EE = 'X-EE-';
-
-    /**
-     * @deprecated use all-caps version instead
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_wp = 'X-WP-';
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_WP = 'X-WP-';
-
-    /**
-     * Contains debug info we'll send back in the response headers
-     *
-     * @var array
-     */
-    protected $debug_info = array();
-
-    /**
-     * Indicates whether or not the API is in debug mode
-     *
-     * @var boolean
-     */
-    protected $debug_mode = false;
-
-    /**
-     * Indicates the version that was requested
-     *
-     * @var string
-     */
-    protected $requested_version;
-
-    /**
-     * flat array of headers to send in the response
-     *
-     * @var array
-     */
-    protected $response_headers = array();
-
-
-    public function __construct()
-    {
-        $this->debug_mode = EED_Core_Rest_Api::debugMode();
-        // we are handling a REST request. Don't show a fancy HTML error message is any error comes up
-        add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
-    }
-
-
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function setRequestedVersion($version)
-    {
-        $this->requested_version = $version;
-    }
-
-
-    /**
-     * Sets some debug info that we'll send back in headers
-     *
-     * @param string       $key
-     * @param string|array $info
-     */
-    protected function setDebugInfo($key, $info)
-    {
-        $this->debug_info[ $key ] = $info;
-    }
-
-
-    /**
-     * Sets headers for the response
-     *
-     * @param string       $header_key    , excluding the "X-EE-" part
-     * @param array|string $value         if an array, multiple headers will be added, one
-     *                                    for each key in the array
-     * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
-     *                                    the standard WP one
-     */
-    protected function setResponseHeader($header_key, $value, $use_ee_prefix = true)
-    {
-        if (is_array($value)) {
-            foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
-            }
-        } else {
-            $prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[ $prefix . $header_key ] = $value;
-        }
-    }
-
-
-    /**
-     * Returns a flat array of headers to be added to the response
-     *
-     * @return array
-     */
-    protected function getResponseHeaders()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            $this->response_headers,
-            $this,
-            $this->requested_version
-        );
-    }
-
-
-    /**
-     * Adds error notices from EE_Error onto the provided \WP_Error
-     *
-     * @param WP_Error $wp_error_response
-     * @return WP_Error
-     */
-    protected function addEeErrorsToResponse(WP_Error $wp_error_response)
-    {
-        $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
-            foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
-                $wp_error_response->add(
-                    sanitize_key($error_code),
-                    strip_tags($error_message)
-                );
-            }
-        }
-        return $wp_error_response;
-    }
-
-
-    /**
-     * Sends a response, but also makes sure to attach headers that
-     * are handy for debugging.
-     * Specifically, we assume folks will want to know what exactly was the DB query that got run,
-     * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
-     * the response, others?
-     *
-     * @param array|WP_Error|Exception|RestException $response
-     * @return WP_REST_Response
-     */
-    public function sendResponse($response)
-    {
-        if ($response instanceof RestException) {
-            $response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
-        }
-        if ($response instanceof Exception) {
-            $code = $response->getCode() ? $response->getCode() : 'error_occurred';
-            $response = new WP_Error($code, $response->getMessage());
-        }
-        if ($response instanceof WP_Error) {
-            $response = $this->addEeErrorsToResponse($response);
-            $rest_response = $this->createRestResponseFromWpError($response);
-        } else {
-            $rest_response = new WP_REST_Response($response, 200);
-        }
-        $headers = array();
-        if ($this->debug_mode && is_array($this->debug_info)) {
-            foreach ($this->debug_info as $debug_key => $debug_info) {
-                if (is_array($debug_info)) {
-                    $debug_info = wp_json_encode($debug_info);
-                }
-                $headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
-            }
-        }
-        $headers = array_merge(
-            $headers,
-            $this->getResponseHeaders(),
-            $this->getHeadersFromEeNotices()
-        );
-        $rest_response->set_headers($headers);
-        return $rest_response;
-    }
-
-
-    /**
-     * Converts the \WP_Error into `WP_REST_Response.
-     * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
-     * (which is protected)
-     *
-     * @param WP_Error $wp_error
-     * @return WP_REST_Response
-     */
-    protected function createRestResponseFromWpError(WP_Error $wp_error)
-    {
-        $error_data = $wp_error->get_error_data();
-        if (is_array($error_data) && isset($error_data['status'])) {
-            $status = $error_data['status'];
-        } else {
-            $status = 500;
-        }
-        $errors = array();
-        foreach ((array) $wp_error->errors as $code => $messages) {
-            foreach ((array) $messages as $message) {
-                $errors[] = array(
-                    'code'    => $code,
-                    'message' => $message,
-                    'data'    => $wp_error->get_error_data($code),
-                );
-            }
-        }
-        $data = isset($errors[0]) ? $errors[0] : array();
-        if (count($errors) > 1) {
-            // Remove the primary error.
-            array_shift($errors);
-            $data['additional_errors'] = $errors;
-        }
-        return new WP_REST_Response($data, $status);
-    }
-
-
-    /**
-     * Array of headers derived from EE success, attention, and error messages
-     *
-     * @return array
-     */
-    protected function getHeadersFromEeNotices()
-    {
-        $headers = array();
-        $notices = EE_Error::get_raw_notices();
-        foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
-                continue;
-            }
-            foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers[ 'X-EE4-Notices-'
-                          . EEH_Inflector::humanize($notice_type)
-                          . '['
-                          . $notice_code
-                          . ']' ] = strip_tags($sub_notice);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            $headers,
-            $this->requested_version,
-            $notices
-        );
-    }
-
-
-    /**
-     * Finds which version of the API was requested given the route, and returns it.
-     * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
-     * "4.8.29".
-     * We should know hte requested version in this model though, so if no route is
-     * provided just use what we set earlier
-     *
-     * @param string $route
-     * @return string
-     */
-    public function getRequestedVersion($route = null)
-    {
-        if ($route === null) {
-            return $this->requested_version;
-        }
-        $matches = $this->parseRoute(
-            $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
-            array('version')
-        );
-        if (isset($matches['version'])) {
-            return $matches['version'];
-        } else {
-            return EED_Core_Rest_Api::latest_rest_api_version();
-        }
-    }
-
-
-    /**
-     * Applies the regex to the route, then creates an array using the values of
-     * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
-     * For example, if you call
-     * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
-     * it will return array( 'version' => '4.8', 'model' => 'events' )
-     *
-     * @param string $route
-     * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
-     * @return array where  $match_keys are the keys (the first value of $match_keys
-     *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
-     *                           array( 'model', 'id' ), will, if the regex is successful, will return
-     *                           array( 'model' => 'foo', 'id' => 'bar' )
-     * @throws EE_Error if it couldn't be parsed
-     */
-    public function parseRoute($route, $regex, $match_keys)
-    {
-        $indexed_matches = array();
-        $success = preg_match($regex, $route, $matches);
-        if (is_array($matches)) {
-            // skip the overall regex match. Who cares
-            for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[ $i ])) {
-                    $success = false;
-                } else {
-                    $indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
-                }
-            }
-        }
-        if (! $success) {
-            throw new EE_Error(
-                __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
-                'endpoint_parsing_error'
-            );
-        }
-        return $indexed_matches;
-    }
-
-
-    /**
-     * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
-     *
-     * @param \WP_REST_Request $request
-     * @return array
-     */
-    protected function getBodyParams(\WP_REST_Request $request)
-    {
-        // $request->get_params();
-        return array_merge(
-            (array) $request->get_body_params(),
-            (array) $request->get_json_params()
-        );
-        // return array_diff_key(
-        //    $request->get_params(),
-        //     $request->get_url_params(),
-        //     $request->get_query_params()
-        // );
-    }
+	/**
+	 * @deprecated use all-caps version
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_ee = 'X-EE-';
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_EE = 'X-EE-';
+
+	/**
+	 * @deprecated use all-caps version instead
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_wp = 'X-WP-';
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_WP = 'X-WP-';
+
+	/**
+	 * Contains debug info we'll send back in the response headers
+	 *
+	 * @var array
+	 */
+	protected $debug_info = array();
+
+	/**
+	 * Indicates whether or not the API is in debug mode
+	 *
+	 * @var boolean
+	 */
+	protected $debug_mode = false;
+
+	/**
+	 * Indicates the version that was requested
+	 *
+	 * @var string
+	 */
+	protected $requested_version;
+
+	/**
+	 * flat array of headers to send in the response
+	 *
+	 * @var array
+	 */
+	protected $response_headers = array();
+
+
+	public function __construct()
+	{
+		$this->debug_mode = EED_Core_Rest_Api::debugMode();
+		// we are handling a REST request. Don't show a fancy HTML error message is any error comes up
+		add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
+	}
+
+
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function setRequestedVersion($version)
+	{
+		$this->requested_version = $version;
+	}
+
+
+	/**
+	 * Sets some debug info that we'll send back in headers
+	 *
+	 * @param string       $key
+	 * @param string|array $info
+	 */
+	protected function setDebugInfo($key, $info)
+	{
+		$this->debug_info[ $key ] = $info;
+	}
+
+
+	/**
+	 * Sets headers for the response
+	 *
+	 * @param string       $header_key    , excluding the "X-EE-" part
+	 * @param array|string $value         if an array, multiple headers will be added, one
+	 *                                    for each key in the array
+	 * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
+	 *                                    the standard WP one
+	 */
+	protected function setResponseHeader($header_key, $value, $use_ee_prefix = true)
+	{
+		if (is_array($value)) {
+			foreach ($value as $value_key => $value_value) {
+				$this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+			}
+		} else {
+			$prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
+			$this->response_headers[ $prefix . $header_key ] = $value;
+		}
+	}
+
+
+	/**
+	 * Returns a flat array of headers to be added to the response
+	 *
+	 * @return array
+	 */
+	protected function getResponseHeaders()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			$this->response_headers,
+			$this,
+			$this->requested_version
+		);
+	}
+
+
+	/**
+	 * Adds error notices from EE_Error onto the provided \WP_Error
+	 *
+	 * @param WP_Error $wp_error_response
+	 * @return WP_Error
+	 */
+	protected function addEeErrorsToResponse(WP_Error $wp_error_response)
+	{
+		$notices_during_checkin = EE_Error::get_raw_notices();
+		if (! empty($notices_during_checkin['errors'])) {
+			foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
+				$wp_error_response->add(
+					sanitize_key($error_code),
+					strip_tags($error_message)
+				);
+			}
+		}
+		return $wp_error_response;
+	}
+
+
+	/**
+	 * Sends a response, but also makes sure to attach headers that
+	 * are handy for debugging.
+	 * Specifically, we assume folks will want to know what exactly was the DB query that got run,
+	 * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
+	 * the response, others?
+	 *
+	 * @param array|WP_Error|Exception|RestException $response
+	 * @return WP_REST_Response
+	 */
+	public function sendResponse($response)
+	{
+		if ($response instanceof RestException) {
+			$response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
+		}
+		if ($response instanceof Exception) {
+			$code = $response->getCode() ? $response->getCode() : 'error_occurred';
+			$response = new WP_Error($code, $response->getMessage());
+		}
+		if ($response instanceof WP_Error) {
+			$response = $this->addEeErrorsToResponse($response);
+			$rest_response = $this->createRestResponseFromWpError($response);
+		} else {
+			$rest_response = new WP_REST_Response($response, 200);
+		}
+		$headers = array();
+		if ($this->debug_mode && is_array($this->debug_info)) {
+			foreach ($this->debug_info as $debug_key => $debug_info) {
+				if (is_array($debug_info)) {
+					$debug_info = wp_json_encode($debug_info);
+				}
+				$headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
+			}
+		}
+		$headers = array_merge(
+			$headers,
+			$this->getResponseHeaders(),
+			$this->getHeadersFromEeNotices()
+		);
+		$rest_response->set_headers($headers);
+		return $rest_response;
+	}
+
+
+	/**
+	 * Converts the \WP_Error into `WP_REST_Response.
+	 * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
+	 * (which is protected)
+	 *
+	 * @param WP_Error $wp_error
+	 * @return WP_REST_Response
+	 */
+	protected function createRestResponseFromWpError(WP_Error $wp_error)
+	{
+		$error_data = $wp_error->get_error_data();
+		if (is_array($error_data) && isset($error_data['status'])) {
+			$status = $error_data['status'];
+		} else {
+			$status = 500;
+		}
+		$errors = array();
+		foreach ((array) $wp_error->errors as $code => $messages) {
+			foreach ((array) $messages as $message) {
+				$errors[] = array(
+					'code'    => $code,
+					'message' => $message,
+					'data'    => $wp_error->get_error_data($code),
+				);
+			}
+		}
+		$data = isset($errors[0]) ? $errors[0] : array();
+		if (count($errors) > 1) {
+			// Remove the primary error.
+			array_shift($errors);
+			$data['additional_errors'] = $errors;
+		}
+		return new WP_REST_Response($data, $status);
+	}
+
+
+	/**
+	 * Array of headers derived from EE success, attention, and error messages
+	 *
+	 * @return array
+	 */
+	protected function getHeadersFromEeNotices()
+	{
+		$headers = array();
+		$notices = EE_Error::get_raw_notices();
+		foreach ($notices as $notice_type => $sub_notices) {
+			if (! is_array($sub_notices)) {
+				continue;
+			}
+			foreach ($sub_notices as $notice_code => $sub_notice) {
+				$headers[ 'X-EE4-Notices-'
+						  . EEH_Inflector::humanize($notice_type)
+						  . '['
+						  . $notice_code
+						  . ']' ] = strip_tags($sub_notice);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			$headers,
+			$this->requested_version,
+			$notices
+		);
+	}
+
+
+	/**
+	 * Finds which version of the API was requested given the route, and returns it.
+	 * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
+	 * "4.8.29".
+	 * We should know hte requested version in this model though, so if no route is
+	 * provided just use what we set earlier
+	 *
+	 * @param string $route
+	 * @return string
+	 */
+	public function getRequestedVersion($route = null)
+	{
+		if ($route === null) {
+			return $this->requested_version;
+		}
+		$matches = $this->parseRoute(
+			$route,
+			'~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+			array('version')
+		);
+		if (isset($matches['version'])) {
+			return $matches['version'];
+		} else {
+			return EED_Core_Rest_Api::latest_rest_api_version();
+		}
+	}
+
+
+	/**
+	 * Applies the regex to the route, then creates an array using the values of
+	 * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
+	 * For example, if you call
+	 * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
+	 * it will return array( 'version' => '4.8', 'model' => 'events' )
+	 *
+	 * @param string $route
+	 * @param string $regex
+	 * @param array  $match_keys EXCLUDING matching the entire regex
+	 * @return array where  $match_keys are the keys (the first value of $match_keys
+	 *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
+	 *                           array( 'model', 'id' ), will, if the regex is successful, will return
+	 *                           array( 'model' => 'foo', 'id' => 'bar' )
+	 * @throws EE_Error if it couldn't be parsed
+	 */
+	public function parseRoute($route, $regex, $match_keys)
+	{
+		$indexed_matches = array();
+		$success = preg_match($regex, $route, $matches);
+		if (is_array($matches)) {
+			// skip the overall regex match. Who cares
+			for ($i = 1; $i <= count($match_keys); $i++) {
+				if (! isset($matches[ $i ])) {
+					$success = false;
+				} else {
+					$indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
+				}
+			}
+		}
+		if (! $success) {
+			throw new EE_Error(
+				__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
+				'endpoint_parsing_error'
+			);
+		}
+		return $indexed_matches;
+	}
+
+
+	/**
+	 * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return array
+	 */
+	protected function getBodyParams(\WP_REST_Request $request)
+	{
+		// $request->get_params();
+		return array_merge(
+			(array) $request->get_body_params(),
+			(array) $request->get_json_params()
+		);
+		// return array_diff_key(
+		//    $request->get_params(),
+		//     $request->get_url_params(),
+		//     $request->get_query_params()
+		// );
+	}
 }

core/interfaces/line_items/EEI_Line_Item_Display.interface.php

Indentation +6 added lines, -6 removed lines

@@ -9,12 +9,12 @@
 interface EEI_Line_Item_Display
 {
 
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array());
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array());
 
 }
 

admin_pages/events/help_tabs/events_default_settings_max_tickets.help_tab.php

Indentation +3 added lines, -3 removed lines

@@ -1,6 +1,6 @@
 <p>
     <?php esc_html_e(
-        'Use this to control what the default will be for maximum tickets on an order when creating a new event.',
-        'event_espresso'
-    ); ?>
+		'Use this to control what the default will be for maximum tickets on an order when creating a new event.',
+		'event_espresso'
+	); ?>
 </p>
\ No newline at end of file

core/services/notices/ConvertNoticesToEeErrors.php

Spacing +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
             $error_string = esc_html__('The following errors occurred:', 'event_espresso');
             foreach ($notices->getError() as $notice) {
                 if ($this->getThrowExceptions()) {
-                    $error_string .= '<br />' . $notice->message();
+                    $error_string .= '<br />'.$notice->message();
                 } else {
                     EE_Error::add_error(
                         $notice->message(),

Indentation +50 added lines, -50 removed lines

@@ -19,56 +19,56 @@
 class ConvertNoticesToEeErrors extends NoticeConverter
 {
 
-    /**
-     * Converts Notice objects into EE_Error notifications
-     *
-     * @param NoticesContainerInterface $notices
-     * @throws EE_Error
-     */
-    public function process(NoticesContainerInterface $notices)
-    {
-        $this->setNotices($notices);
-        $notices = $this->getNotices();
-        if ($notices->hasAttention()) {
-            foreach ($notices->getAttention() as $notice) {
-                EE_Error::add_attention(
-                    $notice->message(),
-                    $notice->file(),
-                    $notice->func(),
-                    $notice->line()
-                );
-            }
-        }
-        if ($notices->hasError()) {
-            $error_string = esc_html__('The following errors occurred:', 'event_espresso');
-            foreach ($notices->getError() as $notice) {
-                if ($this->getThrowExceptions()) {
-                    $error_string .= '<br />' . $notice->message();
-                } else {
-                    EE_Error::add_error(
-                        $notice->message(),
-                        $notice->file(),
-                        $notice->func(),
-                        $notice->line()
-                    );
-                }
-            }
-            if ($this->getThrowExceptions()) {
-                throw new EE_Error($error_string);
-            }
-        }
-        if ($notices->hasSuccess()) {
-            foreach ($notices->getSuccess() as $notice) {
-                EE_Error::add_success(
-                    $notice->message(),
-                    $notice->file(),
-                    $notice->func(),
-                    $notice->line()
-                );
-            }
-        }
-        $this->clearNotices();
-    }
+	/**
+	 * Converts Notice objects into EE_Error notifications
+	 *
+	 * @param NoticesContainerInterface $notices
+	 * @throws EE_Error
+	 */
+	public function process(NoticesContainerInterface $notices)
+	{
+		$this->setNotices($notices);
+		$notices = $this->getNotices();
+		if ($notices->hasAttention()) {
+			foreach ($notices->getAttention() as $notice) {
+				EE_Error::add_attention(
+					$notice->message(),
+					$notice->file(),
+					$notice->func(),
+					$notice->line()
+				);
+			}
+		}
+		if ($notices->hasError()) {
+			$error_string = esc_html__('The following errors occurred:', 'event_espresso');
+			foreach ($notices->getError() as $notice) {
+				if ($this->getThrowExceptions()) {
+					$error_string .= '<br />' . $notice->message();
+				} else {
+					EE_Error::add_error(
+						$notice->message(),
+						$notice->file(),
+						$notice->func(),
+						$notice->line()
+					);
+				}
+			}
+			if ($this->getThrowExceptions()) {
+				throw new EE_Error($error_string);
+			}
+		}
+		if ($notices->hasSuccess()) {
+			foreach ($notices->getSuccess() as $notice) {
+				EE_Error::add_success(
+					$notice->message(),
+					$notice->file(),
+					$notice->func(),
+					$notice->line()
+				);
+			}
+		}
+		$this->clearNotices();
+	}
 
 
 }

public/Espresso_Arabica_2014/loop-espresso_events.php

Indentation +34 added lines, -34 removed lines

@@ -11,48 +11,48 @@
  * @version     4+
  */
 if (have_posts()) :
-    if (apply_filters('FHEE__archive_espresso_events_template__show_header', true)) : ?>
+	if (apply_filters('FHEE__archive_espresso_events_template__show_header', true)) : ?>
         <header class="page-header">
             <h1 class="page-title">
                 <?php
-                if (is_day()) :
-                    printf(__('Today\'s Events: %s', 'event_espresso'), get_the_date());
-                elseif (is_month()) :
-                    printf(
-                        __('Events This Month: %s', 'event_espresso'),
-                        get_the_date(_x('F Y', 'monthly archives date format', 'event_espresso'))
-                    );
-                elseif (is_year()) :
-                    printf(
-                        __('Events This Year: %s', 'event_espresso'),
-                        get_the_date(_x('Y', 'yearly archives date format', 'event_espresso'))
-                    );
-                else :
-                    echo apply_filters(
-                        'FHEE__archive_espresso_events_template__upcoming_events_h1',
-                        __('Upcoming Events', 'event_espresso')
-                    );
-                endif;
-                ?>
+				if (is_day()) :
+					printf(__('Today\'s Events: %s', 'event_espresso'), get_the_date());
+				elseif (is_month()) :
+					printf(
+						__('Events This Month: %s', 'event_espresso'),
+						get_the_date(_x('F Y', 'monthly archives date format', 'event_espresso'))
+					);
+				elseif (is_year()) :
+					printf(
+						__('Events This Year: %s', 'event_espresso'),
+						get_the_date(_x('Y', 'yearly archives date format', 'event_espresso'))
+					);
+				else :
+					echo apply_filters(
+						'FHEE__archive_espresso_events_template__upcoming_events_h1',
+						__('Upcoming Events', 'event_espresso')
+					);
+				endif;
+				?>
             </h1>
 
         </header><!-- .page-header -->
 
         <?php
-    endif;
-    // allow other stuff
-    do_action('AHEE__archive_espresso_events_template__before_loop');
-    // Start the Loop.
-    while (have_posts()) : the_post();
-        // Include the post TYPE-specific template for the content.
-        espresso_get_template_part('content', 'espresso_events-shortcode');
-    endwhile;
-    // Previous/next page navigation.
-    espresso_pagination();
-    // allow moar other stuff
-    do_action('AHEE__archive_espresso_events_template__after_loop');
+	endif;
+	// allow other stuff
+	do_action('AHEE__archive_espresso_events_template__before_loop');
+	// Start the Loop.
+	while (have_posts()) : the_post();
+		// Include the post TYPE-specific template for the content.
+		espresso_get_template_part('content', 'espresso_events-shortcode');
+	endwhile;
+	// Previous/next page navigation.
+	espresso_pagination();
+	// allow moar other stuff
+	do_action('AHEE__archive_espresso_events_template__after_loop');
 else :
-    // If no content, include the "No posts found" template.
-    espresso_get_template_part('content', 'none');
+	// If no content, include the "No posts found" template.
+	espresso_get_template_part('content', 'none');
 endif;
 

Braces +6 added lines, -2 removed lines

@@ -27,11 +27,13 @@ 
                         __('Events This Year: %s', 'event_espresso'),
                         get_the_date(_x('Y', 'yearly archives date format', 'event_espresso'))
                     );
-                else :
+                else {
+                	:
                     echo apply_filters(
                         'FHEE__archive_espresso_events_template__upcoming_events_h1',
                         __('Upcoming Events', 'event_espresso')
                     );
+                }
                 endif;
                 ?>
             </h1>
@@ -51,8 +53,10 @@ 
     espresso_pagination();
     // allow moar other stuff
     do_action('AHEE__archive_espresso_events_template__after_loop');
-else :
+else {
+	:
     // If no content, include the "No posts found" template.
     espresso_get_template_part('content', 'none');
+}
 endif;
 

acceptance_tests/Helpers/TicketSelector.php

Indentation +17 added lines, -17 removed lines

@@ -12,23 +12,23 @@
 trait TicketSelector
 {
 
-    /**
-     * Use to select a quantity from the first ticket for the given event (so this can be used on a event archive page).
-     * @param int|string $event_id
-     * @param int|string $quantity
-     */
-    public function selectQuantityOfFirstTicketForEventId($event_id, $quantity = 1)
-    {
-        $this->actor()->selectOption(TicketSelectorElements::ticketOptionByEventIdSelector($event_id), $quantity);
-    }
+	/**
+	 * Use to select a quantity from the first ticket for the given event (so this can be used on a event archive page).
+	 * @param int|string $event_id
+	 * @param int|string $quantity
+	 */
+	public function selectQuantityOfFirstTicketForEventId($event_id, $quantity = 1)
+	{
+		$this->actor()->selectOption(TicketSelectorElements::ticketOptionByEventIdSelector($event_id), $quantity);
+	}
 
 
-    /**
-     * Used to submit the ticket selection for the given event id (so this can be used on an event archive page).
-     * @param int|string $event_id
-     */
-    public function submitTicketSelectionsForEventId($event_id)
-    {
-        $this->actor()->click(TicketSelectorElements::ticketSelectionSubmitSelectorByEventId($event_id));
-    }
+	/**
+	 * Used to submit the ticket selection for the given event id (so this can be used on an event archive page).
+	 * @param int|string $event_id
+	 */
+	public function submitTicketSelectionsForEventId($event_id)
+	{
+		$this->actor()->click(TicketSelectorElements::ticketSelectionSubmitSelectorByEventId($event_id));
+	}
 }
\ No newline at end of file