eventespresso / event-espresso-core

caffeinated/admin/extend/registrations/Extend_EE_Attendee_Contact_List_Table.class.php

Spacing +2 added lines, -2 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -36,7 +36,7 @@ 
 				'route' => 'contact_list_report',
 				'extra_request' =>  
 						array( 
-							'return_url' => urlencode( "//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}" ) ) 
+							'return_url' => urlencode("//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}") ) 
 			),
 //			'contact_list_export'=> array(
 //				'route' => 'contact_list_export'

core/EE_Psr4AutoloaderInit.core.php

Spacing +4 added lines, -4 removed lines

@@ -24,15 +24,15 @@
 	 */
 	public function __construct() {
 		static $initialized = false;
-		if ( ! $initialized ) {
+		if ( ! $initialized) {
 			// instantiate PSR4 autoloader
-			espresso_load_required( 'Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php' );
+			espresso_load_required('Psr4Autoloader', EE_CORE.'Psr4Autoloader.php');
 			EE_Psr4AutoloaderInit::$psr4_loader = new \EventEspresso\Core\Psr4Autoloader();
 			// register the autoloader
 			EE_Psr4AutoloaderInit::$psr4_loader->register();
 			// register the base directories for the namespace prefix
-			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace( 'EventEspresso', EE_PLUGIN_DIR_PATH );
-			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace( 'EventEspressoBatchRequest', EE_LIBRARIES . 'batch' );
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES.'batch');
 			$initialized = true;
 		}
 	}

core/helpers/EEH_Export.helper.php

Spacing +35 added lines, -35 removed lines

@@ -30,7 +30,7 @@ 
 	 * @param EE_Model_Field_Base $field
 	 * @return string
 	 */
