eventespresso / event-espresso-core

core/libraries/iframe_display/EventListIframeEmbedButton.php

Indentation +41 added lines, -41 removed lines

@@ -12,49 +12,49 @@
 class EventListIframeEmbedButton extends IframeEmbedButton
 {
 
-    /**
-     * EventListIframeEmbedButton constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            esc_html__('Upcoming Event List', 'event_espresso'),
-            'event_list'
-        );
-    }
+	/**
+	 * EventListIframeEmbedButton constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			esc_html__('Upcoming Event List', 'event_espresso'),
+			'event_list'
+		);
+	}
 
 
-    public function addEmbedButton()
-    {
-        add_filter(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
-            array($this, 'addEventListIframeEmbedButtonSection')
-        );
-        add_action(
-            'admin_enqueue_scripts',
-            array($this, 'embedButtonAssets'),
-            10
-        );
-    }
+	public function addEmbedButton()
+	{
+		add_filter(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
+			array($this, 'addEventListIframeEmbedButtonSection')
+		);
+		add_action(
+			'admin_enqueue_scripts',
+			array($this, 'embedButtonAssets'),
+			10
+		);
+	}
 
 
-    /**
-     * Adds an iframe embed code button to the Event editor.
-     * return string
-     *
-     * @param array $after_list_table
-     * @return array
-     */
-    public function addEventListIframeEmbedButtonSection(array $after_list_table)
-    {
-        return \EEH_Array::insert_into_array(
-            $after_list_table,
-            array(
-                'iframe_embed_buttons' => $this->addIframeEmbedButtonsSection(
-                    array('event_list' => $this->embedButtonHtml())
-                ),
-            ),
-            'legend'
-        );
-    }
+	/**
+	 * Adds an iframe embed code button to the Event editor.
+	 * return string
+	 *
+	 * @param array $after_list_table
+	 * @return array
+	 */
+	public function addEventListIframeEmbedButtonSection(array $after_list_table)
+	{
+		return \EEH_Array::insert_into_array(
+			$after_list_table,
+			array(
+				'iframe_embed_buttons' => $this->addIframeEmbedButtonsSection(
+					array('event_list' => $this->embedButtonHtml())
+				),
+			),
+			'legend'
+		);
+	}
 }

core/libraries/rest_api/RestException.php

Indentation +40 added lines, -40 removed lines

@@ -14,54 +14,54 @@
 class RestException extends \EE_Error
 {
 
-    /**
-     * @var array
-     */
-    protected $wp_error_data = array();
+	/**
+	 * @var array
+	 */
+	protected $wp_error_data = array();
 
-    protected $wp_error_code = '';
+	protected $wp_error_code = '';
 
 
 
-    public function __construct($string_code, $message, $wp_error_data = array(), $previous = null)
-    {
-        if (is_array($wp_error_data)
-            && isset($wp_error_data['status'])
-        ) {
-            $http_status_number = $wp_error_data['status'];
-        } else {
-            $http_status_number = 500;
-        }
-        parent::__construct(
-            $message,
-            $http_status_number,
-            $previous
-        );
-        $this->wp_error_data = $wp_error_data;
-        $this->wp_error_code = $string_code;
-    }
+	public function __construct($string_code, $message, $wp_error_data = array(), $previous = null)
+	{
+		if (is_array($wp_error_data)
+			&& isset($wp_error_data['status'])
+		) {
+			$http_status_number = $wp_error_data['status'];
+		} else {
+			$http_status_number = 500;
+		}
+		parent::__construct(
+			$message,
+			$http_status_number,
+			$previous
+		);
+		$this->wp_error_data = $wp_error_data;
+		$this->wp_error_code = $string_code;
+	}
 
 
 
-    /**
-     * Array of data that may have been set during the constructor, intended for WP_Error's data
-     *
-     * @return array
-     */
-    public function getData()
-    {
-        return $this->wp_error_data;
-    }
+	/**
+	 * Array of data that may have been set during the constructor, intended for WP_Error's data
+	 *
+	 * @return array
+	 */
+	public function getData()
+	{
+		return $this->wp_error_data;
+	}
 
 
 
-    /**
-     * Gets the error string
-     *
-     * @return string
-     */
-    public function getStringCode()
-    {
-        return $this->wp_error_code;
-    }
+	/**
+	 * Gets the error string
+	 *
+	 * @return string
+	 */
+	public function getStringCode()
+	{
+		return $this->wp_error_code;
+	}
 }

