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/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/JobHandler.php

Spacing +5 added lines, -5 removed lines

@@ -17,8 +17,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');
 }
 
 
@@ -34,7 +34,7 @@ 
 	 * @throws BatchRequestException
 	 * @return JobStepResponse
 	 */
-	abstract public function create_job( JobParameters $job_parameters );
+	abstract public function create_job(JobParameters $job_parameters);
 
 	/**
 	 * Performs another step of the job
@@ -44,7 +44,7 @@ 
 	 * @return JobStepResponse
 	 * @throws BatchRequestException
 	 */
-	abstract public function continue_job( JobParameters $job_parameters, $batch_size = 50 );
+	abstract public function continue_job(JobParameters $job_parameters, $batch_size = 50);
 
 
 
@@ -55,6 +55,6 @@ 
 	 * @return JobStepResponse
 	 * @throws BatchRequestException
 	 */
-	abstract public function cleanup_job( JobParameters $job_parameters );
+	abstract public function cleanup_job(JobParameters $job_parameters);
 }
 

Indentation +11 added lines, -11 removed lines

@@ -1,16 +1,16 @@
 <?php
 /**
- *
- * Class JobHandler
- *
- * Base class for common implementations of JobHandlerInterface.
- *
- * @package         Event Espresso
- * @subpackage    batch
- * @author				Mike Nelson
- * @since		 	   4.8.26
- *
- */
+	 *
+	 * Class JobHandler
+	 *
+	 * Base class for common implementations of JobHandlerInterface.
+	 *
+	 * @package         Event Espresso
+	 * @subpackage    batch
+	 * @author				Mike Nelson
+	 * @since		 	   4.8.26
+	 *
+	 */
 namespace EventEspressoBatchRequest\JobHandlerBaseClasses;
 
 use EventEspressoBatchRequest\Helpers\BatchRequestException;

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

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/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 +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
 	 * Gets the questions which are to be used for this report, so they
 	 * can be remembered for later
 	 * @param int|null $event_id
-	 * @return array of wpdb results for questions which are to be used for this report
+	 * @return \stdClass[] of wpdb results for questions which are to be used for this report
 	 */
 	protected function _get_questions_for_report( $event_id ) {
 		$question_query_params = array(
@@ -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 +139 added lines, -139 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,36 +35,36 @@ 
 	 * @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' ) );
-		\EE_Registry::instance()->load_helper( 'Export' );
-		\EEH_Export::write_data_array_to_csv( $filepath, $csv_data_for_row, true );
+			$job_parameters->extra_datum('questions_data') );
+		\EE_Registry::instance()->load_helper('Export');
+		\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')
 		);
 	}
 
@@ -75,16 +75,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);
 	}
 
 	/**
@@ -93,17 +93,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);
 	}
 
 
@@ -116,28 +116,28 @@ 
 	 * @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' ) );
-		\EE_Registry::instance()->load_helper( 'Export' );
-		\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') );
+		\EE_Registry::instance()->load_helper('Export');
+		\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 );
 	}
 
@@ -150,8 +150,8 @@ 
 	 * @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 ) {
-		\EE_Registry::instance()->load_helper( 'Export' );
+	function get_csv_data_for($event_id, $offset, $limit, $questions_for_these_regs_rows) {
+		\EE_Registry::instance()->load_helper('Export');
 		$reg_fields_to_include = array(
 			'TXN_ID',
 			'ATT_ID',
@@ -182,165 +182,165 @@ 
 				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),
 			),
 			$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[ 'Transaction.STS_ID' ] => __( 'unknown', 'event_espresso' ) ),
+				$stati = \EEM_Status::instance()->localized_status(array(
+					$reg_row['Registration.STS_ID'] => __('unknown', 'event_espresso'),
+					$reg_row['Transaction.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[ 'Transaction.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[ 'Transaction.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[ 'Transaction.TXN_paid' ], 'localized_float' ) : '0.00';
+				$reg_csv_array[__("Transaction Status", 'event_espresso')] = $stati[$reg_row['Transaction.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['Transaction.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['Transaction.TXN_paid'], 'localized_float') : '0.00';
 				$payment_methods = array();
 				$gateway_txn_ids_etc = array();
 				$payment_times = array();
-				if( $is_primary_reg && $reg_row[ 'Transaction.TXN_ID' ] ){
+				if ($is_primary_reg && $reg_row['Transaction.TXN_ID']) {
 					$payments_info = \EEM_Payment::instance()->get_all_wpdb_results(
 							array(
 								array(
-									'TXN_ID' => $reg_row[ 'Transaction.TXN_ID' ],
+									'TXN_ID' => $reg_row['Transaction.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']
 						);
 					}
 				}
@@ -351,17 +351,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;
@@ -377,7 +377,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',
@@ -385,23 +385,23 @@ 
 				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')
 			),
 			$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);
 	}
 
 
@@ -412,13 +412,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'));
 	}
 }
 

shortcodes/espresso_event_attendees/EES_Espresso_Event_Attendees.shortcode.php

Spacing +35 added lines, -35 removed lines

@@ -19,7 +19,7 @@ 
 	 * @param       WP $WP
 	 * @return    void
 	 */