-	public static function get_column_name_for_field(EE_Model_Field_Base $field){
+	public static function get_column_name_for_field(EE_Model_Field_Base $field) {
 		return $field->get_nicename()."[".$field->get_name()."]";
 	}
 
@@ -52,32 +52,32 @@ 
 	 * 						we consider that a success (because we wrote everything there was...nothing)
 	 * @throws EE_Error
 	 */
-	public static function write_data_array_to_csv( $filepath, $data, $write_column_headers = true ){
+	public static function write_data_array_to_csv($filepath, $data, $write_column_headers = true) {
 		EE_Registry::instance()->load_helper('Array');
 
 		$new_file_contents = '';
 		//determine if $data is actually a 2d array
-		if ( $data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))){
+		if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
 			//make sure top level is numerically indexed,
 
-			if( EEH_Array::is_associative_array($data)){
-				throw new EE_Error(sprintf(__("top-level array must be numerically indexed. Does these look like numbers to you? %s","event_espresso"),implode(",",array_keys($data))));
+			if (EEH_Array::is_associative_array($data)) {
+				throw new EE_Error(sprintf(__("top-level array must be numerically indexed. Does these look like numbers to you? %s", "event_espresso"), implode(",", array_keys($data))));
 			}
 			$item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
 			//now, is the last item in the top-level array of $data an associative or numeric array?
-			if( $write_column_headers &&
-					EEH_Array::is_associative_array($item_in_top_level_array)){
+			if ($write_column_headers &&
+					EEH_Array::is_associative_array($item_in_top_level_array)) {
 				//its associative, so we want to output its keys as column headers
 				$keys = array_keys($item_in_top_level_array);
-				$new_file_contents .=  EEH_Export::get_csv_row( $keys );
+				$new_file_contents .= EEH_Export::get_csv_row($keys);
 
 			}
 			//start writing data
-			foreach($data as $data_row){
-				$new_file_contents .= EEH_Export::get_csv_row( $data_row);
+			foreach ($data as $data_row) {
+				$new_file_contents .= EEH_Export::get_csv_row($data_row);
 			}
-			return EEH_File::write_to_file( $filepath, EEH_File::get_file_contents( $filepath ) . $new_file_contents );
-		}else{
+			return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath).$new_file_contents);
+		} else {
 			//no data TO write... so we can assume that's a success
 			return true;
 		}
@@ -94,29 +94,29 @@ 
 	 *	@param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
 	 *	@return string of text for teh csv file
 	 */
-	public static function get_csv_row ( array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false ) {
+	public static function get_csv_row(array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false) {
 		//Allow user to filter the csv delimiter and enclosure for other countries csv standards
-		$delimiter = apply_filters( 'FHEE__EE_CSV__fputcsv2__delimiter', $delimiter );
-		$enclosure = apply_filters( 'FHEE__EE_CSV__fputcsv2__enclosure', $enclosure );
+		$delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
+		$enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
 
 		$delimiter_esc = preg_quote($delimiter, '/');
 		$enclosure_esc = preg_quote($enclosure, '/');
 
 		$output = array();
 		foreach ($row as $field_value) {
-			if(is_object($field_value) || is_array($field_value)){
+			if (is_object($field_value) || is_array($field_value)) {
 				$field_value = serialize($field_value);
 			}
-			if ($field_value === null && $mysql_null ) {
+			if ($field_value === null && $mysql_null) {
 				$output[] = 'NULL';
 				continue;
 			}
 
 			$output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-				( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value;
+				($enclosure.str_replace($enclosure, $enclosure.$enclosure, $field_value).$enclosure) : $field_value;
 		}
 
-		return  implode($delimiter, $output) . PHP_EOL;
+		return  implode($delimiter, $output).PHP_EOL;
 	}
 
 
@@ -129,19 +129,19 @@ 
 	 * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to NOT display pretty
 	 * @return string
 	 */
-	public static function prepare_value_from_db_for_display( $model, $field_name,  $raw_db_value, $pretty_schema = true ) {
-		$field_obj = $model->field_settings_for( $field_name );
-		$value_on_model_obj = $field_obj->prepare_for_set_from_db( $raw_db_value );
-		if( $field_obj instanceof EE_Datetime_Field ) {
-			$field_obj->set_date_format( EEH_Export::get_date_format_for_export( $field_obj->get_date_format( $pretty_schema ) ), $pretty_schema );
-			$field_obj->set_time_format( EEH_Export::get_time_format_for_export( $field_obj->get_time_format( $pretty_schema ) ), $pretty_schema );
+	public static function prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true) {
+		$field_obj = $model->field_settings_for($field_name);
+		$value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$field_obj->set_date_format(EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)), $pretty_schema);
+			$field_obj->set_time_format(EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)), $pretty_schema);
 		}
-		if( $pretty_schema === true){
-			return $field_obj->prepare_for_pretty_echoing( $value_on_model_obj );
-		}elseif( is_string( $pretty_schema ) ) {
-			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema );
-		}else{
-			return $field_obj->prepare_for_get( $value_on_model_obj );
+		if ($pretty_schema === true) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
+		}elseif (is_string($pretty_schema)) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
+		} else {
+			return $field_obj->prepare_for_get($value_on_model_obj);
 		}
 	}
 
@@ -152,8 +152,8 @@ 
 	 * @param string $current_format
 	 * @return string
 	 */