core/libraries/rest_api/changes/ChangesIn40834.php

Indentation +32 added lines, -32 removed lines

@@ -10,38 +10,38 @@
 class ChangesIn40834 extends ChangesInBase
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function setHooks()
-    {
-        // set a hook to remove the checkout/checkout endpoints if the request
-        // is for lower than 4.8.33
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'removeResponseHeaders'),
-            10,
-            3
-        );
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function setHooks()
+	{
+		// set a hook to remove the checkout/checkout endpoints if the request
+		// is for lower than 4.8.33
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'removeResponseHeaders'),
+			10,
+			3
+		);
+	}
 
 
-    /**
-     * Removes the checkin and checkout endpoints from the index for requests
-     * to api versions lowers than 4.8.33
-     *
-     * @param array  $response_headers
-     * @param Base   $controller
-     * @param string $requested_version
-     * @return array like $routes_on_this_version
-     */
-    public function removeResponseHeaders($response_headers, $controller, $requested_version)
-    {
-        if ($controller instanceof Base
-            && $this->appliesToVersion($requested_version)
-        ) {
-            return array();
-        }
-        return $response_headers;
-    }
+	/**
+	 * Removes the checkin and checkout endpoints from the index for requests
+	 * to api versions lowers than 4.8.33
+	 *
+	 * @param array  $response_headers
+	 * @param Base   $controller
+	 * @param string $requested_version
+	 * @return array like $routes_on_this_version
+	 */
+	public function removeResponseHeaders($response_headers, $controller, $requested_version)
+	{
+		if ($controller instanceof Base
+			&& $this->appliesToVersion($requested_version)
+		) {
+			return array();
+		}
+		return $response_headers;
+	}
 }

core/libraries/rest_api/changes/ChangesIn40833.php

Indentation +49 added lines, -49 removed lines

