@@ -87,13 +87,13 @@ |
||
87 | 87 | |
88 | 88 | /** |
89 | 89 | * |
90 | - * Writes a row to the csv file |
|
91 | - * @param array $row - individual row of csv data |
|
92 | - * @param string $delimiter - csv delimiter |
|
93 | - * @param string $enclosure - csv enclosure |
|
94 | - * @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value |
|
95 | - * @return string of text for teh csv file |
|
96 | - */ |
|
90 | + * Writes a row to the csv file |
|
91 | + * @param array $row - individual row of csv data |
|
92 | + * @param string $delimiter - csv delimiter |
|
93 | + * @param string $enclosure - csv enclosure |
|
94 | + * @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value |
|
95 | + * @return string of text for teh csv file |
|
96 | + */ |
|
97 | 97 | public static function get_csv_row ( array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false ) { |
98 | 98 | //Allow user to filter the csv delimiter and enclosure for other countries csv standards |
99 | 99 | $delimiter = apply_filters( 'FHEE__EE_CSV__fputcsv2__delimiter', $delimiter ); |
@@ -30,7 +30,7 @@ discard block |
||
30 | 30 | * @param EE_Model_Field_Base $field |
31 | 31 | * @return string |
32 | 32 | */ |
33 | - public static function get_column_name_for_field(EE_Model_Field_Base $field){ |
|
33 | + public static function get_column_name_for_field(EE_Model_Field_Base $field) { |
|
34 | 34 | return $field->get_nicename()."[".$field->get_name()."]"; |
35 | 35 | } |
36 | 36 | |
@@ -52,32 +52,32 @@ discard block |
||
52 | 52 | * we consider that a success (because we wrote everything there was...nothing) |
53 | 53 | * @throws EE_Error |
54 | 54 | */ |
55 | - public static function write_data_array_to_csv( $filepath, $data, $write_column_headers = true ){ |
|
55 | + public static function write_data_array_to_csv($filepath, $data, $write_column_headers = true) { |
|
56 | 56 | EE_Registry::instance()->load_helper('Array'); |
57 | 57 | |
58 | 58 | $new_file_contents = ''; |
59 | 59 | //determine if $data is actually a 2d array |
60 | - if ( $data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))){ |
|
60 | + if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) { |
|
61 | 61 | //make sure top level is numerically indexed, |
62 | 62 | |
63 | - if( EEH_Array::is_associative_array($data)){ |
|
64 | - throw new EE_Error(sprintf(__("top-level array must be numerically indexed. Does these look like numbers to you? %s","event_espresso"),implode(",",array_keys($data)))); |
|
63 | + if (EEH_Array::is_associative_array($data)) { |
|
64 | + throw new EE_Error(sprintf(__("top-level array must be numerically indexed. Does these look like numbers to you? %s", "event_espresso"), implode(",", array_keys($data)))); |
|
65 | 65 | } |
66 | 66 | $item_in_top_level_array = EEH_Array::get_one_item_from_array($data); |
67 | 67 | //now, is the last item in the top-level array of $data an associative or numeric array? |
68 | - if( $write_column_headers && |
|
69 | - EEH_Array::is_associative_array($item_in_top_level_array)){ |
|
68 | + if ($write_column_headers && |
|
69 | + EEH_Array::is_associative_array($item_in_top_level_array)) { |
|
70 | 70 | //its associative, so we want to output its keys as column headers |
71 | 71 | $keys = array_keys($item_in_top_level_array); |
72 | - $new_file_contents .= EEH_Export::get_csv_row( $keys ); |
|
72 | + $new_file_contents .= EEH_Export::get_csv_row($keys); |
|
73 | 73 | |
74 | 74 | } |
75 | 75 | //start writing data |
76 | - foreach($data as $data_row){ |
|
77 | - $new_file_contents .= EEH_Export::get_csv_row( $data_row); |
|
76 | + foreach ($data as $data_row) { |
|
77 | + $new_file_contents .= EEH_Export::get_csv_row($data_row); |
|
78 | 78 | } |
79 | - return EEH_File::write_to_file( $filepath, EEH_File::get_file_contents( $filepath ) . $new_file_contents ); |
|
80 | - }else{ |
|
79 | + return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath).$new_file_contents); |
|
80 | + } else { |
|
81 | 81 | //no data TO write... so we can assume that's a success |
82 | 82 | return true; |
83 | 83 | } |
@@ -94,29 +94,29 @@ discard block |
||
94 | 94 | * @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value |
95 | 95 | * @return string of text for teh csv file |
96 | 96 | */ |
97 | - public static function get_csv_row ( array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false ) { |
|
97 | + public static function get_csv_row(array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false) { |
|
98 | 98 | //Allow user to filter the csv delimiter and enclosure for other countries csv standards |
99 | - $delimiter = apply_filters( 'FHEE__EE_CSV__fputcsv2__delimiter', $delimiter ); |
|
100 | - $enclosure = apply_filters( 'FHEE__EE_CSV__fputcsv2__enclosure', $enclosure ); |
|
99 | + $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter); |
|
100 | + $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure); |
|
101 | 101 | |
102 | 102 | $delimiter_esc = preg_quote($delimiter, '/'); |
103 | 103 | $enclosure_esc = preg_quote($enclosure, '/'); |
104 | 104 | |
105 | 105 | $output = array(); |
106 | 106 | foreach ($row as $field_value) { |
107 | - if(is_object($field_value) || is_array($field_value)){ |
|
107 | + if (is_object($field_value) || is_array($field_value)) { |
|
108 | 108 | $field_value = serialize($field_value); |
109 | 109 | } |
110 | - if ($field_value === null && $mysql_null ) { |
|
110 | + if ($field_value === null && $mysql_null) { |
|
111 | 111 | $output[] = 'NULL'; |
112 | 112 | continue; |
113 | 113 | } |
114 | 114 | |
115 | 115 | $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ? |
116 | - ( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value; |
|
116 | + ($enclosure.str_replace($enclosure, $enclosure.$enclosure, $field_value).$enclosure) : $field_value; |
|
117 | 117 | } |
118 | 118 | |
119 | - return implode($delimiter, $output) . PHP_EOL; |
|
119 | + return implode($delimiter, $output).PHP_EOL; |
|
120 | 120 | } |
121 | 121 | |
122 | 122 | |
@@ -129,19 +129,19 @@ discard block |
||
129 | 129 | * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to NOT display pretty |
130 | 130 | * @return string |
131 | 131 | */ |
132 | - public static function prepare_value_from_db_for_display( $model, $field_name, $raw_db_value, $pretty_schema = true ) { |
|
133 | - $field_obj = $model->field_settings_for( $field_name ); |
|
134 | - $value_on_model_obj = $field_obj->prepare_for_set_from_db( $raw_db_value ); |
|
135 | - if( $field_obj instanceof EE_Datetime_Field ) { |
|
136 | - $field_obj->set_date_format( EEH_Export::get_date_format_for_export( $field_obj->get_date_format( $pretty_schema ) ), $pretty_schema ); |
|
137 | - $field_obj->set_time_format( EEH_Export::get_time_format_for_export( $field_obj->get_time_format( $pretty_schema ) ), $pretty_schema ); |
|
132 | + public static function prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true) { |
|
133 | + $field_obj = $model->field_settings_for($field_name); |
|
134 | + $value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value); |
|
135 | + if ($field_obj instanceof EE_Datetime_Field) { |
|
136 | + $field_obj->set_date_format(EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)), $pretty_schema); |
|
137 | + $field_obj->set_time_format(EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)), $pretty_schema); |
|
138 | 138 | } |
139 | - if( $pretty_schema === true){ |
|
140 | - return $field_obj->prepare_for_pretty_echoing( $value_on_model_obj ); |
|
141 | - }elseif( is_string( $pretty_schema ) ) { |
|
142 | - return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema ); |
|
143 | - }else{ |
|
144 | - return $field_obj->prepare_for_get( $value_on_model_obj ); |
|
139 | + if ($pretty_schema === true) { |
|
140 | + return $field_obj->prepare_for_pretty_echoing($value_on_model_obj); |
|
141 | + }elseif (is_string($pretty_schema)) { |
|
142 | + return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema); |
|
143 | + } else { |
|
144 | + return $field_obj->prepare_for_get($value_on_model_obj); |
|
145 | 145 | } |
146 | 146 | } |
147 | 147 | |
@@ -152,8 +152,8 @@ discard block |
||
152 | 152 | * @param string $current_format |
153 | 153 | * @return string |
154 | 154 | */ |
155 | - public static function get_date_format_for_export( $current_format = null ) { |
|
156 | - return apply_filters( 'FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format ); |
|
155 | + public static function get_date_format_for_export($current_format = null) { |
|
156 | + return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format); |
|
157 | 157 | } |
158 | 158 | |
159 | 159 | |
@@ -163,8 +163,8 @@ discard block |
||
163 | 163 | * @param string $current_format |
164 | 164 | * @return string |
165 | 165 | */ |
166 | - public static function get_time_format_for_export( $current_format = null ) { |
|
167 | - return apply_filters( 'FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format ); |
|
166 | + public static function get_time_format_for_export($current_format = null) { |
|
167 | + return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format); |
|
168 | 168 | } |
169 | 169 | |
170 | 170 |
@@ -1,4 +1,6 @@ discard block |
||
1 | -<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed'); |
|
1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | + exit('No direct script access allowed'); |
|
3 | +} |
|
2 | 4 | /** |
3 | 5 | * Event Espresso |
4 | 6 | * |
@@ -77,7 +79,7 @@ discard block |
||
77 | 79 | $new_file_contents .= EEH_Export::get_csv_row( $data_row); |
78 | 80 | } |
79 | 81 | return EEH_File::write_to_file( $filepath, EEH_File::get_file_contents( $filepath ) . $new_file_contents ); |
80 | - }else{ |
|
82 | + } else{ |
|
81 | 83 | //no data TO write... so we can assume that's a success |
82 | 84 | return true; |
83 | 85 | } |
@@ -138,9 +140,9 @@ discard block |
||
138 | 140 | } |
139 | 141 | if( $pretty_schema === true){ |
140 | 142 | return $field_obj->prepare_for_pretty_echoing( $value_on_model_obj ); |
141 | - }elseif( is_string( $pretty_schema ) ) { |
|
143 | + } elseif( is_string( $pretty_schema ) ) { |
|
142 | 144 | return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema ); |
143 | - }else{ |
|
145 | + } else{ |
|
144 | 146 | return $field_obj->prepare_for_get( $value_on_model_obj ); |
145 | 147 | } |
146 | 148 | } |
@@ -23,8 +23,8 @@ discard block |
||
23 | 23 | use EventEspressoBatchRequest\Helpers\JobParameters; |
24 | 24 | use EventEspressoBatchRequest\Helpers\JobStepResponse; |
25 | 25 | |
26 | -if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
27 | - exit( 'No direct script access allowed' ); |
|
26 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
27 | + exit('No direct script access allowed'); |
|
28 | 28 | } |
29 | 29 | |
30 | 30 | |
@@ -50,32 +50,32 @@ discard block |
||
50 | 50 | * @param array $request_data to be used by the batch job handler |
51 | 51 | * @return JobStepResponse |
52 | 52 | */ |
53 | - public function create_job( $batch_job_handler_class, $request_data ) { |
|
53 | + public function create_job($batch_job_handler_class, $request_data) { |
|
54 | 54 | try { |
55 | - $this->_job_id = wp_generate_password( 15, false ); |
|
56 | - $obj = $this->instantiate_batch_job_handler_from_classname( $batch_job_handler_class ); |
|
57 | - $this->_job_parameters = new JobParameters( $this->_job_id, $batch_job_handler_class, $request_data ); |
|
58 | - $response = $obj->create_job( $this->_job_parameters ); |
|
59 | - if( ! $response instanceof JobStepResponse ) { |
|
55 | + $this->_job_id = wp_generate_password(15, false); |
|
56 | + $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class); |
|
57 | + $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data); |
|
58 | + $response = $obj->create_job($this->_job_parameters); |
|
59 | + if ( ! $response instanceof JobStepResponse) { |
|
60 | 60 | throw new BatchRequestException( |
61 | 61 | sprintf( |
62 | - __( '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' ), |
|
63 | - wp_json_encode( $request_data ) |
|
62 | + __('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'), |
|
63 | + wp_json_encode($request_data) |
|
64 | 64 | ) |
65 | 65 | ); |
66 | 66 | } |
67 | - $success = $this->_job_parameters->save( true ); |
|
68 | - if( ! $success ) { |
|
67 | + $success = $this->_job_parameters->save(true); |
|
68 | + if ( ! $success) { |
|
69 | 69 | throw new BatchRequestException( |
70 | 70 | sprintf( |
71 | 71 | __('Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s', 'event_espresso'), |
72 | 72 | $this->_job_id, |
73 | - wp_json_encode( $request_data ) |
|
73 | + wp_json_encode($request_data) |
|
74 | 74 | ) |
75 | 75 | ); |
76 | 76 | } |
77 | - } catch( \Exception $e ) { |
|
78 | - $response = $this->_get_error_response( $e, 'create_job' ); |
|
77 | + } catch (\Exception $e) { |
|
78 | + $response = $this->_get_error_response($e, 'create_job'); |
|
79 | 79 | } |
80 | 80 | return $response; |
81 | 81 | } |
@@ -88,26 +88,26 @@ discard block |
||
88 | 88 | * @param int $batch_size |
89 | 89 | * @return JobStepResponse |
90 | 90 | */ |
91 | - public function continue_job( $job_id, $batch_size = 50 ) { |
|
91 | + public function continue_job($job_id, $batch_size = 50) { |
|
92 | 92 | try { |
93 | 93 | $this->_job_id = $job_id; |
94 | - $batch_size = defined( 'EE_BATCHRUNNER_BATCH_SIZE' ) ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size; |
|
94 | + $batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size; |
|
95 | 95 | //get the corresponding WordPress option for the job |
96 | - $this->_job_parameters = JobParameters::load( $this->_job_id ); |
|
97 | - $handler_obj = $this->instantiate_batch_job_handler_from_classname( $this->_job_parameters->classname() ); |
|
96 | + $this->_job_parameters = JobParameters::load($this->_job_id); |
|
97 | + $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname()); |
|
98 | 98 | //continue it |
99 | - $response = $handler_obj->continue_job( $this->_job_parameters, $batch_size ); |
|
100 | - if( ! $response instanceof JobStepResponse ) { |
|
99 | + $response = $handler_obj->continue_job($this->_job_parameters, $batch_size); |
|
100 | + if ( ! $response instanceof JobStepResponse) { |
|
101 | 101 | throw new BatchRequestException( |
102 | 102 | sprintf( |
103 | - __( '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' ), |
|
103 | + __('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'), |
|
104 | 104 | $this->_job_id |
105 | 105 | ) |
106 | 106 | ); |
107 | 107 | } |
108 | 108 | $this->_job_parameters->save(); |
109 | - } catch( \Exception $e ) { |
|
110 | - $response = $this->_get_error_response( $e, 'continue_job' ); |
|
109 | + } catch (\Exception $e) { |
|
110 | + $response = $this->_get_error_response($e, 'continue_job'); |
|
111 | 111 | } |
112 | 112 | return $response; |
113 | 113 | } |
@@ -122,8 +122,8 @@ discard block |
||
122 | 122 | * @return JobHandlerInterface |
123 | 123 | * @throws BatchRequestException |
124 | 124 | */ |
125 | - public function instantiate_batch_job_handler_from_classname( $classname ) { |
|
126 | - if( ! class_exists( $classname ) ) { |
|
125 | + public function instantiate_batch_job_handler_from_classname($classname) { |
|
126 | + if ( ! class_exists($classname)) { |
|
127 | 127 | throw new BatchRequestException( |
128 | 128 | sprintf( |
129 | 129 | __('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 @@ discard block |
||
132 | 132 | ); |
133 | 133 | } |
134 | 134 | $obj = new $classname; |
135 | - if( ! $obj instanceof JobHandlerInterface ) { |
|
135 | + if ( ! $obj instanceof JobHandlerInterface) { |
|
136 | 136 | throw new BatchRequestException( |
137 | 137 | sprintf( |
138 | 138 | __('The class %1$s does not implement JobHandlerInterface and so could not be used for running a job', 'event_espresso'), |
@@ -152,26 +152,26 @@ discard block |
||
152 | 152 | * @return JobStepResponse |
153 | 153 | * @throws BatchRequestException |
154 | 154 | */ |
155 | - public function cleanup_job( $job_id ) { |
|
156 | - try{ |
|
155 | + public function cleanup_job($job_id) { |
|
156 | + try { |
|
157 | 157 | $this->_job_id = $job_id; |
158 | - $job_parameters = JobParameters::load( $this->_job_id ); |
|
159 | - $handler_obj = $this->instantiate_batch_job_handler_from_classname( $job_parameters->classname() ); |
|
158 | + $job_parameters = JobParameters::load($this->_job_id); |
|
159 | + $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname()); |
|
160 | 160 | //continue it |
161 | - $response = $handler_obj->cleanup_job( $job_parameters ); |
|
162 | - if( ! $response instanceof JobStepResponse ) { |
|
161 | + $response = $handler_obj->cleanup_job($job_parameters); |
|
162 | + if ( ! $response instanceof JobStepResponse) { |
|
163 | 163 | throw new BatchRequestException( |
164 | 164 | sprintf( |
165 | - __( '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' ), |
|
165 | + __('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'), |
|
166 | 166 | $this->_job_id |
167 | 167 | ) |
168 | 168 | ); |
169 | 169 | } |
170 | - $job_parameters->set_status( JobParameters::status_cleaned_up ); |
|
170 | + $job_parameters->set_status(JobParameters::status_cleaned_up); |
|
171 | 171 | $job_parameters->delete(); |
172 | 172 | return $response; |
173 | - } catch( \Exception $e ) { |
|
174 | - $response = $this->_get_error_response( $e, 'cleanup_job' ); |
|
173 | + } catch (\Exception $e) { |
|
174 | + $response = $this->_get_error_response($e, 'cleanup_job'); |
|
175 | 175 | } |
176 | 176 | return $response; |
177 | 177 | } |
@@ -184,17 +184,17 @@ discard block |
||
184 | 184 | * @param string $method_name |
185 | 185 | * @return JobStepResponse |
186 | 186 | */ |
187 | - protected function _get_error_response( \Exception $exception, $method_name ) { |
|
188 | - if( ! $this->_job_parameters instanceof JobParameters ) { |
|
189 | - $this->_job_parameters = new JobParameters( $this->_job_id, __( '__Unknown__', 'event_espresso' ), array() ); |
|
187 | + protected function _get_error_response(\Exception $exception, $method_name) { |
|
188 | + if ( ! $this->_job_parameters instanceof JobParameters) { |
|
189 | + $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array()); |
|
190 | 190 | } |
191 | - $this->_job_parameters->set_status( JobParameters::status_error ); |
|
191 | + $this->_job_parameters->set_status(JobParameters::status_error); |
|
192 | 192 | return new JobStepResponse( |
193 | 193 | $this->_job_parameters, |
194 | 194 | sprintf( |
195 | 195 | __('An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s', 'event_espresso'), |
196 | - get_class( $exception ), |
|
197 | - 'BatchRunner::' . $method_name . '()', |
|
196 | + get_class($exception), |
|
197 | + 'BatchRunner::'.$method_name.'()', |
|
198 | 198 | $exception->getMessage(), |
199 | 199 | $exception->getTraceAsString() |
200 | 200 | ) |
@@ -1,21 +1,21 @@ |
||
1 | 1 | <?php |
2 | 2 | /** |
3 | - * |
|
4 | - * Class BatchRequetProcessor |
|
3 | + * |
|
4 | + * Class BatchRequetProcessor |
|
5 | 5 | * |
6 | - * Responsible for receiving a request to start a job and assign it a job Id. |
|
7 | - * Then when subsequent requests come in to continue that job, dispatches |
|
8 | - * the request to the appropriate JobHandler, which processes a step of the batch, |
|
9 | - * and then returns the job's new status. |
|
10 | - * This class is used by controller code, and the controller code is sent HTTP |
|
11 | - * requests from the batch_runner.js library |
|
12 | - * |
|
13 | - * @package Event Espresso |
|
14 | - * @subpackage batch |
|
15 | - * @author Mike Nelson |
|
16 | - * @since 4.8.26 |
|
17 | - * |
|
18 | - */ |
|
6 | + * Responsible for receiving a request to start a job and assign it a job Id. |
|
7 | + * Then when subsequent requests come in to continue that job, dispatches |
|
8 | + * the request to the appropriate JobHandler, which processes a step of the batch, |
|
9 | + * and then returns the job's new status. |
|
10 | + * This class is used by controller code, and the controller code is sent HTTP |
|
11 | + * requests from the batch_runner.js library |
|
12 | + * |
|
13 | + * @package Event Espresso |
|
14 | + * @subpackage batch |
|
15 | + * @author Mike Nelson |
|
16 | + * @since 4.8.26 |
|
17 | + * |
|
18 | + */ |
|
19 | 19 | namespace EventEspressoBatchRequest; |
20 | 20 | |
21 | 21 | use EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandlerInterface; |
@@ -15,7 +15,7 @@ |
||
15 | 15 | namespace EventEspressoBatchRequest\Helpers; |
16 | 16 | if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); } |
17 | 17 | |
18 | -class BatchRequestException extends \Exception{ |
|
18 | +class BatchRequestException extends \Exception { |
|
19 | 19 | //so far the same as exception |
20 | 20 | } |
21 | 21 |
@@ -1,17 +1,17 @@ |
||
1 | 1 | <?php |
2 | 2 | /** |
3 | - * |
|
4 | - * Class BatchRequestException |
|
5 | - * |
|
6 | - * Exception class for whenever we have trouble running start, continuing, or finishing |
|
7 | - * a batch job. |
|
8 | - * |
|
9 | - * @package Event Espresso |
|
10 | - * @subpackage batch |
|
11 | - * @author Mike Nelson |
|
12 | - * @since 4.8.26 |
|
13 | - * |
|
14 | - */ |
|
3 | + * |
|
4 | + * Class BatchRequestException |
|
5 | + * |
|
6 | + * Exception class for whenever we have trouble running start, continuing, or finishing |
|
7 | + * a batch job. |
|
8 | + * |
|
9 | + * @package Event Espresso |
|
10 | + * @subpackage batch |
|
11 | + * @author Mike Nelson |
|
12 | + * @since 4.8.26 |
|
13 | + * |
|
14 | + */ |
|
15 | 15 | namespace EventEspressoBatchRequest\Helpers; |
16 | 16 | if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); } |
17 | 17 |
@@ -43,10 +43,10 @@ |
||
43 | 43 | * @param string $update_text |
44 | 44 | * @param array $extra_data |
45 | 45 | */ |
46 | - public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array() ) { |
|
47 | - $this->_job_parameters = $job_parameters; |
|
46 | + public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array()) { |
|
47 | + $this->_job_parameters = $job_parameters; |
|
48 | 48 | $this->_update_text = $update_text; |
49 | - $this->_extra_data = (array)$extra_data; |
|
49 | + $this->_extra_data = (array) $extra_data; |
|
50 | 50 | } |
51 | 51 | |
52 | 52 |
@@ -17,8 +17,8 @@ discard block |
||
17 | 17 | use EventEspressoBatchRequest\Helpers\JobParameters; |
18 | 18 | use EventEspressoBatchRequest\Helpers\JobStepResponse; |
19 | 19 | |
20 | -if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
21 | - exit( 'No direct script access allowed' ); |
|
20 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
21 | + exit('No direct script access allowed'); |
|
22 | 22 | } |
23 | 23 | |
24 | 24 | |
@@ -34,7 +34,7 @@ discard block |
||
34 | 34 | * @throws BatchRequestException |
35 | 35 | * @return JobStepResponse |
36 | 36 | */ |
37 | - abstract public function create_job( JobParameters $job_parameters ); |
|
37 | + abstract public function create_job(JobParameters $job_parameters); |
|
38 | 38 | |
39 | 39 | /** |
40 | 40 | * Performs another step of the job |
@@ -44,7 +44,7 @@ discard block |
||
44 | 44 | * @return JobStepResponse |
45 | 45 | * @throws BatchRequestException |
46 | 46 | */ |
47 | - abstract public function continue_job( JobParameters $job_parameters, $batch_size = 50 ); |
|
47 | + abstract public function continue_job(JobParameters $job_parameters, $batch_size = 50); |
|
48 | 48 | |
49 | 49 | |
50 | 50 | |
@@ -55,6 +55,6 @@ discard block |
||
55 | 55 | * @return JobStepResponse |
56 | 56 | * @throws BatchRequestException |
57 | 57 | */ |
58 | - abstract public function cleanup_job( JobParameters $job_parameters ); |
|
58 | + abstract public function cleanup_job(JobParameters $job_parameters); |
|
59 | 59 | } |
60 | 60 |
@@ -16,8 +16,8 @@ discard block |
||
16 | 16 | |
17 | 17 | use EventEspressoBatchRequest\Helpers\BatchRequestException; |
18 | 18 | |
19 | -if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
20 | - exit( 'No direct script access allowed' ); |
|
19 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
20 | + exit('No direct script access allowed'); |
|
21 | 21 | } |
22 | 22 | |
23 | 23 | |
@@ -29,8 +29,8 @@ discard block |
||
29 | 29 | */ |
30 | 30 | protected $_file_helper = null; |
31 | 31 | const temp_folder_name = 'batch_temp_folder'; |
32 | - public function __construct( EEHI_File $file_helper = null ) { |
|
33 | - if( ! $file_helper ) { |
|
32 | + public function __construct(EEHI_File $file_helper = null) { |
|
33 | + if ( ! $file_helper) { |
|
34 | 34 | $this->_file_helper = new \EEH_File(); |
35 | 35 | } |
36 | 36 | } |
@@ -45,30 +45,30 @@ discard block |
||
45 | 45 | * @return string |
46 | 46 | * @throws BatchRequestException |
47 | 47 | */ |
48 | - public function create_file_from_job_with_name( $job_id, $filename ) { |
|
48 | + public function create_file_from_job_with_name($job_id, $filename) { |
|
49 | 49 | $filepath = ''; |
50 | - try{ |
|
50 | + try { |
|
51 | 51 | $success = $this->_file_helper->ensure_folder_exists_and_is_writable( |
52 | - EVENT_ESPRESSO_UPLOAD_DIR . JobHandlerFile::temp_folder_name |
|
52 | + EVENT_ESPRESSO_UPLOAD_DIR.JobHandlerFile::temp_folder_name |
|
53 | 53 | ); |
54 | - if ( $success ) { |
|
54 | + if ($success) { |
|
55 | 55 | $success = $this->_file_helper->ensure_folder_exists_and_is_writable( |
56 | - EVENT_ESPRESSO_UPLOAD_DIR . JobHandlerFile::temp_folder_name . DS . $job_id |
|
56 | + EVENT_ESPRESSO_UPLOAD_DIR.JobHandlerFile::temp_folder_name.DS.$job_id |
|
57 | 57 | ); |
58 | 58 | } |
59 | - if( $success ) { |
|
60 | - $filepath = EVENT_ESPRESSO_UPLOAD_DIR . JobHandlerFile::temp_folder_name . DS . $job_id . DS. $filename; |
|
61 | - $success = $this->_file_helper->ensure_file_exists_and_is_writable( $filepath ); |
|
59 | + if ($success) { |
|
60 | + $filepath = EVENT_ESPRESSO_UPLOAD_DIR.JobHandlerFile::temp_folder_name.DS.$job_id.DS.$filename; |
|
61 | + $success = $this->_file_helper->ensure_file_exists_and_is_writable($filepath); |
|
62 | 62 | } |
63 | 63 | //those methods normally fail with an exception, but if not, let's do it |
64 | - if( ! $success ) { |
|
65 | - throw new \EE_Error( 'could_not_create_temp_file', |
|
66 | - __( 'An unknown error occurred', 'event_espresso' )); |
|
64 | + if ( ! $success) { |
|
65 | + throw new \EE_Error('could_not_create_temp_file', |
|
66 | + __('An unknown error occurred', 'event_espresso')); |
|
67 | 67 | } |
68 | - } catch( \EE_Error $e ) { |
|
68 | + } catch (\EE_Error $e) { |
|
69 | 69 | throw new BatchRequestException( |
70 | 70 | sprintf( |
71 | - __( 'Could not create temporary file for job %1$s, because: %2$s ', 'event_espresso' ), |
|
71 | + __('Could not create temporary file for job %1$s, because: %2$s ', 'event_espresso'), |
|
72 | 72 | $job_id, |
73 | 73 | $e->getMessage() |
74 | 74 | ), |
@@ -84,8 +84,8 @@ discard block |
||
84 | 84 | * @param string $filepath |
85 | 85 | * @return string url to file |
86 | 86 | */ |
87 | - public function get_url_to_file( $filepath ) { |
|
88 | - return str_replace( EVENT_ESPRESSO_UPLOAD_DIR, EVENT_ESPRESSO_UPLOAD_URL, $filepath ); |
|
87 | + public function get_url_to_file($filepath) { |
|
88 | + return str_replace(EVENT_ESPRESSO_UPLOAD_DIR, EVENT_ESPRESSO_UPLOAD_URL, $filepath); |
|
89 | 89 | } |
90 | 90 | } |
91 | 91 |
@@ -20,8 +20,8 @@ discard block |
||
20 | 20 | use EventEspressoBatchRequest\Helpers\JobParameters; |
21 | 21 | use EventEspressoBatchRequest\Helpers\JobStepResponse; |
22 | 22 | |
23 | -if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
24 | - exit( 'No direct script access allowed' ); |
|
23 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
24 | + exit('No direct script access allowed'); |
|
25 | 25 | } |
26 | 26 | |
27 | 27 | |
@@ -35,7 +35,7 @@ discard block |
||
35 | 35 | * @throws BatchRequestException |
36 | 36 | * @return JobStepResponse |
37 | 37 | */ |
38 | - public function create_job( JobParameters $job_parameters ); |
|
38 | + public function create_job(JobParameters $job_parameters); |
|
39 | 39 | |
40 | 40 | /** |
41 | 41 | * Performs another step of the job |
@@ -44,7 +44,7 @@ discard block |
||
44 | 44 | * @return JobStepResponse |
45 | 45 | * @throws BatchRequestException |
46 | 46 | */ |
47 | - public function continue_job( JobParameters $job_parameters, $batch_size = 50 ); |
|
47 | + public function continue_job(JobParameters $job_parameters, $batch_size = 50); |
|
48 | 48 | |
49 | 49 | /** |
50 | 50 | * Performs any clean-up logic when we know the job is completed |
@@ -52,5 +52,5 @@ discard block |
||
52 | 52 | * @return JobStepResponse |
53 | 53 | * @throws BatchRequestException |
54 | 54 | */ |
55 | - public function cleanup_job( JobParameters $job_parameters ); |
|
55 | + public function cleanup_job(JobParameters $job_parameters); |
|
56 | 56 | } |
@@ -2,18 +2,18 @@ |
||
2 | 2 | <p> |
3 | 3 | <?php _e('The importer can be used to import event information into Event Espresso using a CSV file.', 'event_espresso'); ?> |
4 | 4 | </p> |
5 | -<h3><?php _e("Importing from other Event Espresso 4 Sites", 'event_espresso');?></h3> |
|
5 | +<h3><?php _e("Importing from other Event Espresso 4 Sites", 'event_espresso'); ?></h3> |
|
6 | 6 | <p> |
7 | 7 | <?php _e('To import Event Espresso data from another Event Espresso 4 install, export a CSV file from the admin Events overview page, or anywhere you can generate a CSV export file from. Then upload that file here (regardless of what type of information was exported).', 'event_espresso'); ?> |
8 | 8 | </p> |
9 | 9 | <p> |
10 | 10 | <?php _e('Note: its possible that data from the other site have the same IDs as data in this site. The importer recognizes that this data is from a different database and inserts new items for each item in the CSV file, regardless of whether its ID matches that of an item in this site\'s database or not. However, the importer also remembers the mapping from the old site\'s database to this site\'s database, and on subsequent CSV importers from that site, the data in this database will be updated instead of re-inserting new items.', 'event_espresso'); ?> |
11 | 11 | </p> |
12 | -<h3><?php _e("Importing from this Site", 'event_espresso');?></h3> |
|
13 | -<p><?php _e("You may want to export data from this site, modify it (or modify the database), and re-import it. When this is done, the importer recognizes that the data is from this site\'s database and updates the records (instead of inserting new items like it would have, had the CSV data been from a different site).", 'event_espresso');?></p> |
|
12 | +<h3><?php _e("Importing from this Site", 'event_espresso'); ?></h3> |
|
13 | +<p><?php _e("You may want to export data from this site, modify it (or modify the database), and re-import it. When this is done, the importer recognizes that the data is from this site\'s database and updates the records (instead of inserting new items like it would have, had the CSV data been from a different site).", 'event_espresso'); ?></p> |
|
14 | 14 | |
15 | - <h3><?php _e("Notes about Generating your own CSV Import Files", "event_espresso");?></h3> |
|
16 | - <p><?php _e("If you think you could save time entering data into a CSV file, you can use the sample import file below. Note that creating your own CSV file is more complicated than in Event Espresso 3.1 because of the more advanced data structure, and so we recommend creating/editing your events using the normal web-interface.", "event_espresso");?></p> |
|
17 | - <p><?php _e("The export file is just an export of an event, or if you do not have any events in your system, it will only contain column headers. Do not change those column headers. Add as many rows as you like. ", "event_espresso");?></p> |
|
18 | - <p><?php _e("In the ID columns (columns ending in '_ID'), you should enter 'temporary IDs', which are unique numbers/words that identify that item, which can be used later when you want to refer to that item. (For example, if you assign an event's EVT_ID to be a temporary id of 'my-event-1', then use that same phrase 'my-event-1' to refer to that event in the Datetime model's EVT_ID column)", "event_espresso");?></p> |
|
19 | - <p><?php _e("Also note, you do NOT have to enter info in for each model. (You can, for example, only enter in Term_Taxonomies and Term model data)", "event_espresso");?></p> |
|
20 | 15 | \ No newline at end of file |
16 | + <h3><?php _e("Notes about Generating your own CSV Import Files", "event_espresso"); ?></h3> |
|
17 | + <p><?php _e("If you think you could save time entering data into a CSV file, you can use the sample import file below. Note that creating your own CSV file is more complicated than in Event Espresso 3.1 because of the more advanced data structure, and so we recommend creating/editing your events using the normal web-interface.", "event_espresso"); ?></p> |
|
18 | + <p><?php _e("The export file is just an export of an event, or if you do not have any events in your system, it will only contain column headers. Do not change those column headers. Add as many rows as you like. ", "event_espresso"); ?></p> |
|
19 | + <p><?php _e("In the ID columns (columns ending in '_ID'), you should enter 'temporary IDs', which are unique numbers/words that identify that item, which can be used later when you want to refer to that item. (For example, if you assign an event's EVT_ID to be a temporary id of 'my-event-1', then use that same phrase 'my-event-1' to refer to that event in the Datetime model's EVT_ID column)", "event_espresso"); ?></p> |
|
20 | + <p><?php _e("Also note, you do NOT have to enter info in for each model. (You can, for example, only enter in Term_Taxonomies and Term model data)", "event_espresso"); ?></p> |
|
21 | 21 | \ No newline at end of file |
@@ -1,17 +1,17 @@ |
||
1 | 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed'); |
2 | 2 | /** |
3 | - * |
|
4 | - * Class EE_Payment_Method_Manager |
|
5 | - * |
|
6 | - * Used for finding all payment method types that can be defined. |
|
7 | - * Allows addons to easily add other payment methods |
|
8 | - * |
|
9 | - * @package Event Espresso |
|
10 | - * @subpackage core |
|
11 | - * @author Michael Nelson |
|
12 | - * @since $VID:$ |
|
13 | - * |
|
14 | - */ |
|
3 | + * |
|
4 | + * Class EE_Payment_Method_Manager |
|
5 | + * |
|
6 | + * Used for finding all payment method types that can be defined. |
|
7 | + * Allows addons to easily add other payment methods |
|
8 | + * |
|
9 | + * @package Event Espresso |
|
10 | + * @subpackage core |
|
11 | + * @author Michael Nelson |
|
12 | + * @since $VID:$ |
|
13 | + * |
|
14 | + */ |
|
15 | 15 | class EE_Payment_Method_Manager { |
16 | 16 | |
17 | 17 | /** |
@@ -1,4 +1,6 @@ discard block |
||
1 | -<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed'); |
|
1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | + exit('No direct script access allowed'); |
|
3 | +} |
|
2 | 4 | /** |
3 | 5 | * Event Espresso |
4 | 6 | * |
@@ -513,7 +515,7 @@ discard block |
||
513 | 515 | |
514 | 516 | if($count){ |
515 | 517 | return EEM_Price::instance()->count_deleted_and_undeleted(array($_where)); |
516 | - }else{ |
|
518 | + } else{ |
|
517 | 519 | return EEM_Price::instance()->get_all_deleted_and_undeleted($query_params); |
518 | 520 | } |
519 | 521 | } |
@@ -943,7 +945,7 @@ discard block |
||
943 | 945 | 'limit'=>$limit); |
944 | 946 | if($count){ |
945 | 947 | return EEM_Price_Type::instance()->count_deleted_and_undeleted($query_params); |
946 | - }else{ |
|
948 | + } else{ |
|
947 | 949 | return EEM_Price_Type::instance()->get_all_deleted_and_undeleted($query_params); |
948 | 950 | } |
949 | 951 |
@@ -35,7 +35,7 @@ discard block |
||
35 | 35 | */ |
36 | 36 | public static function instance() { |
37 | 37 | // check if class object is instantiated, and instantiated properly |
38 | - if ( ! self::$_instance instanceof EE_Payment_Method_Manager ) { |
|
38 | + if ( ! self::$_instance instanceof EE_Payment_Method_Manager) { |
|
39 | 39 | self::$_instance = new self(); |
40 | 40 | } |
41 | 41 | EE_Registry::instance()->load_lib('PMT_Base'); |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | * Resets the instance and returns a new one |
47 | 47 | * @return EE_Payment_Method_Manager |
48 | 48 | */ |
49 | - public static function reset(){ |
|
49 | + public static function reset() { |
|
50 | 50 | self::$_instance = NULL; |
51 | 51 | return self::instance(); |
52 | 52 | } |
@@ -57,12 +57,12 @@ discard block |
||
57 | 57 | * or just re-use the PMTs we found last time we checked during this request (if |
58 | 58 | * we have not yet checked during this request, then we need to check anyways) |
59 | 59 | */ |
60 | - public function maybe_register_payment_methods( $force_recheck = FALSE ){ |
|
61 | - if( ! $this->_payment_method_types || $force_recheck ){ |
|
60 | + public function maybe_register_payment_methods($force_recheck = FALSE) { |
|
61 | + if ( ! $this->_payment_method_types || $force_recheck) { |
|
62 | 62 | $this->_register_payment_methods(); |
63 | 63 | //if in admin lets ensure caps are set. |
64 | - if ( is_admin() ) { |
|
65 | - add_filter( 'FHEE__EE_Capabilities__init_caps_map__caps', array( $this, 'add_payment_method_caps' ) ); |
|
64 | + if (is_admin()) { |
|
65 | + add_filter('FHEE__EE_Capabilities__init_caps_map__caps', array($this, 'add_payment_method_caps')); |
|
66 | 66 | EE_Registry::instance()->CAP->init_caps(); |
67 | 67 | } |
68 | 68 | } |
@@ -75,19 +75,19 @@ discard block |
||
75 | 75 | */ |
76 | 76 | protected function _register_payment_methods() { |
77 | 77 | // grab list of installed modules |
78 | - $pm_to_register = glob( EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR ); |
|
78 | + $pm_to_register = glob(EE_PAYMENT_METHODS.'*', GLOB_ONLYDIR); |
|
79 | 79 | // filter list of modules to register |
80 | - $pm_to_register = apply_filters( 'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register', $pm_to_register ); |
|
80 | + $pm_to_register = apply_filters('FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register', $pm_to_register); |
|
81 | 81 | |
82 | 82 | // loop through folders |
83 | - foreach ( $pm_to_register as $pm_path ) { |
|
84 | - $this->register_payment_method( $pm_path ); |
|
83 | + foreach ($pm_to_register as $pm_path) { |
|
84 | + $this->register_payment_method($pm_path); |
|
85 | 85 | } |
86 | - do_action( 'FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods' ); |
|
86 | + do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods'); |
|
87 | 87 | // filter list of installed modules |
88 | 88 | //keep them organized alphabetically by the payment method type's name |
89 | - ksort( $this->_payment_method_types ); |
|
90 | - return apply_filters( 'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods', $this->_payment_method_types ); |
|
89 | + ksort($this->_payment_method_types); |
|
90 | + return apply_filters('FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods', $this->_payment_method_types); |
|
91 | 91 | } |
92 | 92 | |
93 | 93 | |
@@ -99,35 +99,35 @@ discard block |
||
99 | 99 | * @param string $payment_method_path - full path up to and including payment method folder |
100 | 100 | * @return boolean |
101 | 101 | */ |
102 | - public function register_payment_method( $payment_method_path = '' ) { |
|
103 | - do_action( 'AHEE__EE_Payment_Method_Manager__register_payment_method__begin',$payment_method_path ); |
|
102 | + public function register_payment_method($payment_method_path = '') { |
|
103 | + do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path); |
|
104 | 104 | $module_ext = '.pm.php'; |
105 | 105 | // make all separators match |
106 | - $payment_method_path = rtrim( str_replace( '/\\', DS, $payment_method_path ), DS ); |
|
106 | + $payment_method_path = rtrim(str_replace('/\\', DS, $payment_method_path), DS); |
|
107 | 107 | // grab and sanitize module name |
108 | - $module_dir = basename( $payment_method_path ); |
|
108 | + $module_dir = basename($payment_method_path); |
|
109 | 109 | // create classname from module directory name |
110 | - $module = str_replace( ' ', '_', str_replace( '_', ' ', $module_dir )); |
|
110 | + $module = str_replace(' ', '_', str_replace('_', ' ', $module_dir)); |
|
111 | 111 | // add class prefix |
112 | - $module_class = 'EE_PMT_' . $module; |
|
112 | + $module_class = 'EE_PMT_'.$module; |
|
113 | 113 | // does the module exist ? |
114 | - if ( ! is_readable( $payment_method_path . DS . $module_class . $module_ext )) { |
|
115 | - $msg = sprintf( __( 'The requested %s payment method file could not be found or is not readable due to file permissions.', 'event_espresso' ), $module ); |
|
116 | - EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ ); |
|
114 | + if ( ! is_readable($payment_method_path.DS.$module_class.$module_ext)) { |
|
115 | + $msg = sprintf(__('The requested %s payment method file could not be found or is not readable due to file permissions.', 'event_espresso'), $module); |
|
116 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
117 | 117 | return FALSE; |
118 | 118 | } |
119 | - if ( WP_DEBUG === TRUE ) { EEH_Debug_Tools::instance()->start_timer(); } |
|
119 | + if (WP_DEBUG === TRUE) { EEH_Debug_Tools::instance()->start_timer(); } |
|
120 | 120 | // load the module class file |
121 | - require_once( $payment_method_path . DS . $module_class . $module_ext ); |
|
122 | - if ( WP_DEBUG === TRUE ) { EEH_Debug_Tools::instance()->stop_timer("Requiring payment method $module_class"); } |
|
121 | + require_once($payment_method_path.DS.$module_class.$module_ext); |
|
122 | + if (WP_DEBUG === TRUE) { EEH_Debug_Tools::instance()->stop_timer("Requiring payment method $module_class"); } |
|
123 | 123 | // verify that class exists |
124 | - if ( ! class_exists( $module_class )) { |
|
125 | - $msg = sprintf( __( 'The requested %s module class does not exist.', 'event_espresso' ), $module_class ); |
|
126 | - EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ ); |
|
124 | + if ( ! class_exists($module_class)) { |
|
125 | + $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class); |
|
126 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
127 | 127 | return FALSE; |
128 | 128 | } |
129 | 129 | // add to array of registered modules |
130 | - $this->_payment_method_types[ $module ] = $payment_method_path . DS . $module_class . $module_ext; |
|
130 | + $this->_payment_method_types[$module] = $payment_method_path.DS.$module_class.$module_ext; |
|
131 | 131 | return TRUE; |
132 | 132 | } |
133 | 133 | /** |
@@ -136,15 +136,15 @@ discard block |
||
136 | 136 | * @param boolean $force_recheck whether to force re-checking for new payment method types |
137 | 137 | * @return boolean |
138 | 138 | */ |
139 | - public function payment_method_type_exists($payment_method_name, $force_recheck = FALSE){ |
|
140 | - if ( ! is_array( $this->_payment_method_types ) || ! isset( $this->_payment_method_types[$payment_method_name] ) |
|
141 | - || $force_recheck ) { |
|
139 | + public function payment_method_type_exists($payment_method_name, $force_recheck = FALSE) { |
|
140 | + if ( ! is_array($this->_payment_method_types) || ! isset($this->_payment_method_types[$payment_method_name]) |
|
141 | + || $force_recheck) { |
|
142 | 142 | $this->maybe_register_payment_methods($force_recheck); |
143 | 143 | } |
144 | - if(isset($this->_payment_method_types[$payment_method_name])){ |
|
144 | + if (isset($this->_payment_method_types[$payment_method_name])) { |
|
145 | 145 | require_once($this->_payment_method_types[$payment_method_name]); |
146 | 146 | return true; |
147 | - }else{ |
|
147 | + } else { |
|
148 | 148 | return false; |
149 | 149 | } |
150 | 150 | } |
@@ -155,16 +155,16 @@ discard block |
||
155 | 155 | * @param boolean $force_recheck whether to force re-checking for new payment method types |
156 | 156 | * @return array |
157 | 157 | */ |
158 | - public function payment_method_type_names($with_prefixes = FALSE, $force_recheck = FALSE ){ |
|
158 | + public function payment_method_type_names($with_prefixes = FALSE, $force_recheck = FALSE) { |
|
159 | 159 | $this->maybe_register_payment_methods($force_recheck); |
160 | - if($with_prefixes){ |
|
160 | + if ($with_prefixes) { |
|
161 | 161 | $classnames = array_keys($this->_payment_method_types); |
162 | 162 | $payment_methods = array(); |
163 | - foreach($classnames as $classname){ |
|
163 | + foreach ($classnames as $classname) { |
|
164 | 164 | $payment_methods[] = $this->payment_method_class_from_type($classname); |
165 | 165 | } |
166 | 166 | return $payment_methods; |
167 | - }else{ |
|
167 | + } else { |
|
168 | 168 | return array_keys($this->_payment_method_types); |
169 | 169 | } |
170 | 170 | } |
@@ -174,10 +174,10 @@ discard block |
||
174 | 174 | * @param boolean $force_recheck whether to force re-checking for new payment method types |
175 | 175 | * @return EE_PMT_Base[] |
176 | 176 | */ |
177 | - public function payment_method_types( $force_recheck = FALSE ){ |
|
177 | + public function payment_method_types($force_recheck = FALSE) { |
|
178 | 178 | $this->maybe_register_payment_methods($force_recheck); |
179 | 179 | $pmt_objs = array(); |
180 | - foreach($this->payment_method_type_names(true) as $classname){ |
|
180 | + foreach ($this->payment_method_type_names(true) as $classname) { |
|
181 | 181 | $pmt_objs[] = new $classname; |
182 | 182 | } |
183 | 183 | return $pmt_objs; |
@@ -189,8 +189,8 @@ discard block |
||
189 | 189 | * @param string $classname |
190 | 190 | * @return string |
191 | 191 | */ |
192 | - public function payment_method_type_sans_class_prefix($classname){ |
|
193 | - $pmt_name = str_replace("EE_PMT_","",$classname); |
|
192 | + public function payment_method_type_sans_class_prefix($classname) { |
|
193 | + $pmt_name = str_replace("EE_PMT_", "", $classname); |
|
194 | 194 | return $pmt_name; |
195 | 195 | } |
196 | 196 | |
@@ -199,7 +199,7 @@ discard block |
||
199 | 199 | * @param string $type |
200 | 200 | * @return string |
201 | 201 | */ |
202 | - public function payment_method_class_from_type($type){ |
|
202 | + public function payment_method_class_from_type($type) { |
|
203 | 203 | $this->maybe_register_payment_methods(); |
204 | 204 | return "EE_PMT_".$type; |
205 | 205 | } |
@@ -213,38 +213,38 @@ discard block |
||
213 | 213 | * @return \EE_Payment_Method |
214 | 214 | * @throws \EE_Error |
215 | 215 | */ |
216 | - public function activate_a_payment_method_of_type( $payment_method_type ){ |
|
216 | + public function activate_a_payment_method_of_type($payment_method_type) { |
|
217 | 217 | $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type); |
218 | - if( ! $payment_method instanceof EE_Payment_Method ){ |
|
218 | + if ( ! $payment_method instanceof EE_Payment_Method) { |
|
219 | 219 | $pm_type_class = $this->payment_method_class_from_type($payment_method_type); |
220 | - if(class_exists($pm_type_class)){ |
|
220 | + if (class_exists($pm_type_class)) { |
|
221 | 221 | /** @var $pm_type_obj EE_PMT_Base */ |
222 | 222 | $pm_type_obj = new $pm_type_class; |
223 | 223 | $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name()); |
224 | - if( ! $payment_method){ |
|
225 | - $payment_method = $this->create_payment_method_of_type( $pm_type_obj ); |
|
224 | + if ( ! $payment_method) { |
|
225 | + $payment_method = $this->create_payment_method_of_type($pm_type_obj); |
|
226 | 226 | } |
227 | - $payment_method->set_type( $payment_method_type ); |
|
228 | - $this->initialize_payment_method( $payment_method ); |
|
227 | + $payment_method->set_type($payment_method_type); |
|
228 | + $this->initialize_payment_method($payment_method); |
|
229 | 229 | } else { |
230 | 230 | throw new EE_Error( |
231 | 231 | sprintf( |
232 | - __( 'There is no payment method of type %1$s, so it could not be activated', 'event_espresso'), |
|
232 | + __('There is no payment method of type %1$s, so it could not be activated', 'event_espresso'), |
|
233 | 233 | $pm_type_class ) |
234 | 234 | ); |
235 | 235 | } |
236 | 236 | } |
237 | 237 | $payment_method->set_active(); |
238 | 238 | $payment_method->save(); |
239 | - $this->set_usable_currencies_on_payment_method( $payment_method ); |
|
240 | - if( $payment_method->type() == 'Invoice' ){ |
|
241 | - $messages = EE_Registry::instance()->load_lib( 'messages' ); |
|
242 | - $messages->ensure_message_type_is_active( 'invoice', 'html' ); |
|
243 | - $messages->ensure_messenger_is_active( 'pdf' ); |
|
239 | + $this->set_usable_currencies_on_payment_method($payment_method); |
|
240 | + if ($payment_method->type() == 'Invoice') { |
|
241 | + $messages = EE_Registry::instance()->load_lib('messages'); |
|
242 | + $messages->ensure_message_type_is_active('invoice', 'html'); |
|
243 | + $messages->ensure_messenger_is_active('pdf'); |
|
244 | 244 | EE_Error::add_attention( |
245 | 245 | sprintf( |
246 | - __( 'Note, when the invoice payment method is activated, the invoice message type, html messenger, and pdf messenger are activated as well for the %1$smessages system%2$s.', 'event_espresso' ), |
|
247 | - '<a href="' . admin_url( 'admin.php?page=espresso_messages') . '">', |
|
246 | + __('Note, when the invoice payment method is activated, the invoice message type, html messenger, and pdf messenger are activated as well for the %1$smessages system%2$s.', 'event_espresso'), |
|
247 | + '<a href="'.admin_url('admin.php?page=espresso_messages').'">', |
|
248 | 248 | '</a>' |
249 | 249 | ) |
250 | 250 | ); |
@@ -258,17 +258,17 @@ discard block |
||
258 | 258 | * @param EE_PMT_Base $pm_type_obj |
259 | 259 | * @return EE_Payment_Method |
260 | 260 | */ |
261 | - public function create_payment_method_of_type( $pm_type_obj ) { |
|
261 | + public function create_payment_method_of_type($pm_type_obj) { |
|
262 | 262 | global $current_user; |
263 | 263 | $payment_method = EE_Payment_Method::new_instance( |
264 | 264 | array( |
265 | 265 | 'PMD_type' => $pm_type_obj->system_name(), |
266 | 266 | 'PMD_name' => $pm_type_obj->pretty_name(), |
267 | 267 | 'PMD_admin_name' => $pm_type_obj->pretty_name(), |
268 | - 'PMD_slug' => $pm_type_obj->system_name(),//automatically converted to slug |
|
268 | + 'PMD_slug' => $pm_type_obj->system_name(), //automatically converted to slug |
|
269 | 269 | 'PMD_wp_user' => $current_user->ID, |
270 | 270 | 'PMD_order' => EEM_Payment_Method::instance()->count( |
271 | - array( array( 'PMD_type' => array( '!=', 'Admin_Only' ))) |
|
271 | + array(array('PMD_type' => array('!=', 'Admin_Only'))) |
|
272 | 272 | ) * 10, |
273 | 273 | ) |
274 | 274 | ); |
@@ -280,16 +280,16 @@ discard block |
||
280 | 280 | * @param EE_Payment_Method $payment_method |
281 | 281 | * @return EE_Payment_Method |
282 | 282 | */ |
283 | - public function initialize_payment_method( $payment_method ) { |
|
283 | + public function initialize_payment_method($payment_method) { |
|
284 | 284 | $pm_type_obj = $payment_method->type_obj(); |
285 | - $payment_method->set_description( $pm_type_obj->default_description() ); |
|
286 | - if( ! $payment_method->button_url() ){ |
|
287 | - $payment_method->set_button_url( $pm_type_obj->default_button_url() ); |
|
285 | + $payment_method->set_description($pm_type_obj->default_description()); |
|
286 | + if ( ! $payment_method->button_url()) { |
|
287 | + $payment_method->set_button_url($pm_type_obj->default_button_url()); |
|
288 | 288 | } |
289 | 289 | //now add setup its default extra meta properties |
290 | 290 | $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs(); |
291 | - foreach( $extra_metas as $meta_name => $input ){ |
|
292 | - $payment_method->update_extra_meta($meta_name, $input->raw_value() ); |
|
291 | + foreach ($extra_metas as $meta_name => $input) { |
|
292 | + $payment_method->update_extra_meta($meta_name, $input->raw_value()); |
|
293 | 293 | } |
294 | 294 | return $payment_method; |
295 | 295 | } |
@@ -299,8 +299,8 @@ discard block |
||
299 | 299 | * @param EE_Payment_Method $payment_method |
300 | 300 | * @return EE_Payment_Method |
301 | 301 | */ |
302 | - public function set_usable_currencies_on_payment_method( $payment_method ) { |
|
303 | - foreach($payment_method->get_all_usable_currencies() as $currency_obj){ |
|
302 | + public function set_usable_currencies_on_payment_method($payment_method) { |
|
303 | + foreach ($payment_method->get_all_usable_currencies() as $currency_obj) { |
|
304 | 304 | $payment_method->_add_relation_to($currency_obj, 'Currency'); |
305 | 305 | } |
306 | 306 | return $payment_method; |
@@ -318,8 +318,8 @@ discard block |
||
318 | 318 | * |
319 | 319 | * @return int count of rows updated. |
320 | 320 | */ |
321 | - public function deactivate_payment_method( $payment_method_slug ) { |
|
322 | - $count_updated = EEM_Payment_Method::instance()->update(array('PMD_scope'=>array()),array(array('PMD_slug'=>$payment_method_slug))); |
|
321 | + public function deactivate_payment_method($payment_method_slug) { |
|
322 | + $count_updated = EEM_Payment_Method::instance()->update(array('PMD_scope'=>array()), array(array('PMD_slug'=>$payment_method_slug))); |
|
323 | 323 | return $count_updated; |
324 | 324 | } |
325 | 325 | |
@@ -332,7 +332,7 @@ discard block |
||
332 | 332 | * @param array $caps capabilities being filtered |
333 | 333 | * @return array |
334 | 334 | */ |
335 | - public function add_payment_method_caps( $caps ) { |
|
335 | + public function add_payment_method_caps($caps) { |
|
336 | 336 | /* add dynamic caps from payment methods |
337 | 337 | * at the time of writing, october 20 2014, these are the caps added: |
338 | 338 | * ee_payment_method_admin_only |
@@ -347,7 +347,7 @@ discard block |
||
347 | 347 | * their related capability automatically added too, so long as they are |
348 | 348 | * registered properly using EE_Register_Payment_Method::register() |
349 | 349 | */ |
350 | - foreach( $this->payment_method_types() as $payment_method_type_obj ){ |
|
350 | + foreach ($this->payment_method_types() as $payment_method_type_obj) { |
|
351 | 351 | $caps['administrator'][] = $payment_method_type_obj->cap_name(); |
352 | 352 | } |
353 | 353 | return $caps; |