eventespresso /
event-espresso-core
@@ -19,106 +19,106 @@ |
||
| 19 | 19 | class AttendeesReport extends JobHandlerFile |
| 20 | 20 | { |
| 21 | 21 | |
| 22 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 23 | - public function create_job(JobParameters $job_parameters) |
|
| 24 | - { |
|
| 25 | - if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) { |
|
| 26 | - throw new BatchRequestException( |
|
| 27 | - __('You do not have permission to view contacts', 'event_espresso') |
|
| 28 | - ); |
|
| 29 | - } |
|
| 30 | - $filepath = $this->create_file_from_job_with_name( |
|
| 31 | - $job_parameters->job_id(), |
|
| 32 | - __('contact-list-report.csv', 'event_espresso') |
|
| 33 | - ); |
|
| 34 | - $job_parameters->add_extra_data('filepath', $filepath); |
|
| 35 | - $job_parameters->set_job_size($this->count_units_to_process()); |
|
| 36 | - // we should also set the header columns |
|
| 37 | - $csv_data_for_row = $this->get_csv_data(0, 1); |
|
| 38 | - \EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true); |
|
| 39 | - // if we actually processed a row there, record it |
|
| 40 | - if ($job_parameters->job_size()) { |
|
| 41 | - $job_parameters->mark_processed(1); |
|
| 42 | - } |
|
| 43 | - return new JobStepResponse( |
|
| 44 | - $job_parameters, |
|
| 45 | - __('Contacts report started successfully...', 'event_espresso') |
|
| 46 | - ); |
|
| 47 | - } |
|
| 22 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 23 | + public function create_job(JobParameters $job_parameters) |
|
| 24 | + { |
|
| 25 | + if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) { |
|
| 26 | + throw new BatchRequestException( |
|
| 27 | + __('You do not have permission to view contacts', 'event_espresso') |
|
| 28 | + ); |
|
| 29 | + } |
|
| 30 | + $filepath = $this->create_file_from_job_with_name( |
|
| 31 | + $job_parameters->job_id(), |
|
| 32 | + __('contact-list-report.csv', 'event_espresso') |
|
| 33 | + ); |
|
| 34 | + $job_parameters->add_extra_data('filepath', $filepath); |
|
| 35 | + $job_parameters->set_job_size($this->count_units_to_process()); |
|
| 36 | + // we should also set the header columns |
|
| 37 | + $csv_data_for_row = $this->get_csv_data(0, 1); |
|
| 38 | + \EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true); |
|
| 39 | + // if we actually processed a row there, record it |
|
| 40 | + if ($job_parameters->job_size()) { |
|
| 41 | + $job_parameters->mark_processed(1); |
|
| 42 | + } |
|
| 43 | + return new JobStepResponse( |
|
| 44 | + $job_parameters, |
|
| 45 | + __('Contacts report started successfully...', 'event_espresso') |
|
| 46 | + ); |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | 49 | |
| 50 | - public function continue_job(JobParameters $job_parameters, $batch_size = 50) |
|
| 51 | - { |
|
| 52 | - $csv_data = $this->get_csv_data($job_parameters->units_processed(), $batch_size); |
|
| 53 | - \EEH_Export::write_data_array_to_csv( |
|
| 54 | - $job_parameters->extra_datum('filepath'), |
|
| 55 | - $csv_data, |
|
| 56 | - false |
|
| 57 | - ); |
|
| 58 | - $units_processed = count($csv_data); |
|
| 59 | - $job_parameters->mark_processed($units_processed); |
|
| 60 | - $extra_response_data = array( |
|
| 61 | - 'file_url' => '', |
|
| 62 | - ); |
|
| 63 | - if ($units_processed < $batch_size) { |
|
| 64 | - $job_parameters->set_status(JobParameters::status_complete); |
|
| 65 | - $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath')); |
|
| 66 | - } |
|
| 67 | - return new JobStepResponse( |
|
| 68 | - $job_parameters, |
|
| 69 | - sprintf( |
|
| 70 | - __('Wrote %1$s rows to report CSV file...', 'event_espresso'), |
|
| 71 | - count($csv_data) |
|
| 72 | - ), |
|
| 73 | - $extra_response_data |
|
| 74 | - ); |
|
| 75 | - } |
|
| 50 | + public function continue_job(JobParameters $job_parameters, $batch_size = 50) |
|
| 51 | + { |
|
| 52 | + $csv_data = $this->get_csv_data($job_parameters->units_processed(), $batch_size); |
|
| 53 | + \EEH_Export::write_data_array_to_csv( |
|
| 54 | + $job_parameters->extra_datum('filepath'), |
|
| 55 | + $csv_data, |
|
| 56 | + false |
|
| 57 | + ); |
|
| 58 | + $units_processed = count($csv_data); |
|
| 59 | + $job_parameters->mark_processed($units_processed); |
|
| 60 | + $extra_response_data = array( |
|
| 61 | + 'file_url' => '', |
|
| 62 | + ); |
|
| 63 | + if ($units_processed < $batch_size) { |
|
| 64 | + $job_parameters->set_status(JobParameters::status_complete); |
|
| 65 | + $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath')); |
|
| 66 | + } |
|
| 67 | + return new JobStepResponse( |
|
| 68 | + $job_parameters, |
|
| 69 | + sprintf( |
|
| 70 | + __('Wrote %1$s rows to report CSV file...', 'event_espresso'), |
|
| 71 | + count($csv_data) |
|
| 72 | + ), |
|
| 73 | + $extra_response_data |
|
| 74 | + ); |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | 77 | |
| 78 | - public function cleanup_job(JobParameters $job_parameters) |
|
| 79 | - { |
|
| 80 | - $this->_file_helper->delete( |
|
| 81 | - \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')), |
|
| 82 | - true, |
|
| 83 | - 'd' |
|
| 84 | - ); |
|
| 85 | - return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso')); |
|
| 86 | - } |
|
| 78 | + public function cleanup_job(JobParameters $job_parameters) |
|
| 79 | + { |
|
| 80 | + $this->_file_helper->delete( |
|
| 81 | + \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')), |
|
| 82 | + true, |
|
| 83 | + 'd' |
|
| 84 | + ); |
|
| 85 | + return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso')); |
|
| 86 | + } |
|
| 87 | 87 | |
| 88 | - public function count_units_to_process() |
|
| 89 | - { |
|
| 90 | - return \EEM_Attendee::instance()->count(array('caps' => \EEM_Base::caps_read_admin)); |
|
| 91 | - } |
|
| 88 | + public function count_units_to_process() |
|
| 89 | + { |
|
| 90 | + return \EEM_Attendee::instance()->count(array('caps' => \EEM_Base::caps_read_admin)); |
|
| 91 | + } |
|
| 92 | 92 | |
| 93 | - public function get_csv_data($offset, $limit) |
|
| 94 | - { |
|
| 95 | - $attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results( |
|
| 96 | - array( |
|
| 97 | - 'limit' => array($offset, $limit), |
|
| 98 | - 'force_join' => array('State', 'Country'), |
|
| 99 | - 'caps' => \EEM_Base::caps_read_admin, |
|
| 100 | - ) |
|
| 101 | - ); |
|
| 102 | - $csv_data = array(); |
|
| 103 | - foreach ($attendee_rows as $attendee_row) { |
|
| 104 | - $csv_row = array(); |
|
| 105 | - foreach (\EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) { |
|
| 106 | - if ($field_name == 'STA_ID') { |
|
| 107 | - $state_name_field = \EEM_State::instance()->field_settings_for('STA_name'); |
|
| 108 | - $csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column() ]; |
|
| 109 | - } elseif ($field_name == 'CNT_ISO') { |
|
| 110 | - $country_name_field = \EEM_Country::instance()->field_settings_for('CNT_name'); |
|
| 111 | - $csv_row[ __('Country', 'event_espresso') ] = $attendee_row[ $country_name_field->get_qualified_column() ]; |
|
| 112 | - } else { |
|
| 113 | - $csv_row[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ]; |
|
| 114 | - } |
|
| 115 | - } |
|
| 116 | - $csv_data[] = apply_filters( |
|
| 117 | - 'FHEE___EventEspresso_core_libraries_batch_JobHandlers_AttendeesReport__get_csv_data__row', |
|
| 118 | - $csv_row, |
|
| 119 | - $attendee_row |
|
| 120 | - ); |
|
| 121 | - } |
|
| 122 | - return $csv_data; |
|
| 123 | - } |
|
| 93 | + public function get_csv_data($offset, $limit) |
|
| 94 | + { |
|
| 95 | + $attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results( |
|
| 96 | + array( |
|
| 97 | + 'limit' => array($offset, $limit), |
|
| 98 | + 'force_join' => array('State', 'Country'), |
|
| 99 | + 'caps' => \EEM_Base::caps_read_admin, |
|
| 100 | + ) |
|
| 101 | + ); |
|
| 102 | + $csv_data = array(); |
|
| 103 | + foreach ($attendee_rows as $attendee_row) { |
|
| 104 | + $csv_row = array(); |
|
| 105 | + foreach (\EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) { |
|
| 106 | + if ($field_name == 'STA_ID') { |
|
| 107 | + $state_name_field = \EEM_State::instance()->field_settings_for('STA_name'); |
|
| 108 | + $csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column() ]; |
|
| 109 | + } elseif ($field_name == 'CNT_ISO') { |
|
| 110 | + $country_name_field = \EEM_Country::instance()->field_settings_for('CNT_name'); |
|
| 111 | + $csv_row[ __('Country', 'event_espresso') ] = $attendee_row[ $country_name_field->get_qualified_column() ]; |
|
| 112 | + } else { |
|
| 113 | + $csv_row[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ]; |
|
| 114 | + } |
|
| 115 | + } |
|
| 116 | + $csv_data[] = apply_filters( |
|
| 117 | + 'FHEE___EventEspresso_core_libraries_batch_JobHandlers_AttendeesReport__get_csv_data__row', |
|
| 118 | + $csv_row, |
|
| 119 | + $attendee_row |
|
| 120 | + ); |
|
| 121 | + } |
|
| 122 | + return $csv_data; |
|
| 123 | + } |
|
| 124 | 124 | } |
@@ -22,7 +22,7 @@ discard block |
||
| 22 | 22 | // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
| 23 | 23 | public function create_job(JobParameters $job_parameters) |
| 24 | 24 | { |
| 25 | - if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) { |
|
| 25 | + if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) { |
|
| 26 | 26 | throw new BatchRequestException( |
| 27 | 27 | __('You do not have permission to view contacts', 'event_espresso') |
| 28 | 28 | ); |
@@ -105,12 +105,12 @@ discard block |
||
| 105 | 105 | foreach (\EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) { |
| 106 | 106 | if ($field_name == 'STA_ID') { |
| 107 | 107 | $state_name_field = \EEM_State::instance()->field_settings_for('STA_name'); |
| 108 | - $csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column() ]; |
|
| 108 | + $csv_row[__('State', 'event_espresso')] = $attendee_row[$state_name_field->get_qualified_column()]; |
|
| 109 | 109 | } elseif ($field_name == 'CNT_ISO') { |
| 110 | 110 | $country_name_field = \EEM_Country::instance()->field_settings_for('CNT_name'); |
| 111 | - $csv_row[ __('Country', 'event_espresso') ] = $attendee_row[ $country_name_field->get_qualified_column() ]; |
|
| 111 | + $csv_row[__('Country', 'event_espresso')] = $attendee_row[$country_name_field->get_qualified_column()]; |
|
| 112 | 112 | } else { |
| 113 | - $csv_row[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ]; |
|
| 113 | + $csv_row[wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES)] = $attendee_row[$field_obj->get_qualified_column()]; |
|
| 114 | 114 | } |
| 115 | 115 | } |
| 116 | 116 | $csv_data[] = apply_filters( |
@@ -24,471 +24,471 @@ |
||
| 24 | 24 | class DatetimeOffsetFix extends JobHandler |
| 25 | 25 | { |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Key for the option used to track which models have been processed when doing the batches. |
|
| 29 | - */ |
|
| 30 | - const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix'; |
|
| 31 | - |
|
| 32 | - |
|
| 33 | - const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed'; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * Key for the option used to track what the current offset is that will be applied when this tool is executed. |
|
| 37 | - */ |
|
| 38 | - const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply'; |
|
| 39 | - |
|
| 40 | - |
|
| 41 | - const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range'; |
|
| 42 | - |
|
| 43 | - |
|
| 44 | - const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range'; |
|
| 45 | - |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * String labelling the datetime offset fix type for change-log entries. |
|
| 49 | - */ |
|
| 50 | - const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix'; |
|
| 51 | - |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * String labelling a datetime offset fix error for change-log entries. |
|
| 55 | - */ |
|
| 56 | - const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error'; |
|
| 57 | - |
|
| 58 | - /** |
|
| 59 | - * @var EEM_Base[] |
|
| 60 | - */ |
|
| 61 | - protected $models_with_datetime_fields = array(); |
|
| 62 | - |
|
| 63 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Performs any necessary setup for starting the job. This is also a good |
|
| 67 | - * place to setup the $job_arguments which will be used for subsequent HTTP requests |
|
| 68 | - * when continue_job will be called |
|
| 69 | - * |
|
| 70 | - * @param JobParameters $job_parameters |
|
| 71 | - * @return JobStepResponse |
|
| 72 | - * @throws EE_Error |
|
| 73 | - * @throws InvalidArgumentException |
|
| 74 | - * @throws InvalidDataTypeException |
|
| 75 | - * @throws InvalidInterfaceException |
|
| 76 | - */ |
|
| 77 | - public function create_job(JobParameters $job_parameters) |
|
| 78 | - { |
|
| 79 | - $models_with_datetime_fields = $this->getModelsWithDatetimeFields(); |
|
| 80 | - // we'll be doing each model as a batch. |
|
| 81 | - $job_parameters->set_job_size(count($models_with_datetime_fields)); |
|
| 82 | - return new JobStepResponse( |
|
| 83 | - $job_parameters, |
|
| 84 | - esc_html__('Starting Datetime Offset Fix', 'event_espresso') |
|
| 85 | - ); |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - /** |
|
| 89 | - * Performs another step of the job |
|
| 90 | - * |
|
| 91 | - * @param JobParameters $job_parameters |
|
| 92 | - * @param int $batch_size |
|
| 93 | - * @return JobStepResponse |
|
| 94 | - * @throws EE_Error |
|
| 95 | - * @throws InvalidArgumentException |
|
| 96 | - * @throws InvalidDataTypeException |
|
| 97 | - * @throws InvalidInterfaceException |
|
| 98 | - */ |
|
| 99 | - public function continue_job(JobParameters $job_parameters, $batch_size = 50) |
|
| 100 | - { |
|
| 101 | - $models_to_process = $this->getModelsWithDatetimeFields(); |
|
| 102 | - // let's pop off the a model and do the query to apply the offset. |
|
| 103 | - $model_to_process = array_pop($models_to_process); |
|
| 104 | - // update our record |
|
| 105 | - $this->setModelsToProcess($models_to_process); |
|
| 106 | - $this->processModel($model_to_process); |
|
| 107 | - $this->updateCountOfModelsProcessed(); |
|
| 108 | - $job_parameters->set_units_processed($this->getCountOfModelsProcessed()); |
|
| 109 | - if (count($models_to_process) > 0) { |
|
| 110 | - $job_parameters->set_status(JobParameters::status_continue); |
|
| 111 | - } else { |
|
| 112 | - $job_parameters->set_status(JobParameters::status_complete); |
|
| 113 | - } |
|
| 114 | - return new JobStepResponse( |
|
| 115 | - $job_parameters, |
|
| 116 | - sprintf( |
|
| 117 | - esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'), |
|
| 118 | - $model_to_process |
|
| 119 | - ) |
|
| 120 | - ); |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * Performs any clean-up logic when we know the job is completed |
|
| 125 | - * |
|
| 126 | - * @param JobParameters $job_parameters |
|
| 127 | - * @return JobStepResponse |
|
| 128 | - * @throws BatchRequestException |
|
| 129 | - */ |
|
| 130 | - public function cleanup_job(JobParameters $job_parameters) |
|
| 131 | - { |
|
| 132 | - // delete important saved options. |
|
| 133 | - delete_option(self::MODELS_TO_PROCESS_OPTION_KEY); |
|
| 134 | - delete_option(self::COUNT_OF_MODELS_PROCESSED); |
|
| 135 | - delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE); |
|
| 136 | - delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE); |
|
| 137 | - return new JobStepResponse($job_parameters, esc_html__( |
|
| 138 | - 'Offset has been applied to all affected fields.', |
|
| 139 | - 'event_espresso' |
|
| 140 | - )); |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * Contains the logic for processing a model and applying the datetime offset to affected fields on that model. |
|
| 146 | - * |
|
| 147 | - * @param string $model_class_name |
|
| 148 | - * @throws EE_Error |
|
| 149 | - */ |
|
| 150 | - protected function processModel($model_class_name) |
|
| 151 | - { |
|
| 152 | - global $wpdb; |
|
| 153 | - /** @var EEM_Base $model */ |
|
| 154 | - $model = $model_class_name::instance(); |
|
| 155 | - $original_offset = self::getOffset(); |
|
| 156 | - $start_date_range = self::getStartDateRange(); |
|
| 157 | - $end_date_range = self::getEndDateRange(); |
|
| 158 | - $sql_date_function = $original_offset > 0 ? 'DATE_ADD' : 'DATE_SUB'; |
|
| 159 | - $offset = abs($original_offset) * 60; |
|
| 160 | - $date_ranges = array(); |
|
| 161 | - // since some affected models might have two tables, we have to get our tables and set up a query for each table. |
|
| 162 | - foreach ($model->get_tables() as $table) { |
|
| 163 | - $query = 'UPDATE ' . $table->get_table_name(); |
|
| 164 | - $fields_affected = array(); |
|
| 165 | - $inner_query = array(); |
|
| 166 | - foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) { |
|
| 167 | - if ($model_field instanceof EE_Datetime_Field) { |
|
| 168 | - $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = ' |
|
| 169 | - . $sql_date_function . '(' |
|
| 170 | - . $model_field->get_table_column() |
|
| 171 | - . ", INTERVAL {$offset} MINUTE)"; |
|
| 172 | - $fields_affected[] = $model_field; |
|
| 173 | - } |
|
| 174 | - } |
|
| 175 | - if (! $fields_affected) { |
|
| 176 | - continue; |
|
| 177 | - } |
|
| 178 | - // do we do one query per column/field or one query for all fields on the model? It all depends on whether |
|
| 179 | - // there is a date range applied or not. |
|
| 180 | - if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) { |
|
| 181 | - $result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range); |
|
| 182 | - } else { |
|
| 183 | - $result = $this->doQueryForAllFields($query, $inner_query); |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - // record appropriate logs for the query |
|
| 187 | - switch (true) { |
|
| 188 | - case $result === false: |
|
| 189 | - // record error. |
|
| 190 | - $error_message = $wpdb->last_error; |
|
| 191 | - // handle the edgecases where last_error might be empty. |
|
| 192 | - if (! $error_message) { |
|
| 193 | - $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso'); |
|
| 194 | - } |
|
| 195 | - $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message); |
|
| 196 | - break; |
|
| 197 | - case is_array($result) && ! empty($result): |
|
| 198 | - foreach ($result as $field_name => $error_message) { |
|
| 199 | - $this->recordChangeLog($model, $original_offset, $table, array($field_name), $error_message); |
|
| 200 | - } |
|
| 201 | - break; |
|
| 202 | - default: |
|
| 203 | - $this->recordChangeLog($model, $original_offset, $table, $fields_affected); |
|
| 204 | - } |
|
| 205 | - } |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * Does the query on each $inner_query individually. |
|
| 211 | - * |
|
| 212 | - * @param string $query |
|
| 213 | - * @param array $inner_query |
|
| 214 | - * @param DbSafeDateTime|null $start_date_range |
|
| 215 | - * @param DbSafeDateTime|null $end_date_range |
|
| 216 | - * @return array An array of any errors encountered and the fields they were for. |
|
| 217 | - */ |
|
| 218 | - private function doQueryForEachField($query, array $inner_query, $start_date_range, $end_date_range) |
|
| 219 | - { |
|
| 220 | - global $wpdb; |
|
| 221 | - $errors = array(); |
|
| 222 | - foreach ($inner_query as $field_name => $field_query) { |
|
| 223 | - $query_to_run = $query; |
|
| 224 | - $where_conditions = array(); |
|
| 225 | - $query_to_run .= ' SET ' . $field_query; |
|
| 226 | - if ($start_date_range instanceof DbSafeDateTime) { |
|
| 227 | - $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format); |
|
| 228 | - $where_conditions[] = "{$field_name} > '{$start_date}'"; |
|
| 229 | - } |
|
| 230 | - if ($end_date_range instanceof DbSafeDateTime) { |
|
| 231 | - $end_date = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format); |
|
| 232 | - $where_conditions[] = "{$field_name} < '{$end_date}'"; |
|
| 233 | - } |
|
| 234 | - if ($where_conditions) { |
|
| 235 | - $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions); |
|
| 236 | - } |
|
| 237 | - $result = $wpdb->query($query_to_run); |
|
| 238 | - if ($result === false) { |
|
| 239 | - // record error. |
|
| 240 | - $error_message = $wpdb->last_error; |
|
| 241 | - // handle the edgecases where last_error might be empty. |
|
| 242 | - if (! $error_message) { |
|
| 243 | - $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso'); |
|
| 244 | - } |
|
| 245 | - $errors[ $field_name ] = $error_message; |
|
| 246 | - } |
|
| 247 | - } |
|
| 248 | - return $errors; |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - |
|
| 252 | - /** |
|
| 253 | - * Performs the query for all fields within the inner_query |
|
| 254 | - * |
|
| 255 | - * @param string $query |
|
| 256 | - * @param array $inner_query |
|
| 257 | - * @return false|int |
|
| 258 | - */ |
|
| 259 | - private function doQueryForAllFields($query, array $inner_query) |
|
| 260 | - { |
|
| 261 | - global $wpdb; |
|
| 262 | - $query .= ' SET ' . implode(',', $inner_query); |
|
| 263 | - return $wpdb->query($query); |
|
| 264 | - } |
|
| 265 | - |
|
| 266 | - |
|
| 267 | - /** |
|
| 268 | - * Records a changelog entry using the given information. |
|
| 269 | - * |
|
| 270 | - * @param EEM_Base $model |
|
| 271 | - * @param float $offset |
|
| 272 | - * @param EE_Table_Base $table |
|
| 273 | - * @param EE_Model_Field_Base[] $model_fields_affected |
|
| 274 | - * @param string $error_message If present then there was an error so let's record that instead. |
|
| 275 | - * @throws EE_Error |
|
| 276 | - */ |
|
| 277 | - private function recordChangeLog( |
|
| 278 | - EEM_Base $model, |
|
| 279 | - $offset, |
|
| 280 | - EE_Table_Base $table, |
|
| 281 | - $model_fields_affected, |
|
| 282 | - $error_message = '' |
|
| 283 | - ) { |
|
| 284 | - // setup $fields list. |
|
| 285 | - $fields = array(); |
|
| 286 | - /** @var EE_Datetime_Field $model_field */ |
|
| 287 | - foreach ($model_fields_affected as $model_field) { |
|
| 288 | - if (! $model_field instanceof EE_Datetime_Field) { |
|
| 289 | - continue; |
|
| 290 | - } |
|
| 291 | - $fields[] = $model_field->get_name(); |
|
| 292 | - } |
|
| 293 | - // setup the message for the changelog entry. |
|
| 294 | - $message = $error_message |
|
| 295 | - ? sprintf( |
|
| 296 | - esc_html__( |
|
| 297 | - 'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s', |
|
| 298 | - 'event_espresso' |
|
| 299 | - ), |
|
| 300 | - $table->get_table_name(), |
|
| 301 | - $model->get_this_model_name(), |
|
| 302 | - $offset, |
|
| 303 | - implode(',', $fields), |
|
| 304 | - $error_message |
|
| 305 | - ) |
|
| 306 | - : sprintf( |
|
| 307 | - esc_html__( |
|
| 308 | - 'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s', |
|
| 309 | - 'event_espresso' |
|
| 310 | - ), |
|
| 311 | - $table->get_table_name(), |
|
| 312 | - $model->get_this_model_name(), |
|
| 313 | - $offset, |
|
| 314 | - implode(',', $fields) |
|
| 315 | - ); |
|
| 316 | - // write to the log |
|
| 317 | - $changelog = EE_Change_Log::new_instance(array( |
|
| 318 | - 'LOG_type' => $error_message |
|
| 319 | - ? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE |
|
| 320 | - : self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE, |
|
| 321 | - 'LOG_message' => $message, |
|
| 322 | - )); |
|
| 323 | - $changelog->save(); |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - |
|
| 327 | - /** |
|
| 328 | - * Returns an array of models that have datetime fields. |
|
| 329 | - * This array is added to a short lived transient cache to keep having to build this list to a minimum. |
|
| 330 | - * |
|
| 331 | - * @return array an array of model class names. |
|
| 332 | - * @throws EE_Error |
|
| 333 | - * @throws InvalidDataTypeException |
|
| 334 | - * @throws InvalidInterfaceException |
|
| 335 | - * @throws InvalidArgumentException |
|
| 336 | - */ |
|
| 337 | - private function getModelsWithDatetimeFields() |
|
| 338 | - { |
|
| 339 | - $this->getModelsToProcess(); |
|
| 340 | - if (! empty($this->models_with_datetime_fields)) { |
|
| 341 | - return $this->models_with_datetime_fields; |
|
| 342 | - } |
|
| 343 | - |
|
| 344 | - $all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models; |
|
| 345 | - foreach ($all_non_abstract_models as $non_abstract_model) { |
|
| 346 | - // get model instance |
|
| 347 | - /** @var EEM_Base $non_abstract_model */ |
|
| 348 | - $non_abstract_model = $non_abstract_model::instance(); |
|
| 349 | - if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) { |
|
| 350 | - $this->models_with_datetime_fields[] = get_class($non_abstract_model); |
|
| 351 | - } |
|
| 352 | - } |
|
| 353 | - $this->setModelsToProcess($this->models_with_datetime_fields); |
|
| 354 | - return $this->models_with_datetime_fields; |
|
| 355 | - } |
|
| 356 | - |
|
| 357 | - |
|
| 358 | - /** |
|
| 359 | - * This simply records the models that have been processed with our tracking option. |
|
| 360 | - * |
|
| 361 | - * @param array $models_to_set array of model class names. |
|
| 362 | - */ |
|
| 363 | - private function setModelsToProcess($models_to_set) |
|
| 364 | - { |
|
| 365 | - update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set); |
|
| 366 | - } |
|
| 367 | - |
|
| 368 | - |
|
| 369 | - /** |
|
| 370 | - * Used to keep track of how many models have been processed for the batch |
|
| 371 | - * |
|
| 372 | - * @param $count |
|
| 373 | - */ |
|
| 374 | - private function updateCountOfModelsProcessed($count = 1) |
|
| 375 | - { |
|
| 376 | - $count = $this->getCountOfModelsProcessed() + (int) $count; |
|
| 377 | - update_option(self::COUNT_OF_MODELS_PROCESSED, $count); |
|
| 378 | - } |
|
| 379 | - |
|
| 380 | - |
|
| 381 | - /** |
|
| 382 | - * Retrieve the tracked number of models processed between requests. |
|
| 383 | - * |
|
| 384 | - * @return int |
|
| 385 | - */ |
|
| 386 | - private function getCountOfModelsProcessed() |
|
| 387 | - { |
|
| 388 | - return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0); |
|
| 389 | - } |
|
| 390 | - |
|
| 391 | - |
|
| 392 | - /** |
|
| 393 | - * Returns the models that are left to process. |
|
| 394 | - * |
|
| 395 | - * @return array an array of model class names. |
|
| 396 | - */ |
|
| 397 | - private function getModelsToProcess() |
|
| 398 | - { |
|
| 399 | - if (empty($this->models_with_datetime_fields)) { |
|
| 400 | - $this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array()); |
|
| 401 | - } |
|
| 402 | - return $this->models_with_datetime_fields; |
|
| 403 | - } |
|
| 404 | - |
|
| 405 | - |
|
| 406 | - /** |
|
| 407 | - * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns. |
|
| 408 | - * |
|
| 409 | - * @param float $offset |
|
| 410 | - */ |
|
| 411 | - public static function updateOffset($offset) |
|
| 412 | - { |
|
| 413 | - update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset); |
|
| 414 | - } |
|
| 415 | - |
|
| 416 | - |
|
| 417 | - /** |
|
| 418 | - * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns. |
|
| 419 | - * |
|
| 420 | - * @return float |
|
| 421 | - */ |
|
| 422 | - public static function getOffset() |
|
| 423 | - { |
|
| 424 | - return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0); |
|
| 425 | - } |
|
| 426 | - |
|
| 427 | - |
|
| 428 | - /** |
|
| 429 | - * Used to set the saved offset range start date. |
|
| 430 | - * |
|
| 431 | - * @param DbSafeDateTime|null $start_date |
|
| 432 | - */ |
|
| 433 | - public static function updateStartDateRange(DbSafeDateTime $start_date = null) |
|
| 434 | - { |
|
| 435 | - $date_to_save = $start_date instanceof DbSafeDateTime |
|
| 436 | - ? $start_date->format('U') |
|
| 437 | - : ''; |
|
| 438 | - update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save); |
|
| 439 | - } |
|
| 440 | - |
|
| 441 | - |
|
| 442 | - /** |
|
| 443 | - * Used to get the saved offset range start date. |
|
| 444 | - * |
|
| 445 | - * @return DbSafeDateTime|null |
|
| 446 | - */ |
|
| 447 | - public static function getStartDateRange() |
|
| 448 | - { |
|
| 449 | - $start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null); |
|
| 450 | - try { |
|
| 451 | - $datetime = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC')); |
|
| 452 | - $start_date = $datetime instanceof DateTime |
|
| 453 | - ? DbSafeDateTime::createFromDateTime($datetime) |
|
| 454 | - : null; |
|
| 455 | - } catch (Exception $e) { |
|
| 456 | - $start_date = null; |
|
| 457 | - } |
|
| 458 | - return $start_date; |
|
| 459 | - } |
|
| 460 | - |
|
| 461 | - |
|
| 462 | - /** |
|
| 463 | - * Used to set the saved offset range end date. |
|
| 464 | - * |
|
| 465 | - * @param DbSafeDateTime|null $end_date |
|
| 466 | - */ |
|
| 467 | - public static function updateEndDateRange(DbSafeDateTime $end_date = null) |
|
| 468 | - { |
|
| 469 | - $date_to_save = $end_date instanceof DbSafeDateTime |
|
| 470 | - ? $end_date->format('U') |
|
| 471 | - : ''; |
|
| 472 | - update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save); |
|
| 473 | - } |
|
| 474 | - |
|
| 475 | - |
|
| 476 | - /** |
|
| 477 | - * Used to get the saved offset range end date. |
|
| 478 | - * |
|
| 479 | - * @return DbSafeDateTime|null |
|
| 480 | - */ |
|
| 481 | - public static function getEndDateRange() |
|
| 482 | - { |
|
| 483 | - $end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null); |
|
| 484 | - try { |
|
| 485 | - $datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC')); |
|
| 486 | - $end_date = $datetime instanceof Datetime |
|
| 487 | - ? DbSafeDateTime::createFromDateTime($datetime) |
|
| 488 | - : null; |
|
| 489 | - } catch (Exception $e) { |
|
| 490 | - $end_date = null; |
|
| 491 | - } |
|
| 492 | - return $end_date; |
|
| 493 | - } |
|
| 27 | + /** |
|
| 28 | + * Key for the option used to track which models have been processed when doing the batches. |
|
| 29 | + */ |
|
| 30 | + const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix'; |
|
| 31 | + |
|
| 32 | + |
|
| 33 | + const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed'; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * Key for the option used to track what the current offset is that will be applied when this tool is executed. |
|
| 37 | + */ |
|
| 38 | + const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply'; |
|
| 39 | + |
|
| 40 | + |
|
| 41 | + const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range'; |
|
| 42 | + |
|
| 43 | + |
|
| 44 | + const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range'; |
|
| 45 | + |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * String labelling the datetime offset fix type for change-log entries. |
|
| 49 | + */ |
|
| 50 | + const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix'; |
|
| 51 | + |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * String labelling a datetime offset fix error for change-log entries. |
|
| 55 | + */ |
|
| 56 | + const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error'; |
|
| 57 | + |
|
| 58 | + /** |
|
| 59 | + * @var EEM_Base[] |
|
| 60 | + */ |
|
| 61 | + protected $models_with_datetime_fields = array(); |
|
| 62 | + |
|
| 63 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Performs any necessary setup for starting the job. This is also a good |
|
| 67 | + * place to setup the $job_arguments which will be used for subsequent HTTP requests |
|
| 68 | + * when continue_job will be called |
|
| 69 | + * |
|
| 70 | + * @param JobParameters $job_parameters |
|
| 71 | + * @return JobStepResponse |
|
| 72 | + * @throws EE_Error |
|
| 73 | + * @throws InvalidArgumentException |
|
| 74 | + * @throws InvalidDataTypeException |
|
| 75 | + * @throws InvalidInterfaceException |
|
| 76 | + */ |
|
| 77 | + public function create_job(JobParameters $job_parameters) |
|
| 78 | + { |
|
| 79 | + $models_with_datetime_fields = $this->getModelsWithDatetimeFields(); |
|
| 80 | + // we'll be doing each model as a batch. |
|
| 81 | + $job_parameters->set_job_size(count($models_with_datetime_fields)); |
|
| 82 | + return new JobStepResponse( |
|
| 83 | + $job_parameters, |
|
| 84 | + esc_html__('Starting Datetime Offset Fix', 'event_espresso') |
|
| 85 | + ); |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + /** |
|
| 89 | + * Performs another step of the job |
|
| 90 | + * |
|
| 91 | + * @param JobParameters $job_parameters |
|
| 92 | + * @param int $batch_size |
|
| 93 | + * @return JobStepResponse |
|
| 94 | + * @throws EE_Error |
|
| 95 | + * @throws InvalidArgumentException |
|
| 96 | + * @throws InvalidDataTypeException |
|
| 97 | + * @throws InvalidInterfaceException |
|
| 98 | + */ |
|
| 99 | + public function continue_job(JobParameters $job_parameters, $batch_size = 50) |
|
| 100 | + { |
|
| 101 | + $models_to_process = $this->getModelsWithDatetimeFields(); |
|
| 102 | + // let's pop off the a model and do the query to apply the offset. |
|
| 103 | + $model_to_process = array_pop($models_to_process); |
|
| 104 | + // update our record |
|
| 105 | + $this->setModelsToProcess($models_to_process); |
|
| 106 | + $this->processModel($model_to_process); |
|
| 107 | + $this->updateCountOfModelsProcessed(); |
|
| 108 | + $job_parameters->set_units_processed($this->getCountOfModelsProcessed()); |
|
| 109 | + if (count($models_to_process) > 0) { |
|
| 110 | + $job_parameters->set_status(JobParameters::status_continue); |
|
| 111 | + } else { |
|
| 112 | + $job_parameters->set_status(JobParameters::status_complete); |
|
| 113 | + } |
|
| 114 | + return new JobStepResponse( |
|
| 115 | + $job_parameters, |
|
| 116 | + sprintf( |
|
| 117 | + esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'), |
|
| 118 | + $model_to_process |
|
| 119 | + ) |
|
| 120 | + ); |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * Performs any clean-up logic when we know the job is completed |
|
| 125 | + * |
|
| 126 | + * @param JobParameters $job_parameters |
|
| 127 | + * @return JobStepResponse |
|
| 128 | + * @throws BatchRequestException |
|
| 129 | + */ |
|
| 130 | + public function cleanup_job(JobParameters $job_parameters) |
|
| 131 | + { |
|
| 132 | + // delete important saved options. |
|
| 133 | + delete_option(self::MODELS_TO_PROCESS_OPTION_KEY); |
|
| 134 | + delete_option(self::COUNT_OF_MODELS_PROCESSED); |
|
| 135 | + delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE); |
|
| 136 | + delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE); |
|
| 137 | + return new JobStepResponse($job_parameters, esc_html__( |
|
| 138 | + 'Offset has been applied to all affected fields.', |
|
| 139 | + 'event_espresso' |
|
| 140 | + )); |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * Contains the logic for processing a model and applying the datetime offset to affected fields on that model. |
|
| 146 | + * |
|
| 147 | + * @param string $model_class_name |
|
| 148 | + * @throws EE_Error |
|
| 149 | + */ |
|
| 150 | + protected function processModel($model_class_name) |
|
| 151 | + { |
|
| 152 | + global $wpdb; |
|
| 153 | + /** @var EEM_Base $model */ |
|
| 154 | + $model = $model_class_name::instance(); |
|
| 155 | + $original_offset = self::getOffset(); |
|
| 156 | + $start_date_range = self::getStartDateRange(); |
|
| 157 | + $end_date_range = self::getEndDateRange(); |
|
| 158 | + $sql_date_function = $original_offset > 0 ? 'DATE_ADD' : 'DATE_SUB'; |
|
| 159 | + $offset = abs($original_offset) * 60; |
|
| 160 | + $date_ranges = array(); |
|
| 161 | + // since some affected models might have two tables, we have to get our tables and set up a query for each table. |
|
| 162 | + foreach ($model->get_tables() as $table) { |
|
| 163 | + $query = 'UPDATE ' . $table->get_table_name(); |
|
| 164 | + $fields_affected = array(); |
|
| 165 | + $inner_query = array(); |
|
| 166 | + foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) { |
|
| 167 | + if ($model_field instanceof EE_Datetime_Field) { |
|
| 168 | + $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = ' |
|
| 169 | + . $sql_date_function . '(' |
|
| 170 | + . $model_field->get_table_column() |
|
| 171 | + . ", INTERVAL {$offset} MINUTE)"; |
|
| 172 | + $fields_affected[] = $model_field; |
|
| 173 | + } |
|
| 174 | + } |
|
| 175 | + if (! $fields_affected) { |
|
| 176 | + continue; |
|
| 177 | + } |
|
| 178 | + // do we do one query per column/field or one query for all fields on the model? It all depends on whether |
|
| 179 | + // there is a date range applied or not. |
|
| 180 | + if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) { |
|
| 181 | + $result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range); |
|
| 182 | + } else { |
|
| 183 | + $result = $this->doQueryForAllFields($query, $inner_query); |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + // record appropriate logs for the query |
|
| 187 | + switch (true) { |
|
| 188 | + case $result === false: |
|
| 189 | + // record error. |
|
| 190 | + $error_message = $wpdb->last_error; |
|
| 191 | + // handle the edgecases where last_error might be empty. |
|
| 192 | + if (! $error_message) { |
|
| 193 | + $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso'); |
|
| 194 | + } |
|
| 195 | + $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message); |
|
| 196 | + break; |
|
| 197 | + case is_array($result) && ! empty($result): |
|
| 198 | + foreach ($result as $field_name => $error_message) { |
|
| 199 | + $this->recordChangeLog($model, $original_offset, $table, array($field_name), $error_message); |
|
| 200 | + } |
|
| 201 | + break; |
|
| 202 | + default: |
|
| 203 | + $this->recordChangeLog($model, $original_offset, $table, $fields_affected); |
|
| 204 | + } |
|
| 205 | + } |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * Does the query on each $inner_query individually. |
|
| 211 | + * |
|
| 212 | + * @param string $query |
|
| 213 | + * @param array $inner_query |
|
| 214 | + * @param DbSafeDateTime|null $start_date_range |
|
| 215 | + * @param DbSafeDateTime|null $end_date_range |
|
| 216 | + * @return array An array of any errors encountered and the fields they were for. |
|
| 217 | + */ |
|
| 218 | + private function doQueryForEachField($query, array $inner_query, $start_date_range, $end_date_range) |
|
| 219 | + { |
|
| 220 | + global $wpdb; |
|
| 221 | + $errors = array(); |
|
| 222 | + foreach ($inner_query as $field_name => $field_query) { |
|
| 223 | + $query_to_run = $query; |
|
| 224 | + $where_conditions = array(); |
|
| 225 | + $query_to_run .= ' SET ' . $field_query; |
|
| 226 | + if ($start_date_range instanceof DbSafeDateTime) { |
|
| 227 | + $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format); |
|
| 228 | + $where_conditions[] = "{$field_name} > '{$start_date}'"; |
|
| 229 | + } |
|
| 230 | + if ($end_date_range instanceof DbSafeDateTime) { |
|
| 231 | + $end_date = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format); |
|
| 232 | + $where_conditions[] = "{$field_name} < '{$end_date}'"; |
|
| 233 | + } |
|
| 234 | + if ($where_conditions) { |
|
| 235 | + $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions); |
|
| 236 | + } |
|
| 237 | + $result = $wpdb->query($query_to_run); |
|
| 238 | + if ($result === false) { |
|
| 239 | + // record error. |
|
| 240 | + $error_message = $wpdb->last_error; |
|
| 241 | + // handle the edgecases where last_error might be empty. |
|
| 242 | + if (! $error_message) { |
|
| 243 | + $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso'); |
|
| 244 | + } |
|
| 245 | + $errors[ $field_name ] = $error_message; |
|
| 246 | + } |
|
| 247 | + } |
|
| 248 | + return $errors; |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + |
|
| 252 | + /** |
|
| 253 | + * Performs the query for all fields within the inner_query |
|
| 254 | + * |
|
| 255 | + * @param string $query |
|
| 256 | + * @param array $inner_query |
|
| 257 | + * @return false|int |
|
| 258 | + */ |
|
| 259 | + private function doQueryForAllFields($query, array $inner_query) |
|
| 260 | + { |
|
| 261 | + global $wpdb; |
|
| 262 | + $query .= ' SET ' . implode(',', $inner_query); |
|
| 263 | + return $wpdb->query($query); |
|
| 264 | + } |
|
| 265 | + |
|
| 266 | + |
|
| 267 | + /** |
|
| 268 | + * Records a changelog entry using the given information. |
|
| 269 | + * |
|
| 270 | + * @param EEM_Base $model |
|
| 271 | + * @param float $offset |
|
| 272 | + * @param EE_Table_Base $table |
|
| 273 | + * @param EE_Model_Field_Base[] $model_fields_affected |
|
| 274 | + * @param string $error_message If present then there was an error so let's record that instead. |
|
| 275 | + * @throws EE_Error |
|
| 276 | + */ |
|
| 277 | + private function recordChangeLog( |
|
| 278 | + EEM_Base $model, |
|
| 279 | + $offset, |
|
| 280 | + EE_Table_Base $table, |
|
| 281 | + $model_fields_affected, |
|
| 282 | + $error_message = '' |
|
| 283 | + ) { |
|
| 284 | + // setup $fields list. |
|
| 285 | + $fields = array(); |
|
| 286 | + /** @var EE_Datetime_Field $model_field */ |
|
| 287 | + foreach ($model_fields_affected as $model_field) { |
|
| 288 | + if (! $model_field instanceof EE_Datetime_Field) { |
|
| 289 | + continue; |
|
| 290 | + } |
|
| 291 | + $fields[] = $model_field->get_name(); |
|
| 292 | + } |
|
| 293 | + // setup the message for the changelog entry. |
|
| 294 | + $message = $error_message |
|
| 295 | + ? sprintf( |
|
| 296 | + esc_html__( |
|
| 297 | + 'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s', |
|
| 298 | + 'event_espresso' |
|
| 299 | + ), |
|
| 300 | + $table->get_table_name(), |
|
| 301 | + $model->get_this_model_name(), |
|
| 302 | + $offset, |
|
| 303 | + implode(',', $fields), |
|
| 304 | + $error_message |
|
| 305 | + ) |
|
| 306 | + : sprintf( |
|
| 307 | + esc_html__( |
|
| 308 | + 'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s', |
|
| 309 | + 'event_espresso' |
|
| 310 | + ), |
|
| 311 | + $table->get_table_name(), |
|
| 312 | + $model->get_this_model_name(), |
|
| 313 | + $offset, |
|
| 314 | + implode(',', $fields) |
|
| 315 | + ); |
|
| 316 | + // write to the log |
|
| 317 | + $changelog = EE_Change_Log::new_instance(array( |
|
| 318 | + 'LOG_type' => $error_message |
|
| 319 | + ? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE |
|
| 320 | + : self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE, |
|
| 321 | + 'LOG_message' => $message, |
|
| 322 | + )); |
|
| 323 | + $changelog->save(); |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + |
|
| 327 | + /** |
|
| 328 | + * Returns an array of models that have datetime fields. |
|
| 329 | + * This array is added to a short lived transient cache to keep having to build this list to a minimum. |
|
| 330 | + * |
|
| 331 | + * @return array an array of model class names. |
|
| 332 | + * @throws EE_Error |
|
| 333 | + * @throws InvalidDataTypeException |
|
| 334 | + * @throws InvalidInterfaceException |
|
| 335 | + * @throws InvalidArgumentException |
|
| 336 | + */ |
|
| 337 | + private function getModelsWithDatetimeFields() |
|
| 338 | + { |
|
| 339 | + $this->getModelsToProcess(); |
|
| 340 | + if (! empty($this->models_with_datetime_fields)) { |
|
| 341 | + return $this->models_with_datetime_fields; |
|
| 342 | + } |
|
| 343 | + |
|
| 344 | + $all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models; |
|
| 345 | + foreach ($all_non_abstract_models as $non_abstract_model) { |
|
| 346 | + // get model instance |
|
| 347 | + /** @var EEM_Base $non_abstract_model */ |
|
| 348 | + $non_abstract_model = $non_abstract_model::instance(); |
|
| 349 | + if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) { |
|
| 350 | + $this->models_with_datetime_fields[] = get_class($non_abstract_model); |
|
| 351 | + } |
|
| 352 | + } |
|
| 353 | + $this->setModelsToProcess($this->models_with_datetime_fields); |
|
| 354 | + return $this->models_with_datetime_fields; |
|
| 355 | + } |
|
| 356 | + |
|
| 357 | + |
|
| 358 | + /** |
|
| 359 | + * This simply records the models that have been processed with our tracking option. |
|
| 360 | + * |
|
| 361 | + * @param array $models_to_set array of model class names. |
|
| 362 | + */ |
|
| 363 | + private function setModelsToProcess($models_to_set) |
|
| 364 | + { |
|
| 365 | + update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set); |
|
| 366 | + } |
|
| 367 | + |
|
| 368 | + |
|
| 369 | + /** |
|
| 370 | + * Used to keep track of how many models have been processed for the batch |
|
| 371 | + * |
|
| 372 | + * @param $count |
|
| 373 | + */ |
|
| 374 | + private function updateCountOfModelsProcessed($count = 1) |
|
| 375 | + { |
|
| 376 | + $count = $this->getCountOfModelsProcessed() + (int) $count; |
|
| 377 | + update_option(self::COUNT_OF_MODELS_PROCESSED, $count); |
|
| 378 | + } |
|
| 379 | + |
|
| 380 | + |
|
| 381 | + /** |
|
| 382 | + * Retrieve the tracked number of models processed between requests. |
|
| 383 | + * |
|
| 384 | + * @return int |
|
| 385 | + */ |
|
| 386 | + private function getCountOfModelsProcessed() |
|
| 387 | + { |
|
| 388 | + return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0); |
|
| 389 | + } |
|
| 390 | + |
|
| 391 | + |
|
| 392 | + /** |
|
| 393 | + * Returns the models that are left to process. |
|
| 394 | + * |
|
| 395 | + * @return array an array of model class names. |
|
| 396 | + */ |
|
| 397 | + private function getModelsToProcess() |
|
| 398 | + { |
|
| 399 | + if (empty($this->models_with_datetime_fields)) { |
|
| 400 | + $this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array()); |
|
| 401 | + } |
|
| 402 | + return $this->models_with_datetime_fields; |
|
| 403 | + } |
|
| 404 | + |
|
| 405 | + |
|
| 406 | + /** |
|
| 407 | + * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns. |
|
| 408 | + * |
|
| 409 | + * @param float $offset |
|
| 410 | + */ |
|
| 411 | + public static function updateOffset($offset) |
|
| 412 | + { |
|
| 413 | + update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset); |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + |
|
| 417 | + /** |
|
| 418 | + * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns. |
|
| 419 | + * |
|
| 420 | + * @return float |
|
| 421 | + */ |
|
| 422 | + public static function getOffset() |
|
| 423 | + { |
|
| 424 | + return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0); |
|
| 425 | + } |
|
| 426 | + |
|
| 427 | + |
|
| 428 | + /** |
|
| 429 | + * Used to set the saved offset range start date. |
|
| 430 | + * |
|
| 431 | + * @param DbSafeDateTime|null $start_date |
|
| 432 | + */ |
|
| 433 | + public static function updateStartDateRange(DbSafeDateTime $start_date = null) |
|
| 434 | + { |
|
| 435 | + $date_to_save = $start_date instanceof DbSafeDateTime |
|
| 436 | + ? $start_date->format('U') |
|
| 437 | + : ''; |
|
| 438 | + update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save); |
|
| 439 | + } |
|
| 440 | + |
|
| 441 | + |
|
| 442 | + /** |
|
| 443 | + * Used to get the saved offset range start date. |
|
| 444 | + * |
|
| 445 | + * @return DbSafeDateTime|null |
|
| 446 | + */ |
|
| 447 | + public static function getStartDateRange() |
|
| 448 | + { |
|
| 449 | + $start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null); |
|
| 450 | + try { |
|
| 451 | + $datetime = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC')); |
|
| 452 | + $start_date = $datetime instanceof DateTime |
|
| 453 | + ? DbSafeDateTime::createFromDateTime($datetime) |
|
| 454 | + : null; |
|
| 455 | + } catch (Exception $e) { |
|
| 456 | + $start_date = null; |
|
| 457 | + } |
|
| 458 | + return $start_date; |
|
| 459 | + } |
|
| 460 | + |
|
| 461 | + |
|
| 462 | + /** |
|
| 463 | + * Used to set the saved offset range end date. |
|
| 464 | + * |
|
| 465 | + * @param DbSafeDateTime|null $end_date |
|
| 466 | + */ |
|
| 467 | + public static function updateEndDateRange(DbSafeDateTime $end_date = null) |
|
| 468 | + { |
|
| 469 | + $date_to_save = $end_date instanceof DbSafeDateTime |
|
| 470 | + ? $end_date->format('U') |
|
| 471 | + : ''; |
|
| 472 | + update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save); |
|
| 473 | + } |
|
| 474 | + |
|
| 475 | + |
|
| 476 | + /** |
|
| 477 | + * Used to get the saved offset range end date. |
|
| 478 | + * |
|
| 479 | + * @return DbSafeDateTime|null |
|
| 480 | + */ |
|
| 481 | + public static function getEndDateRange() |
|
| 482 | + { |
|
| 483 | + $end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null); |
|
| 484 | + try { |
|
| 485 | + $datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC')); |
|
| 486 | + $end_date = $datetime instanceof Datetime |
|
| 487 | + ? DbSafeDateTime::createFromDateTime($datetime) |
|
| 488 | + : null; |
|
| 489 | + } catch (Exception $e) { |
|
| 490 | + $end_date = null; |
|
| 491 | + } |
|
| 492 | + return $end_date; |
|
| 493 | + } |
|
| 494 | 494 | } |
@@ -160,19 +160,19 @@ discard block |
||
| 160 | 160 | $date_ranges = array(); |
| 161 | 161 | // since some affected models might have two tables, we have to get our tables and set up a query for each table. |
| 162 | 162 | foreach ($model->get_tables() as $table) { |
| 163 | - $query = 'UPDATE ' . $table->get_table_name(); |
|
| 163 | + $query = 'UPDATE '.$table->get_table_name(); |
|
| 164 | 164 | $fields_affected = array(); |
| 165 | 165 | $inner_query = array(); |
| 166 | 166 | foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) { |
| 167 | 167 | if ($model_field instanceof EE_Datetime_Field) { |
| 168 | - $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = ' |
|
| 169 | - . $sql_date_function . '(' |
|
| 168 | + $inner_query[$model_field->get_table_column()] = $model_field->get_table_column().' = ' |
|
| 169 | + . $sql_date_function.'(' |
|
| 170 | 170 | . $model_field->get_table_column() |
| 171 | 171 | . ", INTERVAL {$offset} MINUTE)"; |
| 172 | 172 | $fields_affected[] = $model_field; |
| 173 | 173 | } |
| 174 | 174 | } |
| 175 | - if (! $fields_affected) { |
|
| 175 | + if ( ! $fields_affected) { |
|
| 176 | 176 | continue; |
| 177 | 177 | } |
| 178 | 178 | // do we do one query per column/field or one query for all fields on the model? It all depends on whether |
@@ -189,7 +189,7 @@ discard block |
||
| 189 | 189 | // record error. |
| 190 | 190 | $error_message = $wpdb->last_error; |
| 191 | 191 | // handle the edgecases where last_error might be empty. |
| 192 | - if (! $error_message) { |
|
| 192 | + if ( ! $error_message) { |
|
| 193 | 193 | $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso'); |
| 194 | 194 | } |
| 195 | 195 | $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message); |
@@ -222,7 +222,7 @@ discard block |
||
| 222 | 222 | foreach ($inner_query as $field_name => $field_query) { |
| 223 | 223 | $query_to_run = $query; |
| 224 | 224 | $where_conditions = array(); |
| 225 | - $query_to_run .= ' SET ' . $field_query; |
|
| 225 | + $query_to_run .= ' SET '.$field_query; |
|
| 226 | 226 | if ($start_date_range instanceof DbSafeDateTime) { |
| 227 | 227 | $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format); |
| 228 | 228 | $where_conditions[] = "{$field_name} > '{$start_date}'"; |
@@ -232,17 +232,17 @@ discard block |
||
| 232 | 232 | $where_conditions[] = "{$field_name} < '{$end_date}'"; |
| 233 | 233 | } |
| 234 | 234 | if ($where_conditions) { |
| 235 | - $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions); |
|
| 235 | + $query_to_run .= ' WHERE '.implode(' AND ', $where_conditions); |
|
| 236 | 236 | } |
| 237 | 237 | $result = $wpdb->query($query_to_run); |
| 238 | 238 | if ($result === false) { |
| 239 | 239 | // record error. |
| 240 | 240 | $error_message = $wpdb->last_error; |
| 241 | 241 | // handle the edgecases where last_error might be empty. |
| 242 | - if (! $error_message) { |
|
| 242 | + if ( ! $error_message) { |
|
| 243 | 243 | $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso'); |
| 244 | 244 | } |
| 245 | - $errors[ $field_name ] = $error_message; |
|
| 245 | + $errors[$field_name] = $error_message; |
|
| 246 | 246 | } |
| 247 | 247 | } |
| 248 | 248 | return $errors; |
@@ -259,7 +259,7 @@ discard block |
||
| 259 | 259 | private function doQueryForAllFields($query, array $inner_query) |
| 260 | 260 | { |
| 261 | 261 | global $wpdb; |
| 262 | - $query .= ' SET ' . implode(',', $inner_query); |
|
| 262 | + $query .= ' SET '.implode(',', $inner_query); |
|
| 263 | 263 | return $wpdb->query($query); |
| 264 | 264 | } |
| 265 | 265 | |
@@ -285,7 +285,7 @@ discard block |
||
| 285 | 285 | $fields = array(); |
| 286 | 286 | /** @var EE_Datetime_Field $model_field */ |
| 287 | 287 | foreach ($model_fields_affected as $model_field) { |
| 288 | - if (! $model_field instanceof EE_Datetime_Field) { |
|
| 288 | + if ( ! $model_field instanceof EE_Datetime_Field) { |
|
| 289 | 289 | continue; |
| 290 | 290 | } |
| 291 | 291 | $fields[] = $model_field->get_name(); |
@@ -337,7 +337,7 @@ discard block |
||
| 337 | 337 | private function getModelsWithDatetimeFields() |
| 338 | 338 | { |
| 339 | 339 | $this->getModelsToProcess(); |
| 340 | - if (! empty($this->models_with_datetime_fields)) { |
|
| 340 | + if ( ! empty($this->models_with_datetime_fields)) { |
|
| 341 | 341 | return $this->models_with_datetime_fields; |
| 342 | 342 | } |
| 343 | 343 | |
@@ -14,396 +14,396 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class JobParameters |
| 16 | 16 | { |
| 17 | - // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase |
|
| 18 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 19 | - // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore |
|
| 20 | - /** |
|
| 21 | - * status indicating the job should continue |
|
| 22 | - */ |
|
| 23 | - const status_continue = 'continue'; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * status indicated the job has been completed successfully and should be cleaned up next |
|
| 27 | - */ |
|
| 28 | - const status_complete = 'complete'; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * status indicating there was an error and the job should be cleaned up |
|
| 32 | - */ |
|
| 33 | - const status_error = 'error'; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * status indicating the job has been cleaned up, and so this is probably the last |
|
| 37 | - * time you'll see this job |
|
| 38 | - */ |
|
| 39 | - const status_cleaned_up = 'cleaned_up'; |
|
| 40 | - |
|
| 41 | - const wp_option_prefix = 'ee_job_parameters_'; |
|
| 42 | - |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * String uniquely identifying the job |
|
| 46 | - * |
|
| 47 | - * @var string |
|
| 48 | - */ |
|
| 49 | - protected $_job_id; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 54 | - protected $_classname; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * @var array |
|
| 58 | - */ |
|
| 59 | - protected $_request_data; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Array of any extra data we want to remember about this request, that |
|
| 63 | - * wasn't necessarily past in with the request data |
|
| 64 | - * |
|
| 65 | - * @var array |
|
| 66 | - */ |
|
| 67 | - protected $_extra_data; |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * Estimate of how many units HAVE been processed |
|
| 71 | - * |
|
| 72 | - * @var int |
|
| 73 | - */ |
|
| 74 | - protected $_units_processed = 0; |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * @var string |
|
| 78 | - */ |
|
| 79 | - protected $_status; |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * The size of the total job in whatever units you want. |
|
| 83 | - * If you can't provide an estimate leave as 0. |
|
| 84 | - * Once _units_processed equals _job_size, we should be done |
|
| 85 | - * |
|
| 86 | - * @var int |
|
| 87 | - */ |
|
| 88 | - protected $_job_size = 0; |
|
| 89 | - |
|
| 90 | - |
|
| 91 | - /** |
|
| 92 | - * @param string $job_id |
|
| 93 | - * @param string $classname |
|
| 94 | - * @param array $request_data |
|
| 95 | - * @param array $extra_data |
|
| 96 | - */ |
|
| 97 | - public function __construct($job_id, $classname, $request_data, $extra_data = array()) |
|
| 98 | - { |
|
| 99 | - $this->set_job_id($job_id); |
|
| 100 | - $this->set_classname($classname); |
|
| 101 | - $this->set_request_data($request_data); |
|
| 102 | - $this->set_extra_data($extra_data); |
|
| 103 | - $this->set_status(JobParameters::status_continue); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Returns the array of strings of valid stati |
|
| 109 | - * |
|
| 110 | - * @return array |
|
| 111 | - */ |
|
| 112 | - public static function valid_stati() |
|
| 113 | - { |
|
| 114 | - return array( |
|
| 115 | - JobParameters::status_complete, |
|
| 116 | - JobParameters::status_continue, |
|
| 117 | - JobParameters::status_error, |
|
| 118 | - JobParameters::status_cleaned_up, |
|
| 119 | - ); |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * Saves this option to the database (wordpress options table) |
|
| 125 | - * |
|
| 126 | - * @param boolean $first |
|
| 127 | - * @return boolean success |
|
| 128 | - */ |
|
| 129 | - public function save($first = false) |
|
| 130 | - { |
|
| 131 | - $object_vars = get_object_vars($this); |
|
| 132 | - if ($first) { |
|
| 133 | - return add_option($this->option_name(), $object_vars, null, 'no'); |
|
| 134 | - } else { |
|
| 135 | - return update_option($this->option_name(), $object_vars); |
|
| 136 | - } |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * Deletes the job from teh database, although this object is still usable |
|
| 142 | - * for the rest of the request |
|
| 143 | - * |
|
| 144 | - * @return boolean |
|
| 145 | - */ |
|
| 146 | - public function delete() |
|
| 147 | - { |
|
| 148 | - return delete_option($this->option_name()); |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * Loads the specified job from the database |
|
| 154 | - * |
|
| 155 | - * @param string $job_id |
|
| 156 | - * @return JobParameters |
|
| 157 | - * @throws BatchRequestException |
|
| 158 | - */ |
|
| 159 | - public static function load($job_id) |
|
| 160 | - { |
|
| 161 | - $job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id); |
|
| 162 | - if (! is_array($job_parameter_vars) || |
|
| 163 | - ! isset($job_parameter_vars['_classname']) || |
|
| 164 | - ! isset($job_parameter_vars['_request_data']) |
|
| 165 | - ) { |
|
| 166 | - throw new BatchRequestException( |
|
| 167 | - sprintf( |
|
| 168 | - __( |
|
| 169 | - 'Could not retrieve job %1$s from the Wordpress options table, and so the job could not continue. The wordpress option was %2$s', |
|
| 170 | - 'event_espresso' |
|
| 171 | - ), |
|
| 172 | - $job_id, |
|
| 173 | - get_option(JobParameters::wp_option_prefix . $job_id) |
|
| 174 | - ) |
|
| 175 | - ); |
|
| 176 | - } |
|
| 177 | - $job_parameters = new JobParameters( |
|
| 178 | - $job_id, |
|
| 179 | - $job_parameter_vars['_classname'], |
|
| 180 | - $job_parameter_vars['_request_data'] |
|
| 181 | - ); |
|
| 182 | - foreach ($job_parameter_vars as $key => $value) { |
|
| 183 | - $job_parameters->{$key} = $value; |
|
| 184 | - } |
|
| 185 | - return $job_parameters; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * Gets the job's unique string |
|
| 191 | - * |
|
| 192 | - * @return string |
|
| 193 | - */ |
|
| 194 | - public function job_id() |
|
| 195 | - { |
|
| 196 | - return $this->_job_id; |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - |
|
| 200 | - /** |
|
| 201 | - * Gets the classname that should run this job |
|
| 202 | - * |
|
| 203 | - * @return string |
|
| 204 | - */ |
|
| 205 | - public function classname() |
|
| 206 | - { |
|
| 207 | - return $this->_classname; |
|
| 208 | - } |
|
| 209 | - |
|
| 210 | - |
|
| 211 | - /** |
|
| 212 | - * Gets the original array of $_REQUEST data for this job |
|
| 213 | - * |
|
| 214 | - * @return array |
|
| 215 | - */ |
|
| 216 | - public function request_data() |
|
| 217 | - { |
|
| 218 | - return $this->_request_data; |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * Gets a single item from the request data |
|
| 224 | - * |
|
| 225 | - * @param string $key |
|
| 226 | - * @param string|array $default |
|
| 227 | - * @return string|array |
|
| 228 | - */ |
|
| 229 | - public function request_datum($key, $default = '') |
|
| 230 | - { |
|
| 231 | - if (isset($this->_request_data[ $key ])) { |
|
| 232 | - return $this->_request_data[ $key ]; |
|
| 233 | - } else { |
|
| 234 | - return $default; |
|
| 235 | - } |
|
| 236 | - } |
|
| 237 | - |
|
| 238 | - |
|
| 239 | - /** |
|
| 240 | - * Gets a single item from the extra data |
|
| 241 | - * |
|
| 242 | - * @param string $key |
|
| 243 | - * @param string|array $default |
|
| 244 | - * @return string|array |
|
| 245 | - */ |
|
| 246 | - public function extra_datum($key, $default = '') |
|
| 247 | - { |
|
| 248 | - if (isset($this->_extra_data[ $key ])) { |
|
| 249 | - return $this->_extra_data[ $key ]; |
|
| 250 | - } else { |
|
| 251 | - return $default; |
|
| 252 | - } |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - |
|
| 256 | - /** |
|
| 257 | - * Adds an extra piece of extra data that we're going to want later during the job |
|
| 258 | - * |
|
| 259 | - * @param string $key |
|
| 260 | - * @param string|int|array|null $value almost any extra data you want to store |
|
| 261 | - */ |
|
| 262 | - public function add_extra_data($key, $value) |
|
| 263 | - { |
|
| 264 | - $this->_extra_data[ $key ] = $value; |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - |
|
| 268 | - /** |
|
| 269 | - * Array of any extra data we want to store |
|
| 270 | - * |
|
| 271 | - * @return array |
|
| 272 | - */ |
|
| 273 | - public function extra_data() |
|
| 274 | - { |
|
| 275 | - return $this->_extra_data; |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * Returns the job size, in whatever units you want |
|
| 281 | - * |
|
| 282 | - * @return int |
|
| 283 | - */ |
|
| 284 | - public function job_size() |
|
| 285 | - { |
|
| 286 | - return $this->_job_size; |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - |
|
| 290 | - /** |
|
| 291 | - * Sets the job size. You decide what units to use |
|
| 292 | - * |
|
| 293 | - * @param int $size |
|
| 294 | - */ |
|
| 295 | - public function set_job_size($size) |
|
| 296 | - { |
|
| 297 | - $this->_job_size = $size; |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - |
|
| 301 | - /** |
|
| 302 | - * The number of "units" processed, in the same units as the "job size" |
|
| 303 | - * |
|
| 304 | - * @return int |
|
| 305 | - */ |
|
| 306 | - public function units_processed() |
|
| 307 | - { |
|
| 308 | - return $this->_units_processed; |
|
| 309 | - } |
|
| 310 | - |
|
| 311 | - |
|
| 312 | - /** |
|
| 313 | - * Marks more units as processed |
|
| 314 | - * |
|
| 315 | - * @param int $newly_processed |
|
| 316 | - * @return int updated units processed |
|
| 317 | - */ |
|
| 318 | - public function mark_processed($newly_processed) |
|
| 319 | - { |
|
| 320 | - $this->_units_processed += $newly_processed; |
|
| 321 | - return $this->_units_processed; |
|
| 322 | - } |
|
| 323 | - |
|
| 324 | - |
|
| 325 | - /** |
|
| 326 | - * Sets the total count of units processed. You might prefer to use mark_processed |
|
| 327 | - * |
|
| 328 | - * @param int $total_units_processed |
|
| 329 | - */ |
|
| 330 | - public function set_units_processed($total_units_processed) |
|
| 331 | - { |
|
| 332 | - $this->_units_processed = $total_units_processed; |
|
| 333 | - } |
|
| 334 | - |
|
| 335 | - |
|
| 336 | - /** |
|
| 337 | - * Sets the job's ID |
|
| 338 | - * |
|
| 339 | - * @param string $job_id |
|
| 340 | - */ |
|
| 341 | - public function set_job_id($job_id) |
|
| 342 | - { |
|
| 343 | - $this->_job_id = $job_id; |
|
| 344 | - } |
|
| 345 | - |
|
| 346 | - |
|
| 347 | - /** |
|
| 348 | - * sets the classname |
|
| 349 | - * |
|
| 350 | - * @param string $classname |
|
| 351 | - */ |
|
| 352 | - public function set_classname($classname) |
|
| 353 | - { |
|
| 354 | - $this->_classname = $classname; |
|
| 355 | - } |
|
| 356 | - |
|
| 357 | - |
|
| 358 | - /** |
|
| 359 | - * Sets the request data |
|
| 360 | - * |
|
| 361 | - * @param array $request_data |
|
| 362 | - */ |
|
| 363 | - public function set_request_data($request_data) |
|
| 364 | - { |
|
| 365 | - $this->_request_data = $request_data; |
|
| 366 | - } |
|
| 367 | - |
|
| 368 | - |
|
| 369 | - /** |
|
| 370 | - * Sets the array of extra data we want to store on this request |
|
| 371 | - * |
|
| 372 | - * @param array $extra_data |
|
| 373 | - */ |
|
| 374 | - public function set_extra_data($extra_data) |
|
| 375 | - { |
|
| 376 | - $this->_extra_data = $extra_data; |
|
| 377 | - } |
|
| 378 | - |
|
| 379 | - |
|
| 380 | - /** |
|
| 381 | - * Gets the name of the wordpress option that should store these job parameters |
|
| 382 | - * |
|
| 383 | - * @return string |
|
| 384 | - */ |
|
| 385 | - public function option_name() |
|
| 386 | - { |
|
| 387 | - return JobParameters::wp_option_prefix . $this->job_id(); |
|
| 388 | - } |
|
| 389 | - |
|
| 390 | - |
|
| 391 | - /** |
|
| 392 | - * Gets the job\s current status. One of JobParameters::valid_stati(); |
|
| 393 | - * |
|
| 394 | - * @return string |
|
| 395 | - */ |
|
| 396 | - public function status() |
|
| 397 | - { |
|
| 398 | - return $this->_status; |
|
| 399 | - } |
|
| 400 | - |
|
| 401 | - |
|
| 402 | - /** |
|
| 403 | - * @param string $status on eof JobParameters::valid_stati() |
|
| 404 | - */ |
|
| 405 | - public function set_status($status) |
|
| 406 | - { |
|
| 407 | - $this->_status = $status; |
|
| 408 | - } |
|
| 17 | + // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase |
|
| 18 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 19 | + // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore |
|
| 20 | + /** |
|
| 21 | + * status indicating the job should continue |
|
| 22 | + */ |
|
| 23 | + const status_continue = 'continue'; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * status indicated the job has been completed successfully and should be cleaned up next |
|
| 27 | + */ |
|
| 28 | + const status_complete = 'complete'; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * status indicating there was an error and the job should be cleaned up |
|
| 32 | + */ |
|
| 33 | + const status_error = 'error'; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * status indicating the job has been cleaned up, and so this is probably the last |
|
| 37 | + * time you'll see this job |
|
| 38 | + */ |
|
| 39 | + const status_cleaned_up = 'cleaned_up'; |
|
| 40 | + |
|
| 41 | + const wp_option_prefix = 'ee_job_parameters_'; |
|
| 42 | + |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * String uniquely identifying the job |
|
| 46 | + * |
|
| 47 | + * @var string |
|
| 48 | + */ |
|
| 49 | + protected $_job_id; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | + protected $_classname; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * @var array |
|
| 58 | + */ |
|
| 59 | + protected $_request_data; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Array of any extra data we want to remember about this request, that |
|
| 63 | + * wasn't necessarily past in with the request data |
|
| 64 | + * |
|
| 65 | + * @var array |
|
| 66 | + */ |
|
| 67 | + protected $_extra_data; |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * Estimate of how many units HAVE been processed |
|
| 71 | + * |
|
| 72 | + * @var int |
|
| 73 | + */ |
|
| 74 | + protected $_units_processed = 0; |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * @var string |
|
| 78 | + */ |
|
| 79 | + protected $_status; |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * The size of the total job in whatever units you want. |
|
| 83 | + * If you can't provide an estimate leave as 0. |
|
| 84 | + * Once _units_processed equals _job_size, we should be done |
|
| 85 | + * |
|
| 86 | + * @var int |
|
| 87 | + */ |
|
| 88 | + protected $_job_size = 0; |
|
| 89 | + |
|
| 90 | + |
|
| 91 | + /** |
|
| 92 | + * @param string $job_id |
|
| 93 | + * @param string $classname |
|
| 94 | + * @param array $request_data |
|
| 95 | + * @param array $extra_data |
|
| 96 | + */ |
|
| 97 | + public function __construct($job_id, $classname, $request_data, $extra_data = array()) |
|
| 98 | + { |
|
| 99 | + $this->set_job_id($job_id); |
|
| 100 | + $this->set_classname($classname); |
|
| 101 | + $this->set_request_data($request_data); |
|
| 102 | + $this->set_extra_data($extra_data); |
|
| 103 | + $this->set_status(JobParameters::status_continue); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Returns the array of strings of valid stati |
|
| 109 | + * |
|
| 110 | + * @return array |
|
| 111 | + */ |
|
| 112 | + public static function valid_stati() |
|
| 113 | + { |
|
| 114 | + return array( |
|
| 115 | + JobParameters::status_complete, |
|
| 116 | + JobParameters::status_continue, |
|
| 117 | + JobParameters::status_error, |
|
| 118 | + JobParameters::status_cleaned_up, |
|
| 119 | + ); |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * Saves this option to the database (wordpress options table) |
|
| 125 | + * |
|
| 126 | + * @param boolean $first |
|
| 127 | + * @return boolean success |
|
| 128 | + */ |
|
| 129 | + public function save($first = false) |
|
| 130 | + { |
|
| 131 | + $object_vars = get_object_vars($this); |
|
| 132 | + if ($first) { |
|
| 133 | + return add_option($this->option_name(), $object_vars, null, 'no'); |
|
| 134 | + } else { |
|
| 135 | + return update_option($this->option_name(), $object_vars); |
|
| 136 | + } |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * Deletes the job from teh database, although this object is still usable |
|
| 142 | + * for the rest of the request |
|
| 143 | + * |
|
| 144 | + * @return boolean |
|
| 145 | + */ |
|
| 146 | + public function delete() |
|
| 147 | + { |
|
| 148 | + return delete_option($this->option_name()); |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * Loads the specified job from the database |
|
| 154 | + * |
|
| 155 | + * @param string $job_id |
|
| 156 | + * @return JobParameters |
|
| 157 | + * @throws BatchRequestException |
|
| 158 | + */ |
|
| 159 | + public static function load($job_id) |
|
| 160 | + { |
|
| 161 | + $job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id); |
|
| 162 | + if (! is_array($job_parameter_vars) || |
|
| 163 | + ! isset($job_parameter_vars['_classname']) || |
|
| 164 | + ! isset($job_parameter_vars['_request_data']) |
|
| 165 | + ) { |
|
| 166 | + throw new BatchRequestException( |
|
| 167 | + sprintf( |
|
| 168 | + __( |
|
| 169 | + 'Could not retrieve job %1$s from the Wordpress options table, and so the job could not continue. The wordpress option was %2$s', |
|
| 170 | + 'event_espresso' |
|
| 171 | + ), |
|
| 172 | + $job_id, |
|
| 173 | + get_option(JobParameters::wp_option_prefix . $job_id) |
|
| 174 | + ) |
|
| 175 | + ); |
|
| 176 | + } |
|
| 177 | + $job_parameters = new JobParameters( |
|
| 178 | + $job_id, |
|
| 179 | + $job_parameter_vars['_classname'], |
|
| 180 | + $job_parameter_vars['_request_data'] |
|
| 181 | + ); |
|
| 182 | + foreach ($job_parameter_vars as $key => $value) { |
|
| 183 | + $job_parameters->{$key} = $value; |
|
| 184 | + } |
|
| 185 | + return $job_parameters; |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * Gets the job's unique string |
|
| 191 | + * |
|
| 192 | + * @return string |
|
| 193 | + */ |
|
| 194 | + public function job_id() |
|
| 195 | + { |
|
| 196 | + return $this->_job_id; |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + |
|
| 200 | + /** |
|
| 201 | + * Gets the classname that should run this job |
|
| 202 | + * |
|
| 203 | + * @return string |
|
| 204 | + */ |
|
| 205 | + public function classname() |
|
| 206 | + { |
|
| 207 | + return $this->_classname; |
|
| 208 | + } |
|
| 209 | + |
|
| 210 | + |
|
| 211 | + /** |
|
| 212 | + * Gets the original array of $_REQUEST data for this job |
|
| 213 | + * |
|
| 214 | + * @return array |
|
| 215 | + */ |
|
| 216 | + public function request_data() |
|
| 217 | + { |
|
| 218 | + return $this->_request_data; |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * Gets a single item from the request data |
|
| 224 | + * |
|
| 225 | + * @param string $key |
|
| 226 | + * @param string|array $default |
|
| 227 | + * @return string|array |
|
| 228 | + */ |
|
| 229 | + public function request_datum($key, $default = '') |
|
| 230 | + { |
|
| 231 | + if (isset($this->_request_data[ $key ])) { |
|
| 232 | + return $this->_request_data[ $key ]; |
|
| 233 | + } else { |
|
| 234 | + return $default; |
|
| 235 | + } |
|
| 236 | + } |
|
| 237 | + |
|
| 238 | + |
|
| 239 | + /** |
|
| 240 | + * Gets a single item from the extra data |
|
| 241 | + * |
|
| 242 | + * @param string $key |
|
| 243 | + * @param string|array $default |
|
| 244 | + * @return string|array |
|
| 245 | + */ |
|
| 246 | + public function extra_datum($key, $default = '') |
|
| 247 | + { |
|
| 248 | + if (isset($this->_extra_data[ $key ])) { |
|
| 249 | + return $this->_extra_data[ $key ]; |
|
| 250 | + } else { |
|
| 251 | + return $default; |
|
| 252 | + } |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + |
|
| 256 | + /** |
|
| 257 | + * Adds an extra piece of extra data that we're going to want later during the job |
|
| 258 | + * |
|
| 259 | + * @param string $key |
|
| 260 | + * @param string|int|array|null $value almost any extra data you want to store |
|
| 261 | + */ |
|
| 262 | + public function add_extra_data($key, $value) |
|
| 263 | + { |
|
| 264 | + $this->_extra_data[ $key ] = $value; |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + |
|
| 268 | + /** |
|
| 269 | + * Array of any extra data we want to store |
|
| 270 | + * |
|
| 271 | + * @return array |
|
| 272 | + */ |
|
| 273 | + public function extra_data() |
|
| 274 | + { |
|
| 275 | + return $this->_extra_data; |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * Returns the job size, in whatever units you want |
|
| 281 | + * |
|
| 282 | + * @return int |
|
| 283 | + */ |
|
| 284 | + public function job_size() |
|
| 285 | + { |
|
| 286 | + return $this->_job_size; |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + |
|
| 290 | + /** |
|
| 291 | + * Sets the job size. You decide what units to use |
|
| 292 | + * |
|
| 293 | + * @param int $size |
|
| 294 | + */ |
|
| 295 | + public function set_job_size($size) |
|
| 296 | + { |
|
| 297 | + $this->_job_size = $size; |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + |
|
| 301 | + /** |
|
| 302 | + * The number of "units" processed, in the same units as the "job size" |
|
| 303 | + * |
|
| 304 | + * @return int |
|
| 305 | + */ |
|
| 306 | + public function units_processed() |
|
| 307 | + { |
|
| 308 | + return $this->_units_processed; |
|
| 309 | + } |
|
| 310 | + |
|
| 311 | + |
|
| 312 | + /** |
|
| 313 | + * Marks more units as processed |
|
| 314 | + * |
|
| 315 | + * @param int $newly_processed |
|
| 316 | + * @return int updated units processed |
|
| 317 | + */ |
|
| 318 | + public function mark_processed($newly_processed) |
|
| 319 | + { |
|
| 320 | + $this->_units_processed += $newly_processed; |
|
| 321 | + return $this->_units_processed; |
|
| 322 | + } |
|
| 323 | + |
|
| 324 | + |
|
| 325 | + /** |
|
| 326 | + * Sets the total count of units processed. You might prefer to use mark_processed |
|
| 327 | + * |
|
| 328 | + * @param int $total_units_processed |
|
| 329 | + */ |
|
| 330 | + public function set_units_processed($total_units_processed) |
|
| 331 | + { |
|
| 332 | + $this->_units_processed = $total_units_processed; |
|
| 333 | + } |
|
| 334 | + |
|
| 335 | + |
|
| 336 | + /** |
|
| 337 | + * Sets the job's ID |
|
| 338 | + * |
|
| 339 | + * @param string $job_id |
|
| 340 | + */ |
|
| 341 | + public function set_job_id($job_id) |
|
| 342 | + { |
|
| 343 | + $this->_job_id = $job_id; |
|
| 344 | + } |
|
| 345 | + |
|
| 346 | + |
|
| 347 | + /** |
|
| 348 | + * sets the classname |
|
| 349 | + * |
|
| 350 | + * @param string $classname |
|
| 351 | + */ |
|
| 352 | + public function set_classname($classname) |
|
| 353 | + { |
|
| 354 | + $this->_classname = $classname; |
|
| 355 | + } |
|
| 356 | + |
|
| 357 | + |
|
| 358 | + /** |
|
| 359 | + * Sets the request data |
|
| 360 | + * |
|
| 361 | + * @param array $request_data |
|
| 362 | + */ |
|
| 363 | + public function set_request_data($request_data) |
|
| 364 | + { |
|
| 365 | + $this->_request_data = $request_data; |
|
| 366 | + } |
|
| 367 | + |
|
| 368 | + |
|
| 369 | + /** |
|
| 370 | + * Sets the array of extra data we want to store on this request |
|
| 371 | + * |
|
| 372 | + * @param array $extra_data |
|
| 373 | + */ |
|
| 374 | + public function set_extra_data($extra_data) |
|
| 375 | + { |
|
| 376 | + $this->_extra_data = $extra_data; |
|
| 377 | + } |
|
| 378 | + |
|
| 379 | + |
|
| 380 | + /** |
|
| 381 | + * Gets the name of the wordpress option that should store these job parameters |
|
| 382 | + * |
|
| 383 | + * @return string |
|
| 384 | + */ |
|
| 385 | + public function option_name() |
|
| 386 | + { |
|
| 387 | + return JobParameters::wp_option_prefix . $this->job_id(); |
|
| 388 | + } |
|
| 389 | + |
|
| 390 | + |
|
| 391 | + /** |
|
| 392 | + * Gets the job\s current status. One of JobParameters::valid_stati(); |
|
| 393 | + * |
|
| 394 | + * @return string |
|
| 395 | + */ |
|
| 396 | + public function status() |
|
| 397 | + { |
|
| 398 | + return $this->_status; |
|
| 399 | + } |
|
| 400 | + |
|
| 401 | + |
|
| 402 | + /** |
|
| 403 | + * @param string $status on eof JobParameters::valid_stati() |
|
| 404 | + */ |
|
| 405 | + public function set_status($status) |
|
| 406 | + { |
|
| 407 | + $this->_status = $status; |
|
| 408 | + } |
|
| 409 | 409 | } |
@@ -158,8 +158,8 @@ discard block |
||
| 158 | 158 | */ |
| 159 | 159 | public static function load($job_id) |
| 160 | 160 | { |
| 161 | - $job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id); |
|
| 162 | - if (! is_array($job_parameter_vars) || |
|
| 161 | + $job_parameter_vars = get_option(JobParameters::wp_option_prefix.$job_id); |
|
| 162 | + if ( ! is_array($job_parameter_vars) || |
|
| 163 | 163 | ! isset($job_parameter_vars['_classname']) || |
| 164 | 164 | ! isset($job_parameter_vars['_request_data']) |
| 165 | 165 | ) { |
@@ -170,7 +170,7 @@ discard block |
||
| 170 | 170 | 'event_espresso' |
| 171 | 171 | ), |
| 172 | 172 | $job_id, |
| 173 | - get_option(JobParameters::wp_option_prefix . $job_id) |
|
| 173 | + get_option(JobParameters::wp_option_prefix.$job_id) |
|
| 174 | 174 | ) |
| 175 | 175 | ); |
| 176 | 176 | } |
@@ -228,8 +228,8 @@ discard block |
||
| 228 | 228 | */ |
| 229 | 229 | public function request_datum($key, $default = '') |
| 230 | 230 | { |
| 231 | - if (isset($this->_request_data[ $key ])) { |
|
| 232 | - return $this->_request_data[ $key ]; |
|
| 231 | + if (isset($this->_request_data[$key])) { |
|
| 232 | + return $this->_request_data[$key]; |
|
| 233 | 233 | } else { |
| 234 | 234 | return $default; |
| 235 | 235 | } |
@@ -245,8 +245,8 @@ discard block |
||
| 245 | 245 | */ |
| 246 | 246 | public function extra_datum($key, $default = '') |
| 247 | 247 | { |
| 248 | - if (isset($this->_extra_data[ $key ])) { |
|
| 249 | - return $this->_extra_data[ $key ]; |
|
| 248 | + if (isset($this->_extra_data[$key])) { |
|
| 249 | + return $this->_extra_data[$key]; |
|
| 250 | 250 | } else { |
| 251 | 251 | return $default; |
| 252 | 252 | } |
@@ -261,7 +261,7 @@ discard block |
||
| 261 | 261 | */ |
| 262 | 262 | public function add_extra_data($key, $value) |
| 263 | 263 | { |
| 264 | - $this->_extra_data[ $key ] = $value; |
|
| 264 | + $this->_extra_data[$key] = $value; |
|
| 265 | 265 | } |
| 266 | 266 | |
| 267 | 267 | |
@@ -384,7 +384,7 @@ discard block |
||
| 384 | 384 | */ |
| 385 | 385 | public function option_name() |
| 386 | 386 | { |
| 387 | - return JobParameters::wp_option_prefix . $this->job_id(); |
|
| 387 | + return JobParameters::wp_option_prefix.$this->job_id(); |
|
| 388 | 388 | } |
| 389 | 389 | |
| 390 | 390 | |
@@ -13,99 +13,99 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | class JobStepResponse |
| 15 | 15 | { |
| 16 | - // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore |
|
| 17 | - /** |
|
| 18 | - * Description fo what happened during this step |
|
| 19 | - * |
|
| 20 | - * @var string |
|
| 21 | - */ |
|
| 22 | - protected $_update_text; |
|
| 16 | + // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore |
|
| 17 | + /** |
|
| 18 | + * Description fo what happened during this step |
|
| 19 | + * |
|
| 20 | + * @var string |
|
| 21 | + */ |
|
| 22 | + protected $_update_text; |
|
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * @var JobParameters |
|
| 26 | - */ |
|
| 27 | - protected $_job_parameters; |
|
| 24 | + /** |
|
| 25 | + * @var JobParameters |
|
| 26 | + */ |
|
| 27 | + protected $_job_parameters; |
|
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * Extra data to include as part of the response. |
|
| 31 | - * |
|
| 32 | - * @var array |
|
| 33 | - */ |
|
| 34 | - protected $_extra_data = array(); |
|
| 35 | - // phpcs:enable |
|
| 29 | + /** |
|
| 30 | + * Extra data to include as part of the response. |
|
| 31 | + * |
|
| 32 | + * @var array |
|
| 33 | + */ |
|
| 34 | + protected $_extra_data = array(); |
|
| 35 | + // phpcs:enable |
|
| 36 | 36 | |
| 37 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 38 | - /** |
|
| 39 | - * @param \EventEspressoBatchRequest\Helpers\JobParameters $job_parameters |
|
| 40 | - * @param string $update_text |
|
| 41 | - * @param array $extra_data |
|
| 42 | - */ |
|
| 43 | - public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array()) |
|
| 44 | - { |
|
| 45 | - $this->_job_parameters = $job_parameters; |
|
| 46 | - $this->_update_text = $update_text; |
|
| 47 | - $this->_extra_data = (array) $extra_data; |
|
| 48 | - } |
|
| 37 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 38 | + /** |
|
| 39 | + * @param \EventEspressoBatchRequest\Helpers\JobParameters $job_parameters |
|
| 40 | + * @param string $update_text |
|
| 41 | + * @param array $extra_data |
|
| 42 | + */ |
|
| 43 | + public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array()) |
|
| 44 | + { |
|
| 45 | + $this->_job_parameters = $job_parameters; |
|
| 46 | + $this->_update_text = $update_text; |
|
| 47 | + $this->_extra_data = (array) $extra_data; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @return JobParameters |
|
| 53 | - */ |
|
| 54 | - public function job_parameters() |
|
| 55 | - { |
|
| 56 | - return $this->_job_parameters; |
|
| 57 | - } |
|
| 51 | + /** |
|
| 52 | + * @return JobParameters |
|
| 53 | + */ |
|
| 54 | + public function job_parameters() |
|
| 55 | + { |
|
| 56 | + return $this->_job_parameters; |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Gets the update_text of what happened in this job during the current step |
|
| 62 | - * |
|
| 63 | - * @return string |
|
| 64 | - */ |
|
| 65 | - public function update_text() |
|
| 66 | - { |
|
| 67 | - return $this->_update_text; |
|
| 68 | - } |
|
| 60 | + /** |
|
| 61 | + * Gets the update_text of what happened in this job during the current step |
|
| 62 | + * |
|
| 63 | + * @return string |
|
| 64 | + */ |
|
| 65 | + public function update_text() |
|
| 66 | + { |
|
| 67 | + return $this->_update_text; |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Returns any extra data we may want to include with this response |
|
| 73 | - * |
|
| 74 | - * @return array |
|
| 75 | - */ |
|
| 76 | - public function extra_data() |
|
| 77 | - { |
|
| 78 | - return $this->_extra_data; |
|
| 79 | - } |
|
| 71 | + /** |
|
| 72 | + * Returns any extra data we may want to include with this response |
|
| 73 | + * |
|
| 74 | + * @return array |
|
| 75 | + */ |
|
| 76 | + public function extra_data() |
|
| 77 | + { |
|
| 78 | + return $this->_extra_data; |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Converts this response into an array that can be easily serialized. |
|
| 84 | - * This is most useful for serializing or json encoding |
|
| 85 | - * |
|
| 86 | - * @return array { |
|
| 87 | - * @type string $status , one of JobParameters::valid_stati() |
|
| 88 | - * @type int $units_processed count of units processed |
|
| 89 | - * @type int $job_size total number of units TO process |
|
| 90 | - * @type string $job_id unique string identifying the job |
|
| 91 | - * @type string $update_text string describing what happened during this step |
|
| 92 | - * } and any other items from $this->extra_data() |
|
| 93 | - */ |
|
| 94 | - public function to_array() |
|
| 95 | - { |
|
| 96 | - return apply_filters( |
|
| 97 | - 'FHEE__EventEspressoBatchRequest\Helpers\JobStepResponse__to_array__return', |
|
| 98 | - array_merge( |
|
| 99 | - $this->extra_data(), |
|
| 100 | - array( |
|
| 101 | - 'status' => $this->job_parameters()->status(), |
|
| 102 | - 'units_processed' => $this->job_parameters()->units_processed(), |
|
| 103 | - 'job_size' => $this->job_parameters()->job_size(), |
|
| 104 | - 'job_id' => $this->job_parameters()->job_id(), |
|
| 105 | - 'update_text' => $this->update_text(), |
|
| 106 | - ) |
|
| 107 | - ), |
|
| 108 | - $this |
|
| 109 | - ); |
|
| 110 | - } |
|
| 82 | + /** |
|
| 83 | + * Converts this response into an array that can be easily serialized. |
|
| 84 | + * This is most useful for serializing or json encoding |
|
| 85 | + * |
|
| 86 | + * @return array { |
|
| 87 | + * @type string $status , one of JobParameters::valid_stati() |
|
| 88 | + * @type int $units_processed count of units processed |
|
| 89 | + * @type int $job_size total number of units TO process |
|
| 90 | + * @type string $job_id unique string identifying the job |
|
| 91 | + * @type string $update_text string describing what happened during this step |
|
| 92 | + * } and any other items from $this->extra_data() |
|
| 93 | + */ |
|
| 94 | + public function to_array() |
|
| 95 | + { |
|
| 96 | + return apply_filters( |
|
| 97 | + 'FHEE__EventEspressoBatchRequest\Helpers\JobStepResponse__to_array__return', |
|
| 98 | + array_merge( |
|
| 99 | + $this->extra_data(), |
|
| 100 | + array( |
|
| 101 | + 'status' => $this->job_parameters()->status(), |
|
| 102 | + 'units_processed' => $this->job_parameters()->units_processed(), |
|
| 103 | + 'job_size' => $this->job_parameters()->job_size(), |
|
| 104 | + 'job_id' => $this->job_parameters()->job_id(), |
|
| 105 | + 'update_text' => $this->update_text(), |
|
| 106 | + ) |
|
| 107 | + ), |
|
| 108 | + $this |
|
| 109 | + ); |
|
| 110 | + } |
|
| 111 | 111 | } |
@@ -19,45 +19,45 @@ |
||
| 19 | 19 | class VsprintfFilter extends FormHtmlFilter |
| 20 | 20 | { |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @var string $format |
|
| 24 | - */ |
|
| 25 | - protected $format = ''; |
|
| 26 | - |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * @var array $args |
|
| 30 | - */ |
|
| 31 | - protected $args = array(); |
|
| 32 | - |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * VsprintfFilter constructor. |
|
| 36 | - * |
|
| 37 | - * @param string $format |
|
| 38 | - * @param array $args |
|
| 39 | - */ |
|
| 40 | - public function __construct($format, array $args) |
|
| 41 | - { |
|
| 42 | - $this->format = $format; |
|
| 43 | - $this->args = $args; |
|
| 44 | - } |
|
| 45 | - |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * @param $html |
|
| 49 | - * @param EE_Form_Section_Validatable $form_section |
|
| 50 | - * @return string |
|
| 51 | - */ |
|
| 52 | - public function filterHtml($html, EE_Form_Section_Validatable $form_section) |
|
| 53 | - { |
|
| 54 | - $this->args[] = $html; |
|
| 55 | - if ($form_section instanceof EE_Form_Section_Proper) { |
|
| 56 | - $subsections = $form_section->subsections(); |
|
| 57 | - foreach ((array) $subsections as $subsection) { |
|
| 58 | - $this->args[] = $subsection->get_html(); |
|
| 59 | - } |
|
| 60 | - } |
|
| 61 | - return vsprintf($this->format, $this->args); |
|
| 62 | - } |
|
| 22 | + /** |
|
| 23 | + * @var string $format |
|
| 24 | + */ |
|
| 25 | + protected $format = ''; |
|
| 26 | + |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * @var array $args |
|
| 30 | + */ |
|
| 31 | + protected $args = array(); |
|
| 32 | + |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * VsprintfFilter constructor. |
|
| 36 | + * |
|
| 37 | + * @param string $format |
|
| 38 | + * @param array $args |
|
| 39 | + */ |
|
| 40 | + public function __construct($format, array $args) |
|
| 41 | + { |
|
| 42 | + $this->format = $format; |
|
| 43 | + $this->args = $args; |
|
| 44 | + } |
|
| 45 | + |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * @param $html |
|
| 49 | + * @param EE_Form_Section_Validatable $form_section |
|
| 50 | + * @return string |
|
| 51 | + */ |
|
| 52 | + public function filterHtml($html, EE_Form_Section_Validatable $form_section) |
|
| 53 | + { |
|
| 54 | + $this->args[] = $html; |
|
| 55 | + if ($form_section instanceof EE_Form_Section_Proper) { |
|
| 56 | + $subsections = $form_section->subsections(); |
|
| 57 | + foreach ((array) $subsections as $subsection) { |
|
| 58 | + $this->args[] = $subsection->get_html(); |
|
| 59 | + } |
|
| 60 | + } |
|
| 61 | + return vsprintf($this->format, $this->args); |
|
| 62 | + } |
|
| 63 | 63 | } |
@@ -18,97 +18,97 @@ |
||
| 18 | 18 | class RegUrlLink |
| 19 | 19 | { |
| 20 | 20 | |
| 21 | - /* |
|
| 21 | + /* |
|
| 22 | 22 | * @var string $reg_url_link |
| 23 | 23 | */ |
| 24 | - private $reg_url_link; |
|
| 24 | + private $reg_url_link; |
|
| 25 | 25 | |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @param string $reg_url_link |
|
| 29 | - * @return RegUrlLink |
|
| 30 | - * @throws InvalidArgumentException |
|
| 31 | - */ |
|
| 32 | - public static function fromRegUrlLinkString($reg_url_link) |
|
| 33 | - { |
|
| 34 | - if (empty($reg_url_link) || ! is_string($reg_url_link)) { |
|
| 35 | - throw new InvalidArgumentException( |
|
| 36 | - __( |
|
| 37 | - 'You must supply a valid non-empty string to generate a reg_url_link.', |
|
| 38 | - 'event_espresso' |
|
| 39 | - ) |
|
| 40 | - ); |
|
| 41 | - } |
|
| 42 | - return new RegUrlLink(1, '', $reg_url_link); |
|
| 43 | - } |
|
| 27 | + /** |
|
| 28 | + * @param string $reg_url_link |
|
| 29 | + * @return RegUrlLink |
|
| 30 | + * @throws InvalidArgumentException |
|
| 31 | + */ |
|
| 32 | + public static function fromRegUrlLinkString($reg_url_link) |
|
| 33 | + { |
|
| 34 | + if (empty($reg_url_link) || ! is_string($reg_url_link)) { |
|
| 35 | + throw new InvalidArgumentException( |
|
| 36 | + __( |
|
| 37 | + 'You must supply a valid non-empty string to generate a reg_url_link.', |
|
| 38 | + 'event_espresso' |
|
| 39 | + ) |
|
| 40 | + ); |
|
| 41 | + } |
|
| 42 | + return new RegUrlLink(1, '', $reg_url_link); |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @param EE_Registration $registration |
|
| 48 | - * @return RegUrlLink |
|
| 49 | - * @throws EntityNotFoundException |
|
| 50 | - * @throws EE_Error |
|
| 51 | - * @throws InvalidArgumentException |
|
| 52 | - */ |
|
| 53 | - public static function fromRegistration(EE_Registration $registration) |
|
| 54 | - { |
|
| 55 | - return new RegUrlLink( |
|
| 56 | - $registration->count(), |
|
| 57 | - $registration->ticket_line_item() |
|
| 58 | - ); |
|
| 59 | - } |
|
| 46 | + /** |
|
| 47 | + * @param EE_Registration $registration |
|
| 48 | + * @return RegUrlLink |
|
| 49 | + * @throws EntityNotFoundException |
|
| 50 | + * @throws EE_Error |
|
| 51 | + * @throws InvalidArgumentException |
|
| 52 | + */ |
|
| 53 | + public static function fromRegistration(EE_Registration $registration) |
|
| 54 | + { |
|
| 55 | + return new RegUrlLink( |
|
| 56 | + $registration->count(), |
|
| 57 | + $registration->ticket_line_item() |
|
| 58 | + ); |
|
| 59 | + } |
|
| 60 | 60 | |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * CreateRegUrlLinkCommand constructor. |
|
| 64 | - * |
|
| 65 | - * @param int $reg_count |
|
| 66 | - * @param mixed $base_code |
|
| 67 | - * @param string $reg_url_link |
|
| 68 | - * @throws InvalidArgumentException |
|
| 69 | - */ |
|
| 70 | - public function __construct( |
|
| 71 | - $reg_count = 1, |
|
| 72 | - $base_code = '', |
|
| 73 | - $reg_url_link = '' |
|
| 74 | - ) { |
|
| 75 | - if (! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 76 | - $this->reg_url_link = apply_filters( |
|
| 77 | - 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 78 | - $reg_url_link, |
|
| 79 | - $reg_count, |
|
| 80 | - $base_code, |
|
| 81 | - $reg_url_link |
|
| 82 | - ); |
|
| 83 | - return; |
|
| 84 | - } |
|
| 85 | - $reg_count = max(1, absint($reg_count)); |
|
| 86 | - $base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code; |
|
| 87 | - if (empty($base_code) || ! is_string($base_code)) { |
|
| 88 | - throw new InvalidArgumentException( |
|
| 89 | - __( |
|
| 90 | - 'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.', |
|
| 91 | - 'event_espresso' |
|
| 92 | - ) |
|
| 93 | - ); |
|
| 94 | - } |
|
| 95 | - $this->reg_url_link = (string) apply_filters( |
|
| 96 | - 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 97 | - $reg_count . '-' . md5($base_code . microtime()), |
|
| 98 | - $reg_count, |
|
| 99 | - $base_code, |
|
| 100 | - $reg_url_link |
|
| 101 | - ); |
|
| 102 | - } |
|
| 62 | + /** |
|
| 63 | + * CreateRegUrlLinkCommand constructor. |
|
| 64 | + * |
|
| 65 | + * @param int $reg_count |
|
| 66 | + * @param mixed $base_code |
|
| 67 | + * @param string $reg_url_link |
|
| 68 | + * @throws InvalidArgumentException |
|
| 69 | + */ |
|
| 70 | + public function __construct( |
|
| 71 | + $reg_count = 1, |
|
| 72 | + $base_code = '', |
|
| 73 | + $reg_url_link = '' |
|
| 74 | + ) { |
|
| 75 | + if (! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 76 | + $this->reg_url_link = apply_filters( |
|
| 77 | + 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 78 | + $reg_url_link, |
|
| 79 | + $reg_count, |
|
| 80 | + $base_code, |
|
| 81 | + $reg_url_link |
|
| 82 | + ); |
|
| 83 | + return; |
|
| 84 | + } |
|
| 85 | + $reg_count = max(1, absint($reg_count)); |
|
| 86 | + $base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code; |
|
| 87 | + if (empty($base_code) || ! is_string($base_code)) { |
|
| 88 | + throw new InvalidArgumentException( |
|
| 89 | + __( |
|
| 90 | + 'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.', |
|
| 91 | + 'event_espresso' |
|
| 92 | + ) |
|
| 93 | + ); |
|
| 94 | + } |
|
| 95 | + $this->reg_url_link = (string) apply_filters( |
|
| 96 | + 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 97 | + $reg_count . '-' . md5($base_code . microtime()), |
|
| 98 | + $reg_count, |
|
| 99 | + $base_code, |
|
| 100 | + $reg_url_link |
|
| 101 | + ); |
|
| 102 | + } |
|
| 103 | 103 | |
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Return the object as a string |
|
| 107 | - * |
|
| 108 | - * @return string |
|
| 109 | - */ |
|
| 110 | - public function __toString() |
|
| 111 | - { |
|
| 112 | - return $this->reg_url_link; |
|
| 113 | - } |
|
| 105 | + /** |
|
| 106 | + * Return the object as a string |
|
| 107 | + * |
|
| 108 | + * @return string |
|
| 109 | + */ |
|
| 110 | + public function __toString() |
|
| 111 | + { |
|
| 112 | + return $this->reg_url_link; |
|
| 113 | + } |
|
| 114 | 114 | } |
@@ -72,7 +72,7 @@ discard block |
||
| 72 | 72 | $base_code = '', |
| 73 | 73 | $reg_url_link = '' |
| 74 | 74 | ) { |
| 75 | - if (! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 75 | + if ( ! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 76 | 76 | $this->reg_url_link = apply_filters( |
| 77 | 77 | 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
| 78 | 78 | $reg_url_link, |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | } |
| 95 | 95 | $this->reg_url_link = (string) apply_filters( |
| 96 | 96 | 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
| 97 | - $reg_count . '-' . md5($base_code . microtime()), |
|
| 97 | + $reg_count.'-'.md5($base_code.microtime()), |
|
| 98 | 98 | $reg_count, |
| 99 | 99 | $base_code, |
| 100 | 100 | $reg_url_link |
@@ -30,132 +30,132 @@ |
||
| 30 | 30 | { |
| 31 | 31 | |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * the actual shortcode tag that gets registered with WordPress |
|
| 35 | - * |
|
| 36 | - * @return string |
|
| 37 | - */ |
|
| 38 | - public function getTag() |
|
| 39 | - { |
|
| 40 | - return 'ESPRESSO_EVENTS'; |
|
| 41 | - } |
|
| 33 | + /** |
|
| 34 | + * the actual shortcode tag that gets registered with WordPress |
|
| 35 | + * |
|
| 36 | + * @return string |
|
| 37 | + */ |
|
| 38 | + public function getTag() |
|
| 39 | + { |
|
| 40 | + return 'ESPRESSO_EVENTS'; |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * the time in seconds to cache the results of the processShortcode() method |
|
| 46 | - * 0 means the processShortcode() results will NOT be cached at all |
|
| 47 | - * |
|
| 48 | - * @return int |
|
| 49 | - */ |
|
| 50 | - public function cacheExpiration() |
|
| 51 | - { |
|
| 52 | - return 0; |
|
| 53 | - } |
|
| 44 | + /** |
|
| 45 | + * the time in seconds to cache the results of the processShortcode() method |
|
| 46 | + * 0 means the processShortcode() results will NOT be cached at all |
|
| 47 | + * |
|
| 48 | + * @return int |
|
| 49 | + */ |
|
| 50 | + public function cacheExpiration() |
|
| 51 | + { |
|
| 52 | + return 0; |
|
| 53 | + } |
|
| 54 | 54 | |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * a place for adding any initialization code that needs to run prior to wp_header(). |
|
| 58 | - * this may be required for shortcodes that utilize a corresponding module, |
|
| 59 | - * and need to enqueue assets for that module |
|
| 60 | - * |
|
| 61 | - * @return void |
|
| 62 | - */ |
|
| 63 | - public function initializeShortcode() |
|
| 64 | - { |
|
| 65 | - EED_Events_Archive::instance()->event_list(); |
|
| 66 | - $this->shortcodeHasBeenInitialized(); |
|
| 67 | - } |
|
| 56 | + /** |
|
| 57 | + * a place for adding any initialization code that needs to run prior to wp_header(). |
|
| 58 | + * this may be required for shortcodes that utilize a corresponding module, |
|
| 59 | + * and need to enqueue assets for that module |
|
| 60 | + * |
|
| 61 | + * @return void |
|
| 62 | + */ |
|
| 63 | + public function initializeShortcode() |
|
| 64 | + { |
|
| 65 | + EED_Events_Archive::instance()->event_list(); |
|
| 66 | + $this->shortcodeHasBeenInitialized(); |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * callback that runs when the shortcode is encountered in post content. |
|
| 72 | - * IMPORTANT !!! |
|
| 73 | - * remember that shortcode content should be RETURNED and NOT echoed out |
|
| 74 | - * |
|
| 75 | - * @param array $attributes |
|
| 76 | - * @return string |
|
| 77 | - */ |
|
| 78 | - public function processShortcode($attributes = array()) |
|
| 79 | - { |
|
| 80 | - // grab attributes and merge with defaults |
|
| 81 | - $attributes = $this->getAttributes($attributes); |
|
| 82 | - // make sure we use the_excerpt() |
|
| 83 | - add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true'); |
|
| 84 | - // apply query filters |
|
| 85 | - add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true'); |
|
| 86 | - // run the query |
|
| 87 | - global $wp_query; |
|
| 88 | - // yes we have to overwrite the main wp query, but it's ok... |
|
| 89 | - // we're going to reset it again below, so everything will be Hunky Dory (amazing album) |
|
| 90 | - $wp_query = new EventListQuery($attributes); |
|
| 91 | - // check what template is loaded and load filters accordingly |
|
| 92 | - EED_Events_Archive::instance()->template_include('loop-espresso_events.php'); |
|
| 93 | - // load our template |
|
| 94 | - $event_list = EEH_Template::locate_template( |
|
| 95 | - 'loop-espresso_events.php', |
|
| 96 | - array(), |
|
| 97 | - true, |
|
| 98 | - true |
|
| 99 | - ); |
|
| 100 | - // now reset the query and post data |
|
| 101 | - wp_reset_query(); |
|
| 102 | - wp_reset_postdata(); |
|
| 103 | - EED_Events_Archive::remove_all_events_archive_filters(); |
|
| 104 | - // remove query filters |
|
| 105 | - remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true'); |
|
| 106 | - // pull our content from the output buffer and return it |
|
| 107 | - return $event_list; |
|
| 108 | - } |
|
| 70 | + /** |
|
| 71 | + * callback that runs when the shortcode is encountered in post content. |
|
| 72 | + * IMPORTANT !!! |
|
| 73 | + * remember that shortcode content should be RETURNED and NOT echoed out |
|
| 74 | + * |
|
| 75 | + * @param array $attributes |
|
| 76 | + * @return string |
|
| 77 | + */ |
|
| 78 | + public function processShortcode($attributes = array()) |
|
| 79 | + { |
|
| 80 | + // grab attributes and merge with defaults |
|
| 81 | + $attributes = $this->getAttributes($attributes); |
|
| 82 | + // make sure we use the_excerpt() |
|
| 83 | + add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true'); |
|
| 84 | + // apply query filters |
|
| 85 | + add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true'); |
|
| 86 | + // run the query |
|
| 87 | + global $wp_query; |
|
| 88 | + // yes we have to overwrite the main wp query, but it's ok... |
|
| 89 | + // we're going to reset it again below, so everything will be Hunky Dory (amazing album) |
|
| 90 | + $wp_query = new EventListQuery($attributes); |
|
| 91 | + // check what template is loaded and load filters accordingly |
|
| 92 | + EED_Events_Archive::instance()->template_include('loop-espresso_events.php'); |
|
| 93 | + // load our template |
|
| 94 | + $event_list = EEH_Template::locate_template( |
|
| 95 | + 'loop-espresso_events.php', |
|
| 96 | + array(), |
|
| 97 | + true, |
|
| 98 | + true |
|
| 99 | + ); |
|
| 100 | + // now reset the query and post data |
|
| 101 | + wp_reset_query(); |
|
| 102 | + wp_reset_postdata(); |
|
| 103 | + EED_Events_Archive::remove_all_events_archive_filters(); |
|
| 104 | + // remove query filters |
|
| 105 | + remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true'); |
|
| 106 | + // pull our content from the output buffer and return it |
|
| 107 | + return $event_list; |
|
| 108 | + } |
|
| 109 | 109 | |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * merge incoming attributes with filtered defaults |
|
| 113 | - * |
|
| 114 | - * @param array $attributes |
|
| 115 | - * @return array |
|
| 116 | - */ |
|
| 117 | - private function getAttributes(array $attributes) |
|
| 118 | - { |
|
| 119 | - return array_merge( |
|
| 120 | - (array) apply_filters( |
|
| 121 | - 'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts', |
|
| 122 | - array( |
|
| 123 | - 'title' => '', |
|
| 124 | - 'limit' => 10, |
|
| 125 | - 'css_class' => '', |
|
| 126 | - 'show_expired' => false, |
|
| 127 | - 'month' => '', |
|
| 128 | - 'category_slug' => '', |
|
| 129 | - 'order_by' => 'start_date', |
|
| 130 | - 'sort' => 'ASC', |
|
| 131 | - 'show_title' => true, |
|
| 132 | - ) |
|
| 133 | - ), |
|
| 134 | - $attributes |
|
| 135 | - ); |
|
| 136 | - } |
|
| 111 | + /** |
|
| 112 | + * merge incoming attributes with filtered defaults |
|
| 113 | + * |
|
| 114 | + * @param array $attributes |
|
| 115 | + * @return array |
|
| 116 | + */ |
|
| 117 | + private function getAttributes(array $attributes) |
|
| 118 | + { |
|
| 119 | + return array_merge( |
|
| 120 | + (array) apply_filters( |
|
| 121 | + 'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts', |
|
| 122 | + array( |
|
| 123 | + 'title' => '', |
|
| 124 | + 'limit' => 10, |
|
| 125 | + 'css_class' => '', |
|
| 126 | + 'show_expired' => false, |
|
| 127 | + 'month' => '', |
|
| 128 | + 'category_slug' => '', |
|
| 129 | + 'order_by' => 'start_date', |
|
| 130 | + 'sort' => 'ASC', |
|
| 131 | + 'show_title' => true, |
|
| 132 | + ) |
|
| 133 | + ), |
|
| 134 | + $attributes |
|
| 135 | + ); |
|
| 136 | + } |
|
| 137 | 137 | |
| 138 | 138 | |
| 139 | - /** |
|
| 140 | - * array for defining custom attribute sanitization callbacks, |
|
| 141 | - * where keys match keys in your attributes array, |
|
| 142 | - * and values represent the sanitization function you wish to be applied to that attribute. |
|
| 143 | - * So for example, if you had an integer attribute named "event_id" |
|
| 144 | - * that you wanted to be sanitized using absint(), |
|
| 145 | - * then you would pass the following for your $custom_sanitization array: |
|
| 146 | - * array('event_id' => 'absint') |
|
| 147 | - * |
|
| 148 | - * @return array |
|
| 149 | - */ |
|
| 150 | - protected function customAttributeSanitizationMap() |
|
| 151 | - { |
|
| 152 | - // the following get sanitized/whitelisted in EEH_Event_Query |
|
| 153 | - return array( |
|
| 154 | - 'category_slug' => 'skip_sanitization', |
|
| 155 | - 'show_expired' => 'skip_sanitization', |
|
| 156 | - 'order_by' => 'skip_sanitization', |
|
| 157 | - 'month' => 'skip_sanitization', |
|
| 158 | - 'sort' => 'skip_sanitization', |
|
| 159 | - ); |
|
| 160 | - } |
|
| 139 | + /** |
|
| 140 | + * array for defining custom attribute sanitization callbacks, |
|
| 141 | + * where keys match keys in your attributes array, |
|
| 142 | + * and values represent the sanitization function you wish to be applied to that attribute. |
|
| 143 | + * So for example, if you had an integer attribute named "event_id" |
|
| 144 | + * that you wanted to be sanitized using absint(), |
|
| 145 | + * then you would pass the following for your $custom_sanitization array: |
|
| 146 | + * array('event_id' => 'absint') |
|
| 147 | + * |
|
| 148 | + * @return array |
|
| 149 | + */ |
|
| 150 | + protected function customAttributeSanitizationMap() |
|
| 151 | + { |
|
| 152 | + // the following get sanitized/whitelisted in EEH_Event_Query |
|
| 153 | + return array( |
|
| 154 | + 'category_slug' => 'skip_sanitization', |
|
| 155 | + 'show_expired' => 'skip_sanitization', |
|
| 156 | + 'order_by' => 'skip_sanitization', |
|
| 157 | + 'month' => 'skip_sanitization', |
|
| 158 | + 'sort' => 'skip_sanitization', |
|
| 159 | + ); |
|
| 160 | + } |
|
| 161 | 161 | } |
@@ -20,78 +20,78 @@ |
||
| 20 | 20 | { |
| 21 | 21 | |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * the actual shortcode tag that gets registered with WordPress |
|
| 25 | - * |
|
| 26 | - * @return string |
|
| 27 | - */ |
|
| 28 | - public function getTag() |
|
| 29 | - { |
|
| 30 | - return 'ESPRESSO_CANCELLED'; |
|
| 31 | - } |
|
| 23 | + /** |
|
| 24 | + * the actual shortcode tag that gets registered with WordPress |
|
| 25 | + * |
|
| 26 | + * @return string |
|
| 27 | + */ |
|
| 28 | + public function getTag() |
|
| 29 | + { |
|
| 30 | + return 'ESPRESSO_CANCELLED'; |
|
| 31 | + } |
|
| 32 | 32 | |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * the time in seconds to cache the results of the processShortcode() method |
|
| 36 | - * 0 means the processShortcode() results will NOT be cached at all |
|
| 37 | - * |
|
| 38 | - * @return int |
|
| 39 | - */ |
|
| 40 | - public function cacheExpiration() |
|
| 41 | - { |
|
| 42 | - return 0; |
|
| 43 | - } |
|
| 34 | + /** |
|
| 35 | + * the time in seconds to cache the results of the processShortcode() method |
|
| 36 | + * 0 means the processShortcode() results will NOT be cached at all |
|
| 37 | + * |
|
| 38 | + * @return int |
|
| 39 | + */ |
|
| 40 | + public function cacheExpiration() |
|
| 41 | + { |
|
| 42 | + return 0; |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * a place for adding any initialization code that needs to run prior to wp_header(). |
|
| 48 | - * this may be required for shortcodes that utilize a corresponding module, |
|
| 49 | - * and need to enqueue assets for that module |
|
| 50 | - * |
|
| 51 | - * @return void |
|
| 52 | - */ |
|
| 53 | - public function initializeShortcode() |
|
| 54 | - { |
|
| 55 | - $this->shortcodeHasBeenInitialized(); |
|
| 56 | - } |
|
| 46 | + /** |
|
| 47 | + * a place for adding any initialization code that needs to run prior to wp_header(). |
|
| 48 | + * this may be required for shortcodes that utilize a corresponding module, |
|
| 49 | + * and need to enqueue assets for that module |
|
| 50 | + * |
|
| 51 | + * @return void |
|
| 52 | + */ |
|
| 53 | + public function initializeShortcode() |
|
| 54 | + { |
|
| 55 | + $this->shortcodeHasBeenInitialized(); |
|
| 56 | + } |
|
| 57 | 57 | |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * callback that runs when the shortcode is encountered in post content. |
|
| 61 | - * IMPORTANT !!! |
|
| 62 | - * remember that shortcode content should be RETURNED and NOT echoed out |
|
| 63 | - * |
|
| 64 | - * @param array $attributes |
|
| 65 | - * @return string |
|
| 66 | - * @throws \EE_Error |
|
| 67 | - */ |
|
| 68 | - public function processShortcode($attributes = array()) |
|
| 69 | - { |
|
| 70 | - $transaction = EE_Registry::instance()->SSN->get_session_data('transaction'); |
|
| 71 | - if ($transaction instanceof EE_Transaction) { |
|
| 72 | - do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction); |
|
| 73 | - $registrations = $transaction->registrations(); |
|
| 74 | - foreach ($registrations as $registration) { |
|
| 75 | - if ($registration instanceof EE_Registration) { |
|
| 76 | - do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration); |
|
| 77 | - } |
|
| 78 | - } |
|
| 79 | - } |
|
| 80 | - do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session'); |
|
| 81 | - // remove all unwanted records from the db |
|
| 82 | - if (EE_Registry::instance()->CART instanceof EE_Cart) { |
|
| 83 | - EE_Registry::instance()->CART->delete_cart(); |
|
| 84 | - } |
|
| 85 | - // phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText |
|
| 86 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 87 | - return sprintf( |
|
| 88 | - __( |
|
| 89 | - '%sAll unsaved registration information entered during this session has been deleted.%s', |
|
| 90 | - 'event_espresso' |
|
| 91 | - ), |
|
| 92 | - '<p class="ee-registrations-cancelled-pg ee-attention">', |
|
| 93 | - '</p>' |
|
| 94 | - ); |
|
| 95 | - // phpcs:enable |
|
| 96 | - } |
|
| 59 | + /** |
|
| 60 | + * callback that runs when the shortcode is encountered in post content. |
|
| 61 | + * IMPORTANT !!! |
|
| 62 | + * remember that shortcode content should be RETURNED and NOT echoed out |
|
| 63 | + * |
|
| 64 | + * @param array $attributes |
|
| 65 | + * @return string |
|
| 66 | + * @throws \EE_Error |
|
| 67 | + */ |
|
| 68 | + public function processShortcode($attributes = array()) |
|
| 69 | + { |
|
| 70 | + $transaction = EE_Registry::instance()->SSN->get_session_data('transaction'); |
|
| 71 | + if ($transaction instanceof EE_Transaction) { |
|
| 72 | + do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction); |
|
| 73 | + $registrations = $transaction->registrations(); |
|
| 74 | + foreach ($registrations as $registration) { |
|
| 75 | + if ($registration instanceof EE_Registration) { |
|
| 76 | + do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration); |
|
| 77 | + } |
|
| 78 | + } |
|
| 79 | + } |
|
| 80 | + do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session'); |
|
| 81 | + // remove all unwanted records from the db |
|
| 82 | + if (EE_Registry::instance()->CART instanceof EE_Cart) { |
|
| 83 | + EE_Registry::instance()->CART->delete_cart(); |
|
| 84 | + } |
|
| 85 | + // phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText |
|
| 86 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 87 | + return sprintf( |
|
| 88 | + __( |
|
| 89 | + '%sAll unsaved registration information entered during this session has been deleted.%s', |
|
| 90 | + 'event_espresso' |
|
| 91 | + ), |
|
| 92 | + '<p class="ee-registrations-cancelled-pg ee-attention">', |
|
| 93 | + '</p>' |
|
| 94 | + ); |
|
| 95 | + // phpcs:enable |
|
| 96 | + } |
|
| 97 | 97 | } |
@@ -12,205 +12,205 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class GenericAddress implements \EEI_Address |
| 14 | 14 | { |
| 15 | - // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore |
|
| 16 | - private $_address = ''; |
|
| 17 | - |
|
| 18 | - private $_address2 = ''; |
|
| 19 | - |
|
| 20 | - private $_city = ''; |
|
| 21 | - |
|
| 22 | - private $_state_ID = ''; |
|
| 23 | - |
|
| 24 | - private $_state_obj = ''; |
|
| 25 | - |
|
| 26 | - private $_zip = ''; |
|
| 27 | - |
|
| 28 | - private $_country_ID = ''; |
|
| 29 | - |
|
| 30 | - private $_country_obj = ''; |
|
| 31 | - // phpcs:enable |
|
| 32 | - |
|
| 33 | - // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore |
|
| 34 | - /** |
|
| 35 | - * @param string $address |
|
| 36 | - * @param string $address2 |
|
| 37 | - * @param string $city |
|
| 38 | - * @param \EE_State | string $state |
|
| 39 | - * @param string $zip |
|
| 40 | - * @param \EE_Country | string $country |
|
| 41 | - * @return GenericAddress |
|
| 42 | - */ |
|
| 43 | - public function __construct($address, $address2, $city, $state, $zip, $country) |
|
| 44 | - { |
|
| 45 | - $this->_address = $address; |
|
| 46 | - $this->_address2 = $address2; |
|
| 47 | - $this->_city = $city; |
|
| 48 | - if ($state instanceof \EE_State) { |
|
| 49 | - $this->_state_obj = $state; |
|
| 50 | - } else { |
|
| 51 | - $this->_state_ID = $state; |
|
| 52 | - $this->_state_obj = $this->_get_state_obj(); |
|
| 53 | - } |
|
| 54 | - $this->_zip = $zip; |
|
| 55 | - if ($country instanceof \EE_Country) { |
|
| 56 | - $this->_country_obj = $country; |
|
| 57 | - } else { |
|
| 58 | - $this->_country_ID = $country; |
|
| 59 | - $this->_country_obj = $this->_get_country_obj(); |
|
| 60 | - } |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * @return string |
|
| 66 | - */ |
|
| 67 | - public function address() |
|
| 68 | - { |
|
| 69 | - return $this->_address; |
|
| 70 | - } |
|
| 71 | - |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * @return string |
|
| 75 | - */ |
|
| 76 | - public function address2() |
|
| 77 | - { |
|
| 78 | - return $this->_address2; |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * @return string |
|
| 84 | - */ |
|
| 85 | - public function city() |
|
| 86 | - { |
|
| 87 | - return $this->_city; |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * @return \EE_State |
|
| 94 | - */ |
|
| 95 | - private function _get_state_obj() |
|
| 96 | - { |
|
| 97 | - return $this->_state_obj instanceof \EE_State |
|
| 98 | - ? $this->_state_obj |
|
| 99 | - : \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID); |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * @return string |
|
| 105 | - */ |
|
| 106 | - public function state_ID() |
|
| 107 | - { |
|
| 108 | - return $this->_state_ID; |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - |
|
| 112 | - /** |
|
| 113 | - * @return string |
|
| 114 | - */ |
|
| 115 | - public function state_abbrev() |
|
| 116 | - { |
|
| 117 | - return $this->state_obj() instanceof \EE_State |
|
| 118 | - ? $this->state_obj()->abbrev() |
|
| 119 | - : ''; |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * @return string |
|
| 125 | - */ |
|
| 126 | - public function state_name() |
|
| 127 | - { |
|
| 128 | - return $this->state_obj() instanceof \EE_State |
|
| 129 | - ? $this->state_obj()->name() |
|
| 130 | - : ''; |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * @return \EE_State |
|
| 136 | - */ |
|
| 137 | - public function state_obj() |
|
| 138 | - { |
|
| 139 | - return $this->_state_obj; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * @return string |
|
| 145 | - */ |
|
| 146 | - public function state() |
|
| 147 | - { |
|
| 148 | - if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) { |
|
| 149 | - return $this->state_obj()->abbrev(); |
|
| 150 | - } else { |
|
| 151 | - return $this->state_name(); |
|
| 152 | - } |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * @return \EE_Country |
|
| 158 | - */ |
|
| 159 | - private function _get_country_obj() |
|
| 160 | - { |
|
| 161 | - return $this->_country_obj instanceof \EE_Country |
|
| 162 | - ? $this->_country_obj |
|
| 163 | - : \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID); |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - |
|
| 167 | - /** |
|
| 168 | - * @return string |
|
| 169 | - */ |
|
| 170 | - public function country_ID() |
|
| 171 | - { |
|
| 172 | - return $this->_country_ID; |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - |
|
| 176 | - /** |
|
| 177 | - * @return string |
|
| 178 | - */ |
|
| 179 | - public function country_name() |
|
| 180 | - { |
|
| 181 | - return $this->country_obj() instanceof \EE_Country |
|
| 182 | - ? $this->country_obj()->name() |
|
| 183 | - : ''; |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - |
|
| 187 | - /** |
|
| 188 | - * @return \EE_Country |
|
| 189 | - */ |
|
| 190 | - public function country_obj() |
|
| 191 | - { |
|
| 192 | - return $this->_country_obj; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - |
|
| 196 | - /** |
|
| 197 | - * @return string |
|
| 198 | - */ |
|
| 199 | - public function country() |
|
| 200 | - { |
|
| 201 | - if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) { |
|
| 202 | - return $this->country_ID(); |
|
| 203 | - } else { |
|
| 204 | - return $this->country_name(); |
|
| 205 | - } |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * @return string |
|
| 211 | - */ |
|
| 212 | - public function zip() |
|
| 213 | - { |
|
| 214 | - return $this->_zip; |
|
| 215 | - } |
|
| 15 | + // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore |
|
| 16 | + private $_address = ''; |
|
| 17 | + |
|
| 18 | + private $_address2 = ''; |
|
| 19 | + |
|
| 20 | + private $_city = ''; |
|
| 21 | + |
|
| 22 | + private $_state_ID = ''; |
|
| 23 | + |
|
| 24 | + private $_state_obj = ''; |
|
| 25 | + |
|
| 26 | + private $_zip = ''; |
|
| 27 | + |
|
| 28 | + private $_country_ID = ''; |
|
| 29 | + |
|
| 30 | + private $_country_obj = ''; |
|
| 31 | + // phpcs:enable |
|
| 32 | + |
|
| 33 | + // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore |
|
| 34 | + /** |
|
| 35 | + * @param string $address |
|
| 36 | + * @param string $address2 |
|
| 37 | + * @param string $city |
|
| 38 | + * @param \EE_State | string $state |
|
| 39 | + * @param string $zip |
|
| 40 | + * @param \EE_Country | string $country |
|
| 41 | + * @return GenericAddress |
|
| 42 | + */ |
|
| 43 | + public function __construct($address, $address2, $city, $state, $zip, $country) |
|
| 44 | + { |
|
| 45 | + $this->_address = $address; |
|
| 46 | + $this->_address2 = $address2; |
|
| 47 | + $this->_city = $city; |
|
| 48 | + if ($state instanceof \EE_State) { |
|
| 49 | + $this->_state_obj = $state; |
|
| 50 | + } else { |
|
| 51 | + $this->_state_ID = $state; |
|
| 52 | + $this->_state_obj = $this->_get_state_obj(); |
|
| 53 | + } |
|
| 54 | + $this->_zip = $zip; |
|
| 55 | + if ($country instanceof \EE_Country) { |
|
| 56 | + $this->_country_obj = $country; |
|
| 57 | + } else { |
|
| 58 | + $this->_country_ID = $country; |
|
| 59 | + $this->_country_obj = $this->_get_country_obj(); |
|
| 60 | + } |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * @return string |
|
| 66 | + */ |
|
| 67 | + public function address() |
|
| 68 | + { |
|
| 69 | + return $this->_address; |
|
| 70 | + } |
|
| 71 | + |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * @return string |
|
| 75 | + */ |
|
| 76 | + public function address2() |
|
| 77 | + { |
|
| 78 | + return $this->_address2; |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * @return string |
|
| 84 | + */ |
|
| 85 | + public function city() |
|
| 86 | + { |
|
| 87 | + return $this->_city; |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * @return \EE_State |
|
| 94 | + */ |
|
| 95 | + private function _get_state_obj() |
|
| 96 | + { |
|
| 97 | + return $this->_state_obj instanceof \EE_State |
|
| 98 | + ? $this->_state_obj |
|
| 99 | + : \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID); |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * @return string |
|
| 105 | + */ |
|
| 106 | + public function state_ID() |
|
| 107 | + { |
|
| 108 | + return $this->_state_ID; |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + |
|
| 112 | + /** |
|
| 113 | + * @return string |
|
| 114 | + */ |
|
| 115 | + public function state_abbrev() |
|
| 116 | + { |
|
| 117 | + return $this->state_obj() instanceof \EE_State |
|
| 118 | + ? $this->state_obj()->abbrev() |
|
| 119 | + : ''; |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * @return string |
|
| 125 | + */ |
|
| 126 | + public function state_name() |
|
| 127 | + { |
|
| 128 | + return $this->state_obj() instanceof \EE_State |
|
| 129 | + ? $this->state_obj()->name() |
|
| 130 | + : ''; |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * @return \EE_State |
|
| 136 | + */ |
|
| 137 | + public function state_obj() |
|
| 138 | + { |
|
| 139 | + return $this->_state_obj; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * @return string |
|
| 145 | + */ |
|
| 146 | + public function state() |
|
| 147 | + { |
|
| 148 | + if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) { |
|
| 149 | + return $this->state_obj()->abbrev(); |
|
| 150 | + } else { |
|
| 151 | + return $this->state_name(); |
|
| 152 | + } |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * @return \EE_Country |
|
| 158 | + */ |
|
| 159 | + private function _get_country_obj() |
|
| 160 | + { |
|
| 161 | + return $this->_country_obj instanceof \EE_Country |
|
| 162 | + ? $this->_country_obj |
|
| 163 | + : \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID); |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + |
|
| 167 | + /** |
|
| 168 | + * @return string |
|
| 169 | + */ |
|
| 170 | + public function country_ID() |
|
| 171 | + { |
|
| 172 | + return $this->_country_ID; |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + |
|
| 176 | + /** |
|
| 177 | + * @return string |
|
| 178 | + */ |
|
| 179 | + public function country_name() |
|
| 180 | + { |
|
| 181 | + return $this->country_obj() instanceof \EE_Country |
|
| 182 | + ? $this->country_obj()->name() |
|
| 183 | + : ''; |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + |
|
| 187 | + /** |
|
| 188 | + * @return \EE_Country |
|
| 189 | + */ |
|
| 190 | + public function country_obj() |
|
| 191 | + { |
|
| 192 | + return $this->_country_obj; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + |
|
| 196 | + /** |
|
| 197 | + * @return string |
|
| 198 | + */ |
|
| 199 | + public function country() |
|
| 200 | + { |
|
| 201 | + if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) { |
|
| 202 | + return $this->country_ID(); |
|
| 203 | + } else { |
|
| 204 | + return $this->country_name(); |
|
| 205 | + } |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * @return string |
|
| 211 | + */ |
|
| 212 | + public function zip() |
|
| 213 | + { |
|
| 214 | + return $this->_zip; |
|
| 215 | + } |
|
| 216 | 216 | } |