@@ -7,57 +7,57 @@
 class ChangesIn40833 extends ChangesInBase
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function setHooks()
-    {
-        // set a hook to remove the checkout/checkout endpoints if the request
-        // is for lower than 4.8.33
-        add_filter(
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-            array($this, 'removeCheckinRoutesEarlierThan4833'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            array($this, 'dontAddHeadersFromEeNotices'),
-            10,
-            2
-        );
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function setHooks()
+	{
+		// set a hook to remove the checkout/checkout endpoints if the request
+		// is for lower than 4.8.33
+		add_filter(
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
+			array($this, 'removeCheckinRoutesEarlierThan4833'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			array($this, 'dontAddHeadersFromEeNotices'),
+			10,
+			2
+		);
+	}
 
 
-    /**
-     * Removes the checkin and checkout endpoints from the index for requests
-     * to api versions lowers than 4.8.33
-     *
-     * @param array  $routes_on_this_version
-     * @param string $version
-     * @return array like $routes_on_this_version
-     */
-    public function removeCheckinRoutesEarlierThan4833($routes_on_this_version, $version)
-    {
-        if ($this->appliesToVersion($version)) {
-            unset($routes_on_this_version['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)']);
-        }
-        return $routes_on_this_version;
-    }
+	/**
+	 * Removes the checkin and checkout endpoints from the index for requests
+	 * to api versions lowers than 4.8.33
+	 *
+	 * @param array  $routes_on_this_version
+	 * @param string $version
+	 * @return array like $routes_on_this_version
+	 */
+	public function removeCheckinRoutesEarlierThan4833($routes_on_this_version, $version)
+	{
+		if ($this->appliesToVersion($version)) {
+			unset($routes_on_this_version['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)']);
+		}
+		return $routes_on_this_version;
+	}
 
 
-    /**
-     * We just added headers for notices in this version
-     *
-     * @param array  $headers_from_ee_notices
-     * @param string $requested_version
-     * @return array
-     */
-    public function dontAddHeadersFromEeNotices($headers_from_ee_notices, $requested_version)
-    {
-        if ($this->appliesToVersion($requested_version)) {
-            return array();
-        }
-        return $headers_from_ee_notices;
-    }
+	/**
+	 * We just added headers for notices in this version
+	 *
+	 * @param array  $headers_from_ee_notices
+	 * @param string $requested_version
+	 * @return array
+	 */
+	public function dontAddHeadersFromEeNotices($headers_from_ee_notices, $requested_version)
+	{
+		if ($this->appliesToVersion($requested_version)) {
+			return array();
+		}
+		return $headers_from_ee_notices;
+	}
 }

core/libraries/rest_api/controllers/rpc/Checkin.php

Indentation +118 added lines, -118 removed lines

@@ -26,124 +26,124 @@
 class Checkin extends Base
 {
 
-    /**
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @return WP_Error|WP_REST_Response
-     */
-    public static function handleRequestToggleCheckin(WP_REST_Request $request, $version)
-    {
-        $controller = new Checkin();
-        return $controller->createCheckinCheckoutObject($request, $version);
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @return WP_Error|WP_REST_Response
+	 */
+	public static function handleRequestToggleCheckin(WP_REST_Request $request, $version)
+	{
+		$controller = new Checkin();
+		return $controller->createCheckinCheckoutObject($request, $version);
+	}
 
 
-    /**
-     * Toggles whether the user is checked in or not.
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @return WP_Error|WP_REST_Response
-     */
-    protected function createCheckinCheckoutObject(WP_REST_Request $request, $version)
-    {
-        $reg_id = $request->get_param('REG_ID');
-        $dtt_id = $request->get_param('DTT_ID');
-        $force = $request->get_param('force');
-        if ($force == 'true') {
-            $force = true;
-        } else {
-            $force = false;
-        }
-        $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_registration_toggle_checkin_invalid_id',
-                    sprintf(
-                        __(
-                            'You cannot checkin registration with ID %1$s because it doesn\'t exist.',
-                            'event_espresso'
-                        ),
-                        $reg_id
-                    ),
-                    array('status' => 422)
-                )
-            );
-        }
-        if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_user_cannot_toggle_checkin',
-                    sprintf(
-                        __('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
-                        $reg_id
-                    ),
-                    array('status' => 403)
-                )
-            );
-        }
-        $success = $reg->toggle_checkin_status($dtt_id, ! $force);
-        if ($success === false) {
-            // check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
-                // rely on EE_Error::add_error messages to have been added to give more data about why it failed
-                return $this->sendResponse(
-                    new WP_Error(
-                        'rest_toggle_checkin_failed',
-                        __(
-                        // @codingStandardsIgnoreStart
-                            'Registration check-in failed because the registration is not approved. You may attempt to force checking in though.',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        )
-                    )
-                );
-            }
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_toggle_checkin_failed_not_forceable',
-                    __('Registration checkin failed. Please see additional error data.', 'event_espresso')
-                )
-            );
-        }
-        $checkin = EEM_Checkin::instance()->get_one(
-            array(
-                array(
-                    'REG_ID' => $reg_id,
-                    'DTT_ID' => $dtt_id,
-                ),
-                'order_by' => array(
-                    'CHK_timestamp' => 'DESC',
-                ),
-            )
-        );
-        if (! $checkin instanceof EE_Checkin) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_toggle_checkin_error',
-                    sprintf(
-                        __(
-                        // @codingStandardsIgnoreStart
-                            'Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                        $reg_id,
-                        $dtt_id
-                    )
-                )
-            );
-        }
-        $get_request = new WP_REST_Request(
-            'GET',
-            '/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
-        );
-        $get_request->set_url_params(
-            array(
-                'id' => $checkin->ID(),
-            )
-        );
-        return Read::handleRequestGetOne($get_request, $version, 'Checkin');
-    }
+	/**
+	 * Toggles whether the user is checked in or not.
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @return WP_Error|WP_REST_Response
+	 */
+	protected function createCheckinCheckoutObject(WP_REST_Request $request, $version)
+	{
+		$reg_id = $request->get_param('REG_ID');
+		$dtt_id = $request->get_param('DTT_ID');
+		$force = $request->get_param('force');
+		if ($force == 'true') {
+			$force = true;
+		} else {
+			$force = false;
+		}
+		$reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		if (! $reg instanceof EE_Registration) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_registration_toggle_checkin_invalid_id',
+					sprintf(
+						__(
+							'You cannot checkin registration with ID %1$s because it doesn\'t exist.',
+							'event_espresso'
+						),
+						$reg_id
+					),
+					array('status' => 422)
+				)
+			);
+		}
+		if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_user_cannot_toggle_checkin',
+					sprintf(
+						__('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
+						$reg_id
+					),
+					array('status' => 403)
+				)
+			);
+		}
+		$success = $reg->toggle_checkin_status($dtt_id, ! $force);
+		if ($success === false) {
+			// check if we know they can't check in because they're not approved and we aren't forcing
+			if (! $reg->is_approved() && ! $force) {
+				// rely on EE_Error::add_error messages to have been added to give more data about why it failed
+				return $this->sendResponse(
+					new WP_Error(
+						'rest_toggle_checkin_failed',
+						__(
+						// @codingStandardsIgnoreStart
+							'Registration check-in failed because the registration is not approved. You may attempt to force checking in though.',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						)
+					)
+				);
+			}
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_toggle_checkin_failed_not_forceable',
+					__('Registration checkin failed. Please see additional error data.', 'event_espresso')
+				)
+			);
+		}
+		$checkin = EEM_Checkin::instance()->get_one(
+			array(
+				array(
+					'REG_ID' => $reg_id,
+					'DTT_ID' => $dtt_id,
+				),
+				'order_by' => array(
+					'CHK_timestamp' => 'DESC',
+				),
+			)
+		);
+		if (! $checkin instanceof EE_Checkin) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_toggle_checkin_error',
+					sprintf(
+						__(
+						// @codingStandardsIgnoreStart
+							'Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+						$reg_id,
+						$dtt_id
+					)
+				)
+			);
+		}
+		$get_request = new WP_REST_Request(
+			'GET',
+			'/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
+		);
+		$get_request->set_url_params(
+			array(
+				'id' => $checkin->ID(),
+			)
+		);
+		return Read::handleRequestGetOne($get_request, $version, 'Checkin');
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -56,7 +56,7 @@ 
             $force = false;
         }
         $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