-	public function run( WP $WP ) {}
+	public function run(WP $WP) {}
 
 
 	/**
@@ -69,14 +69,14 @@ 
 	 *  @param 	    array 	$attributes
 	 *  @return 	string
 	 */
-	public function process_shortcode( $attributes = array() ) {
+	public function process_shortcode($attributes = array()) {
 
 		//load helpers
-		EE_Registry::instance()->load_helper( 'Event_View' );
-		EE_Registry::instance()->load_helper( 'Template' );
+		EE_Registry::instance()->load_helper('Event_View');
+		EE_Registry::instance()->load_helper('Template');
 
 		// merge in any attributes passed via fallback shortcode processor
-		$attributes = array_merge( (array) $attributes, (array) $this->_attributes );
+		$attributes = array_merge((array) $attributes, (array) $this->_attributes);
 
 		//set default attributes
 		$default_shortcode_attributes = array(
@@ -88,9 +88,9 @@ 
 		);
 
 		// allow the defaults to be filtered
-		$default_shortcode_attributes = apply_filters( 'EES_Espresso_Event_Attendees__process_shortcode__default_shortcode_atts', $default_shortcode_attributes );
+		$default_shortcode_attributes = apply_filters('EES_Espresso_Event_Attendees__process_shortcode__default_shortcode_atts', $default_shortcode_attributes);
 		// grab attributes and merge with defaults, then extract
-		$attributes = array_merge( $default_shortcode_attributes, $attributes );
+		$attributes = array_merge($default_shortcode_attributes, $attributes);
 
 		$template_args = array(
 			'contacts'      => array(),
@@ -106,31 +106,31 @@ 
 		$error = false;
 
 		//what event?
-		if ( empty( $attributes['event_id'] ) && empty( $attributes['datetime_id'] ) && empty( $attributes['ticket_id'] ) ) {
+		if (empty($attributes['event_id']) && empty($attributes['datetime_id']) && empty($attributes['ticket_id'])) {
 			//seems like is_espresso_event_single() isn't working as expected. So using alternate method.
-			if ( is_single() && is_espresso_event() ) {
+			if (is_single() && is_espresso_event()) {
 				$event = EEH_Event_View::get_event();
-				if ( $event instanceof EE_Event ) {
+				if ($event instanceof EE_Event) {
 					$template_args['event']          = $event;
 					$query[0]['Registration.EVT_ID'] = $event->ID();
 				}
 			} else {
 				//try getting the earliest active event if none then get the
-				$events = EEM_Event::instance()->get_active_events( array( 'limit'    => 1,
-				                                                          'order_by' => array( 'Datetime.DTT_EVT_start' => 'ASC' )
-				) );
-				$events = empty( $events ) ? EEM_Event::instance()->get_upcoming_events( array( 'limit'    => 1,
-				                                                                              'order_by' => array( 'Datetime.DTT_EVT_start' => 'ASC' )
-				) ) : $events;
-				$event = reset( $events );
-				if ( $event instanceof EE_Event ) {
+				$events = EEM_Event::instance()->get_active_events(array('limit'    => 1,
+				                                                          'order_by' => array('Datetime.DTT_EVT_start' => 'ASC')
+				));
+				$events = empty($events) ? EEM_Event::instance()->get_upcoming_events(array('limit'    => 1,
+				                                                                              'order_by' => array('Datetime.DTT_EVT_start' => 'ASC')
+				)) : $events;
+				$event = reset($events);
+				if ($event instanceof EE_Event) {
 					$query[0]['Registration.EVT_ID'] = $event->ID();
 					$template_args['event']          = $event;
 				}
 			}
-		} elseif ( ! empty( $attributes['event_id'] ) ) {
-			$event = EEM_Event::instance()->get_one_by_ID( $attributes['event_id'] );
-			if ( $event instanceof EE_Event ) {
+		} elseif ( ! empty($attributes['event_id'])) {
+			$event = EEM_Event::instance()->get_one_by_ID($attributes['event_id']);
+			if ($event instanceof EE_Event) {
 				$query[0]['Registration.EVT_ID'] = $attributes['event_id'];
 				$template_args['event']          = $event;
 			} else {
@@ -139,9 +139,9 @@ 
 		}
 
 		//datetime?
-		if ( ! empty( $attributes['datetime_id'] ) && empty( $attributes['event_id'] ) ) {
-			$datetime = EEM_Datetime::instance()->get_one_by_ID( $attributes['datetime_id'] );
-			if ( $datetime instanceof EE_Datetime ) {
+		if ( ! empty($attributes['datetime_id']) && empty($attributes['event_id'])) {
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($attributes['datetime_id']);
+			if ($datetime instanceof EE_Datetime) {
 				$query[0]['Registration.Ticket.Datetime.DTT_ID'] = $attributes['datetime_id'];
 				$query['default_where_conditions'] = 'this_model_only';
 				$template_args['datetime']                      = $datetime;
@@ -152,9 +152,9 @@ 
 		}
 
 		//ticket?just
-		if ( ! empty( $attributes['ticket_id'] ) && empty( $attributes['event_id'] ) && empty( $attributes['datetime_id'] ) ) {
-			$ticket = EEM_Ticket::instance()->get_one_by_ID( $attributes['ticket_id'] );
-			if ( $ticket instanceof EE_Ticket ) {
+		if ( ! empty($attributes['ticket_id']) && empty($attributes['event_id']) && empty($attributes['datetime_id'])) {
+			$ticket = EEM_Ticket::instance()->get_one_by_ID($attributes['ticket_id']);
+			if ($ticket instanceof EE_Ticket) {
 				$query[0]['Registration.TKT_ID'] = $attributes['ticket_id'];
 				$template_args['ticket']         = $ticket;
 				$template_args['event']          = $ticket->first_datetime() instanceof EE_Datetime ? $ticket->first_datetime()->event() : null;
@@ -165,17 +165,17 @@ 
 
 		//status
 		$reg_status_array = EEM_Registration::reg_status_array();
-		if ( $attributes['status'] != 'all' && isset( $reg_status_array[$attributes['status']] ) ) {
+		if ($attributes['status'] != 'all' && isset($reg_status_array[$attributes['status']])) {
 			$query[0]['Registration.STS_ID'] = $attributes['status'];
 		}
-		$query['group_by'] = array( 'ATT_ID' );
-		$query['order_by'] = apply_filters( 'FHEE__EES_Espresso_Event_Attendees__process_shortcode__order_by', array( 'ATT_lname' => 'ASC', 'ATT_fname' => 'ASC' ) );
+		$query['group_by'] = array('ATT_ID');
+		$query['order_by'] = apply_filters('FHEE__EES_Espresso_Event_Attendees__process_shortcode__order_by', array('ATT_lname' => 'ASC', 'ATT_fname' => 'ASC'));
 
 		//if we have NO query where conditions, then there was an invalid parameter or the shortcode was used incorrectly
 		//so when WP_DEBUG is set and true, we'll show a message, otherwise we'll just return an empty string.
-		if ( ( ! isset( $query[0] ) || ! is_array( $query[0] ) ) || $error ) {
-			if ( WP_DEBUG ) {
-				return '<div class="important-notice ee-attention">' . __( 'The [ESPRESSO_EVENT_ATTENDEES] shortcode has been used incorrectly.  Please double check the arguments you used for any typos.  In the case of ID type arguments, its possible the given ID does not correspond to existing data in the database.', 'event_espresso' ) . '</div>';
+		if (( ! isset($query[0]) || ! is_array($query[0])) || $error) {
+			if (WP_DEBUG) {
+				return '<div class="important-notice ee-attention">'.__('The [ESPRESSO_EVENT_ATTENDEES] shortcode has been used incorrectly.  Please double check the arguments you used for any typos.  In the case of ID type arguments, its possible the given ID does not correspond to existing data in the database.', 'event_espresso').'</div>';
 			} else {
 				return '';
 			}
@@ -183,11 +183,11 @@ 
 
 
 		//get contacts!
-		$template_args['contacts'] = EEM_Attendee::instance()->get_all( $query );
+		$template_args['contacts'] = EEM_Attendee::instance()->get_all($query);
 
 
 		//all set let's load up the template and return.
-		return EEH_Template::locate_template( 'loop-espresso_event_attendees.php', $template_args, true, true );
+		return EEH_Template::locate_template('loop-espresso_event_attendees.php', $template_args, true, true);
 
 	}