eventespresso / event-espresso-core

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/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/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);
 }

core/libraries/batch/JobHandlers/AttendeesReport.php

Braces +2 added lines, -2 removed lines

@@ -99,10 +99,10 @@
 				if( $field_name == 'STA_ID' ){
 					$state_name_field = \EEM_State::instance()->field_settings_for( 'STA_name' );
 					$csv_row[ __( 'State', 'event_espresso' ) ] = $attendee_row[ $state_name_field->get_qualified_column() ];
-				}elseif( $field_name == 'CNT_ISO' ){
+				} elseif( $field_name == 'CNT_ISO' ){
 					$country_name_field = \EEM_Country::instance()->field_settings_for( 'CNT_name' );
 					$csv_row[ __( 'Country', 'event_espresso' ) ] = $attendee_row[ $country_name_field->get_qualified_column() ];
-				}else{
+				} else{
 					$csv_row[ $field_obj->get_nicename() ] = $attendee_row[ $field_obj->get_qualified_column() ];
 				}
 			}

Spacing +35 added lines, -35 removed lines

@@ -18,7 +18,7 @@ 
 use EventEspressoBatchRequest\Helpers\JobParameters;
 use EventEspressoBatchRequest\Helpers\JobStepResponse;
 
-if (!defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
 	exit('No direct script access allowed');
 }
 
@@ -27,84 +27,84 @@ 
 
 
 	public function create_job(JobParameters $job_parameters) {
-		if( ! \EE_Capabilities::instance()->current_user_can( 'ee_read_contacts', 'generating_report' ) ) {
+		if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
 			throw new BatchRequestException(
-				__( 'You do not have permission to view contacts', 'event_espresso')
+				__('You do not have permission to view contacts', 'event_espresso')
 			);
 		}
 		$filepath = $this->create_file_from_job_with_name(
 			$job_parameters->job_id(),
 			__('contact-list-report.csv', 'event_espresso')
 		);
-		$job_parameters->add_extra_data( 'filepath', $filepath );
-		$job_parameters->set_job_size( $this->count_units_to_process() );
+		$job_parameters->add_extra_data('filepath', $filepath);
+		$job_parameters->set_job_size($this->count_units_to_process());
 		//we should also set the header columns
-		$csv_data_for_row = $this->get_csv_data( 0, 1 );
-		\EEH_Export::write_data_array_to_csv( $filepath, $csv_data_for_row, true );
+		$csv_data_for_row = $this->get_csv_data(0, 1);
+		\EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
 		//if we actually processed a row there, record it
-		if( $job_parameters->job_size() ) {
-			$job_parameters->mark_processed( 1 );
+		if ($job_parameters->job_size()) {
+			$job_parameters->mark_processed(1);
 		}
 		return new JobStepResponse(
 			$job_parameters,
-			__( 'Contacts report started successfully...', 'event_espresso' )
+			__('Contacts report started successfully...', 'event_espresso')
 		);
 	}
 
 
 	public function continue_job(JobParameters $job_parameters, $batch_size = 50) {
-		$csv_data = $this->get_csv_data( $job_parameters->units_processed(), $batch_size );
-		\EEH_Export::write_data_array_to_csv( $job_parameters->extra_datum( 'filepath' ), $csv_data, false );
-		$units_processed = count( $csv_data );
-		$job_parameters->mark_processed( $units_processed );
+		$csv_data = $this->get_csv_data($job_parameters->units_processed(), $batch_size);
+		\EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
+		$units_processed = count($csv_data);
+		$job_parameters->mark_processed($units_processed);
 		$extra_response_data = array(
 			'file_url' => ''
 		);
-		if( $units_processed < $batch_size ) {
-			$job_parameters->set_status( JobParameters::status_complete );
-			$extra_response_data[ 'file_url' ] = $this->get_url_to_file( $job_parameters->extra_datum( 'filepath' ) );
+		if ($units_processed < $batch_size) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
 		}
 		return new JobStepResponse(
 				$job_parameters,
 				sprintf(
-					__( 'Wrote %1$s rows to report CSV file...', 'event_espresso' ),
-					count( $csv_data ) ),
+					__('Wrote %1$s rows to report CSV file...', 'event_espresso'),
+					count($csv_data) ),
 				$extra_response_data );
 	}
 
 
 	public function cleanup_job(JobParameters $job_parameters) {
 		$this->_file_helper->delete(
-			\EEH_File::remove_filename_from_filepath( $job_parameters->extra_datum( 'filepath' ) ),
+			\EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
 			true,
 			'd'
 		);
-		return new JobStepResponse( $job_parameters, __( 'Cleaned up temporary file', 'event_espresso' ) );
+		return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
 	}
 
 	public function count_units_to_process() {
-		return \EEM_Attendee::instance()->count( array( 'caps' => \EEM_Base::caps_read_admin ));
+		return \EEM_Attendee::instance()->count(array('caps' => \EEM_Base::caps_read_admin));
 	}