+        if ( ! $reg instanceof EE_Registration) {
             return $this->sendResponse(
                 new WP_Error(
                     'rest_registration_toggle_checkin_invalid_id',
@@ -71,7 +71,7 @@ 
                 )
             );
         }
-        if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
+        if ( ! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
             return $this->sendResponse(
                 new WP_Error(
                     'rest_user_cannot_toggle_checkin',
@@ -86,7 +86,7 @@ 
         $success = $reg->toggle_checkin_status($dtt_id, ! $force);
         if ($success === false) {
             // check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
+            if ( ! $reg->is_approved() && ! $force) {
                 // rely on EE_Error::add_error messages to have been added to give more data about why it failed
                 return $this->sendResponse(
                     new WP_Error(
@@ -118,7 +118,7 @@ 
                 ),
             )
         );
-        if (! $checkin instanceof EE_Checkin) {
+        if ( ! $checkin instanceof EE_Checkin) {
             return $this->sendResponse(
                 new WP_Error(
                     'rest_toggle_checkin_error',
@@ -137,7 +137,7 @@ 
         }
         $get_request = new WP_REST_Request(
             'GET',
-            '/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
+            '/'.EED_Core_Rest_Api::ee_api_namespace.'v'.$version.'/checkins/'.$checkin->ID()
         );
         $get_request->set_url_params(
             array(

core/libraries/batch/JobHandlerBaseClasses/JobHandler.php

Indentation +1 added lines, -1 removed lines

@@ -13,5 +13,5 @@
  */
 abstract class JobHandler implements JobHandlerInterface
 {
-    // so far no common methods or properties
+	// so far no common methods or properties
 }

core/libraries/batch/Helpers/BatchRequestException.php

Indentation +1 added lines, -1 removed lines

@@ -14,5 +14,5 @@
  */
 class BatchRequestException extends \Exception
 {
-    // so far the same as exception
+	// so far the same as exception
 }

core/libraries/batch/BatchRequestProcessor.php

Spacing +8 added lines, -8 removed lines

@@ -54,7 +54,7 @@ 
             $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class);
             $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data);
             $response = $obj->create_job($this->_job_parameters);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -66,7 +66,7 @@ 
                 );
             }
             $success = $this->_job_parameters->save(true);
-            if (! $success) {
+            if ( ! $success) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -102,7 +102,7 @@ 
             $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname());
             // continue it
             $response = $handler_obj->continue_job($this->_job_parameters, $batch_size);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -131,7 +131,7 @@ 
      */
     public function instantiate_batch_job_handler_from_classname($classname)
     {
-        if (! class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             throw new BatchRequestException(
                 sprintf(
                     __(
@@ -143,7 +143,7 @@ 
             );
         }
         $obj = new $classname;
-        if (! $obj instanceof JobHandlerInterface) {
+        if ( ! $obj instanceof JobHandlerInterface) {
             throw new BatchRequestException(
                 sprintf(
                     __(
@@ -173,7 +173,7 @@ 
             $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname());
             // continue it
             $response = $handler_obj->cleanup_job($job_parameters);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -203,7 +203,7 @@ 
      */
     protected function _get_error_response(\Exception $exception, $method_name)
     {
-        if (! $this->_job_parameters instanceof JobParameters) {
+        if ( ! $this->_job_parameters instanceof JobParameters) {
             $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array());
         }
         $this->_job_parameters->set_status(JobParameters::status_error);
@@ -215,7 +215,7 @@ 
                     'event_espresso'
                 ),
                 get_class($exception),
-                'BatchRunner::' . $method_name . '()',
+                'BatchRunner::'.$method_name.'()',
                 $exception->getMessage(),
                 $exception->getTraceAsString()
             )

Indentation +189 added lines, -189 removed lines

@@ -23,203 +23,203 @@
  */
 class BatchRequestProcessor
 {
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * Current job's ID (if assigned)
-     *
-     * @var string|null
-     */
-    protected $_job_id;
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * Current job's ID (if assigned)
+	 *
+	 * @var string|null
+	 */
+	protected $_job_id;
 
-    /**
-     * Current job's parameters
-     *
-     * @var JobParameters|null
-     */
-    protected $_job_parameters;
+	/**
+	 * Current job's parameters
+	 *
+	 * @var JobParameters|null
+	 */
+	protected $_job_parameters;
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * Creates a job for the specified batch handler class (which should be autoloaded)
-     * and the specified request data
-     *
-     * @param string $batch_job_handler_class of an auto-loaded class implementing JobHandlerInterface
-     * @param array  $request_data            to be used by the batch job handler
-     * @return JobStepResponse
-     */
-    public function create_job($batch_job_handler_class, $request_data)
-    {
-        try {
-            $this->_job_id = wp_generate_password(15, false);
-            $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class);
-            $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data);
-            $response = $obj->create_job($this->_job_parameters);
-            if (! $response instanceof JobStepResponse) {
-                throw new BatchRequestException(
-                    sprintf(
-                        __(
-                            'The class implementing JobHandlerInterface did not return a JobStepResponse when create_job was called with %1$s. It needs to return one or throw an Exception',
-                            'event_espresso'
-                        ),
-                        wp_json_encode($request_data)
-                    )
-                );
-            }
-            $success = $this->_job_parameters->save(true);
-            if (! $success) {
-                throw new BatchRequestException(
-                    sprintf(
-                        __(
-                            'Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s',
-                            'event_espresso'
-                        ),
-                        $this->_job_id,
-                        wp_json_encode($request_data)
-                    )
-                );
-            }
-        } catch (\Exception $e) {
-            $response = $this->_get_error_response($e, 'create_job');
-        }
-        return $response;
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * Creates a job for the specified batch handler class (which should be autoloaded)
+	 * and the specified request data
+	 *
+	 * @param string $batch_job_handler_class of an auto-loaded class implementing JobHandlerInterface
+	 * @param array  $request_data            to be used by the batch job handler
+	 * @return JobStepResponse
+	 */
+	public function create_job($batch_job_handler_class, $request_data)
+	{
+		try {
+			$this->_job_id = wp_generate_password(15, false);
+			$obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class);
+			$this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data);
+			$response = $obj->create_job($this->_job_parameters);
+			if (! $response instanceof JobStepResponse) {
+				throw new BatchRequestException(
+					sprintf(
+						__(
+							'The class implementing JobHandlerInterface did not return a JobStepResponse when create_job was called with %1$s. It needs to return one or throw an Exception',
+							'event_espresso'
+						),
+						wp_json_encode($request_data)
+					)
+				);
+			}
+			$success = $this->_job_parameters->save(true);
+			if (! $success) {
+				throw new BatchRequestException(
+					sprintf(
+						__(
+							'Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s',
+							'event_espresso'
+						),
+						$this->_job_id,
+						wp_json_encode($request_data)
+					)
+				);
+			}
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'create_job');
+		}
+		return $response;
+	}
 
 
-    /**
-     * Retrieves the job's arguments
-     *
-     * @param string $job_id
-     * @param int    $batch_size
-     * @return JobStepResponse
-     */
-    public function continue_job($job_id, $batch_size = 50)
-    {
-        try {
-            $this->_job_id = $job_id;
-            $batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size;
-            // get the corresponding WordPress option for the job
-            $this->_job_parameters = JobParameters::load($this->_job_id);
-            $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname());
-            // continue it
-            $response = $handler_obj->continue_job($this->_job_parameters, $batch_size);
-            if (! $response instanceof JobStepResponse) {
-                throw new BatchRequestException(
-                    sprintf(
-                        __(
-                            'The class implementing JobHandlerInterface did not return a JobStepResponse when continue_job was called with job %1$s. It needs to return one or throw an Exception',
-                            'event_espresso'
-                        ),
-                        $this->_job_id
-                    )
-                );
-            }
-            $this->_job_parameters->save();
-        } catch (\Exception $e) {
-            $response = $this->_get_error_response($e, 'continue_job');
-        }
-        return $response;
-    }
+	/**
+	 * Retrieves the job's arguments
+	 *
+	 * @param string $job_id
+	 * @param int    $batch_size
+	 * @return JobStepResponse
+	 */
+	public function continue_job($job_id, $batch_size = 50)
+	{
+		try {
+			$this->_job_id = $job_id;
+			$batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size;
+			// get the corresponding WordPress option for the job
+			$this->_job_parameters = JobParameters::load($this->_job_id);
+			$handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname());
+			// continue it
+			$response = $handler_obj->continue_job($this->_job_parameters, $batch_size);
+			if (! $response instanceof JobStepResponse) {
+				throw new BatchRequestException(
+					sprintf(
+						__(
+							'The class implementing JobHandlerInterface did not return a JobStepResponse when continue_job was called with job %1$s. It needs to return one or throw an Exception',
+							'event_espresso'
+						),
+						$this->_job_id
+					)
+				);
+			}
+			$this->_job_parameters->save();
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'continue_job');
+		}
+		return $response;
+	}
 
 
-    /**
-     * Instantiates an object of type $classname, which implements
-     * JobHandlerInterface
-     *
-     * @param string $classname
-     * @return JobHandlerInterface
-     * @throws BatchRequestException
-     */
-    public function instantiate_batch_job_handler_from_classname($classname)
-    {
-        if (! class_exists($classname)) {
-            throw new BatchRequestException(
-                sprintf(
-                    __(
-                        'The class %1$s does not exist, and so could not be used for running a job. It should implement JobHandlerInterface.',
-                        'event_espresso'
-                    ),
-                    $classname
-                )
-            );
-        }
-        $obj = new $classname;
-        if (! $obj instanceof JobHandlerInterface) {
-            throw new BatchRequestException(
-                sprintf(
-                    __(
-                        'The class %1$s does not implement JobHandlerInterface and so could not be used for running a job',
-                        'event_espresso'
-                    ),
-                    $classname
-                )
-            );
-        }
-        return $obj;
-    }
+	/**
+	 * Instantiates an object of type $classname, which implements
+	 * JobHandlerInterface
+	 *
+	 * @param string $classname
+	 * @return JobHandlerInterface
+	 * @throws BatchRequestException
+	 */
+	public function instantiate_batch_job_handler_from_classname($classname)
+	{
+		if (! class_exists($classname)) {
+			throw new BatchRequestException(
+				sprintf(
+					__(
+						'The class %1$s does not exist, and so could not be used for running a job. It should implement JobHandlerInterface.',
+						'event_espresso'
+					),
+					$classname
+				)
+			);
+		}
+		$obj = new $classname;
+		if (! $obj instanceof JobHandlerInterface) {
+			throw new BatchRequestException(
+				sprintf(
+					__(
+						'The class %1$s does not implement JobHandlerInterface and so could not be used for running a job',
+						'event_espresso'
+					),
+					$classname
+				)
+			);
+		}
+		return $obj;
+	}
 
 
-    /**
-     * Forces a job to be cleaned up
-     *
-     * @param string $job_id
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanup_job($job_id)
-    {
-        try {
-            $this->_job_id = $job_id;
-            $job_parameters = JobParameters::load($this->_job_id);
-            $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname());
-            // continue it
-            $response = $handler_obj->cleanup_job($job_parameters);
-            if (! $response instanceof JobStepResponse) {
-                throw new BatchRequestException(
-                    sprintf(
-                        __(
-                            'The class implementing JobHandlerInterface did not return a JobStepResponse when cleanup_job was called with job %1$s. It needs to return one or throw an Exception',
-                            'event_espresso'
-                        ),
-                        $this->_job_id
-                    )
-                );
-            }
-            $job_parameters->set_status(JobParameters::status_cleaned_up);
-            $job_parameters->delete();
-            return $response;
-        } catch (\Exception $e) {
-            $response = $this->_get_error_response($e, 'cleanup_job');
-        }
-        return $response;
-    }
+	/**
+	 * Forces a job to be cleaned up
+	 *
+	 * @param string $job_id
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job($job_id)
+	{
+		try {
+			$this->_job_id = $job_id;
+			$job_parameters = JobParameters::load($this->_job_id);
+			$handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname());
+			// continue it
+			$response = $handler_obj->cleanup_job($job_parameters);
+			if (! $response instanceof JobStepResponse) {
+				throw new BatchRequestException(
+					sprintf(
+						__(
+							'The class implementing JobHandlerInterface did not return a JobStepResponse when cleanup_job was called with job %1$s. It needs to return one or throw an Exception',
+							'event_espresso'
+						),
+						$this->_job_id
+					)
+				);
+			}
+			$job_parameters->set_status(JobParameters::status_cleaned_up);
+			$job_parameters->delete();
+			return $response;
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'cleanup_job');
+		}
+		return $response;
+	}
 
 
-    /**
-     * Creates a valid JobStepResponse object from an exception and method name.
-     *
-     * @param \Exception $exception
-     * @param string     $method_name
-     * @return JobStepResponse
-     */
-    protected function _get_error_response(\Exception $exception, $method_name)
-    {
-        if (! $this->_job_parameters instanceof JobParameters) {
-            $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array());
-        }
-        $this->_job_parameters->set_status(JobParameters::status_error);
-        return new JobStepResponse(
-            $this->_job_parameters,
-            sprintf(
-                __(
-                    'An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s',
-                    'event_espresso'
-                ),
-                get_class($exception),
-                'BatchRunner::' . $method_name . '()',
-                $exception->getMessage(),
-                $exception->getTraceAsString()
-            )
-        );
-    }
+	/**
+	 * Creates a valid JobStepResponse object from an exception and method name.
+	 *
+	 * @param \Exception $exception
+	 * @param string     $method_name
+	 * @return JobStepResponse
+	 */
+	protected function _get_error_response(\Exception $exception, $method_name)
+	{
+		if (! $this->_job_parameters instanceof JobParameters) {
+			$this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array());
+		}
+		$this->_job_parameters->set_status(JobParameters::status_error);
+		return new JobStepResponse(
+			$this->_job_parameters,
+			sprintf(
+				__(
+					'An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s',
+					'event_espresso'
+				),
+				get_class($exception),
+				'BatchRunner::' . $method_name . '()',
+				$exception->getMessage(),
+				$exception->getTraceAsString()
+			)
+		);
+	}
 }

core/entities/interfaces/HasSchemaInterface.php

Indentation +50 added lines, -50 removed lines

@@ -4,63 +4,63 @@
 
 interface HasSchemaInterface
 {
-    /**
-     * Returns whatever is set as the nicename for the object.
-     *
-     * @return string
-     */
-    public function getSchemaDescription();
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaDescription();
 
 
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     *
-     * @return string|array
-     */
-    public function getSchemaType();
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 *
+	 * @return string|array
+	 */
+	public function getSchemaType();
 
 
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties();
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties();
 
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum();
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum();
 
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     *
-     * @return string
-     */
-    public function getSchemaFormat();
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaFormat();
 
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     *
-     * @return bool
-     */
-    public function getSchemaReadonly();
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 *
+	 * @return bool
+	 */
+	public function getSchemaReadonly();
 
 
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema();
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema();
 }