-	public static function get_date_format_for_export( $current_format = null ) {
-		return apply_filters( 'FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format );
+	public static function get_date_format_for_export($current_format = null) {
+		return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
 	}
 
 
@@ -163,8 +163,8 @@ 
 	 * @param string $current_format
 	 * @return string
 	 */
-	public static function get_time_format_for_export( $current_format = null ) {
-		return apply_filters( 'FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format );
+	public static function get_time_format_for_export($current_format = null) {
+		return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
 	}
 
 

Braces +6 added lines, -4 removed lines

@@ -1,4 +1,6 @@ 
-<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 /**
  * Event Espresso
  *
@@ -77,7 +79,7 @@ 
 				$new_file_contents .= EEH_Export::get_csv_row( $data_row);
 			}
 			return EEH_File::write_to_file( $filepath, EEH_File::get_file_contents( $filepath ) . $new_file_contents );
-		}else{
+		} else{
 			//no data TO write... so we can assume that's a success
 			return true;
 		}
@@ -138,9 +140,9 @@ 
 		}
 		if( $pretty_schema === true){
 			return $field_obj->prepare_for_pretty_echoing( $value_on_model_obj );
-		}elseif( is_string( $pretty_schema ) ) {
+		} elseif( is_string( $pretty_schema ) ) {
 			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema );
-		}else{
+		} else{
 			return $field_obj->prepare_for_get( $value_on_model_obj );
 		}
 	}

Indentation +30 added lines, -30 removed lines

@@ -1,28 +1,28 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
 /**
- * Event Espresso
- *
- * Event Registration and Management Plugin for WordPress
- *
- * @ package			Event Espresso
- * @ author			Seth Shoultes
- * @ copyright		(c) 2008-2011 Event Espresso  All Rights Reserved.
- * @ license			http://eventespresso.com/support/terms-conditions/   * see Plugin Licensing *
- * @ link					http://www.eventespresso.com
- * @ version		 	4.0
- *
- * ------------------------------------------------------------------------
- *
- * EEH_Export Helper
- *
- * Static class for helping in creating exports
- *
- * @package			Event Espresso
- * @subpackage	/helpers/
- * @author				Brent Christensen
- *
- * ------------------------------------------------------------------------
- */
+	 * Event Espresso
+	 *
+	 * Event Registration and Management Plugin for WordPress
+	 *
+	 * @ package			Event Espresso
+	 * @ author			Seth Shoultes
+	 * @ copyright		(c) 2008-2011 Event Espresso  All Rights Reserved.
+	 * @ license			http://eventespresso.com/support/terms-conditions/   * see Plugin Licensing *
+	 * @ link					http://www.eventespresso.com
+	 * @ version		 	4.0
+	 *
+	 * ------------------------------------------------------------------------
+	 *
+	 * EEH_Export Helper
+	 *
+	 * Static class for helping in creating exports
+	 *
+	 * @package			Event Espresso
+	 * @subpackage	/helpers/
+	 * @author				Brent Christensen
+	 *
+	 * ------------------------------------------------------------------------
+	 */
 
 class EEH_Export {
 	/**
@@ -87,13 +87,13 @@ 
 
 	 /**
 	  *
-	 *	Writes a row to the csv file
-	 *	@param array $row - individual row of csv data
-	 *	@param string $delimiter - csv delimiter
-	 *	@param string $enclosure - csv enclosure
-	 *	@param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
-	 *	@return string of text for teh csv file
-	 */
+	  *	Writes a row to the csv file
+	  *	@param array $row - individual row of csv data
+	  *	@param string $delimiter - csv delimiter
+	  *	@param string $enclosure - csv enclosure
+	  *	@param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
+	  *	@return string of text for teh csv file
+	  */
 	public static function get_csv_row ( array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false ) {
 		//Allow user to filter the csv delimiter and enclosure for other countries csv standards
 		$delimiter = apply_filters( 'FHEE__EE_CSV__fputcsv2__delimiter', $delimiter );

core/libraries/batch/BatchRequestProcessor.php

Spacing +43 added lines, -43 removed lines

@@ -23,8 +23,8 @@ 
 use EventEspressoBatchRequest\Helpers\JobParameters;
 use EventEspressoBatchRequest\Helpers\JobStepResponse;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -50,32 +50,32 @@ 
 	 * @param array $request_data to be used by the batch job handler
 	 * @return JobStepResponse
 	 */
-	public function create_job( $batch_job_handler_class, $request_data ) {
+	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 ) {
+			$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 )
+						__('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 ) {
+			$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 )
+						wp_json_encode($request_data)
 					)
 				);
 			}
-		} catch( \Exception $e ) {
-			$response = $this->_get_error_response( $e, 'create_job' );
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'create_job');
 		}
 		return $response;
 	}
@@ -88,26 +88,26 @@ 
 	 * @param int $batch_size
 	 * @return JobStepResponse
 	 */
-	public function continue_job( $job_id, $batch_size = 50 ) {
+	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;
+			$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() );
+			$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 ) {
+			$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' ),
+						__('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' );
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'continue_job');
 		}
 		return $response;
 	}
@@ -122,8 +122,8 @@ 
 	 * @return JobHandlerInterface
 	 * @throws BatchRequestException
 	 */
-	public function instantiate_batch_job_handler_from_classname( $classname ) {
-		if( ! class_exists( $classname ) ) {
+	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'),
@@ -132,7 +132,7 @@ 
 			);
 		}
 		$obj = new $classname;