-	public function get_csv_data( $offset, $limit ) {
+	public function get_csv_data($offset, $limit) {
 		$attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results( 
 			array( 
-				'limit' => array( $offset, $limit ),
-				'force_join' => array( 'State', 'Country' ),
+				'limit' => array($offset, $limit),
+				'force_join' => array('State', 'Country'),
 				'caps' => \EEM_Base::caps_read_admin
 			) 
 		);
 		$csv_data = array();
-		foreach( $attendee_rows as $attendee_row ){
+		foreach ($attendee_rows as $attendee_row) {
 			$csv_row = array();
-			foreach( \EEM_Attendee::instance()->field_settings() as $field_name => $field_obj ){
-				if( $field_name == 'STA_ID' ){
-					$state_name_field = \EEM_State::instance()->field_settings_for( 'STA_name' );
-					$csv_row[ __( 'State', 'event_espresso' ) ] = $attendee_row[ $state_name_field->get_qualified_column() ];
-				}elseif( $field_name == 'CNT_ISO' ){
-					$country_name_field = \EEM_Country::instance()->field_settings_for( 'CNT_name' );
-					$csv_row[ __( 'Country', 'event_espresso' ) ] = $attendee_row[ $country_name_field->get_qualified_column() ];
-				}else{
-					$csv_row[ $field_obj->get_nicename() ] = $attendee_row[ $field_obj->get_qualified_column() ];
+			foreach (\EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
+				if ($field_name == 'STA_ID') {
+					$state_name_field = \EEM_State::instance()->field_settings_for('STA_name');
+					$csv_row[__('State', 'event_espresso')] = $attendee_row[$state_name_field->get_qualified_column()];
+				}elseif ($field_name == 'CNT_ISO') {
+					$country_name_field = \EEM_Country::instance()->field_settings_for('CNT_name');
+					$csv_row[__('Country', 'event_espresso')] = $attendee_row[$country_name_field->get_qualified_column()];
+				} else {
+					$csv_row[$field_obj->get_nicename()] = $attendee_row[$field_obj->get_qualified_column()];
 				}
 			}
 			$csv_data[] = $csv_row;

Doc Comments +5 added lines

@@ -85,6 +85,11 @@
 	public function count_units_to_process() {
 		return \EEM_Attendee::instance()->count( array( 'caps' => \EEM_Base::caps_read_admin ));
 	}
+
+	/**
+	 * @param integer $offset
+	 * @param integer $limit
+	 */
 	public function get_csv_data( $offset, $limit ) {
 		$attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results( 
 			array( 

core/libraries/batch/JobHandlers/RegistrationsReport.php

Braces +8 added lines, -8 removed lines

@@ -75,7 +75,7 @@ 
 			if( ! $event_slug ) {
 				$event_slug = __( 'unknown', 'event_espresso' );
 			}
-		}else{
+		} else{
 			$event_slug = __( 'all', 'event_espresso' );
 		}
 		return sprintf( "registrations-for-%s.csv", $event_slug );
@@ -162,7 +162,7 @@ 
 		);
 		if( $event_id ){
 			$query_params[0]['EVT_ID'] =  $event_id;
-		}else{
+		} else{
 			$query_params[ 'force_join' ][] = 'Event';
 		}
 		$registration_rows = $reg_model->get_all_wpdb_results( $query_params );
@@ -191,11 +191,11 @@ 
 					$field = $reg_model->field_settings_for($field_name);
 					if($field_name == 'REG_final_price'){
 						$value = \EEH_Export::prepare_value_from_db_for_display( $reg_model, $field_name, $reg_row[ 'Registration.REG_final_price'], 'localized_float' );
-					}elseif( $field_name == 'REG_count' ){
+					} elseif( $field_name == 'REG_count' ){
 						$value = sprintf( __( '%s of %s', 'event_espresso' ), \EEH_Export::prepare_value_from_db_for_display( $reg_model, 'REG_count', $reg_row['Registration.REG_count'] ), \EEH_Export::prepare_value_from_db_for_display( $reg_model, 'REG_group_size', $reg_row['Registration.REG_group_size' ] ) );
-					}elseif( $field_name == 'REG_date' ) {
+					} elseif( $field_name == 'REG_date' ) {
 						$value = \EEH_Export::prepare_value_from_db_for_display( $reg_model, $field_name, $reg_row[ 'Registration.REG_date'], 'no_html' );
-					}else{
+					} else{
 						$value = \EEH_Export::prepare_value_from_db_for_display( $reg_model, $field_name, $reg_row[ $field->get_qualified_column() ] );
 					}
 					$reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = $value;
@@ -267,12 +267,12 @@ 
 					if( $reg_row[ 'Attendee_CPT.ID' ]){
 						if($att_field_name == 'STA_ID'){
 							$value = \EEM_State::instance()->get_var( array( array( 'STA_ID' => $reg_row[ 'Attendee_Meta.STA_ID' ] ) ), 'STA_name' );
-						}elseif($att_field_name == 'CNT_ISO'){
+						} elseif($att_field_name == 'CNT_ISO'){
 							$value = \EEM_Country::instance()->get_var( array( array( 'CNT_ISO' => $reg_row[ 'Attendee_Meta.CNT_ISO' ] ) ), 'CNT_name' );
-						}else{
+						} else{
 							$value = \EEH_Export::prepare_value_from_db_for_display( \EEM_Attendee::instance(), $att_field_name, $reg_row[ $field_obj->get_qualified_column() ] );
 						}
-					}else{
+					} else{
 						$value = '';
 					}
 

Doc Comments +1 added lines, -1 removed lines

@@ -410,7 +410,7 @@
 	 * Performs any clean-up logic when we know the job is completed.
 	 * In this case, we delete the temporary file
 	 * @param JobParameters $job_parameters
-	 * @return boolean
+	 * @return JobStepResponse
 	 */
 	public function cleanup_job( JobParameters $job_parameters ){
 		$this->_file_helper->delete(

Spacing +136 added lines, -136 removed lines

@@ -19,8 +19,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,35 +35,35 @@ 
 	 * @throws BatchRequestException
 	 * @return JobStepResponse
 	 */
-	public function create_job( JobParameters $job_parameters ) {
-		$event_id = intval( $job_parameters->request_datum( 'EVT_ID', '0' ) );
-		if( ! \EE_Capabilities::instance()->current_user_can( 'ee_read_registrations', 'generating_report' ) ) {
+	public function create_job(JobParameters $job_parameters) {
+		$event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
+		if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
 			throw new BatchRequestException(
-				__( 'You do not have permission to view registrations', 'event_espresso')
+				__('You do not have permission to view registrations', 'event_espresso')
 			);
 		}
 		$filepath = $this->create_file_from_job_with_name(
 			$job_parameters->job_id(),
-			$this->get_filename_from_event( $event_id )
+			$this->get_filename_from_event($event_id)
 		);
-		$job_parameters->add_extra_data( 'filepath', $filepath );
-		$question_data_for_columns = $this->_get_questions_for_report( $event_id );
-		$job_parameters->add_extra_data( 'questions_data', $question_data_for_columns );
-		$job_parameters->set_job_size( $this->count_units_to_process( $event_id ) );
+		$job_parameters->add_extra_data('filepath', $filepath);
+		$question_data_for_columns = $this->_get_questions_for_report($event_id);
+		$job_parameters->add_extra_data('questions_data', $question_data_for_columns);
+		$job_parameters->set_job_size($this->count_units_to_process($event_id));
 		//we should also set the header columns
 		$csv_data_for_row = $this->get_csv_data_for(
 			$event_id,
 			0,
 			1,
-			$job_parameters->extra_datum( 'questions_data' ) );
-		\EEH_Export::write_data_array_to_csv( $filepath, $csv_data_for_row, true );
+			$job_parameters->extra_datum('questions_data') );
+		\EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
 		//if we actually processed a row there, record it
-		if( $job_parameters->job_size() ) {
-			$job_parameters->mark_processed( 1 );
+		if ($job_parameters->job_size()) {
+			$job_parameters->mark_processed(1);
 		}
 		return new JobStepResponse(
 			$job_parameters,
-			__( 'Registrations report started successfully...', 'event_espresso' )
+			__('Registrations report started successfully...', 'event_espresso')
 		);
 	}
 
@@ -74,16 +74,16 @@ 
 	 * @param int $event_id
 	 * @return string
 	 */
-	protected function get_filename_from_event( $event_id ) {
-		if( $event_id ){
-			$event_slug =  \EEM_Event::instance()->get_var( array( array( 'EVT_ID' => $event_id ) ), 'EVT_slug' );
-			if( ! $event_slug ) {
-				$event_slug = __( 'unknown', 'event_espresso' );
+	protected function get_filename_from_event($event_id) {
+		if ($event_id) {
+			$event_slug = \EEM_Event::instance()->get_var(array(array('EVT_ID' => $event_id)), 'EVT_slug');
+			if ( ! $event_slug) {
+				$event_slug = __('unknown', 'event_espresso');
 			}
-		}else{
-			$event_slug = __( 'all', 'event_espresso' );
+		} else {
+			$event_slug = __('all', 'event_espresso');
 		}
-		return sprintf( "registrations-for-%s.csv", $event_slug );
+		return sprintf("registrations-for-%s.csv", $event_slug);
 	}
 
 	/**
@@ -92,17 +92,17 @@ 
 	 * @param int|null $event_id
 	 * @return array of wpdb results for questions which are to be used for this report
 	 */
-	protected function _get_questions_for_report( $event_id ) {
+	protected function _get_questions_for_report($event_id) {
 		$question_query_params = array(
 			array(
-				'Answer.ANS_ID' => array( 'IS_NOT_NULL' ),
+				'Answer.ANS_ID' => array('IS_NOT_NULL'),
 			),
-			'group_by' => array( 'QST_ID' )
+			'group_by' => array('QST_ID')
 		);
-		if( $event_id ) {
+		if ($event_id) {
 			$question_query_params[0]['Answer.Registration.EVT_ID'] = $event_id;
 		}
-		return \EEM_Question::instance()->get_all_wpdb_results( $question_query_params );
+		return \EEM_Question::instance()->get_all_wpdb_results($question_query_params);
 	}
 
 
@@ -115,27 +115,27 @@ 
 	 * @return JobStepResponse
 	 * @throws \EE_Error
 	 */
-	public function continue_job( JobParameters $job_parameters, $batch_size = 50 ) {
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50) {
 		$csv_data = $this->get_csv_data_for(
-			$job_parameters->request_datum( 'EVT_ID', '0'),
+			$job_parameters->request_datum('EVT_ID', '0'),
 			$job_parameters->units_processed(),
 			$batch_size,
-			$job_parameters->extra_datum( 'questions_data' ) );
-		\EEH_Export::write_data_array_to_csv( $job_parameters->extra_datum( 'filepath' ), $csv_data, false );
-		$units_processed = count( $csv_data );
-		$job_parameters->mark_processed( $units_processed );
+			$job_parameters->extra_datum('questions_data') );
+		\EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
+		$units_processed = count($csv_data);
+		$job_parameters->mark_processed($units_processed);
 		$extra_response_data = array(
 			'file_url' => ''
 		);
-		if( $units_processed < $batch_size ) {
-			$job_parameters->set_status( JobParameters::status_complete );
-			$extra_response_data[ 'file_url' ] = $this->get_url_to_file( $job_parameters->extra_datum( 'filepath' ) );
+		if ($units_processed < $batch_size) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
 		}
 		return new JobStepResponse(
 				$job_parameters,
 				sprintf(
-					__( 'Wrote %1$s rows to report CSV file...', 'event_espresso' ),
-					count( $csv_data ) ),
+					__('Wrote %1$s rows to report CSV file...', 'event_espresso'),
+					count($csv_data) ),
 				$extra_response_data );
 	}
 
@@ -148,7 +148,7 @@ 
 	 * @return array top-level keys are numeric, next-level keys are column headers
 	 *
 	 */
-	function get_csv_data_for( $event_id, $offset, $limit, $questions_for_these_regs_rows ) {
+	function get_csv_data_for($event_id, $offset, $limit, $questions_for_these_regs_rows) {
 		$reg_fields_to_include = array(
 			'TXN_ID',
 			'ATT_ID',
@@ -179,166 +179,166 @@ 
 				array(
 					'OR' => array(
 						//don't include registrations from failed or abandoned transactions...
-						'Transaction.STS_ID' => array( 'NOT IN', array( \EEM_Transaction::failed_status_code, \EEM_Transaction::abandoned_status_code ) ),
+						'Transaction.STS_ID' => array('NOT IN', array(\EEM_Transaction::failed_status_code, \EEM_Transaction::abandoned_status_code)),
 						//unless the registration is approved, in which case include it regardless of transaction status
 						'STS_ID' => \EEM_Registration::status_id_approved
 						),
-					'Ticket.TKT_deleted' => array( 'IN', array( true, false ) )
+					'Ticket.TKT_deleted' => array('IN', array(true, false))
 					),
-				'order_by' => array('Transaction.TXN_ID'=>'asc','REG_count'=>'asc'),
-				'force_join' => array( 'Transaction', 'Ticket', 'Attendee' ),
-				'limit' => array( $offset, $limit ),
+				'order_by' => array('Transaction.TXN_ID'=>'asc', 'REG_count'=>'asc'),
+				'force_join' => array('Transaction', 'Ticket', 'Attendee'),
+				'limit' => array($offset, $limit),
 				'caps' => \EEM_Base::caps_read_admin
 			),
 			$event_id
 		);
-		if( $event_id ){
-			$query_params[0]['EVT_ID'] =  $event_id;
-		}else{
-			$query_params[ 'force_join' ][] = 'Event';
+		if ($event_id) {
+			$query_params[0]['EVT_ID'] = $event_id;
+		} else {
+			$query_params['force_join'][] = 'Event';
 		}
-		$registration_rows = $reg_model->get_all_wpdb_results( $query_params );
+		$registration_rows = $reg_model->get_all_wpdb_results($query_params);
 		//get all questions which relate to someone in this group
 		$registration_ids = array();
-		foreach( $registration_rows as $reg_row ) {
-			$registration_ids[] = intval( $reg_row[ 'Registration.REG_ID'] );
+		foreach ($registration_rows as $reg_row) {
+			$registration_ids[] = intval($reg_row['Registration.REG_ID']);
 		}
 
-		foreach($registration_rows as $reg_row){
-			if ( is_array( $reg_row ) ) {
+		foreach ($registration_rows as $reg_row) {
+			if (is_array($reg_row)) {
 				$reg_csv_array = array();
-				if( ! $event_id ){
+				if ( ! $event_id) {
 					//get the event's name and Id
-					$reg_csv_array[ __( 'Event', 'event_espresso' ) ] = sprintf( __( '%1$s (%2$s)', 'event_espresso' ), \EEH_Export::prepare_value_from_db_for_display( \EEM_Event::instance(), 'EVT_name', $reg_row[ 'Event_CPT.post_title'] ), $reg_row[ 'Event_CPT.ID' ] );
+					$reg_csv_array[__('Event', 'event_espresso')] = sprintf(__('%1$s (%2$s)', 'event_espresso'), \EEH_Export::prepare_value_from_db_for_display(\EEM_Event::instance(), 'EVT_name', $reg_row['Event_CPT.post_title']), $reg_row['Event_CPT.ID']);
 				}
-				$is_primary_reg = $reg_row[ 'Registration.REG_count' ] == '1' ? true : false;
+				$is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
 				/*@var $reg_row EE_Registration */
-				foreach($reg_fields_to_include as $field_name){
+				foreach ($reg_fields_to_include as $field_name) {
 					$field = $reg_model->field_settings_for($field_name);
-					if($field_name == 'REG_final_price'){
-						$value = \EEH_Export::prepare_value_from_db_for_display( $reg_model, $field_name, $reg_row[ 'Registration.REG_final_price'], 'localized_float' );
-					}elseif( $field_name == 'REG_count' ){
-						$value = sprintf( __( '%s of %s', 'event_espresso' ), \EEH_Export::prepare_value_from_db_for_display( $reg_model, 'REG_count', $reg_row['Registration.REG_count'] ), \EEH_Export::prepare_value_from_db_for_display( $reg_model, 'REG_group_size', $reg_row['Registration.REG_group_size' ] ) );
-					}elseif( $field_name == 'REG_date' ) {
-						$value = \EEH_Export::prepare_value_from_db_for_display( $reg_model, $field_name, $reg_row[ 'Registration.REG_date'], 'no_html' );
-					}else{
-						$value = \EEH_Export::prepare_value_from_db_for_display( $reg_model, $field_name, $reg_row[ $field->get_qualified_column() ] );
+					if ($field_name == 'REG_final_price') {
+						$value = \EEH_Export::prepare_value_from_db_for_display($reg_model, $field_name, $reg_row['Registration.REG_final_price'], 'localized_float');
+					}elseif ($field_name == 'REG_count') {
+						$value = sprintf(__('%s of %s', 'event_espresso'), \EEH_Export::prepare_value_from_db_for_display($reg_model, 'REG_count', $reg_row['Registration.REG_count']), \EEH_Export::prepare_value_from_db_for_display($reg_model, 'REG_group_size', $reg_row['Registration.REG_group_size']));
+					}elseif ($field_name == 'REG_date') {
+						$value = \EEH_Export::prepare_value_from_db_for_display($reg_model, $field_name, $reg_row['Registration.REG_date'], 'no_html');
+					} else {
+						$value = \EEH_Export::prepare_value_from_db_for_display($reg_model, $field_name, $reg_row[$field->get_qualified_column()]);
 					}
 					$reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = $value;
-					if($field_name == 'REG_final_price'){
+					if ($field_name == 'REG_final_price') {
 						//add a column named Currency after the final price
 						$reg_csv_array[__("Currency", "event_espresso")] = \EE_Config::instance()->currency->code;
 					}
 				}
 				//get pretty status
-				$stati = \EEM_Status::instance()->localized_status( array(
-					$reg_row[ 'Registration.STS_ID' ] => __( 'unknown', 'event_espresso' ),
-					$reg_row[ 'TransactionTable.STS_ID' ] => __( 'unknown', 'event_espresso' ) ),
+				$stati = \EEM_Status::instance()->localized_status(array(
+					$reg_row['Registration.STS_ID'] => __('unknown', 'event_espresso'),
+					$reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso') ),
 						FALSE,
-						'sentence' );
-				$reg_csv_array[__("Registration Status", 'event_espresso')] = $stati[ $reg_row[ 'Registration.STS_ID' ] ];
+						'sentence');
+				$reg_csv_array[__("Registration Status", 'event_espresso')] = $stati[$reg_row['Registration.STS_ID']];
 				//get pretty transaction status
-				$reg_csv_array[__("Transaction Status", 'event_espresso')] = $stati[ $reg_row[ 'TransactionTable.STS_ID' ] ];
-				$reg_csv_array[ __( 'Transaction Amount Due', 'event_espresso' ) ] = $is_primary_reg ? \EEH_Export::prepare_value_from_db_for_display( \EEM_Transaction::instance(), 'TXN_total', $reg_row[ 'TransactionTable.TXN_total' ], 'localized_float' ) : '0.00';
-				$reg_csv_array[ __( 'Amount Paid', 'event_espresso' )] = $is_primary_reg ? \EEH_Export::prepare_value_from_db_for_display( \EEM_Transaction::instance(), 'TXN_paid', $reg_row[ 'TransactionTable.TXN_paid' ], 'localized_float' ) : '0.00';
+				$reg_csv_array[__("Transaction Status", 'event_espresso')] = $stati[$reg_row['TransactionTable.STS_ID']];
+				$reg_csv_array[__('Transaction Amount Due', 'event_espresso')] = $is_primary_reg ? \EEH_Export::prepare_value_from_db_for_display(\EEM_Transaction::instance(), 'TXN_total', $reg_row['TransactionTable.TXN_total'], 'localized_float') : '0.00';
+				$reg_csv_array[__('Amount Paid', 'event_espresso')] = $is_primary_reg ? \EEH_Export::prepare_value_from_db_for_display(\EEM_Transaction::instance(), 'TXN_paid', $reg_row['TransactionTable.TXN_paid'], 'localized_float') : '0.00';
 				$payment_methods = array();
 				$gateway_txn_ids_etc = array();
 				$payment_times = array();
-				if( $is_primary_reg && $reg_row[ 'TransactionTable.TXN_ID' ] ){
+				if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
 					$payments_info = \EEM_Payment::instance()->get_all_wpdb_results(
 							array(
 								array(
-									'TXN_ID' => $reg_row[ 'TransactionTable.TXN_ID' ],
+									'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
 									'STS_ID' => \EEM_Payment::status_id_approved
 								),
-								'force_join' => array( 'Payment_Method' ),
+								'force_join' => array('Payment_Method'),
 
 							),
 							ARRAY_A,
 							'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time' );
 
-					foreach( $payments_info as $payment_method_and_gateway_txn_id ){
-						$payment_methods[] = isset( $payment_method_and_gateway_txn_id[ 'name' ] ) ? $payment_method_and_gateway_txn_id[ 'name' ] : __( 'Unknown', 'event_espresso' );
-						$gateway_txn_ids_etc[] = isset( $payment_method_and_gateway_txn_id[ 'gateway_txn_id' ] ) ? $payment_method_and_gateway_txn_id[ 'gateway_txn_id' ] : '';
-						$payment_times[] = isset( $payment_method_and_gateway_txn_id[ 'payment_time' ] ) ? $payment_method_and_gateway_txn_id[ 'payment_time' ] : '';
+					foreach ($payments_info as $payment_method_and_gateway_txn_id) {
+						$payment_methods[] = isset($payment_method_and_gateway_txn_id['name']) ? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso');
+						$gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id']) ? $payment_method_and_gateway_txn_id['gateway_txn_id'] : '';
+						$payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time']) ? $payment_method_and_gateway_txn_id['payment_time'] : '';
 					}
 
 				}
-				$reg_csv_array[ __( 'Payment Date(s)', 'event_espresso' ) ] = implode( ',', $payment_times );
-				$reg_csv_array[ __( 'Payment Method(s)', 'event_espresso' ) ] = implode( ",", $payment_methods );
-				$reg_csv_array[ __( 'Gateway Transaction ID(s)', 'event_espresso' )] = implode( ',', $gateway_txn_ids_etc );
+				$reg_csv_array[__('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
+				$reg_csv_array[__('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
+				$reg_csv_array[__('Gateway Transaction ID(s)', 'event_espresso')] = implode(',', $gateway_txn_ids_etc);
 
 				//get whether or not the user has checked in
-				$reg_csv_array[__("Check-Ins", "event_espresso")] = $reg_model->count_related( $reg_row[ 'Registration.REG_ID'] , 'Checkin' );
+				$reg_csv_array[__("Check-Ins", "event_espresso")] = $reg_model->count_related($reg_row['Registration.REG_ID'], 'Checkin');
 				//get ticket of registration and its price
 				$ticket_model = \EE_Registry::instance()->load_model('Ticket');
-				if( $reg_row[ 'Ticket.TKT_ID'] ) {
-					$ticket_name = \EEH_Export::prepare_value_from_db_for_display( $ticket_model, 'TKT_name', $reg_row[ 'Ticket.TKT_name' ] );
+				if ($reg_row['Ticket.TKT_ID']) {
+					$ticket_name = \EEH_Export::prepare_value_from_db_for_display($ticket_model, 'TKT_name', $reg_row['Ticket.TKT_name']);
 					$datetimes_strings = array();
-					foreach( \EEM_Datetime::instance()->get_all_wpdb_results( array( array( 'Ticket.TKT_ID' => $reg_row[ 'Ticket.TKT_ID' ] ), 'order_by' => array( 'DTT_EVT_start' => 'ASC' ), 'default_where_conditions' => 'none' ) ) as $datetime){
-						$datetimes_strings[] = \EEH_Export::prepare_value_from_db_for_display( \EEM_Datetime::instance(), 'DTT_EVT_start', $datetime[ 'Datetime.DTT_EVT_start'] );
+					foreach (\EEM_Datetime::instance()->get_all_wpdb_results(array(array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']), 'order_by' => array('DTT_EVT_start' => 'ASC'), 'default_where_conditions' => 'none')) as $datetime) {
+						$datetimes_strings[] = \EEH_Export::prepare_value_from_db_for_display(\EEM_Datetime::instance(), 'DTT_EVT_start', $datetime['Datetime.DTT_EVT_start']);
 					}
 
 				} else {
-					$ticket_name = __( 'Unknown', 'event_espresso' );
-					$datetimes_strings = array( __( 'Unknown', 'event_espresso' ) );
+					$ticket_name = __('Unknown', 'event_espresso');
+					$datetimes_strings = array(__('Unknown', 'event_espresso'));
 				}
 				$reg_csv_array[$ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
 				$reg_csv_array[__("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
 				//get datetime(s) of registration
 
 				//add attendee columns
-				foreach($att_fields_to_include as $att_field_name){
+				foreach ($att_fields_to_include as $att_field_name) {
 					$field_obj = \EEM_Attendee::instance()->field_settings_for($att_field_name);
-					if( $reg_row[ 'Attendee_CPT.ID' ]){
-						if($att_field_name == 'STA_ID'){
-							$value = \EEM_State::instance()->get_var( array( array( 'STA_ID' => $reg_row[ 'Attendee_Meta.STA_ID' ] ) ), 'STA_name' );
-						}elseif($att_field_name == 'CNT_ISO'){
-							$value = \EEM_Country::instance()->get_var( array( array( 'CNT_ISO' => $reg_row[ 'Attendee_Meta.CNT_ISO' ] ) ), 'CNT_name' );
-						}else{
-							$value = \EEH_Export::prepare_value_from_db_for_display( \EEM_Attendee::instance(), $att_field_name, $reg_row[ $field_obj->get_qualified_column() ] );
+					if ($reg_row['Attendee_CPT.ID']) {
+						if ($att_field_name == 'STA_ID') {
+							$value = \EEM_State::instance()->get_var(array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])), 'STA_name');
+						}elseif ($att_field_name == 'CNT_ISO') {
+							$value = \EEM_Country::instance()->get_var(array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])), 'CNT_name');
+						} else {
+							$value = \EEH_Export::prepare_value_from_db_for_display(\EEM_Attendee::instance(), $att_field_name, $reg_row[$field_obj->get_qualified_column()]);
 						}
-					}else{
+					} else {
 						$value = '';
 					}
 
-					$reg_csv_array[ \EEH_Export::get_column_name_for_field($field_obj) ] = $value;
+					$reg_csv_array[\EEH_Export::get_column_name_for_field($field_obj)] = $value;
 				}
 
 				//make sure each registration has the same questions in the same order
-				foreach($questions_for_these_regs_rows as $question_row){
-					if( ! isset($reg_csv_array[$question_row[ 'Question.QST_admin_label']])){
-						$reg_csv_array[$question_row[ 'Question.QST_admin_label' ] ] = null;
+				foreach ($questions_for_these_regs_rows as $question_row) {
+					if ( ! isset($reg_csv_array[$question_row['Question.QST_admin_label']])) {
+						$reg_csv_array[$question_row['Question.QST_admin_label']] = null;
 					}
 				}
 				$answers = \EEM_Answer::instance()->get_all_wpdb_results(
 					array(
-						array( 'REG_ID' => $reg_row[ 'Registration.REG_ID' ] ),
-						'force_join' => array( 'Question' )
+						array('REG_ID' => $reg_row['Registration.REG_ID']),
+						'force_join' => array('Question')
 					)
 				);
 				//now fill out the questions THEY answered
-				foreach( $answers as $answer_row ){
-					if( $answer_row[ 'Question.QST_ID' ] ){
+				foreach ($answers as $answer_row) {
+					if ($answer_row['Question.QST_ID']) {
 						$question_label = \EEH_Export::prepare_value_from_db_for_display(
 							\EEM_Question::instance(),
 							'QST_admin_label',
-							$answer_row[ 'Question.QST_admin_label' ]
+							$answer_row['Question.QST_admin_label']
 						);
 					} else {
-						$question_label = sprintf( __( 'Question $s', 'event_espresso' ), $answer_row[ 'Answer.QST_ID' ] );
+						$question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
 					}
-					if ( isset( $answer_row[ 'Question.QST_type' ] )
-						 && $answer_row[ 'Question.QST_type' ] == \EEM_Question::QST_type_state
+					if (isset($answer_row['Question.QST_type'])
+						 && $answer_row['Question.QST_type'] == \EEM_Question::QST_type_state
 					) {
-						$reg_csv_array[ $question_label ] = \EEM_State::instance()->get_state_name_by_ID(
-							$answer_row[ 'Answer.ANS_value' ]
+						$reg_csv_array[$question_label] = \EEM_State::instance()->get_state_name_by_ID(
+							$answer_row['Answer.ANS_value']
 						);
 					} else {
-						$reg_csv_array[ $question_label ] = \EEH_Export::prepare_value_from_db_for_display(
+						$reg_csv_array[$question_label] = \EEH_Export::prepare_value_from_db_for_display(
 							\EEM_Answer::instance(),
 							'ANS_value',
-							$answer_row[ 'Answer.ANS_value' ]
+							$answer_row['Answer.ANS_value']
 						);
 					}
 				}
@@ -349,17 +349,17 @@ 
 			}
 		}
 		//if we couldn't export anything, we want to at least show the column headers
-		if ( empty( $registrations_csv_ready_array ) ) {
+		if (empty($registrations_csv_ready_array)) {
 			$reg_csv_array = array();
 			$model_and_fields_to_include = array(
 				'Registration' => $reg_fields_to_include,
 				'Attendee'     => $att_fields_to_include
 			);
-			foreach ( $model_and_fields_to_include as $model_name => $field_list ) {
-				$model = \EE_Registry::instance()->load_model( $model_name );
-				foreach ( $field_list as $field_name ) {
-					$field = $model->field_settings_for( $field_name );
-					$reg_csv_array[ \EEH_Export::get_column_name_for_field( $field ) ] = null;
+			foreach ($model_and_fields_to_include as $model_name => $field_list) {
+				$model = \EE_Registry::instance()->load_model($model_name);
+				foreach ($field_list as $field_name) {
+					$field = $model->field_settings_for($field_name);
+					$reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = null;
 				}
 			}
 			$registrations_csv_ready_array[] = $reg_csv_array;
@@ -375,7 +375,7 @@ 
 	 * @param int $event_id
 	 * @return int
 	 */
-	public function count_units_to_process( $event_id ) {
+	public function count_units_to_process($event_id) {
 		//use the legacy filter
 		$query_params = apply_filters(
 			'FHEE__EE_Export__report_registration_for_event',
@@ -383,24 +383,24 @@ 
 				array(
 					'OR' => array(
 						//don't include registrations from failed or abandoned transactions...
-						'Transaction.STS_ID' => array( 'NOT IN', array( \EEM_Transaction::failed_status_code, \EEM_Transaction::abandoned_status_code ) ),
+						'Transaction.STS_ID' => array('NOT IN', array(\EEM_Transaction::failed_status_code, \EEM_Transaction::abandoned_status_code)),
 						//unless the registration is approved, in which case include it regardless of transaction status
 						'STS_ID' => \EEM_Registration::status_id_approved
 						),
-					'Ticket.TKT_deleted' => array( 'IN', array( true, false ) )
+					'Ticket.TKT_deleted' => array('IN', array(true, false))
 					),
-				'order_by' => array('Transaction.TXN_ID'=>'asc','REG_count'=>'asc'),
-				'force_join' => array( 'Transaction', 'Ticket', 'Attendee' ),
+				'order_by' => array('Transaction.TXN_ID'=>'asc', 'REG_count'=>'asc'),
+				'force_join' => array('Transaction', 'Ticket', 'Attendee'),
 				'caps' => \EEM_Base::caps_read_admin
 			),
 			$event_id
 		);
-		if( $event_id ){
-			$query_params[0]['EVT_ID'] =  $event_id;
+		if ($event_id) {
+			$query_params[0]['EVT_ID'] = $event_id;
 		} else {
-			$query_params[ 'force_join' ][] = 'Event';
+			$query_params['force_join'][] = 'Event';
 		}
-		return \EEM_Registration::instance()->count( $query_params );
+		return \EEM_Registration::instance()->count($query_params);
 	}
 
 
@@ -411,13 +411,13 @@ 
 	 * @param JobParameters $job_parameters
 	 * @return boolean
 	 */
-	public function cleanup_job( JobParameters $job_parameters ){
+	public function cleanup_job(JobParameters $job_parameters) {
 		$this->_file_helper->delete(
-			\EEH_File::remove_filename_from_filepath( $job_parameters->extra_datum( 'filepath' ) ),
+			\EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
 			true,
 			'd'
 		);
-		return new JobStepResponse( $job_parameters, __( 'Cleaned up temporary file', 'event_espresso' ) );
+		return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
 	}
 }
 

core/helpers/EEH_Tabbed_Content.helper.php

Spacing +36 added lines, -36 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -46,22 +46,22 @@ 
 	 * @return string the assembled html string containing the tabbed content for display.
 	 * @throws \EE_Error
 	 */
-	public static function display($tabs_contents, $tabs_names = array(), $small_tabs = true, $tabs_content = TRUE ) {
+	public static function display($tabs_contents, $tabs_names = array(), $small_tabs = true, $tabs_content = TRUE) {
 
 		//first check if $tabs_names is not empty then the count must match the count of $tabs_content otherwise we've got a problem houston
-		if ( !empty( $tabs_names) && ( count( (array) $tabs_names) != count( (array) $tabs_content) ) ) {
-			throw new EE_Error( __('The count for $tabs_names and $tabs_content does not match.', 'event_espresso') );
+		if ( ! empty($tabs_names) && (count((array) $tabs_names) != count((array) $tabs_content))) {
+			throw new EE_Error(__('The count for $tabs_names and $tabs_content does not match.', 'event_espresso'));
 		}
 
 		//make sure we've got incoming data setup properly
-		$tabs = !empty( $tabs_names ) ? (array) $tabs_names : array_keys( (array) $tabs_contents );
-		$tabs_content = !empty( $tabs_names ) ? array_combine( (array) $tabs_names, (array) $tabs_content ) : $tabs_contents;
+		$tabs = ! empty($tabs_names) ? (array) $tabs_names : array_keys((array) $tabs_contents);
+		$tabs_content = ! empty($tabs_names) ? array_combine((array) $tabs_names, (array) $tabs_content) : $tabs_contents;
 
-		$all_tabs = '<h2 class="nav-tab-wrapper">' . "\n";
+		$all_tabs = '<h2 class="nav-tab-wrapper">'."\n";
 		$all_tabs_content = '';
 
 		$index = 0;
-		foreach ( $tabs as $tab ) {
+		foreach ($tabs as $tab) {
 			$active = $index === 0 ? true : false;
 			$all_tabs .= self::tab($tab, $active);
 			$all_tabs_content .= self::tab_content($tab, $tabs_content[$tab], $active);
@@ -78,7 +78,7 @@ 
 
 		$tab_container_class = $small_tabs ? 'ee-nav-tabs ee-nav-tabs-small' : 'ee-nav-tabs';
 
-		return '<div class="'. $tab_container_class . '">' . "\n\t" . $all_tabs . $all_tabs_content . "\n" . '</div>';
+		return '<div class="'.$tab_container_class.'">'."\n\t".$all_tabs.$all_tabs_content."\n".'</div>';
 	}
 
 
@@ -102,11 +102,11 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function display_admin_nav_tabs($nav_tabs = array()) {
-		if ( empty($nav_tabs) )
-			throw new EE_Error( __('Nav Tabs cannot be generated because the tab array is missing', 'event_espresso' ) );
+		if (empty($nav_tabs))
+			throw new EE_Error(__('Nav Tabs cannot be generated because the tab array is missing', 'event_espresso'));
 
-		$all_tabs = '<h2 class="nav-tab-wrapper">' . "\n";
-		foreach ( $nav_tabs as $slug => $tab ) {
+		$all_tabs = '<h2 class="nav-tab-wrapper">'."\n";
+		foreach ($nav_tabs as $slug => $tab) {
 			$all_tabs .= self::tab($slug, false, $tab['link_text'], $tab['url'], $tab['css_class']);
 		}
 		$all_tabs .= '</h2>';
@@ -122,13 +122,13 @@ 
 	 * @param bool|string $css If string given then the generated tab will include that as the class.
 	 * @return string          html for tab
 	 */
-	private static function tab($name, $active = false, $nice_name = FALSE, $url = FALSE, $css = FALSE ) {
+	private static function tab($name, $active = false, $nice_name = FALSE, $url = FALSE, $css = FALSE) {
 		$name = str_replace(' ', '-', $name);
 		$class = $active ? 'nav-tab nav-tab-active' : 'nav-tab';
-		$class = $css ? $class . ' ' . $css : $class;
-		$nice_name = $nice_name ? $nice_name : ucwords( preg_replace('/(-|_)/', ' ', $name) );
-		$url = $url ? $url : '#' . $name;
-		$tab = '<a class="' . $class . '" rel="ee-tab-' . $name . '" href="' . $url . '">' . $nice_name . '</a>' . "\n\t";
+		$class = $css ? $class.' '.$css : $class;
+		$nice_name = $nice_name ? $nice_name : ucwords(preg_replace('/(-|_)/', ' ', $name));
+		$url = $url ? $url : '#'.$name;
+		$tab = '<a class="'.$class.'" rel="ee-tab-'.$name.'" href="'.$url.'">'.$nice_name.'</a>'."\n\t";
 		return $tab;
 	}
 
@@ -144,9 +144,9 @@ 
 	 */
 	private static function tab_content($name, $tab_content, $active = false) {
 		$class = $active ? 'nav-tab-content' : 'nav-tab-content hidden';
-		$name = str_replace( ' ', '-', $name);
-		$content = "\t" . '<div class="'. $class . '" id="ee-tab-' . $name . '">' . "\n";
-		$content .= "\t" . $tab_content . "\n";
+		$name = str_replace(' ', '-', $name);
+		$content = "\t".'<div class="'.$class.'" id="ee-tab-'.$name.'">'."\n";
+		$content .= "\t".$tab_content."\n";
 		$content .= '<div style="clear:both"></div></div>';
 		return $content;
 	}
@@ -172,9 +172,9 @@ 
 	 * @param string $default 			You can include a string for the item that will receive the "item_display" class for the js.
 	 * @return string                  a html snippet of of all the formatted link elements.
 	 */
-	public static function tab_text_links( $item_array, $container_class = '', $sep = '|', $default = '' ) {
-		$item_array = apply_filters( 'FHEE__EEH_Tabbed_Content__tab_text_links', $item_array, $container_class );
-		if ( !is_array($item_array) || empty( $item_array ) )
+	public static function tab_text_links($item_array, $container_class = '', $sep = '|', $default = '') {
+		$item_array = apply_filters('FHEE__EEH_Tabbed_Content__tab_text_links', $item_array, $container_class);
+		if ( ! is_array($item_array) || empty($item_array))
 			return false; //get out we don't have even the basic thing we need!
 
 
@@ -185,15 +185,15 @@ 
 			'title' => esc_attr__('Link for Item', 'event_espresso'),
 			'slug' => 'item_slug'
 		);
-		$container_class = !empty($container_class) ? 'ee-text-links ' . $container_class : 'ee-text-links';
-		$list = '<ul class="' . $container_class . '">';
+		$container_class = ! empty($container_class) ? 'ee-text-links '.$container_class : 'ee-text-links';
+		$list = '<ul class="'.$container_class.'">';
 
 		$ci = 1;
-		foreach ( $item_array as $item ) {
-			$item = wp_parse_args( $item, $defaults );
-			$item['class'] = !empty($default) && $default == $item['slug'] ? 'item_display ' . $item['class'] : $item['class'];
+		foreach ($item_array as $item) {
+			$item = wp_parse_args($item, $defaults);
+			$item['class'] = ! empty($default) && $default == $item['slug'] ? 'item_display '.$item['class'] : $item['class'];
 			$list .= self::_text_link_item($item);
-			if ( !empty($sep) && $ci != count($item_array) )
+			if ( ! empty($sep) && $ci != count($item_array))
 				$list .= self::_text_link_item($sep);
 			$ci++;
 		}
@@ -204,9 +204,9 @@ 
 
 
 
-	private static function _text_link_item( $item ) {
+	private static function _text_link_item($item) {
 		//if this isn't an array then we're doing a separator
-		if ( !is_array( $item ) ) {
+		if ( ! is_array($item)) {
 			$label = $item;
 			$class = 'ee-text-link-sep';
 			$href = '';
@@ -215,12 +215,12 @@ 
 			extract($item);
 		}
 
-		$class = $class != 'ee-text-link-sep'  ? 'class="ee-text-link-li ' . $class . '"' : 'class="ee-text-link-sep"';
+		$class = $class != 'ee-text-link-sep' ? 'class="ee-text-link-li '.$class.'"' : 'class="ee-text-link-sep"';
 
-		$content = '<li ' . $class . '>';
-		$content .= !empty($href) ? '<a class="ee-text-link" href="#' . $href . '" title="' . $title . '">' : '';
+		$content = '<li '.$class.'>';
+		$content .= ! empty($href) ? '<a class="ee-text-link" href="#'.$href.'" title="'.$title.'">' : '';
 		$content .= $label;
-		$content .= !empty($href) ? '</a>' : '';
+		$content .= ! empty($href) ? '</a>' : '';
 		$content .= '</li>';
 		return $content;
 	}

Braces +12 added lines, -7 removed lines

@@ -1,6 +1,7 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -102,8 +103,9 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function display_admin_nav_tabs($nav_tabs = array()) {
-		if ( empty($nav_tabs) )
-			throw new EE_Error( __('Nav Tabs cannot be generated because the tab array is missing', 'event_espresso' ) );
+		if ( empty($nav_tabs) ) {
+					throw new EE_Error( __('Nav Tabs cannot be generated because the tab array is missing', 'event_espresso' ) );
+		}
 
 		$all_tabs = '<h2 class="nav-tab-wrapper">' . "\n";
 		foreach ( $nav_tabs as $slug => $tab ) {
@@ -174,8 +176,10 @@ 
 	 */
 	public static function tab_text_links( $item_array, $container_class = '', $sep = '|', $default = '' ) {
 		$item_array = apply_filters( 'FHEE__EEH_Tabbed_Content__tab_text_links', $item_array, $container_class );
-		if ( !is_array($item_array) || empty( $item_array ) )
-			return false; //get out we don't have even the basic thing we need!
+		if ( !is_array($item_array) || empty( $item_array ) ) {
+					return false;
+		}
+		//get out we don't have even the basic thing we need!
 
 
 		$defaults = array(
@@ -193,8 +197,9 @@ 
 			$item = wp_parse_args( $item, $defaults );
 			$item['class'] = !empty($default) && $default == $item['slug'] ? 'item_display ' . $item['class'] : $item['class'];
 			$list .= self::_text_link_item($item);
-			if ( !empty($sep) && $ci != count($item_array) )
-				$list .= self::_text_link_item($sep);
+			if ( !empty($sep) && $ci != count($item_array) ) {
+							$list .= self::_text_link_item($sep);
+			}
 			$ci++;
 		}
 

caffeinated/modules/recaptcha/ReCaptcha/RequestMethod/Post.php

Indentation +32 added lines, -32 removed lines

@@ -34,37 +34,37 @@
  */
 class Post implements RequestMethod
 {
-    /**
-     * URL to which requests are POSTed.
-     * @const string
-     */
-    const SITE_VERIFY_URL = 'https://www.google.com/recaptcha/api/siteverify';
+	/**
+	 * URL to which requests are POSTed.
+	 * @const string
+	 */
+	const SITE_VERIFY_URL = 'https://www.google.com/recaptcha/api/siteverify';
 
-    /**
-     * Submit the POST request with the specified parameters.
-     *
-     * @param RequestParameters $params Request parameters
-     * @return string Body of the reCAPTCHA response
-     */
-    public function submit(RequestParameters $params)
-    {
-        /**
-         * PHP 5.6.0 changed the way you specify the peer name for SSL context options.
-         * Using "CN_name" will still work, but it will raise deprecated errors.
-         */
-        $peer_key = version_compare(PHP_VERSION, '5.6.0', '<') ? 'CN_name' : 'peer_name';
-        $options = array(
-            'http' => array(
-                'header' => "Content-type: application/x-www-form-urlencoded\r\n",
-                'method' => 'POST',
-                'content' => $params->toQueryString(),
-                // Force the peer to validate (not needed in 5.6.0+, but still works
-                'verify_peer' => true,
-                // Force the peer validation to use www.google.com
-                $peer_key => 'www.google.com',
-            ),
-        );
-        $context = stream_context_create($options);
-        return file_get_contents(self::SITE_VERIFY_URL, false, $context);
-    }
+	/**
+	 * Submit the POST request with the specified parameters.
+	 *
+	 * @param RequestParameters $params Request parameters
+	 * @return string Body of the reCAPTCHA response
+	 */
+	public function submit(RequestParameters $params)
+	{
+		/**
+		 * PHP 5.6.0 changed the way you specify the peer name for SSL context options.
+		 * Using "CN_name" will still work, but it will raise deprecated errors.
+		 */
+		$peer_key = version_compare(PHP_VERSION, '5.6.0', '<') ? 'CN_name' : 'peer_name';
+		$options = array(
+			'http' => array(
+				'header' => "Content-type: application/x-www-form-urlencoded\r\n",
+				'method' => 'POST',
+				'content' => $params->toQueryString(),
+				// Force the peer to validate (not needed in 5.6.0+, but still works
+				'verify_peer' => true,
+				// Force the peer validation to use www.google.com
+				$peer_key => 'www.google.com',
+			),
+		);
+		$context = stream_context_create($options);
+		return file_get_contents(self::SITE_VERIFY_URL, false, $context);
+	}
 }

admin_pages/registrations/templates/attendee_registrations_main_meta_box.template.php

Spacing +18 added lines, -18 removed lines

@@ -5,42 +5,42 @@
 		<table class="admin-primary-mbox-tbl">
 			<thead>
 				<tr>
-					<th class="jst-left"><?php esc_html_e( 'Event Name', 'event_espresso' );?></th>
-					<th class="jst-left"><?php esc_html_e( 'REG ID', 'event_espresso' );?></th>
-					<th class="jst-left"><?php esc_html_e( 'TXN ID', 'event_espresso' );?></th>
-					<th class="jst-left"><?php esc_html_e( 'Reg Code', 'event_espresso' );?></th>
-					<th class="jst-rght"><?php esc_html_e( 'Ticket Price', 'event_espresso' );?></th>
+					<th class="jst-left"><?php esc_html_e('Event Name', 'event_espresso'); ?></th>
+					<th class="jst-left"><?php esc_html_e('REG ID', 'event_espresso'); ?></th>
+					<th class="jst-left"><?php esc_html_e('TXN ID', 'event_espresso'); ?></th>
+					<th class="jst-left"><?php esc_html_e('Reg Code', 'event_espresso'); ?></th>
+					<th class="jst-rght"><?php esc_html_e('Ticket Price', 'event_espresso'); ?></th>
 				</tr>
 			</thead>
 			<tbody>
-			<?php foreach( $registrations as $registration ) : ?>
+			<?php foreach ($registrations as $registration) : ?>
 				<tr>
 					<td class="jst-left">
 					<?php
-						$event_url = add_query_arg( array( 'action' => 'edit', 'post' => $registration->event_ID() ), admin_url( 'admin.php?page=espresso_events' ));
-						echo EE_Registry::instance()->CAP->current_user_can( 'ee_edit_event', 'espresso_events_edit', $registration->event_ID() ) ?  '<a href="'. $event_url .'"  title="'. esc_attr__( 'Edit Event', 'event_espresso' ) .'">' . $registration->event_name() . '</a>' : $registration->event_name();
+						$event_url = add_query_arg(array('action' => 'edit', 'post' => $registration->event_ID()), admin_url('admin.php?page=espresso_events'));
+						echo EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'espresso_events_edit', $registration->event_ID()) ? '<a href="'.$event_url.'"  title="'.esc_attr__('Edit Event', 'event_espresso').'">'.$registration->event_name().'</a>' : $registration->event_name();
 					?>
 					</td>
 					<td class="jst-left">
 					<?php
-							$reg_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'view_registration', '_REG_ID'=>$registration->ID() ), REG_ADMIN_URL );
-							echo EE_Registry::instance()->CAP->current_user_can( 'ee_read_registration', 'espresso_registrations_view_registration', $registration->ID() ) ? '
-							<a href="'.$reg_url.'" title="' . esc_attr__( 'View Registration Details', 'event_espresso' ) . '">' . 
-								esc_html__( 'View Registration', 'event_espresso' ) .
+							$reg_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'view_registration', '_REG_ID'=>$registration->ID()), REG_ADMIN_URL);
+							echo EE_Registry::instance()->CAP->current_user_can('ee_read_registration', 'espresso_registrations_view_registration', $registration->ID()) ? '
+							<a href="'.$reg_url.'" title="'.esc_attr__('View Registration Details', 'event_espresso').'">'. 
+								esc_html__('View Registration', 'event_espresso').
 							'</a>' : $registration->ID();
 					?>
 					</td>
 					<td class="jst-left">
 					<?php
-						$txn_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'view_transaction', 'TXN_ID'=>$registration->transaction_ID() ), TXN_ADMIN_URL );
-						echo EE_Registry::instance()->CAP->current_user_can( 'ee_read_transaction', 'espresso_transactions_view_transaction' ) ? '
-						<a href="'.$txn_url.'" title="' . esc_attr__( 'View Transaction Details', 'event_espresso' ) . '">' .
-							sprintf( esc_html__('View Transaction %d', 'event_espresso'), $registration->transaction_ID() ) .
+						$txn_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'view_transaction', 'TXN_ID'=>$registration->transaction_ID()), TXN_ADMIN_URL);
+						echo EE_Registry::instance()->CAP->current_user_can('ee_read_transaction', 'espresso_transactions_view_transaction') ? '
+						<a href="'.$txn_url.'" title="'.esc_attr__('View Transaction Details', 'event_espresso').'">'.
+							sprintf(esc_html__('View Transaction %d', 'event_espresso'), $registration->transaction_ID()).
 						'</a>' : $registration->transaction_ID();
 					?>
 					</td>
-					<td class="jst-left"><?php echo $registration->reg_code();?></td>
-					<td class="jst-rght"><?php echo EEH_Template::format_currency( $registration->final_price() );?></td>
+					<td class="jst-left"><?php echo $registration->reg_code(); ?></td>
+					<td class="jst-rght"><?php echo EEH_Template::format_currency($registration->final_price()); ?></td>
 				</tr>
 			<?php endforeach; ?>
 			</tbody>