-		if( ! $obj instanceof JobHandlerInterface ) {
+		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'),
@@ -152,26 +152,26 @@ 
 	 * @return JobStepResponse
 	 * @throws BatchRequestException
 	 */
-	public function cleanup_job( $job_id ) {
-		try{
+	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() );
+			$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 ) {
+			$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' ),
+						__('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->set_status(JobParameters::status_cleaned_up);
 			$job_parameters->delete();
 			return $response;
-		} catch( \Exception $e ) {
-			$response = $this->_get_error_response( $e, 'cleanup_job' );
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'cleanup_job');
 		}
 		return $response;
 	}
@@ -184,17 +184,17 @@ 
 	 * @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() );
+	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 );
+		$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 . '()',
+				get_class($exception),
+				'BatchRunner::'.$method_name.'()',
 				$exception->getMessage(),
 				$exception->getTraceAsString()
 			)

Indentation +15 added lines, -15 removed lines

@@ -1,21 +1,21 @@
 <?php
  /**
- *
- * Class BatchRequetProcessor
+  *
+  * Class BatchRequetProcessor
   * 
- * Responsible for receiving a request to start a job and assign it a job Id.
- * Then when subsequent requests come in to continue that job, dispatches
- * the request to the appropriate JobHandler, which processes a step of the batch,
- * and then returns the job's new status.
- * This class is used by controller code, and the controller code is sent HTTP
- * requests from the batch_runner.js library
- *
- * @package         Event Espresso
- * @subpackage    batch
- * @author				Mike Nelson
- * @since		 	   4.8.26
- *
- */
+  * Responsible for receiving a request to start a job and assign it a job Id.
+  * Then when subsequent requests come in to continue that job, dispatches
+  * the request to the appropriate JobHandler, which processes a step of the batch,
+  * and then returns the job's new status.
+  * This class is used by controller code, and the controller code is sent HTTP
+  * requests from the batch_runner.js library
+  *
+  * @package         Event Espresso
+  * @subpackage    batch
+  * @author				Mike Nelson
+  * @since		 	   4.8.26
+  *
+  */
 namespace EventEspressoBatchRequest;
 
 use EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandlerInterface;

core/libraries/batch/Helpers/BatchRequestException.php

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
 namespace EventEspressoBatchRequest\Helpers;
 if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
 
-class BatchRequestException extends \Exception{
+class BatchRequestException extends \Exception {
 	//so far the same as exception
 }
 

Indentation +12 added lines, -12 removed lines

@@ -1,17 +1,17 @@
 <?php 
  /**
- *
- * Class BatchRequestException
- *
- * Exception class for whenever we have trouble running start, continuing, or finishing
- * a batch job.
- *
- * @package         Event Espresso
- * @subpackage    batch
- * @author				Mike Nelson
- * @since		 	   4.8.26
- *
- */
+  *
+  * Class BatchRequestException
+  *
+  * Exception class for whenever we have trouble running start, continuing, or finishing
+  * a batch job.
+  *
+  * @package         Event Espresso
+  * @subpackage    batch
+  * @author				Mike Nelson
+  * @since		 	   4.8.26
+  *
+  */
 namespace EventEspressoBatchRequest\Helpers;
 if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
 

core/libraries/batch/Helpers/JobParameters.php

Spacing +40 added lines, -40 removed lines

@@ -96,12 +96,12 @@ 
 	 * @param array $request_data
 	 * @param array $extra_data
 	 */
-	function __construct( $job_id, $classname, $request_data, $extra_data = array() ) {
-		$this->set_job_id( $job_id );
-		$this->set_classname( $classname );
-		$this->set_request_data( $request_data );
-		$this->set_extra_data( $extra_data );
-		$this->set_status( JobParameters::status_continue );
+	function __construct($job_id, $classname, $request_data, $extra_data = array()) {
+		$this->set_job_id($job_id);
+		$this->set_classname($classname);
+		$this->set_request_data($request_data);
+		$this->set_extra_data($extra_data);
+		$this->set_status(JobParameters::status_continue);
 	}
 
 
@@ -126,12 +126,12 @@ 
 	 * @param boolean $first
 	 * @return boolean success
 	 */
-	function save( $first = false ) {
-		$object_vars = wp_json_encode( get_object_vars( $this ) );
-		if( $first ) {
-			return add_option( $this->option_name(), $object_vars, null, 'no' );
-		} else{
-			return update_option( $this->option_name(), $object_vars );
+	function save($first = false) {
+		$object_vars = wp_json_encode(get_object_vars($this));
+		if ($first) {
+			return add_option($this->option_name(), $object_vars, null, 'no');
+		} else {
+			return update_option($this->option_name(), $object_vars);
 		}
 	}
 
@@ -143,7 +143,7 @@ 
 	 * @return boolean
 	 */
 	function delete() {
-		return delete_option( $this->option_name() );
+		return delete_option($this->option_name());
 	}
 
 
@@ -154,26 +154,26 @@ 
 	 * @return JobParameters
 	 * @throws BatchRequestException
 	 */
-	static function load( $job_id ) {
-		$job_parameter_vars = json_decode( get_option( JobParameters::wp_option_prefix . $job_id ), true );
-		if(
-			! is_array( $job_parameter_vars ) ||
-			! isset( $job_parameter_vars[ '_classname' ] ) ||
-			! isset( $job_parameter_vars[ '_request_data' ] )
+	static function load($job_id) {
+		$job_parameter_vars = json_decode(get_option(JobParameters::wp_option_prefix.$job_id), true);
+		if (
+			! is_array($job_parameter_vars) ||
+			! isset($job_parameter_vars['_classname']) ||
+			! isset($job_parameter_vars['_request_data'])
 		) {
 			throw new BatchRequestException(
 				sprintf( 
 					__('Could not retrieve job %1$s from the Wordpress options table, and so the job could not continue. The wordpress option was %2$s', 'event_espresso'),
 					$job_id,
-					get_option( JobParameters::wp_option_prefix . $job_id )
+					get_option(JobParameters::wp_option_prefix.$job_id)
 				)
 			);
 		}
 		$job_parameters = new JobParameters( 
 				$job_id, 
-				$job_parameter_vars[ '_classname' ], 
-				$job_parameter_vars[ '_request_data'] );
-		foreach( $job_parameter_vars as $key => $value ) {
+				$job_parameter_vars['_classname'], 
+				$job_parameter_vars['_request_data'] );
+		foreach ($job_parameter_vars as $key => $value) {
 			$job_parameters->$key = $value;
 		}
 		return $job_parameters;
@@ -217,9 +217,9 @@ 
 	 * @param string|array $default
 	 * @return string|array
 	 */
-	function request_datum( $key, $default = '' ) {
-		if( isset( $this->_request_data[ $key ] ) ) {
-			return $this->_request_data[ $key ];
+	function request_datum($key, $default = '') {
+		if (isset($this->_request_data[$key])) {
+			return $this->_request_data[$key];
 		} else {
 			return $default;
 		}
@@ -233,9 +233,9 @@ 
 	 * @param string|array $default
 	 * @return string|array
 	 */
-	function extra_datum( $key, $default = '' ) {
-		if( isset( $this->_extra_data[ $key ] ) ) {
-			return $this->_extra_data[ $key ];
+	function extra_datum($key, $default = '') {
+		if (isset($this->_extra_data[$key])) {
+			return $this->_extra_data[$key];
 		} else {
 			return $default;
 		}
@@ -248,8 +248,8 @@ 
 	 * @param string $key
 	 * @param string|int|array|null $value almost any extra data you want to store
 	 */
-	function add_extra_data( $key, $value ) {
-		$this->_extra_data[ $key ] = $value;
+	function add_extra_data($key, $value) {
+		$this->_extra_data[$key] = $value;
 	}
 
 
@@ -278,7 +278,7 @@ 
 	 * Sets the job size. You decide what units to use
 	 * @param int $size
 	 */
-	function set_job_size( $size ) {
+	function set_job_size($size) {
 		$this->_job_size = $size;
 	}
 
@@ -299,7 +299,7 @@ 
 	 * @param int $newly_processed
 	 * @return int updated units processed
 	 */
-	function mark_processed( $newly_processed ) {
+	function mark_processed($newly_processed) {
 		$this->_units_processed += $newly_processed;
 		return $this->_units_processed;
 	}
@@ -310,7 +310,7 @@ 
 	 * Sets the total count of units processed. You might prefer to use mark_processed
 	 * @param int $total_units_processed
 	 */
-	function set_units_processed( $total_units_processed ) {
+	function set_units_processed($total_units_processed) {
 		$this->_units_processed = $total_units_processed;
 	}
 
@@ -320,7 +320,7 @@ 
 	 * Sets the job's ID
 	 * @param string $job_id
 	 */
-	function set_job_id( $job_id ) {
+	function set_job_id($job_id) {
 		$this->_job_id = $job_id;
 	}
 
@@ -330,7 +330,7 @@ 
 	 * sets the classname
 	 * @param string $classname
 	 */
-	function set_classname( $classname ) {
+	function set_classname($classname) {
 		$this->_classname = $classname;
 	}
 
@@ -340,7 +340,7 @@ 
 	 * Sets the request data
 	 * @param array $request_data
 	 */
-	function set_request_data( $request_data ) {
+	function set_request_data($request_data) {
 		$this->_request_data = $request_data;
 	}
 
@@ -350,7 +350,7 @@ 
 	 * Sets the array of extra data we want to store on this request
 	 * @param array $extra_data
 	 */
-	function set_extra_data( $extra_data ) {
+	function set_extra_data($extra_data) {
 		$this->_extra_data = $extra_data;
 	}
 
@@ -361,7 +361,7 @@ 
 	 * @return string
 	 */
 	function option_name() {
-		return JobParameters::wp_option_prefix . $this->job_id();
+		return JobParameters::wp_option_prefix.$this->job_id();
 	}
 
 
@@ -380,7 +380,7 @@ 
 	 *
 	 * @param string $status on eof JobParameters::valid_stati()
 	 */
-	public function set_status( $status ) {
+	public function set_status($status) {
 		$this->_status = $status;
 	}
 

Doc Comments +1 added lines, -1 removed lines

@@ -214,7 +214,7 @@
 	/**
 	 * Gets a single item from the request data
 	 * @param string $key
-	 * @param string|array $default
+	 * @param string $default
 	 * @return string|array
 	 */
 	function request_datum( $key, $default = '' ) {

core/libraries/batch/Helpers/JobStepResponse.php

Spacing +3 added lines, -3 removed lines

@@ -43,10 +43,10 @@
 	 * @param string $update_text
 	 * @param array $extra_data
 	 */
-	public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array() ) {
-		$this->_job_parameters 	= $job_parameters;
+	public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array()) {
+		$this->_job_parameters = $job_parameters;
 		$this->_update_text 	= $update_text;
-		$this->_extra_data 		= (array)$extra_data;
+		$this->_extra_data 		= (array) $extra_data;
 	}
 
 

core/libraries/batch/JobHandlerBaseClasses/JobHandlerFile.php

Spacing +19 added lines, -19 removed lines

@@ -16,8 +16,8 @@ 
 
 use EventEspressoBatchRequest\Helpers\BatchRequestException;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -29,8 +29,8 @@ 
 	 */
 	protected $_file_helper = null;
 	const temp_folder_name = 'batch_temp_folder';
-	public function __construct( EEHI_File $file_helper = null ) {
-		if( ! $file_helper ) {
+	public function __construct(EEHI_File $file_helper = null) {
+		if ( ! $file_helper) {
 			$this->_file_helper = new \EEH_File();
 		}
 	}
@@ -45,30 +45,30 @@ 
 	 * @return string
 	 * @throws BatchRequestException
 	 */
-	public function create_file_from_job_with_name( $job_id, $filename ) {
+	public function create_file_from_job_with_name($job_id, $filename) {
 		$filepath = '';
-		try{
+		try {
 			$success = $this->_file_helper->ensure_folder_exists_and_is_writable(
-				EVENT_ESPRESSO_UPLOAD_DIR . JobHandlerFile::temp_folder_name
+				EVENT_ESPRESSO_UPLOAD_DIR.JobHandlerFile::temp_folder_name
 			);
-			if ( $success ) {
+			if ($success) {
 				$success = $this->_file_helper->ensure_folder_exists_and_is_writable(
-					EVENT_ESPRESSO_UPLOAD_DIR . JobHandlerFile::temp_folder_name . DS . $job_id
+					EVENT_ESPRESSO_UPLOAD_DIR.JobHandlerFile::temp_folder_name.DS.$job_id
 				);
 			}
-			if( $success ) {
-				$filepath = EVENT_ESPRESSO_UPLOAD_DIR . JobHandlerFile::temp_folder_name . DS . $job_id . DS. $filename;
-				$success = $this->_file_helper->ensure_file_exists_and_is_writable( $filepath );
+			if ($success) {
+				$filepath = EVENT_ESPRESSO_UPLOAD_DIR.JobHandlerFile::temp_folder_name.DS.$job_id.DS.$filename;
+				$success = $this->_file_helper->ensure_file_exists_and_is_writable($filepath);
 			}
 			//those methods normally fail with an exception, but if not, let's do it
-			if( ! $success ) {
-				throw new \EE_Error( 'could_not_create_temp_file',
-				__( 'An unknown error occurred', 'event_espresso' ));
+			if ( ! $success) {
+				throw new \EE_Error('could_not_create_temp_file',
+				__('An unknown error occurred', 'event_espresso'));
 			}
-		} catch( \EE_Error $e ) {
+		} catch (\EE_Error $e) {
 			throw new BatchRequestException(
 				sprintf(
-					__( 'Could not create temporary file for job %1$s, because: %2$s ', 'event_espresso' ),
+					__('Could not create temporary file for job %1$s, because: %2$s ', 'event_espresso'),
 					$job_id,
 					$e->getMessage()
 				),
@@ -84,8 +84,8 @@ 
 	 * @param string $filepath
 	 * @return string url to file
 	 */
-	public function get_url_to_file( $filepath ) {
-		return str_replace( EVENT_ESPRESSO_UPLOAD_DIR, EVENT_ESPRESSO_UPLOAD_URL, $filepath );
+	public function get_url_to_file($filepath) {
+		return str_replace(EVENT_ESPRESSO_UPLOAD_DIR, EVENT_ESPRESSO_UPLOAD_URL, $filepath);
 	}
 }
 

Indentation +12 added lines, -12 removed lines

@@ -1,17 +1,17 @@
 <?php
 /**
- *
- * Class JobHandlerFile
- *
- * Base class for common implementations of JobHandlerInterface, but ones
- * which write to a temporary file
- *
- * @package         Event Espresso
- * @subpackage    batch
- * @author				Mike Nelson
- * @since		 	   4.8.26
- *
- */
+	 *
+	 * Class JobHandlerFile
+	 *
+	 * Base class for common implementations of JobHandlerInterface, but ones
+	 * which write to a temporary file
+	 *
+	 * @package         Event Espresso
+	 * @subpackage    batch
+	 * @author				Mike Nelson
+	 * @since		 	   4.8.26
+	 *
+	 */
 namespace EventEspressoBatchRequest\JobHandlerBaseClasses;
 
 use EventEspressoBatchRequest\Helpers\BatchRequestException;

core/libraries/batch/JobHandlerBaseClasses/JobHandlerInterface.php

Spacing +5 added lines, -5 removed lines

@@ -20,8 +20,8 @@ 
 use EventEspressoBatchRequest\Helpers\JobParameters;
 use EventEspressoBatchRequest\Helpers\JobStepResponse;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -35,7 +35,7 @@ 
 	 * @throws BatchRequestException
 	 * @return JobStepResponse
 	 */
-	public function create_job( JobParameters $job_parameters );
+	public function create_job(JobParameters $job_parameters);
 
 	/**
 	 * Performs another step of the job
@@ -44,7 +44,7 @@ 
 	 * @return JobStepResponse
 	 * @throws BatchRequestException
 	 */
-	public function continue_job( JobParameters $job_parameters, $batch_size = 50 );
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50);
 
 	/**
 	 * Performs any clean-up logic when we know the job is completed
@@ -52,5 +52,5 @@ 
 	 * @return JobStepResponse
 	 * @throws BatchRequestException
 	 */
-	public function cleanup_job( JobParameters $job_parameters );
+	public function cleanup_job(JobParameters $job_parameters);
 }