@@ -58,13 +58,13 @@ discard block |
||
| 58 | 58 | EEH_Array::is_associative_array($item_in_top_level_array)) { |
| 59 | 59 | // its associative, so we want to output its keys as column headers |
| 60 | 60 | $keys = array_keys($item_in_top_level_array); |
| 61 | - $new_file_contents .= EEH_Export::get_csv_row($keys); |
|
| 61 | + $new_file_contents .= EEH_Export::get_csv_row($keys); |
|
| 62 | 62 | } |
| 63 | 63 | // start writing data |
| 64 | 64 | foreach ($data as $data_row) { |
| 65 | 65 | $new_file_contents .= EEH_Export::get_csv_row($data_row); |
| 66 | 66 | } |
| 67 | - return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents); |
|
| 67 | + return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath).$new_file_contents); |
|
| 68 | 68 | } else { |
| 69 | 69 | // no data TO write... so we can assume that's a success |
| 70 | 70 | return true; |
@@ -102,10 +102,10 @@ discard block |
||
| 102 | 102 | } |
| 103 | 103 | |
| 104 | 104 | $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ? |
| 105 | - ( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value; |
|
| 105 | + ($enclosure.str_replace($enclosure, $enclosure.$enclosure, $field_value).$enclosure) : $field_value; |
|
| 106 | 106 | } |
| 107 | 107 | |
| 108 | - return implode($delimiter, $output) . PHP_EOL; |
|
| 108 | + return implode($delimiter, $output).PHP_EOL; |
|
| 109 | 109 | } |
| 110 | 110 | |
| 111 | 111 | |
@@ -12,161 +12,161 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class EEH_Export |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Gets the 'normal' column named for fields |
|
| 17 | - * @param EE_Model_Field_Base $field |
|
| 18 | - * @return string |
|
| 19 | - * @throws EE_Error |
|
| 20 | - */ |
|
| 21 | - public static function get_column_name_for_field(EE_Model_Field_Base $field) |
|
| 22 | - { |
|
| 23 | - $column_name = wp_specialchars_decode($field->get_nicename(), ENT_QUOTES); |
|
| 24 | - if (apply_filters( |
|
| 25 | - 'FHEE__EEH_Export__get_column_name_for_field__add_field_name', |
|
| 26 | - false, |
|
| 27 | - $column_name, |
|
| 28 | - $field |
|
| 29 | - )) { |
|
| 30 | - $column_name .= "[" |
|
| 31 | - . wp_specialchars_decode($field->get_name(), ENT_QUOTES) |
|
| 32 | - . "]"; |
|
| 33 | - } |
|
| 34 | - return $column_name; |
|
| 35 | - } |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers |
|
| 39 | - * |
|
| 40 | - * @param string $filepath |
|
| 41 | - * @param array $data 2D array, first numerically-indexed, |
|
| 42 | - * and next-level-down preferably indexed by string |
|
| 43 | - * @param boolean $write_column_headers whether or not we should add the keys in the bottom-most array |
|
| 44 | - * as a row for headers in the CSV. |
|
| 45 | - * Eg, if $data looked like: |
|
| 46 | - * array( |
|
| 47 | - * 0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), |
|
| 48 | - * 1=>array(...,...) |
|
| 49 | - * ) |
|
| 50 | - * |
|
| 51 | - * @return boolean if we successfully wrote to the CSV or not. If there's no $data, |
|
| 52 | - * we consider that a success (because we wrote everything there was...nothing) |
|
| 53 | - * @throws EE_Error |
|
| 54 | - */ |
|
| 55 | - public static function write_data_array_to_csv($filepath, $data, $write_column_headers = true) |
|
| 56 | - { |
|
| 57 | - |
|
| 58 | - $new_file_contents = ''; |
|
| 59 | - // determine if $data is actually a 2d array |
|
| 60 | - if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) { |
|
| 61 | - // make sure top level is numerically indexed, |
|
| 62 | - |
|
| 63 | - if (EEH_Array::is_associative_array($data)) { |
|
| 64 | - throw new EE_Error(sprintf(__("top-level array must be numerically indexed. Does these look like numbers to you? %s", "event_espresso"), implode(",", array_keys($data)))); |
|
| 65 | - } |
|
| 66 | - $item_in_top_level_array = EEH_Array::get_one_item_from_array($data); |
|
| 67 | - // now, is the last item in the top-level array of $data an associative or numeric array? |
|
| 68 | - if ($write_column_headers && |
|
| 69 | - EEH_Array::is_associative_array($item_in_top_level_array)) { |
|
| 70 | - // its associative, so we want to output its keys as column headers |
|
| 71 | - $keys = array_keys($item_in_top_level_array); |
|
| 72 | - $new_file_contents .= EEH_Export::get_csv_row($keys); |
|
| 73 | - } |
|
| 74 | - // start writing data |
|
| 75 | - foreach ($data as $data_row) { |
|
| 76 | - $new_file_contents .= EEH_Export::get_csv_row($data_row); |
|
| 77 | - } |
|
| 78 | - return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents); |
|
| 79 | - } else { |
|
| 80 | - // no data TO write... so we can assume that's a success |
|
| 81 | - return true; |
|
| 82 | - } |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * |
|
| 89 | - * Writes a row to the csv file |
|
| 90 | - * @param array $row - individual row of csv data |
|
| 91 | - * @param string $delimiter - csv delimiter |
|
| 92 | - * @param string $enclosure - csv enclosure |
|
| 93 | - * @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value |
|
| 94 | - * @return string of text for teh csv file |
|
| 95 | - */ |
|
| 96 | - public static function get_csv_row(array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false) |
|
| 97 | - { |
|
| 98 | - // Allow user to filter the csv delimiter and enclosure for other countries csv standards |
|
| 99 | - $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter); |
|
| 100 | - $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure); |
|
| 101 | - |
|
| 102 | - $delimiter_esc = preg_quote($delimiter, '/'); |
|
| 103 | - $enclosure_esc = preg_quote($enclosure, '/'); |
|
| 104 | - |
|
| 105 | - $output = array(); |
|
| 106 | - foreach ($row as $field_value) { |
|
| 107 | - if (is_object($field_value) || is_array($field_value)) { |
|
| 108 | - $field_value = serialize($field_value); |
|
| 109 | - } |
|
| 110 | - if ($field_value === null && $mysql_null) { |
|
| 111 | - $output[] = 'NULL'; |
|
| 112 | - continue; |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ? |
|
| 116 | - ( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value; |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - return implode($delimiter, $output) . PHP_EOL; |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * Shortcut for preparing a database result for display |
|
| 126 | - * @param EEM_Base $model |
|
| 127 | - * @param string $field_name |
|
| 128 | - * @param string $raw_db_value |
|
| 129 | - * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to NOT display pretty |
|
| 130 | - * @return string |
|
| 131 | - */ |
|
| 132 | - public static function prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true) |
|
| 133 | - { |
|
| 134 | - $field_obj = $model->field_settings_for($field_name); |
|
| 135 | - $value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value); |
|
| 136 | - if ($field_obj instanceof EE_Datetime_Field) { |
|
| 137 | - $field_obj->set_date_format(EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)), $pretty_schema); |
|
| 138 | - $field_obj->set_time_format(EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)), $pretty_schema); |
|
| 139 | - } |
|
| 140 | - if ($pretty_schema === true) { |
|
| 141 | - return $field_obj->prepare_for_pretty_echoing($value_on_model_obj); |
|
| 142 | - } elseif (is_string($pretty_schema)) { |
|
| 143 | - return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema); |
|
| 144 | - } else { |
|
| 145 | - return $field_obj->prepare_for_get($value_on_model_obj); |
|
| 146 | - } |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - |
|
| 150 | - |
|
| 151 | - /** |
|
| 152 | - * Gets the date format to use in exports. filterable |
|
| 153 | - * @param string $current_format |
|
| 154 | - * @return string |
|
| 155 | - */ |
|
| 156 | - public static function get_date_format_for_export($current_format = null) |
|
| 157 | - { |
|
| 158 | - return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format); |
|
| 159 | - } |
|
| 160 | - |
|
| 161 | - |
|
| 162 | - |
|
| 163 | - /** |
|
| 164 | - * Gets the time format we want to use in exports. Filterable |
|
| 165 | - * @param string $current_format |
|
| 166 | - * @return string |
|
| 167 | - */ |
|
| 168 | - public static function get_time_format_for_export($current_format = null) |
|
| 169 | - { |
|
| 170 | - return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format); |
|
| 171 | - } |
|
| 15 | + /** |
|
| 16 | + * Gets the 'normal' column named for fields |
|
| 17 | + * @param EE_Model_Field_Base $field |
|
| 18 | + * @return string |
|
| 19 | + * @throws EE_Error |
|
| 20 | + */ |
|
| 21 | + public static function get_column_name_for_field(EE_Model_Field_Base $field) |
|
| 22 | + { |
|
| 23 | + $column_name = wp_specialchars_decode($field->get_nicename(), ENT_QUOTES); |
|
| 24 | + if (apply_filters( |
|
| 25 | + 'FHEE__EEH_Export__get_column_name_for_field__add_field_name', |
|
| 26 | + false, |
|
| 27 | + $column_name, |
|
| 28 | + $field |
|
| 29 | + )) { |
|
| 30 | + $column_name .= "[" |
|
| 31 | + . wp_specialchars_decode($field->get_name(), ENT_QUOTES) |
|
| 32 | + . "]"; |
|
| 33 | + } |
|
| 34 | + return $column_name; |
|
| 35 | + } |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers |
|
| 39 | + * |
|
| 40 | + * @param string $filepath |
|
| 41 | + * @param array $data 2D array, first numerically-indexed, |
|
| 42 | + * and next-level-down preferably indexed by string |
|
| 43 | + * @param boolean $write_column_headers whether or not we should add the keys in the bottom-most array |
|
| 44 | + * as a row for headers in the CSV. |
|
| 45 | + * Eg, if $data looked like: |
|
| 46 | + * array( |
|
| 47 | + * 0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), |
|
| 48 | + * 1=>array(...,...) |
|
| 49 | + * ) |
|
| 50 | + * |
|
| 51 | + * @return boolean if we successfully wrote to the CSV or not. If there's no $data, |
|
| 52 | + * we consider that a success (because we wrote everything there was...nothing) |
|
| 53 | + * @throws EE_Error |
|
| 54 | + */ |
|
| 55 | + public static function write_data_array_to_csv($filepath, $data, $write_column_headers = true) |
|
| 56 | + { |
|
| 57 | + |
|
| 58 | + $new_file_contents = ''; |
|
| 59 | + // determine if $data is actually a 2d array |
|
| 60 | + if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) { |
|
| 61 | + // make sure top level is numerically indexed, |
|
| 62 | + |
|
| 63 | + if (EEH_Array::is_associative_array($data)) { |
|
| 64 | + throw new EE_Error(sprintf(__("top-level array must be numerically indexed. Does these look like numbers to you? %s", "event_espresso"), implode(",", array_keys($data)))); |
|
| 65 | + } |
|
| 66 | + $item_in_top_level_array = EEH_Array::get_one_item_from_array($data); |
|
| 67 | + // now, is the last item in the top-level array of $data an associative or numeric array? |
|
| 68 | + if ($write_column_headers && |
|
| 69 | + EEH_Array::is_associative_array($item_in_top_level_array)) { |
|
| 70 | + // its associative, so we want to output its keys as column headers |
|
| 71 | + $keys = array_keys($item_in_top_level_array); |
|
| 72 | + $new_file_contents .= EEH_Export::get_csv_row($keys); |
|
| 73 | + } |
|
| 74 | + // start writing data |
|
| 75 | + foreach ($data as $data_row) { |
|
| 76 | + $new_file_contents .= EEH_Export::get_csv_row($data_row); |
|
| 77 | + } |
|
| 78 | + return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents); |
|
| 79 | + } else { |
|
| 80 | + // no data TO write... so we can assume that's a success |
|
| 81 | + return true; |
|
| 82 | + } |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * |
|
| 89 | + * Writes a row to the csv file |
|
| 90 | + * @param array $row - individual row of csv data |
|
| 91 | + * @param string $delimiter - csv delimiter |
|
| 92 | + * @param string $enclosure - csv enclosure |
|
| 93 | + * @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value |
|
| 94 | + * @return string of text for teh csv file |
|
| 95 | + */ |
|
| 96 | + public static function get_csv_row(array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false) |
|
| 97 | + { |
|
| 98 | + // Allow user to filter the csv delimiter and enclosure for other countries csv standards |
|
| 99 | + $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter); |
|
| 100 | + $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure); |
|
| 101 | + |
|
| 102 | + $delimiter_esc = preg_quote($delimiter, '/'); |
|
| 103 | + $enclosure_esc = preg_quote($enclosure, '/'); |
|
| 104 | + |
|
| 105 | + $output = array(); |
|
| 106 | + foreach ($row as $field_value) { |
|
| 107 | + if (is_object($field_value) || is_array($field_value)) { |
|
| 108 | + $field_value = serialize($field_value); |
|
| 109 | + } |
|
| 110 | + if ($field_value === null && $mysql_null) { |
|
| 111 | + $output[] = 'NULL'; |
|
| 112 | + continue; |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ? |
|
| 116 | + ( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value; |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + return implode($delimiter, $output) . PHP_EOL; |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * Shortcut for preparing a database result for display |
|
| 126 | + * @param EEM_Base $model |
|
| 127 | + * @param string $field_name |
|
| 128 | + * @param string $raw_db_value |
|
| 129 | + * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to NOT display pretty |
|
| 130 | + * @return string |
|
| 131 | + */ |
|
| 132 | + public static function prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true) |
|
| 133 | + { |
|
| 134 | + $field_obj = $model->field_settings_for($field_name); |
|
| 135 | + $value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value); |
|
| 136 | + if ($field_obj instanceof EE_Datetime_Field) { |
|
| 137 | + $field_obj->set_date_format(EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)), $pretty_schema); |
|
| 138 | + $field_obj->set_time_format(EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)), $pretty_schema); |
|
| 139 | + } |
|
| 140 | + if ($pretty_schema === true) { |
|
| 141 | + return $field_obj->prepare_for_pretty_echoing($value_on_model_obj); |
|
| 142 | + } elseif (is_string($pretty_schema)) { |
|
| 143 | + return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema); |
|
| 144 | + } else { |
|
| 145 | + return $field_obj->prepare_for_get($value_on_model_obj); |
|
| 146 | + } |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + |
|
| 150 | + |
|
| 151 | + /** |
|
| 152 | + * Gets the date format to use in exports. filterable |
|
| 153 | + * @param string $current_format |
|
| 154 | + * @return string |
|
| 155 | + */ |
|
| 156 | + public static function get_date_format_for_export($current_format = null) |
|
| 157 | + { |
|
| 158 | + return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format); |
|
| 159 | + } |
|
| 160 | + |
|
| 161 | + |
|
| 162 | + |
|
| 163 | + /** |
|
| 164 | + * Gets the time format we want to use in exports. Filterable |
|
| 165 | + * @param string $current_format |
|
| 166 | + * @return string |
|
| 167 | + */ |
|
| 168 | + public static function get_time_format_for_export($current_format = null) |
|
| 169 | + { |
|
| 170 | + return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format); |
|
| 171 | + } |
|
| 172 | 172 | } |
@@ -84,20 +84,20 @@ discard block |
||
| 84 | 84 | // loop thru and call doing_it_wrong() or remove any that aren't being used |
| 85 | 85 | foreach ($deprecated_filters as $deprecated_filter => $on) { |
| 86 | 86 | // was this filter called ? |
| 87 | - if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) { |
|
| 87 | + if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter)) { |
|
| 88 | 88 | // only display doing_it_wrong() notice to Event Admins during non-AJAX requests |
| 89 | 89 | if (EE_Registry::instance()->CAP->current_user_can( |
| 90 | 90 | 'ee_read_ee', |
| 91 | 91 | 'hide_doing_it_wrong_for_deprecated_SPCO_filter' |
| 92 | 92 | ) && ! defined('DOING_AJAX')) { |
| 93 | 93 | EE_Error::doing_it_wrong( |
| 94 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter, |
|
| 94 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter, |
|
| 95 | 95 | sprintf( |
| 96 | 96 | __( |
| 97 | 97 | 'The %1$s filter is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', |
| 98 | 98 | 'event_espresso' |
| 99 | 99 | ), |
| 100 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter, |
|
| 100 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter, |
|
| 101 | 101 | '<br />', |
| 102 | 102 | 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', |
| 103 | 103 | '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php' |
@@ -106,10 +106,10 @@ discard block |
||
| 106 | 106 | ); |
| 107 | 107 | } |
| 108 | 108 | } else { |
| 109 | - unset($deprecated_filters[ $deprecated_filter ]); |
|
| 109 | + unset($deprecated_filters[$deprecated_filter]); |
|
| 110 | 110 | } |
| 111 | 111 | } |
| 112 | - if (! empty($deprecated_filters)) { |
|
| 112 | + if ( ! empty($deprecated_filters)) { |
|
| 113 | 113 | |
| 114 | 114 | if ($checkout->current_step->slug( |
| 115 | 115 | ) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) { |
@@ -143,7 +143,7 @@ discard block |
||
| 143 | 143 | $submit_button_text = apply_filters( |
| 144 | 144 | 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', |
| 145 | 145 | $submit_button_text |
| 146 | - ) . $checkout->next_step->name(); |
|
| 146 | + ).$checkout->next_step->name(); |
|
| 147 | 147 | } |
| 148 | 148 | } |
| 149 | 149 | |
@@ -327,7 +327,7 @@ discard block |
||
| 327 | 327 | 'event_espresso' |
| 328 | 328 | ); |
| 329 | 329 | EE_Error::doing_it_wrong( |
| 330 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 330 | + __CLASS__.'::'.__FUNCTION__, |
|
| 331 | 331 | $msg, |
| 332 | 332 | '4.8.32.rc.000' |
| 333 | 333 | ); |
@@ -354,7 +354,7 @@ discard block |
||
| 354 | 354 | function ee_deprecated_update_attendee_registration_form_old($admin_page) |
| 355 | 355 | { |
| 356 | 356 | // check if the old hooks are in use. If not, do the default |
| 357 | - if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 357 | + if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 358 | 358 | || ! $admin_page instanceof EE_Admin_Page) { |
| 359 | 359 | return; |
| 360 | 360 | } |
@@ -362,7 +362,7 @@ discard block |
||
| 362 | 362 | $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false; |
| 363 | 363 | $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false; |
| 364 | 364 | $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns); |
| 365 | - if (! $REG_ID || ! $qstns) { |
|
| 365 | + if ( ! $REG_ID || ! $qstns) { |
|
| 366 | 366 | EE_Error::add_error( |
| 367 | 367 | __('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), |
| 368 | 368 | __FILE__, |
@@ -382,7 +382,7 @@ discard block |
||
| 382 | 382 | |
| 383 | 383 | foreach ($qstns as $QST_ID => $qstn) { |
| 384 | 384 | // if $qstn isn't an array then it doesn't already have an answer, so let's create the answer |
| 385 | - if (! is_array($qstn)) { |
|
| 385 | + if ( ! is_array($qstn)) { |
|
| 386 | 386 | $success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn); |
| 387 | 387 | continue; |
| 388 | 388 | } |
@@ -399,7 +399,7 @@ discard block |
||
| 399 | 399 | ); |
| 400 | 400 | $answer = EEM_Answer::instance()->get_one($query_params); |
| 401 | 401 | // this MAY be an array but NOT have an answer because its multi select. If so then we need to create the answer |
| 402 | - if (! $answer instanceof EE_Answer) { |
|
| 402 | + if ( ! $answer instanceof EE_Answer) { |
|
| 403 | 403 | $set_values = array( |
| 404 | 404 | 'QST_ID' => $QST_ID, |
| 405 | 405 | 'REG_ID' => $REG_ID, |
@@ -440,7 +440,7 @@ discard block |
||
| 440 | 440 | function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration) |
| 441 | 441 | { |
| 442 | 442 | // check if the old hooks are in use. If not, do the default |
| 443 | - if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 443 | + if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 444 | 444 | || ! $admin_page instanceof EE_Admin_Page) { |
| 445 | 445 | return $do_default_action; |
| 446 | 446 | } |
@@ -472,7 +472,7 @@ discard block |
||
| 472 | 472 | 'reg_questions_form_action' => 'edit_registration', |
| 473 | 473 | 'REG_ID' => $registration->ID(), |
| 474 | 474 | ); |
| 475 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 475 | + $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 476 | 476 | echo EEH_Template::display_template($template_path, $template_args, true); |
| 477 | 477 | // indicate that we should not do the default admin page code |
| 478 | 478 | return false; |
@@ -590,7 +590,7 @@ discard block |
||
| 590 | 590 | public function _class_is_deprecated($method) |
| 591 | 591 | { |
| 592 | 592 | EE_Error::doing_it_wrong( |
| 593 | - 'EE_messages::' . $method, |
|
| 593 | + 'EE_messages::'.$method, |
|
| 594 | 594 | __('EE_messages has been deprecated. Please use EE_Message_Resource_Manager instead.'), |
| 595 | 595 | '4.9.0', |
| 596 | 596 | '4.10.0.p' |
@@ -729,7 +729,7 @@ discard block |
||
| 729 | 729 | $error = false; |
| 730 | 730 | // try to intelligently determine what method we'll call based on the incoming data. |
| 731 | 731 | // if generating and sending are different then generate and send immediately. |
| 732 | - if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) { |
|
| 732 | + if ( ! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) { |
|
| 733 | 733 | // in the legacy system, when generating and sending were different, that means all the |
| 734 | 734 | // vars are already in the request object. So let's just use that. |
| 735 | 735 | try { |
@@ -742,7 +742,7 @@ discard block |
||
| 742 | 742 | 'event_espresso' |
| 743 | 743 | ); |
| 744 | 744 | // add specific message for developers if WP_DEBUG in on |
| 745 | - $error_msg .= '||' . $e->getMessage(); |
|
| 745 | + $error_msg .= '||'.$e->getMessage(); |
|
| 746 | 746 | EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
| 747 | 747 | $error = true; |
| 748 | 748 | } |
@@ -816,7 +816,7 @@ discard block |
||
| 816 | 816 | } |
| 817 | 817 | } |
| 818 | 818 | // if no error then return the generated message(s). |
| 819 | - if (! $error && ! $send) { |
|
| 819 | + if ( ! $error && ! $send) { |
|
| 820 | 820 | $generated_queue = $processor->generate_queue(false); |
| 821 | 821 | // get message and return. |
| 822 | 822 | $generated_queue->get_message_repository()->rewind(); |
@@ -875,7 +875,7 @@ discard block |
||
| 875 | 875 | /** @type EE_Messages_Queue $queue */ |
| 876 | 876 | $queue = EE_Registry::instance()->load_lib('Messages_Queue'); |
| 877 | 877 | // make sure we have a proper message object |
| 878 | - if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) { |
|
| 878 | + if ( ! $message instanceof EE_Message && is_object($message) && isset($message->content)) { |
|
| 879 | 879 | $msg = EE_Message_Factory::create( |
| 880 | 880 | array( |
| 881 | 881 | 'MSG_messenger' => $messenger, |
@@ -887,11 +887,11 @@ discard block |
||
| 887 | 887 | } else { |
| 888 | 888 | $msg = $message; |
| 889 | 889 | } |
| 890 | - if (! $msg instanceof EE_Message) { |
|
| 890 | + if ( ! $msg instanceof EE_Message) { |
|
| 891 | 891 | return false; |
| 892 | 892 | } |
| 893 | 893 | // make sure any content in a content property (if not empty) is set on the MSG_content. |
| 894 | - if (! empty($msg->content)) { |
|
| 894 | + if ( ! empty($msg->content)) { |
|
| 895 | 895 | $msg->set('MSG_content', $msg->content); |
| 896 | 896 | } |
| 897 | 897 | $queue->add($msg); |
@@ -1130,8 +1130,8 @@ discard block |
||
| 1130 | 1130 | |
| 1131 | 1131 | add_filter( |
| 1132 | 1132 | 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
| 1133 | - function ($event_list_iframe_css) { |
|
| 1134 | - if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) { |
|
| 1133 | + function($event_list_iframe_css) { |
|
| 1134 | + if ( ! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) { |
|
| 1135 | 1135 | return $event_list_iframe_css; |
| 1136 | 1136 | } |
| 1137 | 1137 | deprecated_espresso_action_or_filter_doing_it_wrong( |
@@ -1150,8 +1150,8 @@ discard block |
||
| 1150 | 1150 | ); |
| 1151 | 1151 | add_filter( |
| 1152 | 1152 | 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
| 1153 | - function ($event_list_iframe_js) { |
|
| 1154 | - if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) { |
|
| 1153 | + function($event_list_iframe_js) { |
|
| 1154 | + if ( ! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) { |
|
| 1155 | 1155 | return $event_list_iframe_js; |
| 1156 | 1156 | } |
| 1157 | 1157 | deprecated_espresso_action_or_filter_doing_it_wrong( |
@@ -1170,8 +1170,8 @@ discard block |
||
| 1170 | 1170 | ); |
| 1171 | 1171 | add_action( |
| 1172 | 1172 | 'AHEE__EE_Capabilities__addCaps__complete', |
| 1173 | - function ($capabilities_map) { |
|
| 1174 | - if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) { |
|
| 1173 | + function($capabilities_map) { |
|
| 1174 | + if ( ! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) { |
|
| 1175 | 1175 | return; |
| 1176 | 1176 | } |
| 1177 | 1177 | deprecated_espresso_action_or_filter_doing_it_wrong( |
@@ -1190,8 +1190,8 @@ discard block |
||
| 1190 | 1190 | |
| 1191 | 1191 | add_filter( |
| 1192 | 1192 | 'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee', |
| 1193 | - function ($existing_attendee, $registration, $attendee_data) { |
|
| 1194 | - if (! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) { |
|
| 1193 | + function($existing_attendee, $registration, $attendee_data) { |
|
| 1194 | + if ( ! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) { |
|
| 1195 | 1195 | return $existing_attendee; |
| 1196 | 1196 | } |
| 1197 | 1197 | deprecated_espresso_action_or_filter_doing_it_wrong( |
@@ -1274,7 +1274,7 @@ discard block |
||
| 1274 | 1274 | */ |
| 1275 | 1275 | public function event_list_title($event_list_title = '') |
| 1276 | 1276 | { |
| 1277 | - if (! empty($this->title)) { |
|
| 1277 | + if ( ! empty($this->title)) { |
|
| 1278 | 1278 | return $this->title; |
| 1279 | 1279 | } |
| 1280 | 1280 | return $event_list_title; |
@@ -1417,7 +1417,7 @@ discard block |
||
| 1417 | 1417 | foreach ($model_fields as $field) { |
| 1418 | 1418 | if ($label === EEH_Export::get_column_name_for_field($field)) { |
| 1419 | 1419 | // re-add the old field name |
| 1420 | - $new_label = $label . '[' . $field->get_name() . ']'; |
|
| 1420 | + $new_label = $label.'['.$field->get_name().']'; |
|
| 1421 | 1421 | break; |
| 1422 | 1422 | } |
| 1423 | 1423 | } |
@@ -39,31 +39,31 @@ discard block |
||
| 39 | 39 | * @param string $action_or_filter |
| 40 | 40 | */ |
| 41 | 41 | function deprecated_espresso_action_or_filter_doing_it_wrong( |
| 42 | - $deprecated_filter, |
|
| 43 | - $replacement, |
|
| 44 | - $replacement_location, |
|
| 45 | - $version_deprecated, |
|
| 46 | - $version_applies, |
|
| 47 | - $action_or_filter = 'action' |
|
| 42 | + $deprecated_filter, |
|
| 43 | + $replacement, |
|
| 44 | + $replacement_location, |
|
| 45 | + $version_deprecated, |
|
| 46 | + $version_applies, |
|
| 47 | + $action_or_filter = 'action' |
|
| 48 | 48 | ) { |
| 49 | - $action_or_filter = $action_or_filter === 'action' |
|
| 50 | - ? esc_html__('action', 'event_espresso') |
|
| 51 | - : esc_html__('filter', 'event_espresso'); |
|
| 52 | - EE_Error::doing_it_wrong( |
|
| 53 | - $deprecated_filter, |
|
| 54 | - sprintf( |
|
| 55 | - __( |
|
| 56 | - 'This %1$s is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new %1$s: %4$s"%2$s" found in "%3$s"', |
|
| 57 | - 'event_espresso' |
|
| 58 | - ), |
|
| 59 | - $action_or_filter, |
|
| 60 | - $replacement, |
|
| 61 | - $replacement_location, |
|
| 62 | - '<br />' |
|
| 63 | - ), |
|
| 64 | - $version_deprecated, |
|
| 65 | - $version_applies |
|
| 66 | - ); |
|
| 49 | + $action_or_filter = $action_or_filter === 'action' |
|
| 50 | + ? esc_html__('action', 'event_espresso') |
|
| 51 | + : esc_html__('filter', 'event_espresso'); |
|
| 52 | + EE_Error::doing_it_wrong( |
|
| 53 | + $deprecated_filter, |
|
| 54 | + sprintf( |
|
| 55 | + __( |
|
| 56 | + 'This %1$s is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new %1$s: %4$s"%2$s" found in "%3$s"', |
|
| 57 | + 'event_espresso' |
|
| 58 | + ), |
|
| 59 | + $action_or_filter, |
|
| 60 | + $replacement, |
|
| 61 | + $replacement_location, |
|
| 62 | + '<br />' |
|
| 63 | + ), |
|
| 64 | + $version_deprecated, |
|
| 65 | + $version_applies |
|
| 66 | + ); |
|
| 67 | 67 | } |
| 68 | 68 | |
| 69 | 69 | /** |
@@ -75,90 +75,90 @@ discard block |
||
| 75 | 75 | */ |
| 76 | 76 | function ee_deprecated__registration_checkout__button_text($submit_button_text, EE_Checkout $checkout) |
| 77 | 77 | { |
| 78 | - // list of old filters |
|
| 79 | - $deprecated_filters = array( |
|
| 80 | - 'update_registration_details' => true, |
|
| 81 | - 'process_payment' => true, |
|
| 82 | - 'finalize_registration' => true, |
|
| 83 | - 'and_proceed_to_payment' => true, |
|
| 84 | - 'proceed_to' => true, |
|
| 85 | - ); |
|
| 86 | - // loop thru and call doing_it_wrong() or remove any that aren't being used |
|
| 87 | - foreach ($deprecated_filters as $deprecated_filter => $on) { |
|
| 88 | - // was this filter called ? |
|
| 89 | - if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) { |
|
| 90 | - // only display doing_it_wrong() notice to Event Admins during non-AJAX requests |
|
| 91 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 92 | - 'ee_read_ee', |
|
| 93 | - 'hide_doing_it_wrong_for_deprecated_SPCO_filter' |
|
| 94 | - ) && ! defined('DOING_AJAX')) { |
|
| 95 | - EE_Error::doing_it_wrong( |
|
| 96 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter, |
|
| 97 | - sprintf( |
|
| 98 | - __( |
|
| 99 | - 'The %1$s filter is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', |
|
| 100 | - 'event_espresso' |
|
| 101 | - ), |
|
| 102 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter, |
|
| 103 | - '<br />', |
|
| 104 | - 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', |
|
| 105 | - '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php' |
|
| 106 | - ), |
|
| 107 | - '4.6.10' |
|
| 108 | - ); |
|
| 109 | - } |
|
| 110 | - } else { |
|
| 111 | - unset($deprecated_filters[ $deprecated_filter ]); |
|
| 112 | - } |
|
| 113 | - } |
|
| 114 | - if (! empty($deprecated_filters)) { |
|
| 115 | - |
|
| 116 | - if ($checkout->current_step->slug( |
|
| 117 | - ) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) { |
|
| 118 | - $submit_button_text = apply_filters( |
|
| 119 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details', |
|
| 120 | - $submit_button_text |
|
| 121 | - ); |
|
| 122 | - } elseif ($checkout->current_step->slug( |
|
| 123 | - ) == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) { |
|
| 124 | - $submit_button_text = apply_filters( |
|
| 125 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment', |
|
| 126 | - $submit_button_text |
|
| 127 | - ); |
|
| 128 | - } elseif ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug( |
|
| 129 | - ) == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) { |
|
| 130 | - $submit_button_text = apply_filters( |
|
| 131 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration', |
|
| 132 | - $submit_button_text |
|
| 133 | - ); |
|
| 134 | - } |
|
| 135 | - if ($checkout->next_step instanceof EE_SPCO_Reg_Step) { |
|
| 136 | - if ($checkout->payment_required() && $checkout->next_step->slug( |
|
| 137 | - ) == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) { |
|
| 138 | - $submit_button_text .= apply_filters( |
|
| 139 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment', |
|
| 140 | - $submit_button_text |
|
| 141 | - ); |
|
| 142 | - } |
|
| 143 | - if ($checkout->next_step->slug( |
|
| 144 | - ) != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) { |
|
| 145 | - $submit_button_text = apply_filters( |
|
| 146 | - 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', |
|
| 147 | - $submit_button_text |
|
| 148 | - ) . $checkout->next_step->name(); |
|
| 149 | - } |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - } |
|
| 153 | - return $submit_button_text; |
|
| 78 | + // list of old filters |
|
| 79 | + $deprecated_filters = array( |
|
| 80 | + 'update_registration_details' => true, |
|
| 81 | + 'process_payment' => true, |
|
| 82 | + 'finalize_registration' => true, |
|
| 83 | + 'and_proceed_to_payment' => true, |
|
| 84 | + 'proceed_to' => true, |
|
| 85 | + ); |
|
| 86 | + // loop thru and call doing_it_wrong() or remove any that aren't being used |
|
| 87 | + foreach ($deprecated_filters as $deprecated_filter => $on) { |
|
| 88 | + // was this filter called ? |
|
| 89 | + if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) { |
|
| 90 | + // only display doing_it_wrong() notice to Event Admins during non-AJAX requests |
|
| 91 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 92 | + 'ee_read_ee', |
|
| 93 | + 'hide_doing_it_wrong_for_deprecated_SPCO_filter' |
|
| 94 | + ) && ! defined('DOING_AJAX')) { |
|
| 95 | + EE_Error::doing_it_wrong( |
|
| 96 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter, |
|
| 97 | + sprintf( |
|
| 98 | + __( |
|
| 99 | + 'The %1$s filter is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', |
|
| 100 | + 'event_espresso' |
|
| 101 | + ), |
|
| 102 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter, |
|
| 103 | + '<br />', |
|
| 104 | + 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', |
|
| 105 | + '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php' |
|
| 106 | + ), |
|
| 107 | + '4.6.10' |
|
| 108 | + ); |
|
| 109 | + } |
|
| 110 | + } else { |
|
| 111 | + unset($deprecated_filters[ $deprecated_filter ]); |
|
| 112 | + } |
|
| 113 | + } |
|
| 114 | + if (! empty($deprecated_filters)) { |
|
| 115 | + |
|
| 116 | + if ($checkout->current_step->slug( |
|
| 117 | + ) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) { |
|
| 118 | + $submit_button_text = apply_filters( |
|
| 119 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details', |
|
| 120 | + $submit_button_text |
|
| 121 | + ); |
|
| 122 | + } elseif ($checkout->current_step->slug( |
|
| 123 | + ) == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) { |
|
| 124 | + $submit_button_text = apply_filters( |
|
| 125 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment', |
|
| 126 | + $submit_button_text |
|
| 127 | + ); |
|
| 128 | + } elseif ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug( |
|
| 129 | + ) == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) { |
|
| 130 | + $submit_button_text = apply_filters( |
|
| 131 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration', |
|
| 132 | + $submit_button_text |
|
| 133 | + ); |
|
| 134 | + } |
|
| 135 | + if ($checkout->next_step instanceof EE_SPCO_Reg_Step) { |
|
| 136 | + if ($checkout->payment_required() && $checkout->next_step->slug( |
|
| 137 | + ) == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) { |
|
| 138 | + $submit_button_text .= apply_filters( |
|
| 139 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment', |
|
| 140 | + $submit_button_text |
|
| 141 | + ); |
|
| 142 | + } |
|
| 143 | + if ($checkout->next_step->slug( |
|
| 144 | + ) != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) { |
|
| 145 | + $submit_button_text = apply_filters( |
|
| 146 | + 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', |
|
| 147 | + $submit_button_text |
|
| 148 | + ) . $checkout->next_step->name(); |
|
| 149 | + } |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + } |
|
| 153 | + return $submit_button_text; |
|
| 154 | 154 | |
| 155 | 155 | } |
| 156 | 156 | |
| 157 | 157 | add_filter( |
| 158 | - 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', |
|
| 159 | - 'ee_deprecated__registration_checkout__button_text', |
|
| 160 | - 10, |
|
| 161 | - 2 |
|
| 158 | + 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', |
|
| 159 | + 'ee_deprecated__registration_checkout__button_text', |
|
| 160 | + 10, |
|
| 161 | + 2 |
|
| 162 | 162 | ); |
| 163 | 163 | |
| 164 | 164 | |
@@ -170,54 +170,54 @@ discard block |
||
| 170 | 170 | */ |
| 171 | 171 | function ee_deprecated_finalize_transaction(EE_Checkout $checkout, $status_updates) |
| 172 | 172 | { |
| 173 | - $action_ref = null; |
|
| 174 | - $action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction') |
|
| 175 | - ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref; |
|
| 176 | - $action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction') |
|
| 177 | - ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref; |
|
| 178 | - if ($action_ref) { |
|
| 179 | - |
|
| 180 | - EE_Error::doing_it_wrong( |
|
| 181 | - $action_ref, |
|
| 182 | - sprintf( |
|
| 183 | - __( |
|
| 184 | - 'This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"', |
|
| 185 | - 'event_espresso' |
|
| 186 | - ), |
|
| 187 | - '<br />', |
|
| 188 | - '/core/business/EE_Transaction_Processor.class.php', |
|
| 189 | - 'AHEE__EE_Transaction_Processor__finalize', |
|
| 190 | - 'AHEE__EE_Transaction_Processor__manually_update_registration_statuses', |
|
| 191 | - 'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events', |
|
| 192 | - 'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing' |
|
| 193 | - ), |
|
| 194 | - '4.6.0' |
|
| 195 | - ); |
|
| 196 | - switch ($action_ref) { |
|
| 197 | - case 'AHEE__EE_Transaction__finalize__new_transaction' : |
|
| 198 | - do_action( |
|
| 199 | - 'AHEE__EE_Transaction__finalize__new_transaction', |
|
| 200 | - $checkout->transaction, |
|
| 201 | - $checkout->admin_request |
|
| 202 | - ); |
|
| 203 | - break; |
|
| 204 | - case 'AHEE__EE_Transaction__finalize__all_transaction' : |
|
| 205 | - do_action( |
|
| 206 | - 'AHEE__EE_Transaction__finalize__new_transaction', |
|
| 207 | - $checkout->transaction, |
|
| 208 | - array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates), |
|
| 209 | - $checkout->admin_request |
|
| 210 | - ); |
|
| 211 | - break; |
|
| 212 | - } |
|
| 213 | - } |
|
| 173 | + $action_ref = null; |
|
| 174 | + $action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction') |
|
| 175 | + ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref; |
|
| 176 | + $action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction') |
|
| 177 | + ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref; |
|
| 178 | + if ($action_ref) { |
|
| 179 | + |
|
| 180 | + EE_Error::doing_it_wrong( |
|
| 181 | + $action_ref, |
|
| 182 | + sprintf( |
|
| 183 | + __( |
|
| 184 | + 'This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"', |
|
| 185 | + 'event_espresso' |
|
| 186 | + ), |
|
| 187 | + '<br />', |
|
| 188 | + '/core/business/EE_Transaction_Processor.class.php', |
|
| 189 | + 'AHEE__EE_Transaction_Processor__finalize', |
|
| 190 | + 'AHEE__EE_Transaction_Processor__manually_update_registration_statuses', |
|
| 191 | + 'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events', |
|
| 192 | + 'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing' |
|
| 193 | + ), |
|
| 194 | + '4.6.0' |
|
| 195 | + ); |
|
| 196 | + switch ($action_ref) { |
|
| 197 | + case 'AHEE__EE_Transaction__finalize__new_transaction' : |
|
| 198 | + do_action( |
|
| 199 | + 'AHEE__EE_Transaction__finalize__new_transaction', |
|
| 200 | + $checkout->transaction, |
|
| 201 | + $checkout->admin_request |
|
| 202 | + ); |
|
| 203 | + break; |
|
| 204 | + case 'AHEE__EE_Transaction__finalize__all_transaction' : |
|
| 205 | + do_action( |
|
| 206 | + 'AHEE__EE_Transaction__finalize__new_transaction', |
|
| 207 | + $checkout->transaction, |
|
| 208 | + array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates), |
|
| 209 | + $checkout->admin_request |
|
| 210 | + ); |
|
| 211 | + break; |
|
| 212 | + } |
|
| 213 | + } |
|
| 214 | 214 | } |
| 215 | 215 | |
| 216 | 216 | add_action( |
| 217 | - 'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', |
|
| 218 | - 'ee_deprecated_finalize_transaction', |
|
| 219 | - 10, |
|
| 220 | - 2 |
|
| 217 | + 'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', |
|
| 218 | + 'ee_deprecated_finalize_transaction', |
|
| 219 | + 10, |
|
| 220 | + 2 |
|
| 221 | 221 | ); |
| 222 | 222 | /** |
| 223 | 223 | * ee_deprecated_finalize_registration |
@@ -226,35 +226,35 @@ discard block |
||
| 226 | 226 | */ |
| 227 | 227 | function ee_deprecated_finalize_registration(EE_Registration $registration) |
| 228 | 228 | { |
| 229 | - $action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg') |
|
| 230 | - ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : null; |
|
| 231 | - if ($action_ref) { |
|
| 232 | - EE_Error::doing_it_wrong( |
|
| 233 | - $action_ref, |
|
| 234 | - sprintf( |
|
| 235 | - __( |
|
| 236 | - 'This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"', |
|
| 237 | - 'event_espresso' |
|
| 238 | - ), |
|
| 239 | - '<br />', |
|
| 240 | - '/core/business/EE_Registration_Processor.class.php', |
|
| 241 | - 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications' |
|
| 242 | - ), |
|
| 243 | - '4.6.0' |
|
| 244 | - ); |
|
| 245 | - do_action( |
|
| 246 | - 'AHEE__EE_Registration__finalize__update_and_new_reg', |
|
| 247 | - $registration, |
|
| 248 | - (is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX)) |
|
| 249 | - ); |
|
| 250 | - } |
|
| 229 | + $action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg') |
|
| 230 | + ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : null; |
|
| 231 | + if ($action_ref) { |
|
| 232 | + EE_Error::doing_it_wrong( |
|
| 233 | + $action_ref, |
|
| 234 | + sprintf( |
|
| 235 | + __( |
|
| 236 | + 'This action is deprecated. It *may* work as an attempt to build in backwards compatibility. However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"', |
|
| 237 | + 'event_espresso' |
|
| 238 | + ), |
|
| 239 | + '<br />', |
|
| 240 | + '/core/business/EE_Registration_Processor.class.php', |
|
| 241 | + 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications' |
|
| 242 | + ), |
|
| 243 | + '4.6.0' |
|
| 244 | + ); |
|
| 245 | + do_action( |
|
| 246 | + 'AHEE__EE_Registration__finalize__update_and_new_reg', |
|
| 247 | + $registration, |
|
| 248 | + (is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX)) |
|
| 249 | + ); |
|
| 250 | + } |
|
| 251 | 251 | } |
| 252 | 252 | |
| 253 | 253 | add_action( |
| 254 | - 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', |
|
| 255 | - 'ee_deprecated_finalize_registration', |
|
| 256 | - 10, |
|
| 257 | - 1 |
|
| 254 | + 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', |
|
| 255 | + 'ee_deprecated_finalize_registration', |
|
| 256 | + 10, |
|
| 257 | + 1 |
|
| 258 | 258 | ); |
| 259 | 259 | |
| 260 | 260 | |
@@ -264,44 +264,44 @@ discard block |
||
| 264 | 264 | */ |
| 265 | 265 | function ee_deprecated_hooks() |
| 266 | 266 | { |
| 267 | - /** |
|
| 268 | - * @var $hooks array where keys are hook names, and their values are array{ |
|
| 269 | - * @type string $version when deprecated |
|
| 270 | - * @type string $alternative saying what to use instead |
|
| 271 | - * @type boolean $still_works whether or not the hook still works |
|
| 272 | - * } |
|
| 273 | - */ |
|
| 274 | - $hooks = array( |
|
| 275 | - 'AHEE__EE_System___do_setup_validations' => array( |
|
| 276 | - 'version' => '4.6.0', |
|
| 277 | - 'alternative' => __( |
|
| 278 | - 'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)', |
|
| 279 | - 'event_espresso' |
|
| 280 | - ), |
|
| 281 | - 'still_works' => false, |
|
| 282 | - ), |
|
| 283 | - ); |
|
| 284 | - foreach ($hooks as $name => $deprecation_info) { |
|
| 285 | - if (has_action($name)) { |
|
| 286 | - EE_Error::doing_it_wrong( |
|
| 287 | - $name, |
|
| 288 | - sprintf( |
|
| 289 | - __('This filter is deprecated. %1$s%2$s', 'event_espresso'), |
|
| 290 | - $deprecation_info['still_works'] ? __( |
|
| 291 | - 'It *may* work as an attempt to build in backwards compatibility.', |
|
| 292 | - 'event_espresso' |
|
| 293 | - ) : __('It has been completely removed.', 'event_espresso'), |
|
| 294 | - isset($deprecation_info['alternative']) |
|
| 295 | - ? $deprecation_info['alternative'] |
|
| 296 | - : __( |
|
| 297 | - 'Please read the current EE4 documentation further or contact Support.', |
|
| 298 | - 'event_espresso' |
|
| 299 | - ) |
|
| 300 | - ), |
|
| 301 | - isset($deprecation_info['version']) ? $deprecation_info['version'] : __('recently', 'event_espresso') |
|
| 302 | - ); |
|
| 303 | - } |
|
| 304 | - } |
|
| 267 | + /** |
|
| 268 | + * @var $hooks array where keys are hook names, and their values are array{ |
|
| 269 | + * @type string $version when deprecated |
|
| 270 | + * @type string $alternative saying what to use instead |
|
| 271 | + * @type boolean $still_works whether or not the hook still works |
|
| 272 | + * } |
|
| 273 | + */ |
|
| 274 | + $hooks = array( |
|
| 275 | + 'AHEE__EE_System___do_setup_validations' => array( |
|
| 276 | + 'version' => '4.6.0', |
|
| 277 | + 'alternative' => __( |
|
| 278 | + 'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)', |
|
| 279 | + 'event_espresso' |
|
| 280 | + ), |
|
| 281 | + 'still_works' => false, |
|
| 282 | + ), |
|
| 283 | + ); |
|
| 284 | + foreach ($hooks as $name => $deprecation_info) { |
|
| 285 | + if (has_action($name)) { |
|
| 286 | + EE_Error::doing_it_wrong( |
|
| 287 | + $name, |
|
| 288 | + sprintf( |
|
| 289 | + __('This filter is deprecated. %1$s%2$s', 'event_espresso'), |
|
| 290 | + $deprecation_info['still_works'] ? __( |
|
| 291 | + 'It *may* work as an attempt to build in backwards compatibility.', |
|
| 292 | + 'event_espresso' |
|
| 293 | + ) : __('It has been completely removed.', 'event_espresso'), |
|
| 294 | + isset($deprecation_info['alternative']) |
|
| 295 | + ? $deprecation_info['alternative'] |
|
| 296 | + : __( |
|
| 297 | + 'Please read the current EE4 documentation further or contact Support.', |
|
| 298 | + 'event_espresso' |
|
| 299 | + ) |
|
| 300 | + ), |
|
| 301 | + isset($deprecation_info['version']) ? $deprecation_info['version'] : __('recently', 'event_espresso') |
|
| 302 | + ); |
|
| 303 | + } |
|
| 304 | + } |
|
| 305 | 305 | } |
| 306 | 306 | |
| 307 | 307 | add_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks'); |
@@ -316,34 +316,34 @@ discard block |
||
| 316 | 316 | */ |
| 317 | 317 | function ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
| 318 | 318 | { |
| 319 | - $in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns') |
|
| 320 | - || has_action( |
|
| 321 | - 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save' |
|
| 322 | - ); |
|
| 323 | - if ($in_use) { |
|
| 324 | - $msg = __( |
|
| 325 | - 'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.' |
|
| 326 | - . 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,' |
|
| 327 | - . 'use FHEE__EE_Form_Section_Proper__receive_form_submission__req_data to customize the submission data, or AHEE__EE_Form_Section_Proper__receive_form_submission__end ' |
|
| 328 | - . 'to add other actions after a form submission has been received.', |
|
| 329 | - 'event_espresso' |
|
| 330 | - ); |
|
| 331 | - EE_Error::doing_it_wrong( |
|
| 332 | - __CLASS__ . '::' . __FUNCTION__, |
|
| 333 | - $msg, |
|
| 334 | - '4.8.32.rc.000' |
|
| 335 | - ); |
|
| 336 | - // it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed |
|
| 337 | - if (is_admin() && ! defined('DOING_AJAX')) { |
|
| 338 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 339 | - } |
|
| 340 | - } |
|
| 341 | - return $in_use; |
|
| 319 | + $in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns') |
|
| 320 | + || has_action( |
|
| 321 | + 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save' |
|
| 322 | + ); |
|
| 323 | + if ($in_use) { |
|
| 324 | + $msg = __( |
|
| 325 | + 'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.' |
|
| 326 | + . 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,' |
|
| 327 | + . 'use FHEE__EE_Form_Section_Proper__receive_form_submission__req_data to customize the submission data, or AHEE__EE_Form_Section_Proper__receive_form_submission__end ' |
|
| 328 | + . 'to add other actions after a form submission has been received.', |
|
| 329 | + 'event_espresso' |
|
| 330 | + ); |
|
| 331 | + EE_Error::doing_it_wrong( |
|
| 332 | + __CLASS__ . '::' . __FUNCTION__, |
|
| 333 | + $msg, |
|
| 334 | + '4.8.32.rc.000' |
|
| 335 | + ); |
|
| 336 | + // it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed |
|
| 337 | + if (is_admin() && ! defined('DOING_AJAX')) { |
|
| 338 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 339 | + } |
|
| 340 | + } |
|
| 341 | + return $in_use; |
|
| 342 | 342 | } |
| 343 | 343 | |
| 344 | 344 | add_action( |
| 345 | - 'AHEE__Registrations_Admin_Page___registration_details_metabox__start', |
|
| 346 | - 'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks' |
|
| 345 | + 'AHEE__Registrations_Admin_Page___registration_details_metabox__start', |
|
| 346 | + 'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks' |
|
| 347 | 347 | ); |
| 348 | 348 | |
| 349 | 349 | /** |
@@ -355,77 +355,77 @@ discard block |
||
| 355 | 355 | */ |
| 356 | 356 | function ee_deprecated_update_attendee_registration_form_old($admin_page) |
| 357 | 357 | { |
| 358 | - // check if the old hooks are in use. If not, do the default |
|
| 359 | - if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 360 | - || ! $admin_page instanceof EE_Admin_Page) { |
|
| 361 | - return; |
|
| 362 | - } |
|
| 363 | - $req_data = $admin_page->get_request_data(); |
|
| 364 | - $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false; |
|
| 365 | - $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false; |
|
| 366 | - $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns); |
|
| 367 | - if (! $REG_ID || ! $qstns) { |
|
| 368 | - EE_Error::add_error( |
|
| 369 | - __('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), |
|
| 370 | - __FILE__, |
|
| 371 | - __FUNCTION__, |
|
| 372 | - __LINE__ |
|
| 373 | - ); |
|
| 374 | - } |
|
| 375 | - $success = true; |
|
| 376 | - |
|
| 377 | - // allow others to get in on this awesome fun :D |
|
| 378 | - do_action( |
|
| 379 | - 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save', |
|
| 380 | - $REG_ID, |
|
| 381 | - $qstns |
|
| 382 | - ); |
|
| 383 | - // loop thru questions... FINALLY!!! |
|
| 384 | - |
|
| 385 | - foreach ($qstns as $QST_ID => $qstn) { |
|
| 386 | - // if $qstn isn't an array then it doesn't already have an answer, so let's create the answer |
|
| 387 | - if (! is_array($qstn)) { |
|
| 388 | - $success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn); |
|
| 389 | - continue; |
|
| 390 | - } |
|
| 391 | - |
|
| 392 | - |
|
| 393 | - foreach ($qstn as $ANS_ID => $ANS_value) { |
|
| 394 | - // get answer |
|
| 395 | - $query_params = array( |
|
| 396 | - 0 => array( |
|
| 397 | - 'ANS_ID' => $ANS_ID, |
|
| 398 | - 'REG_ID' => $REG_ID, |
|
| 399 | - 'QST_ID' => $QST_ID, |
|
| 400 | - ), |
|
| 401 | - ); |
|
| 402 | - $answer = EEM_Answer::instance()->get_one($query_params); |
|
| 403 | - // this MAY be an array but NOT have an answer because its multi select. If so then we need to create the answer |
|
| 404 | - if (! $answer instanceof EE_Answer) { |
|
| 405 | - $set_values = array( |
|
| 406 | - 'QST_ID' => $QST_ID, |
|
| 407 | - 'REG_ID' => $REG_ID, |
|
| 408 | - 'ANS_value' => $qstn, |
|
| 409 | - ); |
|
| 410 | - $success = EEM_Answer::instance()->insert($set_values); |
|
| 411 | - continue 2; |
|
| 412 | - } |
|
| 413 | - |
|
| 414 | - $answer->set('ANS_value', $ANS_value); |
|
| 415 | - $success = $answer->save(); |
|
| 416 | - } |
|
| 417 | - } |
|
| 418 | - $what = __('Registration Form', 'event_espresso'); |
|
| 419 | - $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default'); |
|
| 420 | - $admin_page->redirect_after_action($success, $what, __('updated', 'event_espresso'), $route); |
|
| 421 | - exit; |
|
| 358 | + // check if the old hooks are in use. If not, do the default |
|
| 359 | + if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 360 | + || ! $admin_page instanceof EE_Admin_Page) { |
|
| 361 | + return; |
|
| 362 | + } |
|
| 363 | + $req_data = $admin_page->get_request_data(); |
|
| 364 | + $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false; |
|
| 365 | + $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false; |
|
| 366 | + $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns); |
|
| 367 | + if (! $REG_ID || ! $qstns) { |
|
| 368 | + EE_Error::add_error( |
|
| 369 | + __('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), |
|
| 370 | + __FILE__, |
|
| 371 | + __FUNCTION__, |
|
| 372 | + __LINE__ |
|
| 373 | + ); |
|
| 374 | + } |
|
| 375 | + $success = true; |
|
| 376 | + |
|
| 377 | + // allow others to get in on this awesome fun :D |
|
| 378 | + do_action( |
|
| 379 | + 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save', |
|
| 380 | + $REG_ID, |
|
| 381 | + $qstns |
|
| 382 | + ); |
|
| 383 | + // loop thru questions... FINALLY!!! |
|
| 384 | + |
|
| 385 | + foreach ($qstns as $QST_ID => $qstn) { |
|
| 386 | + // if $qstn isn't an array then it doesn't already have an answer, so let's create the answer |
|
| 387 | + if (! is_array($qstn)) { |
|
| 388 | + $success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn); |
|
| 389 | + continue; |
|
| 390 | + } |
|
| 391 | + |
|
| 392 | + |
|
| 393 | + foreach ($qstn as $ANS_ID => $ANS_value) { |
|
| 394 | + // get answer |
|
| 395 | + $query_params = array( |
|
| 396 | + 0 => array( |
|
| 397 | + 'ANS_ID' => $ANS_ID, |
|
| 398 | + 'REG_ID' => $REG_ID, |
|
| 399 | + 'QST_ID' => $QST_ID, |
|
| 400 | + ), |
|
| 401 | + ); |
|
| 402 | + $answer = EEM_Answer::instance()->get_one($query_params); |
|
| 403 | + // this MAY be an array but NOT have an answer because its multi select. If so then we need to create the answer |
|
| 404 | + if (! $answer instanceof EE_Answer) { |
|
| 405 | + $set_values = array( |
|
| 406 | + 'QST_ID' => $QST_ID, |
|
| 407 | + 'REG_ID' => $REG_ID, |
|
| 408 | + 'ANS_value' => $qstn, |
|
| 409 | + ); |
|
| 410 | + $success = EEM_Answer::instance()->insert($set_values); |
|
| 411 | + continue 2; |
|
| 412 | + } |
|
| 413 | + |
|
| 414 | + $answer->set('ANS_value', $ANS_value); |
|
| 415 | + $success = $answer->save(); |
|
| 416 | + } |
|
| 417 | + } |
|
| 418 | + $what = __('Registration Form', 'event_espresso'); |
|
| 419 | + $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default'); |
|
| 420 | + $admin_page->redirect_after_action($success, $what, __('updated', 'event_espresso'), $route); |
|
| 421 | + exit; |
|
| 422 | 422 | } |
| 423 | 423 | |
| 424 | 424 | add_action( |
| 425 | - 'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', |
|
| 426 | - 'ee_deprecated_update_attendee_registration_form_old', |
|
| 427 | - 10, |
|
| 428 | - 1 |
|
| 425 | + 'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', |
|
| 426 | + 'ee_deprecated_update_attendee_registration_form_old', |
|
| 427 | + 10, |
|
| 428 | + 1 |
|
| 429 | 429 | ); |
| 430 | 430 | /** |
| 431 | 431 | * Render the registration admin page's custom questions area in the old fashion |
@@ -441,50 +441,50 @@ discard block |
||
| 441 | 441 | */ |
| 442 | 442 | function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration) |
| 443 | 443 | { |
| 444 | - // check if the old hooks are in use. If not, do the default |
|
| 445 | - if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 446 | - || ! $admin_page instanceof EE_Admin_Page) { |
|
| 447 | - return $do_default_action; |
|
| 448 | - } |
|
| 449 | - add_filter( |
|
| 450 | - 'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', |
|
| 451 | - array($admin_page, 'form_before_question_group'), |
|
| 452 | - 10, |
|
| 453 | - 1 |
|
| 454 | - ); |
|
| 455 | - add_filter( |
|
| 456 | - 'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', |
|
| 457 | - array($admin_page, 'form_after_question_group'), |
|
| 458 | - 10, |
|
| 459 | - 1 |
|
| 460 | - ); |
|
| 461 | - add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1); |
|
| 462 | - add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1); |
|
| 463 | - |
|
| 464 | - $question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options( |
|
| 465 | - $registration, |
|
| 466 | - $registration->get( |
|
| 467 | - 'EVT_ID' |
|
| 468 | - ) |
|
| 469 | - ); |
|
| 470 | - |
|
| 471 | - EE_Registry::instance()->load_helper('Form_Fields'); |
|
| 472 | - $template_args = array( |
|
| 473 | - 'att_questions' => EEH_Form_Fields::generate_question_groups_html($question_groups), |
|
| 474 | - 'reg_questions_form_action' => 'edit_registration', |
|
| 475 | - 'REG_ID' => $registration->ID(), |
|
| 476 | - ); |
|
| 477 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 478 | - echo EEH_Template::display_template($template_path, $template_args, true); |
|
| 479 | - // indicate that we should not do the default admin page code |
|
| 480 | - return false; |
|
| 444 | + // check if the old hooks are in use. If not, do the default |
|
| 445 | + if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() |
|
| 446 | + || ! $admin_page instanceof EE_Admin_Page) { |
|
| 447 | + return $do_default_action; |
|
| 448 | + } |
|
| 449 | + add_filter( |
|
| 450 | + 'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', |
|
| 451 | + array($admin_page, 'form_before_question_group'), |
|
| 452 | + 10, |
|
| 453 | + 1 |
|
| 454 | + ); |
|
| 455 | + add_filter( |
|
| 456 | + 'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', |
|
| 457 | + array($admin_page, 'form_after_question_group'), |
|
| 458 | + 10, |
|
| 459 | + 1 |
|
| 460 | + ); |
|
| 461 | + add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1); |
|
| 462 | + add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1); |
|
| 463 | + |
|
| 464 | + $question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options( |
|
| 465 | + $registration, |
|
| 466 | + $registration->get( |
|
| 467 | + 'EVT_ID' |
|
| 468 | + ) |
|
| 469 | + ); |
|
| 470 | + |
|
| 471 | + EE_Registry::instance()->load_helper('Form_Fields'); |
|
| 472 | + $template_args = array( |
|
| 473 | + 'att_questions' => EEH_Form_Fields::generate_question_groups_html($question_groups), |
|
| 474 | + 'reg_questions_form_action' => 'edit_registration', |
|
| 475 | + 'REG_ID' => $registration->ID(), |
|
| 476 | + ); |
|
| 477 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
| 478 | + echo EEH_Template::display_template($template_path, $template_args, true); |
|
| 479 | + // indicate that we should not do the default admin page code |
|
| 480 | + return false; |
|
| 481 | 481 | } |
| 482 | 482 | |
| 483 | 483 | add_action( |
| 484 | - 'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', |
|
| 485 | - 'ee_deprecated_reg_questions_meta_box_old', |
|
| 486 | - 10, |
|
| 487 | - 3 |
|
| 484 | + 'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', |
|
| 485 | + 'ee_deprecated_reg_questions_meta_box_old', |
|
| 486 | + 10, |
|
| 487 | + 3 |
|
| 488 | 488 | ); |
| 489 | 489 | |
| 490 | 490 | |
@@ -501,42 +501,42 @@ discard block |
||
| 501 | 501 | class EE_Message_Template_Defaults extends EE_Base |
| 502 | 502 | { |
| 503 | 503 | |
| 504 | - /** |
|
| 505 | - * EE_Message_Template_Defaults constructor. |
|
| 506 | - * |
|
| 507 | - * @param EE_messages $messages |
|
| 508 | - * @param $messenger_name |
|
| 509 | - * @param $message_type_name |
|
| 510 | - * @param int $GRP_ID |
|
| 511 | - * @return EE_Messages_Template_Defaults |
|
| 512 | - */ |
|
| 513 | - public function __construct( |
|
| 514 | - EE_messages $messages, |
|
| 515 | - $messenger_name, |
|
| 516 | - $message_type_name, |
|
| 517 | - $GRP_ID = 0 |
|
| 518 | - ) { |
|
| 519 | - EE_Error::doing_it_wrong( |
|
| 520 | - __FUNCTION__, |
|
| 521 | - __( |
|
| 522 | - 'The class EE_Message_Template_Defaults has been deprecated and replaced by EE_Messages_Template_Defaults.', |
|
| 523 | - 'event_espresso' |
|
| 524 | - ), |
|
| 525 | - '4.9.0' |
|
| 526 | - ); |
|
| 527 | - /** @var EE_Message_Resource_Manager $message_resource_manager */ |
|
| 528 | - $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 529 | - $messenger = $message_resource_manager->get_messenger($messenger_name); |
|
| 530 | - $message_type = $message_resource_manager->get_message_type($message_type_name); |
|
| 531 | - return EE_Registry::instance()->load_lib( |
|
| 532 | - 'Messages_Template_Defaults', |
|
| 533 | - array( |
|
| 534 | - $GRP_ID, |
|
| 535 | - $messenger, |
|
| 536 | - $message_type, |
|
| 537 | - ) |
|
| 538 | - ); |
|
| 539 | - } |
|
| 504 | + /** |
|
| 505 | + * EE_Message_Template_Defaults constructor. |
|
| 506 | + * |
|
| 507 | + * @param EE_messages $messages |
|
| 508 | + * @param $messenger_name |
|
| 509 | + * @param $message_type_name |
|
| 510 | + * @param int $GRP_ID |
|
| 511 | + * @return EE_Messages_Template_Defaults |
|
| 512 | + */ |
|
| 513 | + public function __construct( |
|
| 514 | + EE_messages $messages, |
|
| 515 | + $messenger_name, |
|
| 516 | + $message_type_name, |
|
| 517 | + $GRP_ID = 0 |
|
| 518 | + ) { |
|
| 519 | + EE_Error::doing_it_wrong( |
|
| 520 | + __FUNCTION__, |
|
| 521 | + __( |
|
| 522 | + 'The class EE_Message_Template_Defaults has been deprecated and replaced by EE_Messages_Template_Defaults.', |
|
| 523 | + 'event_espresso' |
|
| 524 | + ), |
|
| 525 | + '4.9.0' |
|
| 526 | + ); |
|
| 527 | + /** @var EE_Message_Resource_Manager $message_resource_manager */ |
|
| 528 | + $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 529 | + $messenger = $message_resource_manager->get_messenger($messenger_name); |
|
| 530 | + $message_type = $message_resource_manager->get_message_type($message_type_name); |
|
| 531 | + return EE_Registry::instance()->load_lib( |
|
| 532 | + 'Messages_Template_Defaults', |
|
| 533 | + array( |
|
| 534 | + $GRP_ID, |
|
| 535 | + $messenger, |
|
| 536 | + $message_type, |
|
| 537 | + ) |
|
| 538 | + ); |
|
| 539 | + } |
|
| 540 | 540 | } |
| 541 | 541 | |
| 542 | 542 | |
@@ -554,525 +554,525 @@ discard block |
||
| 554 | 554 | class EE_messages |
| 555 | 555 | { |
| 556 | 556 | |
| 557 | - /** @type EE_messenger[] */ |
|
| 558 | - protected $_active_messengers = array(); |
|
| 559 | - |
|
| 560 | - /** @type array */ |
|
| 561 | - protected $_active_message_types = array(); |
|
| 562 | - |
|
| 563 | - /** @type EE_message_type[] */ |
|
| 564 | - protected $_installed_message_types = array(); |
|
| 565 | - |
|
| 566 | - /** @type EE_messenger */ |
|
| 567 | - protected $_messenger; |
|
| 568 | - |
|
| 569 | - /** @type EE_message_type */ |
|
| 570 | - protected $_message_type; |
|
| 571 | - |
|
| 572 | - /** @type array */ |
|
| 573 | - protected $_contexts = array(); |
|
| 574 | - |
|
| 575 | - /** @type EE_Message_Resource_Manager $_message_resource_manager */ |
|
| 576 | - protected $_message_resource_manager; |
|
| 577 | - |
|
| 578 | - |
|
| 579 | - /** |
|
| 580 | - * EE_messages constructor. |
|
| 581 | - * |
|
| 582 | - * @deprecated 4.9.0 |
|
| 583 | - */ |
|
| 584 | - public function __construct() |
|
| 585 | - { |
|
| 586 | - } |
|
| 587 | - |
|
| 588 | - |
|
| 589 | - /** |
|
| 590 | - * @param string $method |
|
| 591 | - */ |
|
| 592 | - public function _class_is_deprecated($method) |
|
| 593 | - { |
|
| 594 | - EE_Error::doing_it_wrong( |
|
| 595 | - 'EE_messages::' . $method, |
|
| 596 | - __('EE_messages has been deprecated. Please use EE_Message_Resource_Manager instead.'), |
|
| 597 | - '4.9.0', |
|
| 598 | - '4.10.0.p' |
|
| 599 | - ); |
|
| 600 | - // Please use EE_Message_Resource_Manager instead |
|
| 601 | - $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 602 | - } |
|
| 603 | - |
|
| 604 | - |
|
| 605 | - /** |
|
| 606 | - * @deprecated 4.9.0 |
|
| 607 | - * @param string $messenger_name |
|
| 608 | - * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive |
|
| 609 | - */ |
|
| 610 | - public function ensure_messenger_is_active($messenger_name) |
|
| 611 | - { |
|
| 612 | - // EE_messages has been deprecated |
|
| 613 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 614 | - return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name); |
|
| 615 | - } |
|
| 616 | - |
|
| 617 | - |
|
| 618 | - /** |
|
| 619 | - * @deprecated 4.9.0 |
|
| 620 | - * @param string $message_type message type name |
|
| 621 | - * @param $messenger |
|
| 622 | - * @return bool true if it got activated (or was active) and false if not. |
|
| 623 | - * @throws \EE_Error |
|
| 624 | - */ |
|
| 625 | - public function ensure_message_type_is_active($message_type, $messenger) |
|
| 626 | - { |
|
| 627 | - // EE_messages has been deprecated |
|
| 628 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 629 | - return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger); |
|
| 630 | - } |
|
| 631 | - |
|
| 632 | - |
|
| 633 | - /** |
|
| 634 | - * @deprecated 4.9.0 |
|
| 635 | - * @param string $messenger_name |
|
| 636 | - * @param array $mts_to_activate (optional) An array of message types to activate with this messenger. |
|
| 637 | - * If included we do NOT setup the default message types (assuming they |
|
| 638 | - * are already setup.) |
|
| 639 | - * @return boolean an array of generated templates or false if nothing generated/activated. |
|
| 640 | - */ |
|
| 641 | - public function activate_messenger($messenger_name, $mts_to_activate = array()) |
|
| 642 | - { |
|
| 643 | - // EE_messages has been deprecated |
|
| 644 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 645 | - return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate); |
|
| 646 | - } |
|
| 647 | - |
|
| 648 | - |
|
| 649 | - /** |
|
| 650 | - * @deprecated 4.9.0 |
|
| 651 | - * @param EE_messenger $messenger messenger used in trigger |
|
| 652 | - * @param EE_message_type $message_type message type used in trigger |
|
| 653 | - * |
|
| 654 | - * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send. |
|
| 655 | - */ |
|
| 656 | - public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type) |
|
| 657 | - { |
|
| 658 | - // EE_messages has been deprecated |
|
| 659 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 660 | - return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type); |
|
| 661 | - } |
|
| 662 | - |
|
| 663 | - |
|
| 664 | - /** |
|
| 665 | - * @deprecated 4.9.0 |
|
| 666 | - * @param string $messenger |
|
| 667 | - * @return EE_messenger | null |
|
| 668 | - */ |
|
| 669 | - public function get_messenger_if_active($messenger) |
|
| 670 | - { |
|
| 671 | - // EE_messages has been deprecated |
|
| 672 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 673 | - return $this->_message_resource_manager->get_active_messenger($messenger); |
|
| 674 | - } |
|
| 675 | - |
|
| 676 | - |
|
| 677 | - /** |
|
| 678 | - * @deprecated 4.9.0 |
|
| 679 | - * @param EE_Message $message |
|
| 680 | - * @return array An array with 'messenger' and 'message_type' as the index and the corresponding valid object if |
|
| 681 | - * available. |
|
| 682 | - * Eg. Valid Messenger and Message Type: |
|
| 683 | - * array( |
|
| 684 | - * 'messenger' => new EE_Email_messenger(), |
|
| 685 | - * 'message_type' => new EE_Registration_Approved_message_type() |
|
| 686 | - * ) |
|
| 687 | - * Valid Messenger and Invalid Message Type: |
|
| 688 | - * array( |
|
| 689 | - * 'messenger' => new EE_Email_messenger(), |
|
| 690 | - * 'message_type' => null |
|
| 691 | - * ) |
|
| 692 | - */ |
|
| 693 | - public function validate_for_use(EE_Message $message) |
|
| 694 | - { |
|
| 695 | - // EE_messages has been deprecated |
|
| 696 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 697 | - return array( |
|
| 698 | - 'messenger' => $message->messenger_object(), |
|
| 699 | - 'message_type' => $message->message_type_object(), |
|
| 700 | - ); |
|
| 701 | - } |
|
| 702 | - |
|
| 703 | - |
|
| 704 | - /** |
|
| 705 | - * @deprecated 4.9.0 |
|
| 706 | - * @param string $type What type of message are we sending (corresponds to message types) |
|
| 707 | - * @param mixed $vars Data being sent for parsing in the message |
|
| 708 | - * @param string $sending_messenger if included then we ONLY use the specified messenger for delivery. |
|
| 709 | - * Otherwise we cycle through all active messengers. |
|
| 710 | - * @param string $generating_messenger if included then this messenger is used for generating the message |
|
| 711 | - * templates (but not for sending). |
|
| 712 | - * @param string $context If included then only a message type for a specific context will be |
|
| 713 | - * generated. |
|
| 714 | - * @param bool $send Default TRUE. If false, then this will just return the generated |
|
| 715 | - * EE_messages objects which might be used by the trigger to setup a batch |
|
| 716 | - * message (typically html messenger uses it). |
|
| 717 | - * @return bool |
|
| 718 | - */ |
|
| 719 | - public function send_message( |
|
| 720 | - $type, |
|
| 721 | - $vars, |
|
| 722 | - $sending_messenger = '', |
|
| 723 | - $generating_messenger = '', |
|
| 724 | - $context = '', |
|
| 725 | - $send = true |
|
| 726 | - ) { |
|
| 727 | - // EE_messages has been deprecated |
|
| 728 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 729 | - /** @type EE_Messages_Processor $processor */ |
|
| 730 | - $processor = EE_Registry::instance()->load_lib('Messages_Processor'); |
|
| 731 | - $error = false; |
|
| 732 | - // try to intelligently determine what method we'll call based on the incoming data. |
|
| 733 | - // if generating and sending are different then generate and send immediately. |
|
| 734 | - if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) { |
|
| 735 | - // in the legacy system, when generating and sending were different, that means all the |
|
| 736 | - // vars are already in the request object. So let's just use that. |
|
| 737 | - try { |
|
| 738 | - /** @type EE_Message_To_Generate_From_Request $mtg */ |
|
| 739 | - $mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request'); |
|
| 740 | - $processor->generate_and_send_now($mtg); |
|
| 741 | - } catch (EE_Error $e) { |
|
| 742 | - $error_msg = __( |
|
| 743 | - 'Please note that a system message failed to send due to a technical issue.', |
|
| 744 | - 'event_espresso' |
|
| 745 | - ); |
|
| 746 | - // add specific message for developers if WP_DEBUG in on |
|
| 747 | - $error_msg .= '||' . $e->getMessage(); |
|
| 748 | - EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 749 | - $error = true; |
|
| 750 | - } |
|
| 751 | - } else { |
|
| 752 | - $processor->generate_for_all_active_messengers($type, $vars, $send); |
|
| 753 | - // let's find out if there were any errors and how many successfully were queued. |
|
| 754 | - $count_errors = $processor->get_queue()->count_STS_in_queue( |
|
| 755 | - array(EEM_Message::status_failed, EEM_Message::status_debug_only) |
|
| 756 | - ); |
|
| 757 | - $count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete); |
|
| 758 | - $count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry); |
|
| 759 | - $count_errors = $count_errors + $count_retry; |
|
| 760 | - if ($count_errors > 0) { |
|
| 761 | - $error = true; |
|
| 762 | - if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) { |
|
| 763 | - $message = sprintf( |
|
| 764 | - __( |
|
| 765 | - 'There were %d errors and %d messages successfully queued for generation and sending', |
|
| 766 | - 'event_espresso' |
|
| 767 | - ), |
|
| 768 | - $count_errors, |
|
| 769 | - $count_queued |
|
| 770 | - ); |
|
| 771 | - } elseif ($count_errors > 1 && $count_queued === 1) { |
|
| 772 | - $message = sprintf( |
|
| 773 | - __( |
|
| 774 | - 'There were %d errors and %d message successfully queued for generation.', |
|
| 775 | - 'event_espresso' |
|
| 776 | - ), |
|
| 777 | - $count_errors, |
|
| 778 | - $count_queued |
|
| 779 | - ); |
|
| 780 | - } elseif ($count_errors === 1 && $count_queued > 1) { |
|
| 781 | - $message = sprintf( |
|
| 782 | - __( |
|
| 783 | - 'There was %d error and %d messages successfully queued for generation.', |
|
| 784 | - 'event_espresso' |
|
| 785 | - ), |
|
| 786 | - $count_errors, |
|
| 787 | - $count_queued |
|
| 788 | - ); |
|
| 789 | - } else { |
|
| 790 | - $message = sprintf( |
|
| 791 | - __( |
|
| 792 | - 'There was %d message that failed to be queued for generation.', |
|
| 793 | - 'event_espresso' |
|
| 794 | - ), |
|
| 795 | - $count_errors |
|
| 796 | - ); |
|
| 797 | - } |
|
| 798 | - EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__); |
|
| 799 | - } else { |
|
| 800 | - if ($count_queued === 1) { |
|
| 801 | - $message = sprintf( |
|
| 802 | - __( |
|
| 803 | - '%d message successfully queued for generation.', |
|
| 804 | - 'event_espresso' |
|
| 805 | - ), |
|
| 806 | - $count_queued |
|
| 807 | - ); |
|
| 808 | - } else { |
|
| 809 | - $message = sprintf( |
|
| 810 | - __( |
|
| 811 | - '%d messages were successfully queued for generation.', |
|
| 812 | - 'event_espresso' |
|
| 813 | - ), |
|
| 814 | - $count_queued |
|
| 815 | - ); |
|
| 816 | - } |
|
| 817 | - EE_Error::add_success($message); |
|
| 818 | - } |
|
| 819 | - } |
|
| 820 | - // if no error then return the generated message(s). |
|
| 821 | - if (! $error && ! $send) { |
|
| 822 | - $generated_queue = $processor->generate_queue(false); |
|
| 823 | - // get message and return. |
|
| 824 | - $generated_queue->get_message_repository()->rewind(); |
|
| 825 | - $messages = array(); |
|
| 826 | - while ($generated_queue->get_message_repository()->valid()) { |
|
| 827 | - $message = $generated_queue->get_message_repository()->current(); |
|
| 828 | - if ($message instanceof EE_Message) { |
|
| 829 | - // set properties that might be expected by add-ons (backward compat) |
|
| 830 | - $message->content = $message->content(); |
|
| 831 | - $message->template_pack = $message->get_template_pack(); |
|
| 832 | - $message->template_variation = $message->get_template_pack_variation(); |
|
| 833 | - $messages[] = $message; |
|
| 834 | - } |
|
| 835 | - $generated_queue->get_message_repository()->next(); |
|
| 836 | - } |
|
| 837 | - return $messages; |
|
| 838 | - } |
|
| 839 | - return $error ? false |
|
| 840 | - : true; // yeah backwards eh? Really what we're returning is if there is a total success for all the messages or not. We'll modify this once we get message recording in place. |
|
| 841 | - } |
|
| 842 | - |
|
| 843 | - |
|
| 844 | - /** |
|
| 845 | - * @deprecated 4.9.0 |
|
| 846 | - * @param string $type This should correspond with a valid message type |
|
| 847 | - * @param string $context This should correspond with a valid context for the message type |
|
| 848 | - * @param string $messenger This should correspond with a valid messenger. |
|
| 849 | - * @param bool $send true we will do a test send using the messenger delivery, false we just do a regular |
|
| 850 | - * preview |
|
| 851 | - * @return string The body of the message. |
|
| 852 | - */ |
|
| 853 | - public function preview_message($type, $context, $messenger, $send = false) |
|
| 854 | - { |
|
| 855 | - // EE_messages has been deprecated |
|
| 856 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 857 | - return EED_Messages::preview_message($type, $context, $messenger, $send); |
|
| 858 | - } |
|
| 859 | - |
|
| 860 | - |
|
| 861 | - /** |
|
| 862 | - * @since 4.5.0 |
|
| 863 | - * @deprecated 4.9.0 Moved to EED_Messages Module |
|
| 864 | - * @param string $messenger a string matching a valid active messenger in the system |
|
| 865 | - * @param string $message_type Although it seems contrary to the name of the method, a message type name is still |
|
| 866 | - * required to send along the message type to the messenger because this is used for |
|
| 867 | - * determining what specific variations might be loaded for the generated message. |
|
| 868 | - * @param stdClass $message a stdClass object in the format expected by the messenger. |
|
| 869 | - * |
|
| 870 | - * @return bool success or fail. |
|
| 871 | - */ |
|
| 872 | - public function send_message_with_messenger_only($messenger, $message_type, $message) |
|
| 873 | - { |
|
| 874 | - // EE_messages has been deprecated |
|
| 875 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 876 | - // setup for sending to new method. |
|
| 877 | - /** @type EE_Messages_Queue $queue */ |
|
| 878 | - $queue = EE_Registry::instance()->load_lib('Messages_Queue'); |
|
| 879 | - // make sure we have a proper message object |
|
| 880 | - if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) { |
|
| 881 | - $msg = EE_Message_Factory::create( |
|
| 882 | - array( |
|
| 883 | - 'MSG_messenger' => $messenger, |
|
| 884 | - 'MSG_message_type' => $message_type, |
|
| 885 | - 'MSG_content' => $message->content, |
|
| 886 | - 'MSG_subject' => $message->subject, |
|
| 887 | - ) |
|
| 888 | - ); |
|
| 889 | - } else { |
|
| 890 | - $msg = $message; |
|
| 891 | - } |
|
| 892 | - if (! $msg instanceof EE_Message) { |
|
| 893 | - return false; |
|
| 894 | - } |
|
| 895 | - // make sure any content in a content property (if not empty) is set on the MSG_content. |
|
| 896 | - if (! empty($msg->content)) { |
|
| 897 | - $msg->set('MSG_content', $msg->content); |
|
| 898 | - } |
|
| 899 | - $queue->add($msg); |
|
| 900 | - return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue); |
|
| 901 | - } |
|
| 902 | - |
|
| 903 | - |
|
| 904 | - /** |
|
| 905 | - * @deprecated 4.9.0 |
|
| 906 | - * @param $messenger |
|
| 907 | - * @param string $message_type message type that the templates are being created for |
|
| 908 | - * @param int $GRP_ID |
|
| 909 | - * @param bool $is_global |
|
| 910 | - * @return array|object if creation is successful then we return an array of info, otherwise an error_object is |
|
| 911 | - * returned. |
|
| 912 | - * @throws \EE_Error |
|
| 913 | - */ |
|
| 914 | - public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false) |
|
| 915 | - { |
|
| 916 | - // EE_messages has been deprecated |
|
| 917 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 918 | - EE_Registry::instance()->load_helper('MSG_Template'); |
|
| 919 | - return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global); |
|
| 920 | - } |
|
| 921 | - |
|
| 922 | - |
|
| 923 | - /** |
|
| 924 | - * @deprecated 4.9.0 |
|
| 925 | - * @param string $messenger_name name of EE_messenger |
|
| 926 | - * @param string $message_type_name name of EE_message_type |
|
| 927 | - * @return array |
|
| 928 | - */ |
|
| 929 | - public function get_fields($messenger_name, $message_type_name) |
|
| 930 | - { |
|
| 931 | - // EE_messages has been deprecated |
|
| 932 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 933 | - EE_Registry::instance()->load_helper('MSG_Template'); |
|
| 934 | - return EEH_MSG_Template::get_fields($messenger_name, $message_type_name); |
|
| 935 | - } |
|
| 936 | - |
|
| 937 | - |
|
| 938 | - /** |
|
| 939 | - * @deprecated 4.9.0 |
|
| 940 | - * @access public |
|
| 941 | - * @param string $type we can indicate just returning installed message types |
|
| 942 | - * or messengers (or both) via this parameter. |
|
| 943 | - * @param bool $skip_cache if true then we skip the cache and retrieve via files. |
|
| 944 | - * @return array multidimensional array of messenger and message_type objects |
|
| 945 | - * (messengers index, and message_type index); |
|
| 946 | - */ |
|
| 947 | - public function get_installed($type = 'all', $skip_cache = false) |
|
| 948 | - { |
|
| 949 | - // EE_messages has been deprecated |
|
| 950 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 951 | - if ($skip_cache) { |
|
| 952 | - $this->_message_resource_manager->reset_active_messengers_and_message_types(); |
|
| 953 | - } |
|
| 954 | - switch ($type) { |
|
| 955 | - case 'messengers' : |
|
| 956 | - return array( |
|
| 957 | - 'messenger' => $this->_message_resource_manager->installed_messengers(), |
|
| 958 | - ); |
|
| 959 | - break; |
|
| 960 | - case 'message_types' : |
|
| 961 | - return array( |
|
| 962 | - 'message_type' => $this->_message_resource_manager->installed_message_types(), |
|
| 963 | - ); |
|
| 964 | - break; |
|
| 965 | - case 'all' : |
|
| 966 | - default : |
|
| 967 | - return array( |
|
| 968 | - 'messenger' => $this->_message_resource_manager->installed_messengers(), |
|
| 969 | - 'message_type' => $this->_message_resource_manager->installed_message_types(), |
|
| 970 | - ); |
|
| 971 | - break; |
|
| 972 | - } |
|
| 973 | - } |
|
| 974 | - |
|
| 975 | - |
|
| 976 | - /** |
|
| 977 | - * @deprecated 4.9.0 |
|
| 978 | - * @return \EE_messenger[] |
|
| 979 | - */ |
|
| 980 | - public function get_active_messengers() |
|
| 981 | - { |
|
| 982 | - // EE_messages has been deprecated |
|
| 983 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 984 | - return $this->_message_resource_manager->active_messengers(); |
|
| 985 | - } |
|
| 986 | - |
|
| 987 | - |
|
| 988 | - /** |
|
| 989 | - * @deprecated 4.9.0 |
|
| 990 | - * @return array array of message_type references (string) |
|
| 991 | - */ |
|
| 992 | - public function get_active_message_types() |
|
| 993 | - { |
|
| 994 | - // EE_messages has been deprecated |
|
| 995 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 996 | - return $this->_message_resource_manager->list_of_active_message_types(); |
|
| 997 | - } |
|
| 998 | - |
|
| 999 | - |
|
| 1000 | - /** |
|
| 1001 | - * @deprecated 4.9.0 |
|
| 1002 | - * @return EE_message_type[] |
|
| 1003 | - */ |
|
| 1004 | - public function get_active_message_type_objects() |
|
| 1005 | - { |
|
| 1006 | - // EE_messages has been deprecated |
|
| 1007 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 1008 | - return $this->_message_resource_manager->get_active_message_type_objects(); |
|
| 1009 | - } |
|
| 1010 | - |
|
| 1011 | - |
|
| 1012 | - /** |
|
| 1013 | - * @deprecated 4.9.0 |
|
| 1014 | - * @since 4.5.0 |
|
| 1015 | - * @param string $messenger The messenger being checked |
|
| 1016 | - * @return EE_message_type[] (or empty array if none present) |
|
| 1017 | - */ |
|
| 1018 | - public function get_active_message_types_per_messenger($messenger) |
|
| 1019 | - { |
|
| 1020 | - // EE_messages has been deprecated |
|
| 1021 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 1022 | - return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger); |
|
| 1023 | - } |
|
| 1024 | - |
|
| 1025 | - |
|
| 1026 | - /** |
|
| 1027 | - * @deprecated 4.9.0 |
|
| 1028 | - * @param string $messenger The string should correspond to the messenger (message types are |
|
| 1029 | - * @param string $message_type The string should correspond to a message type. |
|
| 1030 | - * @return EE_message_type|null |
|
| 1031 | - */ |
|
| 1032 | - public function get_active_message_type($messenger, $message_type) |
|
| 1033 | - { |
|
| 1034 | - // EE_messages has been deprecated |
|
| 1035 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 1036 | - return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type); |
|
| 1037 | - } |
|
| 1038 | - |
|
| 1039 | - |
|
| 1040 | - /** |
|
| 1041 | - * @deprecated 4.9.0 |
|
| 1042 | - * @return array|\EE_message_type[] |
|
| 1043 | - */ |
|
| 1044 | - public function get_installed_message_types() |
|
| 1045 | - { |
|
| 1046 | - // EE_messages has been deprecated |
|
| 1047 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 1048 | - return $this->_message_resource_manager->installed_message_types(); |
|
| 1049 | - } |
|
| 1050 | - |
|
| 1051 | - |
|
| 1052 | - /** |
|
| 1053 | - * @deprecated 4.9.0 |
|
| 1054 | - * @return array |
|
| 1055 | - */ |
|
| 1056 | - public function get_installed_messengers() |
|
| 1057 | - { |
|
| 1058 | - // EE_messages has been deprecated |
|
| 1059 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 1060 | - return $this->_message_resource_manager->installed_messengers(); |
|
| 1061 | - } |
|
| 1062 | - |
|
| 1063 | - |
|
| 1064 | - /** |
|
| 1065 | - * @deprecated 4.9.0 |
|
| 1066 | - * @param bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by |
|
| 1067 | - * message type. |
|
| 1068 | - * @return array |
|
| 1069 | - */ |
|
| 1070 | - public function get_all_contexts($slugs_only = true) |
|
| 1071 | - { |
|
| 1072 | - // EE_messages has been deprecated |
|
| 1073 | - $this->_class_is_deprecated(__FUNCTION__); |
|
| 1074 | - return $this->_message_resource_manager->get_all_contexts($slugs_only); |
|
| 1075 | - } |
|
| 557 | + /** @type EE_messenger[] */ |
|
| 558 | + protected $_active_messengers = array(); |
|
| 559 | + |
|
| 560 | + /** @type array */ |
|
| 561 | + protected $_active_message_types = array(); |
|
| 562 | + |
|
| 563 | + /** @type EE_message_type[] */ |
|
| 564 | + protected $_installed_message_types = array(); |
|
| 565 | + |
|
| 566 | + /** @type EE_messenger */ |
|
| 567 | + protected $_messenger; |
|
| 568 | + |
|
| 569 | + /** @type EE_message_type */ |
|
| 570 | + protected $_message_type; |
|
| 571 | + |
|
| 572 | + /** @type array */ |
|
| 573 | + protected $_contexts = array(); |
|
| 574 | + |
|
| 575 | + /** @type EE_Message_Resource_Manager $_message_resource_manager */ |
|
| 576 | + protected $_message_resource_manager; |
|
| 577 | + |
|
| 578 | + |
|
| 579 | + /** |
|
| 580 | + * EE_messages constructor. |
|
| 581 | + * |
|
| 582 | + * @deprecated 4.9.0 |
|
| 583 | + */ |
|
| 584 | + public function __construct() |
|
| 585 | + { |
|
| 586 | + } |
|
| 587 | + |
|
| 588 | + |
|
| 589 | + /** |
|
| 590 | + * @param string $method |
|
| 591 | + */ |
|
| 592 | + public function _class_is_deprecated($method) |
|
| 593 | + { |
|
| 594 | + EE_Error::doing_it_wrong( |
|
| 595 | + 'EE_messages::' . $method, |
|
| 596 | + __('EE_messages has been deprecated. Please use EE_Message_Resource_Manager instead.'), |
|
| 597 | + '4.9.0', |
|
| 598 | + '4.10.0.p' |
|
| 599 | + ); |
|
| 600 | + // Please use EE_Message_Resource_Manager instead |
|
| 601 | + $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 602 | + } |
|
| 603 | + |
|
| 604 | + |
|
| 605 | + /** |
|
| 606 | + * @deprecated 4.9.0 |
|
| 607 | + * @param string $messenger_name |
|
| 608 | + * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive |
|
| 609 | + */ |
|
| 610 | + public function ensure_messenger_is_active($messenger_name) |
|
| 611 | + { |
|
| 612 | + // EE_messages has been deprecated |
|
| 613 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 614 | + return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name); |
|
| 615 | + } |
|
| 616 | + |
|
| 617 | + |
|
| 618 | + /** |
|
| 619 | + * @deprecated 4.9.0 |
|
| 620 | + * @param string $message_type message type name |
|
| 621 | + * @param $messenger |
|
| 622 | + * @return bool true if it got activated (or was active) and false if not. |
|
| 623 | + * @throws \EE_Error |
|
| 624 | + */ |
|
| 625 | + public function ensure_message_type_is_active($message_type, $messenger) |
|
| 626 | + { |
|
| 627 | + // EE_messages has been deprecated |
|
| 628 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 629 | + return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger); |
|
| 630 | + } |
|
| 631 | + |
|
| 632 | + |
|
| 633 | + /** |
|
| 634 | + * @deprecated 4.9.0 |
|
| 635 | + * @param string $messenger_name |
|
| 636 | + * @param array $mts_to_activate (optional) An array of message types to activate with this messenger. |
|
| 637 | + * If included we do NOT setup the default message types (assuming they |
|
| 638 | + * are already setup.) |
|
| 639 | + * @return boolean an array of generated templates or false if nothing generated/activated. |
|
| 640 | + */ |
|
| 641 | + public function activate_messenger($messenger_name, $mts_to_activate = array()) |
|
| 642 | + { |
|
| 643 | + // EE_messages has been deprecated |
|
| 644 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 645 | + return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate); |
|
| 646 | + } |
|
| 647 | + |
|
| 648 | + |
|
| 649 | + /** |
|
| 650 | + * @deprecated 4.9.0 |
|
| 651 | + * @param EE_messenger $messenger messenger used in trigger |
|
| 652 | + * @param EE_message_type $message_type message type used in trigger |
|
| 653 | + * |
|
| 654 | + * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send. |
|
| 655 | + */ |
|
| 656 | + public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type) |
|
| 657 | + { |
|
| 658 | + // EE_messages has been deprecated |
|
| 659 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 660 | + return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type); |
|
| 661 | + } |
|
| 662 | + |
|
| 663 | + |
|
| 664 | + /** |
|
| 665 | + * @deprecated 4.9.0 |
|
| 666 | + * @param string $messenger |
|
| 667 | + * @return EE_messenger | null |
|
| 668 | + */ |
|
| 669 | + public function get_messenger_if_active($messenger) |
|
| 670 | + { |
|
| 671 | + // EE_messages has been deprecated |
|
| 672 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 673 | + return $this->_message_resource_manager->get_active_messenger($messenger); |
|
| 674 | + } |
|
| 675 | + |
|
| 676 | + |
|
| 677 | + /** |
|
| 678 | + * @deprecated 4.9.0 |
|
| 679 | + * @param EE_Message $message |
|
| 680 | + * @return array An array with 'messenger' and 'message_type' as the index and the corresponding valid object if |
|
| 681 | + * available. |
|
| 682 | + * Eg. Valid Messenger and Message Type: |
|
| 683 | + * array( |
|
| 684 | + * 'messenger' => new EE_Email_messenger(), |
|
| 685 | + * 'message_type' => new EE_Registration_Approved_message_type() |
|
| 686 | + * ) |
|
| 687 | + * Valid Messenger and Invalid Message Type: |
|
| 688 | + * array( |
|
| 689 | + * 'messenger' => new EE_Email_messenger(), |
|
| 690 | + * 'message_type' => null |
|
| 691 | + * ) |
|
| 692 | + */ |
|
| 693 | + public function validate_for_use(EE_Message $message) |
|
| 694 | + { |
|
| 695 | + // EE_messages has been deprecated |
|
| 696 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 697 | + return array( |
|
| 698 | + 'messenger' => $message->messenger_object(), |
|
| 699 | + 'message_type' => $message->message_type_object(), |
|
| 700 | + ); |
|
| 701 | + } |
|
| 702 | + |
|
| 703 | + |
|
| 704 | + /** |
|
| 705 | + * @deprecated 4.9.0 |
|
| 706 | + * @param string $type What type of message are we sending (corresponds to message types) |
|
| 707 | + * @param mixed $vars Data being sent for parsing in the message |
|
| 708 | + * @param string $sending_messenger if included then we ONLY use the specified messenger for delivery. |
|
| 709 | + * Otherwise we cycle through all active messengers. |
|
| 710 | + * @param string $generating_messenger if included then this messenger is used for generating the message |
|
| 711 | + * templates (but not for sending). |
|
| 712 | + * @param string $context If included then only a message type for a specific context will be |
|
| 713 | + * generated. |
|
| 714 | + * @param bool $send Default TRUE. If false, then this will just return the generated |
|
| 715 | + * EE_messages objects which might be used by the trigger to setup a batch |
|
| 716 | + * message (typically html messenger uses it). |
|
| 717 | + * @return bool |
|
| 718 | + */ |
|
| 719 | + public function send_message( |
|
| 720 | + $type, |
|
| 721 | + $vars, |
|
| 722 | + $sending_messenger = '', |
|
| 723 | + $generating_messenger = '', |
|
| 724 | + $context = '', |
|
| 725 | + $send = true |
|
| 726 | + ) { |
|
| 727 | + // EE_messages has been deprecated |
|
| 728 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 729 | + /** @type EE_Messages_Processor $processor */ |
|
| 730 | + $processor = EE_Registry::instance()->load_lib('Messages_Processor'); |
|
| 731 | + $error = false; |
|
| 732 | + // try to intelligently determine what method we'll call based on the incoming data. |
|
| 733 | + // if generating and sending are different then generate and send immediately. |
|
| 734 | + if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) { |
|
| 735 | + // in the legacy system, when generating and sending were different, that means all the |
|
| 736 | + // vars are already in the request object. So let's just use that. |
|
| 737 | + try { |
|
| 738 | + /** @type EE_Message_To_Generate_From_Request $mtg */ |
|
| 739 | + $mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request'); |
|
| 740 | + $processor->generate_and_send_now($mtg); |
|
| 741 | + } catch (EE_Error $e) { |
|
| 742 | + $error_msg = __( |
|
| 743 | + 'Please note that a system message failed to send due to a technical issue.', |
|
| 744 | + 'event_espresso' |
|
| 745 | + ); |
|
| 746 | + // add specific message for developers if WP_DEBUG in on |
|
| 747 | + $error_msg .= '||' . $e->getMessage(); |
|
| 748 | + EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 749 | + $error = true; |
|
| 750 | + } |
|
| 751 | + } else { |
|
| 752 | + $processor->generate_for_all_active_messengers($type, $vars, $send); |
|
| 753 | + // let's find out if there were any errors and how many successfully were queued. |
|
| 754 | + $count_errors = $processor->get_queue()->count_STS_in_queue( |
|
| 755 | + array(EEM_Message::status_failed, EEM_Message::status_debug_only) |
|
| 756 | + ); |
|
| 757 | + $count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete); |
|
| 758 | + $count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry); |
|
| 759 | + $count_errors = $count_errors + $count_retry; |
|
| 760 | + if ($count_errors > 0) { |
|
| 761 | + $error = true; |
|
| 762 | + if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) { |
|
| 763 | + $message = sprintf( |
|
| 764 | + __( |
|
| 765 | + 'There were %d errors and %d messages successfully queued for generation and sending', |
|
| 766 | + 'event_espresso' |
|
| 767 | + ), |
|
| 768 | + $count_errors, |
|
| 769 | + $count_queued |
|
| 770 | + ); |
|
| 771 | + } elseif ($count_errors > 1 && $count_queued === 1) { |
|
| 772 | + $message = sprintf( |
|
| 773 | + __( |
|
| 774 | + 'There were %d errors and %d message successfully queued for generation.', |
|
| 775 | + 'event_espresso' |
|
| 776 | + ), |
|
| 777 | + $count_errors, |
|
| 778 | + $count_queued |
|
| 779 | + ); |
|
| 780 | + } elseif ($count_errors === 1 && $count_queued > 1) { |
|
| 781 | + $message = sprintf( |
|
| 782 | + __( |
|
| 783 | + 'There was %d error and %d messages successfully queued for generation.', |
|
| 784 | + 'event_espresso' |
|
| 785 | + ), |
|
| 786 | + $count_errors, |
|
| 787 | + $count_queued |
|
| 788 | + ); |
|
| 789 | + } else { |
|
| 790 | + $message = sprintf( |
|
| 791 | + __( |
|
| 792 | + 'There was %d message that failed to be queued for generation.', |
|
| 793 | + 'event_espresso' |
|
| 794 | + ), |
|
| 795 | + $count_errors |
|
| 796 | + ); |
|
| 797 | + } |
|
| 798 | + EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__); |
|
| 799 | + } else { |
|
| 800 | + if ($count_queued === 1) { |
|
| 801 | + $message = sprintf( |
|
| 802 | + __( |
|
| 803 | + '%d message successfully queued for generation.', |
|
| 804 | + 'event_espresso' |
|
| 805 | + ), |
|
| 806 | + $count_queued |
|
| 807 | + ); |
|
| 808 | + } else { |
|
| 809 | + $message = sprintf( |
|
| 810 | + __( |
|
| 811 | + '%d messages were successfully queued for generation.', |
|
| 812 | + 'event_espresso' |
|
| 813 | + ), |
|
| 814 | + $count_queued |
|
| 815 | + ); |
|
| 816 | + } |
|
| 817 | + EE_Error::add_success($message); |
|
| 818 | + } |
|
| 819 | + } |
|
| 820 | + // if no error then return the generated message(s). |
|
| 821 | + if (! $error && ! $send) { |
|
| 822 | + $generated_queue = $processor->generate_queue(false); |
|
| 823 | + // get message and return. |
|
| 824 | + $generated_queue->get_message_repository()->rewind(); |
|
| 825 | + $messages = array(); |
|
| 826 | + while ($generated_queue->get_message_repository()->valid()) { |
|
| 827 | + $message = $generated_queue->get_message_repository()->current(); |
|
| 828 | + if ($message instanceof EE_Message) { |
|
| 829 | + // set properties that might be expected by add-ons (backward compat) |
|
| 830 | + $message->content = $message->content(); |
|
| 831 | + $message->template_pack = $message->get_template_pack(); |
|
| 832 | + $message->template_variation = $message->get_template_pack_variation(); |
|
| 833 | + $messages[] = $message; |
|
| 834 | + } |
|
| 835 | + $generated_queue->get_message_repository()->next(); |
|
| 836 | + } |
|
| 837 | + return $messages; |
|
| 838 | + } |
|
| 839 | + return $error ? false |
|
| 840 | + : true; // yeah backwards eh? Really what we're returning is if there is a total success for all the messages or not. We'll modify this once we get message recording in place. |
|
| 841 | + } |
|
| 842 | + |
|
| 843 | + |
|
| 844 | + /** |
|
| 845 | + * @deprecated 4.9.0 |
|
| 846 | + * @param string $type This should correspond with a valid message type |
|
| 847 | + * @param string $context This should correspond with a valid context for the message type |
|
| 848 | + * @param string $messenger This should correspond with a valid messenger. |
|
| 849 | + * @param bool $send true we will do a test send using the messenger delivery, false we just do a regular |
|
| 850 | + * preview |
|
| 851 | + * @return string The body of the message. |
|
| 852 | + */ |
|
| 853 | + public function preview_message($type, $context, $messenger, $send = false) |
|
| 854 | + { |
|
| 855 | + // EE_messages has been deprecated |
|
| 856 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 857 | + return EED_Messages::preview_message($type, $context, $messenger, $send); |
|
| 858 | + } |
|
| 859 | + |
|
| 860 | + |
|
| 861 | + /** |
|
| 862 | + * @since 4.5.0 |
|
| 863 | + * @deprecated 4.9.0 Moved to EED_Messages Module |
|
| 864 | + * @param string $messenger a string matching a valid active messenger in the system |
|
| 865 | + * @param string $message_type Although it seems contrary to the name of the method, a message type name is still |
|
| 866 | + * required to send along the message type to the messenger because this is used for |
|
| 867 | + * determining what specific variations might be loaded for the generated message. |
|
| 868 | + * @param stdClass $message a stdClass object in the format expected by the messenger. |
|
| 869 | + * |
|
| 870 | + * @return bool success or fail. |
|
| 871 | + */ |
|
| 872 | + public function send_message_with_messenger_only($messenger, $message_type, $message) |
|
| 873 | + { |
|
| 874 | + // EE_messages has been deprecated |
|
| 875 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 876 | + // setup for sending to new method. |
|
| 877 | + /** @type EE_Messages_Queue $queue */ |
|
| 878 | + $queue = EE_Registry::instance()->load_lib('Messages_Queue'); |
|
| 879 | + // make sure we have a proper message object |
|
| 880 | + if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) { |
|
| 881 | + $msg = EE_Message_Factory::create( |
|
| 882 | + array( |
|
| 883 | + 'MSG_messenger' => $messenger, |
|
| 884 | + 'MSG_message_type' => $message_type, |
|
| 885 | + 'MSG_content' => $message->content, |
|
| 886 | + 'MSG_subject' => $message->subject, |
|
| 887 | + ) |
|
| 888 | + ); |
|
| 889 | + } else { |
|
| 890 | + $msg = $message; |
|
| 891 | + } |
|
| 892 | + if (! $msg instanceof EE_Message) { |
|
| 893 | + return false; |
|
| 894 | + } |
|
| 895 | + // make sure any content in a content property (if not empty) is set on the MSG_content. |
|
| 896 | + if (! empty($msg->content)) { |
|
| 897 | + $msg->set('MSG_content', $msg->content); |
|
| 898 | + } |
|
| 899 | + $queue->add($msg); |
|
| 900 | + return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue); |
|
| 901 | + } |
|
| 902 | + |
|
| 903 | + |
|
| 904 | + /** |
|
| 905 | + * @deprecated 4.9.0 |
|
| 906 | + * @param $messenger |
|
| 907 | + * @param string $message_type message type that the templates are being created for |
|
| 908 | + * @param int $GRP_ID |
|
| 909 | + * @param bool $is_global |
|
| 910 | + * @return array|object if creation is successful then we return an array of info, otherwise an error_object is |
|
| 911 | + * returned. |
|
| 912 | + * @throws \EE_Error |
|
| 913 | + */ |
|
| 914 | + public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false) |
|
| 915 | + { |
|
| 916 | + // EE_messages has been deprecated |
|
| 917 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 918 | + EE_Registry::instance()->load_helper('MSG_Template'); |
|
| 919 | + return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global); |
|
| 920 | + } |
|
| 921 | + |
|
| 922 | + |
|
| 923 | + /** |
|
| 924 | + * @deprecated 4.9.0 |
|
| 925 | + * @param string $messenger_name name of EE_messenger |
|
| 926 | + * @param string $message_type_name name of EE_message_type |
|
| 927 | + * @return array |
|
| 928 | + */ |
|
| 929 | + public function get_fields($messenger_name, $message_type_name) |
|
| 930 | + { |
|
| 931 | + // EE_messages has been deprecated |
|
| 932 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 933 | + EE_Registry::instance()->load_helper('MSG_Template'); |
|
| 934 | + return EEH_MSG_Template::get_fields($messenger_name, $message_type_name); |
|
| 935 | + } |
|
| 936 | + |
|
| 937 | + |
|
| 938 | + /** |
|
| 939 | + * @deprecated 4.9.0 |
|
| 940 | + * @access public |
|
| 941 | + * @param string $type we can indicate just returning installed message types |
|
| 942 | + * or messengers (or both) via this parameter. |
|
| 943 | + * @param bool $skip_cache if true then we skip the cache and retrieve via files. |
|
| 944 | + * @return array multidimensional array of messenger and message_type objects |
|
| 945 | + * (messengers index, and message_type index); |
|
| 946 | + */ |
|
| 947 | + public function get_installed($type = 'all', $skip_cache = false) |
|
| 948 | + { |
|
| 949 | + // EE_messages has been deprecated |
|
| 950 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 951 | + if ($skip_cache) { |
|
| 952 | + $this->_message_resource_manager->reset_active_messengers_and_message_types(); |
|
| 953 | + } |
|
| 954 | + switch ($type) { |
|
| 955 | + case 'messengers' : |
|
| 956 | + return array( |
|
| 957 | + 'messenger' => $this->_message_resource_manager->installed_messengers(), |
|
| 958 | + ); |
|
| 959 | + break; |
|
| 960 | + case 'message_types' : |
|
| 961 | + return array( |
|
| 962 | + 'message_type' => $this->_message_resource_manager->installed_message_types(), |
|
| 963 | + ); |
|
| 964 | + break; |
|
| 965 | + case 'all' : |
|
| 966 | + default : |
|
| 967 | + return array( |
|
| 968 | + 'messenger' => $this->_message_resource_manager->installed_messengers(), |
|
| 969 | + 'message_type' => $this->_message_resource_manager->installed_message_types(), |
|
| 970 | + ); |
|
| 971 | + break; |
|
| 972 | + } |
|
| 973 | + } |
|
| 974 | + |
|
| 975 | + |
|
| 976 | + /** |
|
| 977 | + * @deprecated 4.9.0 |
|
| 978 | + * @return \EE_messenger[] |
|
| 979 | + */ |
|
| 980 | + public function get_active_messengers() |
|
| 981 | + { |
|
| 982 | + // EE_messages has been deprecated |
|
| 983 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 984 | + return $this->_message_resource_manager->active_messengers(); |
|
| 985 | + } |
|
| 986 | + |
|
| 987 | + |
|
| 988 | + /** |
|
| 989 | + * @deprecated 4.9.0 |
|
| 990 | + * @return array array of message_type references (string) |
|
| 991 | + */ |
|
| 992 | + public function get_active_message_types() |
|
| 993 | + { |
|
| 994 | + // EE_messages has been deprecated |
|
| 995 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 996 | + return $this->_message_resource_manager->list_of_active_message_types(); |
|
| 997 | + } |
|
| 998 | + |
|
| 999 | + |
|
| 1000 | + /** |
|
| 1001 | + * @deprecated 4.9.0 |
|
| 1002 | + * @return EE_message_type[] |
|
| 1003 | + */ |
|
| 1004 | + public function get_active_message_type_objects() |
|
| 1005 | + { |
|
| 1006 | + // EE_messages has been deprecated |
|
| 1007 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 1008 | + return $this->_message_resource_manager->get_active_message_type_objects(); |
|
| 1009 | + } |
|
| 1010 | + |
|
| 1011 | + |
|
| 1012 | + /** |
|
| 1013 | + * @deprecated 4.9.0 |
|
| 1014 | + * @since 4.5.0 |
|
| 1015 | + * @param string $messenger The messenger being checked |
|
| 1016 | + * @return EE_message_type[] (or empty array if none present) |
|
| 1017 | + */ |
|
| 1018 | + public function get_active_message_types_per_messenger($messenger) |
|
| 1019 | + { |
|
| 1020 | + // EE_messages has been deprecated |
|
| 1021 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 1022 | + return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger); |
|
| 1023 | + } |
|
| 1024 | + |
|
| 1025 | + |
|
| 1026 | + /** |
|
| 1027 | + * @deprecated 4.9.0 |
|
| 1028 | + * @param string $messenger The string should correspond to the messenger (message types are |
|
| 1029 | + * @param string $message_type The string should correspond to a message type. |
|
| 1030 | + * @return EE_message_type|null |
|
| 1031 | + */ |
|
| 1032 | + public function get_active_message_type($messenger, $message_type) |
|
| 1033 | + { |
|
| 1034 | + // EE_messages has been deprecated |
|
| 1035 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 1036 | + return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type); |
|
| 1037 | + } |
|
| 1038 | + |
|
| 1039 | + |
|
| 1040 | + /** |
|
| 1041 | + * @deprecated 4.9.0 |
|
| 1042 | + * @return array|\EE_message_type[] |
|
| 1043 | + */ |
|
| 1044 | + public function get_installed_message_types() |
|
| 1045 | + { |
|
| 1046 | + // EE_messages has been deprecated |
|
| 1047 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 1048 | + return $this->_message_resource_manager->installed_message_types(); |
|
| 1049 | + } |
|
| 1050 | + |
|
| 1051 | + |
|
| 1052 | + /** |
|
| 1053 | + * @deprecated 4.9.0 |
|
| 1054 | + * @return array |
|
| 1055 | + */ |
|
| 1056 | + public function get_installed_messengers() |
|
| 1057 | + { |
|
| 1058 | + // EE_messages has been deprecated |
|
| 1059 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 1060 | + return $this->_message_resource_manager->installed_messengers(); |
|
| 1061 | + } |
|
| 1062 | + |
|
| 1063 | + |
|
| 1064 | + /** |
|
| 1065 | + * @deprecated 4.9.0 |
|
| 1066 | + * @param bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by |
|
| 1067 | + * message type. |
|
| 1068 | + * @return array |
|
| 1069 | + */ |
|
| 1070 | + public function get_all_contexts($slugs_only = true) |
|
| 1071 | + { |
|
| 1072 | + // EE_messages has been deprecated |
|
| 1073 | + $this->_class_is_deprecated(__FUNCTION__); |
|
| 1074 | + return $this->_message_resource_manager->get_all_contexts($slugs_only); |
|
| 1075 | + } |
|
| 1076 | 1076 | |
| 1077 | 1077 | |
| 1078 | 1078 | } |
@@ -1131,88 +1131,88 @@ discard block |
||
| 1131 | 1131 | |
| 1132 | 1132 | |
| 1133 | 1133 | add_filter( |
| 1134 | - 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
|
| 1135 | - function ($event_list_iframe_css) { |
|
| 1136 | - if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) { |
|
| 1137 | - return $event_list_iframe_css; |
|
| 1138 | - } |
|
| 1139 | - deprecated_espresso_action_or_filter_doing_it_wrong( |
|
| 1140 | - 'FHEE__EventsArchiveIframe__event_list_iframe__css', |
|
| 1141 | - 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
|
| 1142 | - '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()', |
|
| 1143 | - '4.9.14', |
|
| 1144 | - '5.0.0', |
|
| 1145 | - 'filter' |
|
| 1146 | - ); |
|
| 1147 | - return apply_filters( |
|
| 1148 | - 'FHEE__EventsArchiveIframe__event_list_iframe__css', |
|
| 1149 | - $event_list_iframe_css |
|
| 1150 | - ); |
|
| 1151 | - } |
|
| 1134 | + 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
|
| 1135 | + function ($event_list_iframe_css) { |
|
| 1136 | + if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) { |
|
| 1137 | + return $event_list_iframe_css; |
|
| 1138 | + } |
|
| 1139 | + deprecated_espresso_action_or_filter_doing_it_wrong( |
|
| 1140 | + 'FHEE__EventsArchiveIframe__event_list_iframe__css', |
|
| 1141 | + 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
|
| 1142 | + '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()', |
|
| 1143 | + '4.9.14', |
|
| 1144 | + '5.0.0', |
|
| 1145 | + 'filter' |
|
| 1146 | + ); |
|
| 1147 | + return apply_filters( |
|
| 1148 | + 'FHEE__EventsArchiveIframe__event_list_iframe__css', |
|
| 1149 | + $event_list_iframe_css |
|
| 1150 | + ); |
|
| 1151 | + } |
|
| 1152 | 1152 | ); |
| 1153 | 1153 | add_filter( |
| 1154 | - 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
|
| 1155 | - function ($event_list_iframe_js) { |
|
| 1156 | - if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) { |
|
| 1157 | - return $event_list_iframe_js; |
|
| 1158 | - } |
|
| 1159 | - deprecated_espresso_action_or_filter_doing_it_wrong( |
|
| 1160 | - 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js', |
|
| 1161 | - 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
|
| 1162 | - '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()', |
|
| 1163 | - '4.9.14', |
|
| 1164 | - '5.0.0', |
|
| 1165 | - 'filter' |
|
| 1166 | - ); |
|
| 1167 | - return apply_filters( |
|
| 1168 | - 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js', |
|
| 1169 | - $event_list_iframe_js |
|
| 1170 | - ); |
|
| 1171 | - } |
|
| 1154 | + 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
|
| 1155 | + function ($event_list_iframe_js) { |
|
| 1156 | + if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) { |
|
| 1157 | + return $event_list_iframe_js; |
|
| 1158 | + } |
|
| 1159 | + deprecated_espresso_action_or_filter_doing_it_wrong( |
|
| 1160 | + 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js', |
|
| 1161 | + 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
|
| 1162 | + '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()', |
|
| 1163 | + '4.9.14', |
|
| 1164 | + '5.0.0', |
|
| 1165 | + 'filter' |
|
| 1166 | + ); |
|
| 1167 | + return apply_filters( |
|
| 1168 | + 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js', |
|
| 1169 | + $event_list_iframe_js |
|
| 1170 | + ); |
|
| 1171 | + } |
|
| 1172 | 1172 | ); |
| 1173 | 1173 | add_action( |
| 1174 | - 'AHEE__EE_Capabilities__addCaps__complete', |
|
| 1175 | - function ($capabilities_map) { |
|
| 1176 | - if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) { |
|
| 1177 | - return; |
|
| 1178 | - } |
|
| 1179 | - deprecated_espresso_action_or_filter_doing_it_wrong( |
|
| 1180 | - 'AHEE__EE_Capabilities__init_role_caps__complete', |
|
| 1181 | - 'AHEE__EE_Capabilities__addCaps__complete', |
|
| 1182 | - '\EE_Capabilities::addCaps()', |
|
| 1183 | - '4.9.42', |
|
| 1184 | - '5.0.0' |
|
| 1185 | - ); |
|
| 1186 | - do_action( |
|
| 1187 | - 'AHEE__EE_Capabilities__init_role_caps__complete', |
|
| 1188 | - $capabilities_map |
|
| 1189 | - ); |
|
| 1190 | - } |
|
| 1174 | + 'AHEE__EE_Capabilities__addCaps__complete', |
|
| 1175 | + function ($capabilities_map) { |
|
| 1176 | + if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) { |
|
| 1177 | + return; |
|
| 1178 | + } |
|
| 1179 | + deprecated_espresso_action_or_filter_doing_it_wrong( |
|
| 1180 | + 'AHEE__EE_Capabilities__init_role_caps__complete', |
|
| 1181 | + 'AHEE__EE_Capabilities__addCaps__complete', |
|
| 1182 | + '\EE_Capabilities::addCaps()', |
|
| 1183 | + '4.9.42', |
|
| 1184 | + '5.0.0' |
|
| 1185 | + ); |
|
| 1186 | + do_action( |
|
| 1187 | + 'AHEE__EE_Capabilities__init_role_caps__complete', |
|
| 1188 | + $capabilities_map |
|
| 1189 | + ); |
|
| 1190 | + } |
|
| 1191 | 1191 | ); |
| 1192 | 1192 | |
| 1193 | 1193 | add_filter( |
| 1194 | - 'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee', |
|
| 1195 | - function ($existing_attendee, $registration, $attendee_data) { |
|
| 1196 | - if (! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) { |
|
| 1197 | - return $existing_attendee; |
|
| 1198 | - } |
|
| 1199 | - deprecated_espresso_action_or_filter_doing_it_wrong( |
|
| 1200 | - 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee', |
|
| 1201 | - 'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee', |
|
| 1202 | - '\EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler::findExistingAttendee()', |
|
| 1203 | - '4.9.34', |
|
| 1204 | - '5.0.0', |
|
| 1205 | - 'filter' |
|
| 1206 | - ); |
|
| 1207 | - return apply_filters( |
|
| 1208 | - 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee', |
|
| 1209 | - $existing_attendee, |
|
| 1210 | - $registration, |
|
| 1211 | - $attendee_data |
|
| 1212 | - ); |
|
| 1213 | - }, |
|
| 1214 | - 10, |
|
| 1215 | - 3 |
|
| 1194 | + 'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee', |
|
| 1195 | + function ($existing_attendee, $registration, $attendee_data) { |
|
| 1196 | + if (! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) { |
|
| 1197 | + return $existing_attendee; |
|
| 1198 | + } |
|
| 1199 | + deprecated_espresso_action_or_filter_doing_it_wrong( |
|
| 1200 | + 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee', |
|
| 1201 | + 'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee', |
|
| 1202 | + '\EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler::findExistingAttendee()', |
|
| 1203 | + '4.9.34', |
|
| 1204 | + '5.0.0', |
|
| 1205 | + 'filter' |
|
| 1206 | + ); |
|
| 1207 | + return apply_filters( |
|
| 1208 | + 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee', |
|
| 1209 | + $existing_attendee, |
|
| 1210 | + $registration, |
|
| 1211 | + $attendee_data |
|
| 1212 | + ); |
|
| 1213 | + }, |
|
| 1214 | + 10, |
|
| 1215 | + 3 |
|
| 1216 | 1216 | ); |
| 1217 | 1217 | |
| 1218 | 1218 | /** |
@@ -1223,88 +1223,88 @@ discard block |
||
| 1223 | 1223 | class EE_Event_List_Query extends WP_Query |
| 1224 | 1224 | { |
| 1225 | 1225 | |
| 1226 | - private $title; |
|
| 1227 | - |
|
| 1228 | - private $css_class; |
|
| 1229 | - |
|
| 1230 | - private $category_slug; |
|
| 1231 | - |
|
| 1232 | - /** |
|
| 1233 | - * EE_Event_List_Query constructor. |
|
| 1234 | - * |
|
| 1235 | - * @param array $args |
|
| 1236 | - */ |
|
| 1237 | - public function __construct($args = array()) |
|
| 1238 | - { |
|
| 1239 | - \EE_Error::doing_it_wrong( |
|
| 1240 | - __METHOD__, |
|
| 1241 | - __( |
|
| 1242 | - 'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.', |
|
| 1243 | - 'event_espresso' |
|
| 1244 | - ), |
|
| 1245 | - '4.9.27', |
|
| 1246 | - '5.0.0' |
|
| 1247 | - ); |
|
| 1248 | - $this->title = isset($args['title']) ? $args['title'] : ''; |
|
| 1249 | - $this->css_class = isset($args['css_class']) ? $args['css_class'] : ''; |
|
| 1250 | - $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : ''; |
|
| 1251 | - $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10; |
|
| 1252 | - // the current "page" we are viewing |
|
| 1253 | - $paged = max(1, get_query_var('paged')); |
|
| 1254 | - // Force these args |
|
| 1255 | - $args = array_merge( |
|
| 1256 | - $args, |
|
| 1257 | - array( |
|
| 1258 | - 'post_type' => 'espresso_events', |
|
| 1259 | - 'posts_per_page' => $limit, |
|
| 1260 | - 'update_post_term_cache' => false, |
|
| 1261 | - 'update_post_meta_cache' => false, |
|
| 1262 | - 'paged' => $paged, |
|
| 1263 | - 'offset' => ($paged - 1) * $limit, |
|
| 1264 | - ) |
|
| 1265 | - ); |
|
| 1266 | - // run the query |
|
| 1267 | - parent::__construct($args); |
|
| 1268 | - } |
|
| 1269 | - |
|
| 1270 | - |
|
| 1271 | - /** |
|
| 1272 | - * event_list_title |
|
| 1273 | - * |
|
| 1274 | - * @param string $event_list_title |
|
| 1275 | - * @return string |
|
| 1276 | - */ |
|
| 1277 | - public function event_list_title($event_list_title = '') |
|
| 1278 | - { |
|
| 1279 | - if (! empty($this->title)) { |
|
| 1280 | - return $this->title; |
|
| 1281 | - } |
|
| 1282 | - return $event_list_title; |
|
| 1283 | - } |
|
| 1284 | - |
|
| 1285 | - |
|
| 1286 | - /** |
|
| 1287 | - * event_list_css |
|
| 1288 | - * |
|
| 1289 | - * @param string $event_list_css |
|
| 1290 | - * @return string |
|
| 1291 | - */ |
|
| 1292 | - public function event_list_css($event_list_css = '') |
|
| 1293 | - { |
|
| 1294 | - $event_list_css .= ! empty($event_list_css) |
|
| 1295 | - ? ' ' |
|
| 1296 | - : ''; |
|
| 1297 | - $event_list_css .= ! empty($this->css_class) |
|
| 1298 | - ? $this->css_class |
|
| 1299 | - : ''; |
|
| 1300 | - $event_list_css .= ! empty($event_list_css) |
|
| 1301 | - ? ' ' |
|
| 1302 | - : ''; |
|
| 1303 | - $event_list_css .= ! empty($this->category_slug) |
|
| 1304 | - ? $this->category_slug |
|
| 1305 | - : ''; |
|
| 1306 | - return $event_list_css; |
|
| 1307 | - } |
|
| 1226 | + private $title; |
|
| 1227 | + |
|
| 1228 | + private $css_class; |
|
| 1229 | + |
|
| 1230 | + private $category_slug; |
|
| 1231 | + |
|
| 1232 | + /** |
|
| 1233 | + * EE_Event_List_Query constructor. |
|
| 1234 | + * |
|
| 1235 | + * @param array $args |
|
| 1236 | + */ |
|
| 1237 | + public function __construct($args = array()) |
|
| 1238 | + { |
|
| 1239 | + \EE_Error::doing_it_wrong( |
|
| 1240 | + __METHOD__, |
|
| 1241 | + __( |
|
| 1242 | + 'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.', |
|
| 1243 | + 'event_espresso' |
|
| 1244 | + ), |
|
| 1245 | + '4.9.27', |
|
| 1246 | + '5.0.0' |
|
| 1247 | + ); |
|
| 1248 | + $this->title = isset($args['title']) ? $args['title'] : ''; |
|
| 1249 | + $this->css_class = isset($args['css_class']) ? $args['css_class'] : ''; |
|
| 1250 | + $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : ''; |
|
| 1251 | + $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10; |
|
| 1252 | + // the current "page" we are viewing |
|
| 1253 | + $paged = max(1, get_query_var('paged')); |
|
| 1254 | + // Force these args |
|
| 1255 | + $args = array_merge( |
|
| 1256 | + $args, |
|
| 1257 | + array( |
|
| 1258 | + 'post_type' => 'espresso_events', |
|
| 1259 | + 'posts_per_page' => $limit, |
|
| 1260 | + 'update_post_term_cache' => false, |
|
| 1261 | + 'update_post_meta_cache' => false, |
|
| 1262 | + 'paged' => $paged, |
|
| 1263 | + 'offset' => ($paged - 1) * $limit, |
|
| 1264 | + ) |
|
| 1265 | + ); |
|
| 1266 | + // run the query |
|
| 1267 | + parent::__construct($args); |
|
| 1268 | + } |
|
| 1269 | + |
|
| 1270 | + |
|
| 1271 | + /** |
|
| 1272 | + * event_list_title |
|
| 1273 | + * |
|
| 1274 | + * @param string $event_list_title |
|
| 1275 | + * @return string |
|
| 1276 | + */ |
|
| 1277 | + public function event_list_title($event_list_title = '') |
|
| 1278 | + { |
|
| 1279 | + if (! empty($this->title)) { |
|
| 1280 | + return $this->title; |
|
| 1281 | + } |
|
| 1282 | + return $event_list_title; |
|
| 1283 | + } |
|
| 1284 | + |
|
| 1285 | + |
|
| 1286 | + /** |
|
| 1287 | + * event_list_css |
|
| 1288 | + * |
|
| 1289 | + * @param string $event_list_css |
|
| 1290 | + * @return string |
|
| 1291 | + */ |
|
| 1292 | + public function event_list_css($event_list_css = '') |
|
| 1293 | + { |
|
| 1294 | + $event_list_css .= ! empty($event_list_css) |
|
| 1295 | + ? ' ' |
|
| 1296 | + : ''; |
|
| 1297 | + $event_list_css .= ! empty($this->css_class) |
|
| 1298 | + ? $this->css_class |
|
| 1299 | + : ''; |
|
| 1300 | + $event_list_css .= ! empty($event_list_css) |
|
| 1301 | + ? ' ' |
|
| 1302 | + : ''; |
|
| 1303 | + $event_list_css .= ! empty($this->category_slug) |
|
| 1304 | + ? $this->category_slug |
|
| 1305 | + : ''; |
|
| 1306 | + return $event_list_css; |
|
| 1307 | + } |
|
| 1308 | 1308 | |
| 1309 | 1309 | } |
| 1310 | 1310 | |
@@ -1321,75 +1321,75 @@ discard block |
||
| 1321 | 1321 | { |
| 1322 | 1322 | |
| 1323 | 1323 | |
| 1324 | - /** |
|
| 1325 | - * class constructor |
|
| 1326 | - * |
|
| 1327 | - * @deprecated 4.9.59.p |
|
| 1328 | - */ |
|
| 1329 | - public function __construct() |
|
| 1330 | - { |
|
| 1331 | - EE_Error::doing_it_wrong( |
|
| 1332 | - __METHOD__, |
|
| 1333 | - sprintf( |
|
| 1334 | - esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'), |
|
| 1335 | - __CLASS__, |
|
| 1336 | - 'EventEspresso\core\services\licensing\LicenseServices' |
|
| 1337 | - ), |
|
| 1338 | - '4.9.59.p' |
|
| 1339 | - ); |
|
| 1340 | - } |
|
| 1341 | - |
|
| 1342 | - |
|
| 1343 | - /** |
|
| 1344 | - * The purpose of this function is to display information about Event Espresso data collection |
|
| 1345 | - * and a optin selection for extra data collecting by users. |
|
| 1346 | - * |
|
| 1347 | - * @param bool $extra |
|
| 1348 | - * @return string html. |
|
| 1349 | - * @deprecated 4.9.59.p |
|
| 1350 | - */ |
|
| 1351 | - public static function espresso_data_collection_optin_text($extra = true) |
|
| 1352 | - { |
|
| 1353 | - EE_Error::doing_it_wrong( |
|
| 1354 | - __METHOD__, |
|
| 1355 | - sprintf( |
|
| 1356 | - esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'), |
|
| 1357 | - __METHOD__, |
|
| 1358 | - 'EventEspresso\core\domain\services\Stats::optinText' |
|
| 1359 | - ), |
|
| 1360 | - '4.9.59.p' |
|
| 1361 | - ); |
|
| 1362 | - Stats::optinText($extra); |
|
| 1363 | - } |
|
| 1364 | - |
|
| 1365 | - /** |
|
| 1366 | - * This is a handy helper method for retrieving whether there is an update available for the given plugin. |
|
| 1367 | - * |
|
| 1368 | - * @param string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to |
|
| 1369 | - * identify plugins. Defaults to core update |
|
| 1370 | - * @return boolean True if update available, false if not. |
|
| 1371 | - * @deprecated 4.9.59.p |
|
| 1372 | - */ |
|
| 1373 | - public static function is_update_available($basename = '') |
|
| 1374 | - { |
|
| 1375 | - EE_Error::doing_it_wrong( |
|
| 1376 | - __METHOD__, |
|
| 1377 | - sprintf( |
|
| 1378 | - esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'), |
|
| 1379 | - __METHOD__, |
|
| 1380 | - 'EventEspresso\core\services\licensing\LicenseService::isUpdateAvailable' |
|
| 1381 | - ), |
|
| 1382 | - '4.9.59.p' |
|
| 1383 | - ); |
|
| 1384 | - return LicenseService::isUpdateAvailable($basename); |
|
| 1385 | - } |
|
| 1324 | + /** |
|
| 1325 | + * class constructor |
|
| 1326 | + * |
|
| 1327 | + * @deprecated 4.9.59.p |
|
| 1328 | + */ |
|
| 1329 | + public function __construct() |
|
| 1330 | + { |
|
| 1331 | + EE_Error::doing_it_wrong( |
|
| 1332 | + __METHOD__, |
|
| 1333 | + sprintf( |
|
| 1334 | + esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'), |
|
| 1335 | + __CLASS__, |
|
| 1336 | + 'EventEspresso\core\services\licensing\LicenseServices' |
|
| 1337 | + ), |
|
| 1338 | + '4.9.59.p' |
|
| 1339 | + ); |
|
| 1340 | + } |
|
| 1341 | + |
|
| 1342 | + |
|
| 1343 | + /** |
|
| 1344 | + * The purpose of this function is to display information about Event Espresso data collection |
|
| 1345 | + * and a optin selection for extra data collecting by users. |
|
| 1346 | + * |
|
| 1347 | + * @param bool $extra |
|
| 1348 | + * @return string html. |
|
| 1349 | + * @deprecated 4.9.59.p |
|
| 1350 | + */ |
|
| 1351 | + public static function espresso_data_collection_optin_text($extra = true) |
|
| 1352 | + { |
|
| 1353 | + EE_Error::doing_it_wrong( |
|
| 1354 | + __METHOD__, |
|
| 1355 | + sprintf( |
|
| 1356 | + esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'), |
|
| 1357 | + __METHOD__, |
|
| 1358 | + 'EventEspresso\core\domain\services\Stats::optinText' |
|
| 1359 | + ), |
|
| 1360 | + '4.9.59.p' |
|
| 1361 | + ); |
|
| 1362 | + Stats::optinText($extra); |
|
| 1363 | + } |
|
| 1364 | + |
|
| 1365 | + /** |
|
| 1366 | + * This is a handy helper method for retrieving whether there is an update available for the given plugin. |
|
| 1367 | + * |
|
| 1368 | + * @param string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to |
|
| 1369 | + * identify plugins. Defaults to core update |
|
| 1370 | + * @return boolean True if update available, false if not. |
|
| 1371 | + * @deprecated 4.9.59.p |
|
| 1372 | + */ |
|
| 1373 | + public static function is_update_available($basename = '') |
|
| 1374 | + { |
|
| 1375 | + EE_Error::doing_it_wrong( |
|
| 1376 | + __METHOD__, |
|
| 1377 | + sprintf( |
|
| 1378 | + esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'), |
|
| 1379 | + __METHOD__, |
|
| 1380 | + 'EventEspresso\core\services\licensing\LicenseService::isUpdateAvailable' |
|
| 1381 | + ), |
|
| 1382 | + '4.9.59.p' |
|
| 1383 | + ); |
|
| 1384 | + return LicenseService::isUpdateAvailable($basename); |
|
| 1385 | + } |
|
| 1386 | 1386 | } |
| 1387 | 1387 | |
| 1388 | 1388 | add_filter( |
| 1389 | - 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array', |
|
| 1390 | - 'ee_deprecated_registrations_report_csv_legacy_fields', |
|
| 1391 | - 10, |
|
| 1392 | - 2 |
|
| 1389 | + 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array', |
|
| 1390 | + 'ee_deprecated_registrations_report_csv_legacy_fields', |
|
| 1391 | + 10, |
|
| 1392 | + 2 |
|
| 1393 | 1393 | ); |
| 1394 | 1394 | /** |
| 1395 | 1395 | * Filters the CSV row to make it appear like the old labels (which were "$pretty_name[$field_name]"). |
@@ -1406,96 +1406,96 @@ discard block |
||
| 1406 | 1406 | */ |
| 1407 | 1407 | function ee_deprecated_registrations_report_csv_legacy_fields($csv_row_data, $reg_row) |
| 1408 | 1408 | { |
| 1409 | - // no need for all this if nobody is using the deprecated filter |
|
| 1410 | - if (has_filter('FHEE__EE_Export__report_registrations__reg_csv_array')) { |
|
| 1411 | - EE_Error::doing_it_wrong( |
|
| 1412 | - __FUNCTION__, |
|
| 1413 | - sprintf( |
|
| 1414 | - // EE_Error::doing_it_wrong with escape HTML, so don't escape it twice by doing it here too. |
|
| 1415 | - _x( |
|
| 1416 | - 'The filter "%1$s" has been deprecated. Please use "%2$s" instead.', |
|
| 1417 | - 'The filter "FHEE__EE_Export__report_registrations__reg_csv_array" has been deprecated. Please use "FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array" instead.', |
|
| 1418 | - 'event_espresso' |
|
| 1419 | - ), |
|
| 1420 | - 'FHEE__EE_Export__report_registrations__reg_csv_array', |
|
| 1421 | - 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array' |
|
| 1422 | - ), |
|
| 1423 | - '$VID:$', |
|
| 1424 | - '4.9.75.p' |
|
| 1425 | - ); |
|
| 1426 | - // there's code that expected the old csv column headers/labels. Let's oblige. Put it back in the old format! |
|
| 1427 | - // first: what model fields might be used as column headers? (whose format we need to change) |
|
| 1428 | - $model_fields = array_merge( |
|
| 1429 | - EEM_Registration::instance()->field_settings(), |
|
| 1430 | - EEM_Attendee::instance()->field_settings() |
|
| 1431 | - ); |
|
| 1432 | - // create an array that uses the legacy column headers/labels. |
|
| 1433 | - $new_csv_row = array(); |
|
| 1434 | - foreach ($csv_row_data as $label => $value) { |
|
| 1435 | - $new_label = $label; |
|
| 1436 | - foreach ($model_fields as $field) { |
|
| 1437 | - if ($label === EEH_Export::get_column_name_for_field($field)) { |
|
| 1438 | - // re-add the old field name |
|
| 1439 | - $new_label = $label . '[' . $field->get_name() . ']'; |
|
| 1440 | - break; |
|
| 1441 | - } |
|
| 1442 | - } |
|
| 1443 | - $new_csv_row[$new_label] = $value; |
|
| 1444 | - } |
|
| 1445 | - // before we run it through the deprecated filter, set the method `EEH_Export::get_column_name_for_field()` |
|
| 1446 | - // to create the old column names, because that's what's in the row temporarily |
|
| 1447 | - add_filter( |
|
| 1448 | - 'FHEE__EEH_Export__get_column_name_for_field__add_field_name', |
|
| 1449 | - '__return_true', |
|
| 1450 | - 777 |
|
| 1451 | - ); |
|
| 1452 | - // now, those old filters can be run on this data. Have fun! |
|
| 1453 | - /** |
|
| 1454 | - * Deprecated. Use FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array instead. |
|
| 1455 | - * |
|
| 1456 | - * Filter to change the contents of each row of the registrations report CSV file. |
|
| 1457 | - * This can be used to add or remote columns from the CSV file, or change their values. * |
|
| 1458 | - * Note: it has this name because originally that's where this filter resided, |
|
| 1459 | - * and we've left its name as-is for backward compatibility. |
|
| 1460 | - * Note when using: all rows in the CSV should have the same columns. |
|
| 1461 | - * |
|
| 1462 | - * @param array $reg_csv_array keys are column-header names, and values are that columns' value |
|
| 1463 | - * in this row |
|
| 1464 | - * @param array $reg_row is the row from the database's wp_esp_registration table |
|
| 1465 | - */ |
|
| 1466 | - $updated_row = apply_filters( |
|
| 1467 | - 'FHEE__EE_Export__report_registrations__reg_csv_array', |
|
| 1468 | - $new_csv_row, |
|
| 1469 | - $reg_row |
|
| 1470 | - ); |
|
| 1471 | - |
|
| 1472 | - // ok now we can revert to normal for EEH_Export::get_column_name_for_field(). |
|
| 1473 | - remove_filter( |
|
| 1474 | - 'FHEE__EEH_Export__get_column_name_for_field__add_field_name', |
|
| 1475 | - '__return_true', |
|
| 1476 | - 777 |
|
| 1477 | - ); |
|
| 1478 | - |
|
| 1479 | - // great. Now that the old filters are done, we can remove the ugly square brackets from column headers/labels. |
|
| 1480 | - $updated_and_restored_row = array(); |
|
| 1481 | - foreach ($updated_row as $label => $value) { |
|
| 1482 | - $matches = array(); |
|
| 1483 | - if (preg_match( |
|
| 1484 | - '~([^\[]*)\[(.*)\]~', |
|
| 1485 | - $label, |
|
| 1486 | - $matches |
|
| 1487 | - ) |
|
| 1488 | - && isset( |
|
| 1489 | - $matches[0], |
|
| 1490 | - $matches[1], |
|
| 1491 | - $matches[2] |
|
| 1492 | - ) |
|
| 1493 | - ) { |
|
| 1494 | - $label = $matches[1]; |
|
| 1495 | - } |
|
| 1496 | - $updated_and_restored_row[$label] = $value; |
|
| 1497 | - } |
|
| 1498 | - $csv_row_data = $updated_and_restored_row; |
|
| 1499 | - } |
|
| 1500 | - return $csv_row_data; |
|
| 1409 | + // no need for all this if nobody is using the deprecated filter |
|
| 1410 | + if (has_filter('FHEE__EE_Export__report_registrations__reg_csv_array')) { |
|
| 1411 | + EE_Error::doing_it_wrong( |
|
| 1412 | + __FUNCTION__, |
|
| 1413 | + sprintf( |
|
| 1414 | + // EE_Error::doing_it_wrong with escape HTML, so don't escape it twice by doing it here too. |
|
| 1415 | + _x( |
|
| 1416 | + 'The filter "%1$s" has been deprecated. Please use "%2$s" instead.', |
|
| 1417 | + 'The filter "FHEE__EE_Export__report_registrations__reg_csv_array" has been deprecated. Please use "FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array" instead.', |
|
| 1418 | + 'event_espresso' |
|
| 1419 | + ), |
|
| 1420 | + 'FHEE__EE_Export__report_registrations__reg_csv_array', |
|
| 1421 | + 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array' |
|
| 1422 | + ), |
|
| 1423 | + '$VID:$', |
|
| 1424 | + '4.9.75.p' |
|
| 1425 | + ); |
|
| 1426 | + // there's code that expected the old csv column headers/labels. Let's oblige. Put it back in the old format! |
|
| 1427 | + // first: what model fields might be used as column headers? (whose format we need to change) |
|
| 1428 | + $model_fields = array_merge( |
|
| 1429 | + EEM_Registration::instance()->field_settings(), |
|
| 1430 | + EEM_Attendee::instance()->field_settings() |
|
| 1431 | + ); |
|
| 1432 | + // create an array that uses the legacy column headers/labels. |
|
| 1433 | + $new_csv_row = array(); |
|
| 1434 | + foreach ($csv_row_data as $label => $value) { |
|
| 1435 | + $new_label = $label; |
|
| 1436 | + foreach ($model_fields as $field) { |
|
| 1437 | + if ($label === EEH_Export::get_column_name_for_field($field)) { |
|
| 1438 | + // re-add the old field name |
|
| 1439 | + $new_label = $label . '[' . $field->get_name() . ']'; |
|
| 1440 | + break; |
|
| 1441 | + } |
|
| 1442 | + } |
|
| 1443 | + $new_csv_row[$new_label] = $value; |
|
| 1444 | + } |
|
| 1445 | + // before we run it through the deprecated filter, set the method `EEH_Export::get_column_name_for_field()` |
|
| 1446 | + // to create the old column names, because that's what's in the row temporarily |
|
| 1447 | + add_filter( |
|
| 1448 | + 'FHEE__EEH_Export__get_column_name_for_field__add_field_name', |
|
| 1449 | + '__return_true', |
|
| 1450 | + 777 |
|
| 1451 | + ); |
|
| 1452 | + // now, those old filters can be run on this data. Have fun! |
|
| 1453 | + /** |
|
| 1454 | + * Deprecated. Use FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array instead. |
|
| 1455 | + * |
|
| 1456 | + * Filter to change the contents of each row of the registrations report CSV file. |
|
| 1457 | + * This can be used to add or remote columns from the CSV file, or change their values. * |
|
| 1458 | + * Note: it has this name because originally that's where this filter resided, |
|
| 1459 | + * and we've left its name as-is for backward compatibility. |
|
| 1460 | + * Note when using: all rows in the CSV should have the same columns. |
|
| 1461 | + * |
|
| 1462 | + * @param array $reg_csv_array keys are column-header names, and values are that columns' value |
|
| 1463 | + * in this row |
|
| 1464 | + * @param array $reg_row is the row from the database's wp_esp_registration table |
|
| 1465 | + */ |
|
| 1466 | + $updated_row = apply_filters( |
|
| 1467 | + 'FHEE__EE_Export__report_registrations__reg_csv_array', |
|
| 1468 | + $new_csv_row, |
|
| 1469 | + $reg_row |
|
| 1470 | + ); |
|
| 1471 | + |
|
| 1472 | + // ok now we can revert to normal for EEH_Export::get_column_name_for_field(). |
|
| 1473 | + remove_filter( |
|
| 1474 | + 'FHEE__EEH_Export__get_column_name_for_field__add_field_name', |
|
| 1475 | + '__return_true', |
|
| 1476 | + 777 |
|
| 1477 | + ); |
|
| 1478 | + |
|
| 1479 | + // great. Now that the old filters are done, we can remove the ugly square brackets from column headers/labels. |
|
| 1480 | + $updated_and_restored_row = array(); |
|
| 1481 | + foreach ($updated_row as $label => $value) { |
|
| 1482 | + $matches = array(); |
|
| 1483 | + if (preg_match( |
|
| 1484 | + '~([^\[]*)\[(.*)\]~', |
|
| 1485 | + $label, |
|
| 1486 | + $matches |
|
| 1487 | + ) |
|
| 1488 | + && isset( |
|
| 1489 | + $matches[0], |
|
| 1490 | + $matches[1], |
|
| 1491 | + $matches[2] |
|
| 1492 | + ) |
|
| 1493 | + ) { |
|
| 1494 | + $label = $matches[1]; |
|
| 1495 | + } |
|
| 1496 | + $updated_and_restored_row[$label] = $value; |
|
| 1497 | + } |
|
| 1498 | + $csv_row_data = $updated_and_restored_row; |
|
| 1499 | + } |
|
| 1500 | + return $csv_row_data; |
|
| 1501 | 1501 | } |
| 1502 | 1502 | \ No newline at end of file |
@@ -19,520 +19,520 @@ |
||
| 19 | 19 | */ |
| 20 | 20 | class RegistrationsReport extends JobHandlerFile |
| 21 | 21 | { |
| 22 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 23 | - // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore |
|
| 24 | - /** |
|
| 25 | - * Performs any necessary setup for starting the job. This is also a good |
|
| 26 | - * place to setup the $job_arguments which will be used for subsequent HTTP requests |
|
| 27 | - * when continue_job will be called |
|
| 28 | - * |
|
| 29 | - * @param JobParameters $job_parameters |
|
| 30 | - * @throws BatchRequestException |
|
| 31 | - * @return JobStepResponse |
|
| 32 | - */ |
|
| 33 | - public function create_job(JobParameters $job_parameters) |
|
| 34 | - { |
|
| 35 | - $event_id = intval($job_parameters->request_datum('EVT_ID', '0')); |
|
| 36 | - if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) { |
|
| 37 | - throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso')); |
|
| 38 | - } |
|
| 39 | - $filepath = $this->create_file_from_job_with_name( |
|
| 40 | - $job_parameters->job_id(), |
|
| 41 | - $this->get_filename($event_id) |
|
| 42 | - ); |
|
| 43 | - $job_parameters->add_extra_data('filepath', $filepath); |
|
| 44 | - if ($job_parameters->request_datum('use_filters', false)) { |
|
| 45 | - $query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array()))); |
|
| 46 | - } else { |
|
| 47 | - $query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array( |
|
| 48 | - array( |
|
| 49 | - 'OR' => array( |
|
| 50 | - // don't include registrations from failed or abandoned transactions... |
|
| 51 | - 'Transaction.STS_ID' => array( |
|
| 52 | - 'NOT IN', |
|
| 53 | - array( |
|
| 54 | - \EEM_Transaction::failed_status_code, |
|
| 55 | - \EEM_Transaction::abandoned_status_code, |
|
| 56 | - ), |
|
| 57 | - ), |
|
| 58 | - // unless the registration is approved, in which case include it regardless of transaction status |
|
| 59 | - 'STS_ID' => \EEM_Registration::status_id_approved, |
|
| 60 | - ), |
|
| 61 | - 'Ticket.TKT_deleted' => array('IN', array(true, false)), |
|
| 62 | - ), |
|
| 63 | - 'order_by' => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'), |
|
| 64 | - 'force_join' => array('Transaction', 'Ticket', 'Attendee'), |
|
| 65 | - 'caps' => \EEM_Base::caps_read_admin, |
|
| 66 | - ), $event_id); |
|
| 67 | - if ($event_id) { |
|
| 68 | - $query_params[0]['EVT_ID'] = $event_id; |
|
| 69 | - } else { |
|
| 70 | - $query_params['force_join'][] = 'Event'; |
|
| 71 | - } |
|
| 72 | - } |
|
| 73 | - if (! isset($query_params['force_join'])) { |
|
| 74 | - $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee'); |
|
| 75 | - } |
|
| 76 | - $job_parameters->add_extra_data('query_params', $query_params); |
|
| 77 | - $question_labels = $this->_get_question_labels($query_params); |
|
| 78 | - $job_parameters->add_extra_data('question_labels', $question_labels); |
|
| 79 | - $job_parameters->set_job_size( |
|
| 80 | - \EEM_Registration::instance()->count( |
|
| 81 | - array_diff_key( |
|
| 82 | - $query_params, |
|
| 83 | - array_flip( |
|
| 84 | - array('limit') |
|
| 85 | - ) |
|
| 86 | - ) |
|
| 87 | - ) |
|
| 88 | - ); |
|
| 89 | - // we should also set the header columns |
|
| 90 | - $csv_data_for_row = $this->get_csv_data_for( |
|
| 91 | - $event_id, |
|
| 92 | - 0, |
|
| 93 | - 1, |
|
| 94 | - $job_parameters->extra_datum('question_labels'), |
|
| 95 | - $job_parameters->extra_datum('query_params') |
|
| 96 | - ); |
|
| 97 | - \EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true); |
|
| 98 | - // if we actually processed a row there, record it |
|
| 99 | - if ($job_parameters->job_size()) { |
|
| 100 | - $job_parameters->mark_processed(1); |
|
| 101 | - } |
|
| 102 | - return new JobStepResponse( |
|
| 103 | - $job_parameters, |
|
| 104 | - __('Registrations report started successfully...', 'event_espresso') |
|
| 105 | - ); |
|
| 106 | - } |
|
| 22 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 23 | + // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore |
|
| 24 | + /** |
|
| 25 | + * Performs any necessary setup for starting the job. This is also a good |
|
| 26 | + * place to setup the $job_arguments which will be used for subsequent HTTP requests |
|
| 27 | + * when continue_job will be called |
|
| 28 | + * |
|
| 29 | + * @param JobParameters $job_parameters |
|
| 30 | + * @throws BatchRequestException |
|
| 31 | + * @return JobStepResponse |
|
| 32 | + */ |
|
| 33 | + public function create_job(JobParameters $job_parameters) |
|
| 34 | + { |
|
| 35 | + $event_id = intval($job_parameters->request_datum('EVT_ID', '0')); |
|
| 36 | + if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) { |
|
| 37 | + throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso')); |
|
| 38 | + } |
|
| 39 | + $filepath = $this->create_file_from_job_with_name( |
|
| 40 | + $job_parameters->job_id(), |
|
| 41 | + $this->get_filename($event_id) |
|
| 42 | + ); |
|
| 43 | + $job_parameters->add_extra_data('filepath', $filepath); |
|
| 44 | + if ($job_parameters->request_datum('use_filters', false)) { |
|
| 45 | + $query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array()))); |
|
| 46 | + } else { |
|
| 47 | + $query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array( |
|
| 48 | + array( |
|
| 49 | + 'OR' => array( |
|
| 50 | + // don't include registrations from failed or abandoned transactions... |
|
| 51 | + 'Transaction.STS_ID' => array( |
|
| 52 | + 'NOT IN', |
|
| 53 | + array( |
|
| 54 | + \EEM_Transaction::failed_status_code, |
|
| 55 | + \EEM_Transaction::abandoned_status_code, |
|
| 56 | + ), |
|
| 57 | + ), |
|
| 58 | + // unless the registration is approved, in which case include it regardless of transaction status |
|
| 59 | + 'STS_ID' => \EEM_Registration::status_id_approved, |
|
| 60 | + ), |
|
| 61 | + 'Ticket.TKT_deleted' => array('IN', array(true, false)), |
|
| 62 | + ), |
|
| 63 | + 'order_by' => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'), |
|
| 64 | + 'force_join' => array('Transaction', 'Ticket', 'Attendee'), |
|
| 65 | + 'caps' => \EEM_Base::caps_read_admin, |
|
| 66 | + ), $event_id); |
|
| 67 | + if ($event_id) { |
|
| 68 | + $query_params[0]['EVT_ID'] = $event_id; |
|
| 69 | + } else { |
|
| 70 | + $query_params['force_join'][] = 'Event'; |
|
| 71 | + } |
|
| 72 | + } |
|
| 73 | + if (! isset($query_params['force_join'])) { |
|
| 74 | + $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee'); |
|
| 75 | + } |
|
| 76 | + $job_parameters->add_extra_data('query_params', $query_params); |
|
| 77 | + $question_labels = $this->_get_question_labels($query_params); |
|
| 78 | + $job_parameters->add_extra_data('question_labels', $question_labels); |
|
| 79 | + $job_parameters->set_job_size( |
|
| 80 | + \EEM_Registration::instance()->count( |
|
| 81 | + array_diff_key( |
|
| 82 | + $query_params, |
|
| 83 | + array_flip( |
|
| 84 | + array('limit') |
|
| 85 | + ) |
|
| 86 | + ) |
|
| 87 | + ) |
|
| 88 | + ); |
|
| 89 | + // we should also set the header columns |
|
| 90 | + $csv_data_for_row = $this->get_csv_data_for( |
|
| 91 | + $event_id, |
|
| 92 | + 0, |
|
| 93 | + 1, |
|
| 94 | + $job_parameters->extra_datum('question_labels'), |
|
| 95 | + $job_parameters->extra_datum('query_params') |
|
| 96 | + ); |
|
| 97 | + \EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true); |
|
| 98 | + // if we actually processed a row there, record it |
|
| 99 | + if ($job_parameters->job_size()) { |
|
| 100 | + $job_parameters->mark_processed(1); |
|
| 101 | + } |
|
| 102 | + return new JobStepResponse( |
|
| 103 | + $job_parameters, |
|
| 104 | + __('Registrations report started successfully...', 'event_espresso') |
|
| 105 | + ); |
|
| 106 | + } |
|
| 107 | 107 | |
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Gets the filename |
|
| 111 | - * |
|
| 112 | - * @return string |
|
| 113 | - */ |
|
| 114 | - protected function get_filename() |
|
| 115 | - { |
|
| 116 | - return sprintf("event-espresso-registrations-%s.csv", str_replace(':', '-', current_time('mysql'))); |
|
| 117 | - } |
|
| 109 | + /** |
|
| 110 | + * Gets the filename |
|
| 111 | + * |
|
| 112 | + * @return string |
|
| 113 | + */ |
|
| 114 | + protected function get_filename() |
|
| 115 | + { |
|
| 116 | + return sprintf("event-espresso-registrations-%s.csv", str_replace(':', '-', current_time('mysql'))); |
|
| 117 | + } |
|
| 118 | 118 | |
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Gets the questions which are to be used for this report, so they |
|
| 122 | - * can be remembered for later |
|
| 123 | - * |
|
| 124 | - * @param array $registration_query_params |
|
| 125 | - * @return array question admin labels to be used for this report |
|
| 126 | - */ |
|
| 127 | - protected function _get_question_labels($registration_query_params) |
|
| 128 | - { |
|
| 129 | - $where = isset($registration_query_params[0]) ? $registration_query_params[0] : null; |
|
| 130 | - $question_query_params = array(); |
|
| 131 | - if ($where !== null) { |
|
| 132 | - $question_query_params = array( |
|
| 133 | - $this->_change_registration_where_params_to_question_where_params($registration_query_params[0]), |
|
| 134 | - ); |
|
| 135 | - } |
|
| 136 | - $question_query_params[0]['QST_system'] = array( |
|
| 137 | - 'NOT_IN', |
|
| 138 | - array_keys(\EEM_Attendee::instance()->system_question_to_attendee_field_mapping()), |
|
| 139 | - ); |
|
| 140 | - if (apply_filters( |
|
| 141 | - 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions', |
|
| 142 | - false, |
|
| 143 | - $registration_query_params |
|
| 144 | - )) { |
|
| 145 | - $question_query_params[0]['Answer.ANS_ID'] = array('IS_NOT_NULL'); |
|
| 146 | - } |
|
| 147 | - $question_query_params['group_by'] = array('QST_ID'); |
|
| 148 | - return array_unique(\EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label')); |
|
| 149 | - } |
|
| 120 | + /** |
|
| 121 | + * Gets the questions which are to be used for this report, so they |
|
| 122 | + * can be remembered for later |
|
| 123 | + * |
|
| 124 | + * @param array $registration_query_params |
|
| 125 | + * @return array question admin labels to be used for this report |
|
| 126 | + */ |
|
| 127 | + protected function _get_question_labels($registration_query_params) |
|
| 128 | + { |
|
| 129 | + $where = isset($registration_query_params[0]) ? $registration_query_params[0] : null; |
|
| 130 | + $question_query_params = array(); |
|
| 131 | + if ($where !== null) { |
|
| 132 | + $question_query_params = array( |
|
| 133 | + $this->_change_registration_where_params_to_question_where_params($registration_query_params[0]), |
|
| 134 | + ); |
|
| 135 | + } |
|
| 136 | + $question_query_params[0]['QST_system'] = array( |
|
| 137 | + 'NOT_IN', |
|
| 138 | + array_keys(\EEM_Attendee::instance()->system_question_to_attendee_field_mapping()), |
|
| 139 | + ); |
|
| 140 | + if (apply_filters( |
|
| 141 | + 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions', |
|
| 142 | + false, |
|
| 143 | + $registration_query_params |
|
| 144 | + )) { |
|
| 145 | + $question_query_params[0]['Answer.ANS_ID'] = array('IS_NOT_NULL'); |
|
| 146 | + } |
|
| 147 | + $question_query_params['group_by'] = array('QST_ID'); |
|
| 148 | + return array_unique(\EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label')); |
|
| 149 | + } |
|
| 150 | 150 | |
| 151 | 151 | |
| 152 | - /** |
|
| 153 | - * Takes where params meant for registrations and changes them to work for questions |
|
| 154 | - * |
|
| 155 | - * @param array $reg_where_params |
|
| 156 | - * @return array |
|
| 157 | - */ |
|
| 158 | - protected function _change_registration_where_params_to_question_where_params($reg_where_params) |
|
| 159 | - { |
|
| 160 | - $question_where_params = array(); |
|
| 161 | - foreach ($reg_where_params as $key => $val) { |
|
| 162 | - if (\EEM_Registration::instance()->is_logic_query_param_key($key)) { |
|
| 163 | - $question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val); |
|
| 164 | - } else { |
|
| 165 | - // it's a normal where condition |
|
| 166 | - $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val; |
|
| 167 | - } |
|
| 168 | - } |
|
| 169 | - return $question_where_params; |
|
| 170 | - } |
|
| 152 | + /** |
|
| 153 | + * Takes where params meant for registrations and changes them to work for questions |
|
| 154 | + * |
|
| 155 | + * @param array $reg_where_params |
|
| 156 | + * @return array |
|
| 157 | + */ |
|
| 158 | + protected function _change_registration_where_params_to_question_where_params($reg_where_params) |
|
| 159 | + { |
|
| 160 | + $question_where_params = array(); |
|
| 161 | + foreach ($reg_where_params as $key => $val) { |
|
| 162 | + if (\EEM_Registration::instance()->is_logic_query_param_key($key)) { |
|
| 163 | + $question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val); |
|
| 164 | + } else { |
|
| 165 | + // it's a normal where condition |
|
| 166 | + $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val; |
|
| 167 | + } |
|
| 168 | + } |
|
| 169 | + return $question_where_params; |
|
| 170 | + } |
|
| 171 | 171 | |
| 172 | 172 | |
| 173 | - /** |
|
| 174 | - * Performs another step of the job |
|
| 175 | - * |
|
| 176 | - * @param JobParameters $job_parameters |
|
| 177 | - * @param int $batch_size |
|
| 178 | - * @return JobStepResponse |
|
| 179 | - * @throws \EE_Error |
|
| 180 | - */ |
|
| 181 | - public function continue_job(JobParameters $job_parameters, $batch_size = 50) |
|
| 182 | - { |
|
| 183 | - if ($job_parameters->units_processed() < $job_parameters->job_size()) { |
|
| 184 | - $csv_data = $this->get_csv_data_for( |
|
| 185 | - $job_parameters->request_datum('EVT_ID', '0'), |
|
| 186 | - $job_parameters->units_processed(), |
|
| 187 | - $batch_size, |
|
| 188 | - $job_parameters->extra_datum('question_labels'), |
|
| 189 | - $job_parameters->extra_datum('query_params') |
|
| 190 | - ); |
|
| 191 | - \EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false); |
|
| 192 | - $units_processed = count($csv_data); |
|
| 193 | - } else { |
|
| 194 | - $units_processed = 0; |
|
| 195 | - } |
|
| 196 | - $job_parameters->mark_processed($units_processed); |
|
| 197 | - $extra_response_data = array( |
|
| 198 | - 'file_url' => '', |
|
| 199 | - ); |
|
| 200 | - if ($units_processed < $batch_size) { |
|
| 201 | - $job_parameters->set_status(JobParameters::status_complete); |
|
| 202 | - $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath')); |
|
| 203 | - } |
|
| 173 | + /** |
|
| 174 | + * Performs another step of the job |
|
| 175 | + * |
|
| 176 | + * @param JobParameters $job_parameters |
|
| 177 | + * @param int $batch_size |
|
| 178 | + * @return JobStepResponse |
|
| 179 | + * @throws \EE_Error |
|
| 180 | + */ |
|
| 181 | + public function continue_job(JobParameters $job_parameters, $batch_size = 50) |
|
| 182 | + { |
|
| 183 | + if ($job_parameters->units_processed() < $job_parameters->job_size()) { |
|
| 184 | + $csv_data = $this->get_csv_data_for( |
|
| 185 | + $job_parameters->request_datum('EVT_ID', '0'), |
|
| 186 | + $job_parameters->units_processed(), |
|
| 187 | + $batch_size, |
|
| 188 | + $job_parameters->extra_datum('question_labels'), |
|
| 189 | + $job_parameters->extra_datum('query_params') |
|
| 190 | + ); |
|
| 191 | + \EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false); |
|
| 192 | + $units_processed = count($csv_data); |
|
| 193 | + } else { |
|
| 194 | + $units_processed = 0; |
|
| 195 | + } |
|
| 196 | + $job_parameters->mark_processed($units_processed); |
|
| 197 | + $extra_response_data = array( |
|
| 198 | + 'file_url' => '', |
|
| 199 | + ); |
|
| 200 | + if ($units_processed < $batch_size) { |
|
| 201 | + $job_parameters->set_status(JobParameters::status_complete); |
|
| 202 | + $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath')); |
|
| 203 | + } |
|
| 204 | 204 | |
| 205 | - return new JobStepResponse( |
|
| 206 | - $job_parameters, |
|
| 207 | - sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count((array) $csv_data)), |
|
| 208 | - $extra_response_data |
|
| 209 | - ); |
|
| 210 | - } |
|
| 205 | + return new JobStepResponse( |
|
| 206 | + $job_parameters, |
|
| 207 | + sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count((array) $csv_data)), |
|
| 208 | + $extra_response_data |
|
| 209 | + ); |
|
| 210 | + } |
|
| 211 | 211 | |
| 212 | 212 | |
| 213 | - /** |
|
| 214 | - * Gets the csv data for a batch of registrations |
|
| 215 | - * |
|
| 216 | - * @param int|null $event_id |
|
| 217 | - * @param int $offset |
|
| 218 | - * @param int $limit |
|
| 219 | - * @param array $question_labels the IDs for all the questions which were answered by someone in this selection |
|
| 220 | - * @param array $query_params for using where querying the model |
|
| 221 | - * @return array top-level keys are numeric, next-level keys are column headers |
|
| 222 | - */ |
|
| 223 | - public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params) |
|
| 224 | - { |
|
| 225 | - $reg_fields_to_include = array( |
|
| 226 | - 'TXN_ID', |
|
| 227 | - 'ATT_ID', |
|
| 228 | - 'REG_ID', |
|
| 229 | - 'REG_date', |
|
| 230 | - 'REG_code', |
|
| 231 | - 'REG_count', |
|
| 232 | - 'REG_final_price', |
|
| 233 | - ); |
|
| 234 | - $att_fields_to_include = array( |
|
| 235 | - 'ATT_fname', |
|
| 236 | - 'ATT_lname', |
|
| 237 | - 'ATT_email', |
|
| 238 | - 'ATT_address', |
|
| 239 | - 'ATT_address2', |
|
| 240 | - 'ATT_city', |
|
| 241 | - 'STA_ID', |
|
| 242 | - 'CNT_ISO', |
|
| 243 | - 'ATT_zip', |
|
| 244 | - 'ATT_phone', |
|
| 245 | - ); |
|
| 246 | - $registrations_csv_ready_array = array(); |
|
| 247 | - $reg_model = \EE_Registry::instance()->load_model('Registration'); |
|
| 248 | - $query_params['limit'] = array($offset, $limit); |
|
| 249 | - $registration_rows = $reg_model->get_all_wpdb_results($query_params); |
|
| 250 | - $registration_ids = array(); |
|
| 251 | - foreach ($registration_rows as $reg_row) { |
|
| 252 | - $registration_ids[] = intval($reg_row['Registration.REG_ID']); |
|
| 253 | - } |
|
| 254 | - foreach ($registration_rows as $reg_row) { |
|
| 255 | - if (is_array($reg_row)) { |
|
| 256 | - $reg_csv_array = array(); |
|
| 257 | - if (! $event_id) { |
|
| 258 | - // get the event's name and Id |
|
| 259 | - $reg_csv_array[ __('Event', 'event_espresso') ] = sprintf( |
|
| 260 | - __('%1$s (%2$s)', 'event_espresso'), |
|
| 261 | - \EEH_Export::prepare_value_from_db_for_display( |
|
| 262 | - \EEM_Event::instance(), |
|
| 263 | - 'EVT_name', |
|
| 264 | - $reg_row['Event_CPT.post_title'] |
|
| 265 | - ), |
|
| 266 | - $reg_row['Event_CPT.ID'] |
|
| 267 | - ); |
|
| 268 | - } |
|
| 269 | - $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false; |
|
| 270 | - /*@var $reg_row EE_Registration */ |
|
| 271 | - foreach ($reg_fields_to_include as $field_name) { |
|
| 272 | - $field = $reg_model->field_settings_for($field_name); |
|
| 273 | - if ($field_name == 'REG_final_price') { |
|
| 274 | - $value = \EEH_Export::prepare_value_from_db_for_display( |
|
| 275 | - $reg_model, |
|
| 276 | - $field_name, |
|
| 277 | - $reg_row['Registration.REG_final_price'], |
|
| 278 | - 'localized_float' |
|
| 279 | - ); |
|
| 280 | - } elseif ($field_name == 'REG_count') { |
|
| 281 | - $value = sprintf( |
|
| 282 | - __('%1$s of %2$s', 'event_espresso'), |
|
| 283 | - \EEH_Export::prepare_value_from_db_for_display( |
|
| 284 | - $reg_model, |
|
| 285 | - 'REG_count', |
|
| 286 | - $reg_row['Registration.REG_count'] |
|
| 287 | - ), |
|
| 288 | - \EEH_Export::prepare_value_from_db_for_display( |
|
| 289 | - $reg_model, |
|
| 290 | - 'REG_group_size', |
|
| 291 | - $reg_row['Registration.REG_group_size'] |
|
| 292 | - ) |
|
| 293 | - ); |
|
| 294 | - } elseif ($field_name == 'REG_date') { |
|
| 295 | - $value = \EEH_Export::prepare_value_from_db_for_display( |
|
| 296 | - $reg_model, |
|
| 297 | - $field_name, |
|
| 298 | - $reg_row['Registration.REG_date'], |
|
| 299 | - 'no_html' |
|
| 300 | - ); |
|
| 301 | - } else { |
|
| 302 | - $value = \EEH_Export::prepare_value_from_db_for_display( |
|
| 303 | - $reg_model, |
|
| 304 | - $field_name, |
|
| 305 | - $reg_row[ $field->get_qualified_column() ] |
|
| 306 | - ); |
|
| 307 | - } |
|
| 308 | - $reg_csv_array[ \EEH_Export::get_column_name_for_field($field) ] = $value; |
|
| 309 | - if ($field_name == 'REG_final_price') { |
|
| 310 | - // add a column named Currency after the final price |
|
| 311 | - $reg_csv_array[ __("Currency", "event_espresso") ] = \EE_Config::instance()->currency->code; |
|
| 312 | - } |
|
| 313 | - } |
|
| 314 | - // get pretty status |
|
| 315 | - $stati = \EEM_Status::instance()->localized_status( |
|
| 316 | - array( |
|
| 317 | - $reg_row['Registration.STS_ID'] => __('unknown', 'event_espresso'), |
|
| 318 | - $reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'), |
|
| 319 | - ), |
|
| 320 | - false, |
|
| 321 | - 'sentence' |
|
| 322 | - ); |
|
| 323 | - $reg_csv_array[ __("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ]; |
|
| 324 | - // get pretty transaction status |
|
| 325 | - $reg_csv_array[ __("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ]; |
|
| 326 | - $reg_csv_array[ __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg |
|
| 327 | - ? \EEH_Export::prepare_value_from_db_for_display( |
|
| 328 | - \EEM_Transaction::instance(), |
|
| 329 | - 'TXN_total', |
|
| 330 | - $reg_row['TransactionTable.TXN_total'], |
|
| 331 | - 'localized_float' |
|
| 332 | - ) : '0.00'; |
|
| 333 | - $reg_csv_array[ __('Amount Paid', 'event_espresso') ] = $is_primary_reg |
|
| 334 | - ? \EEH_Export::prepare_value_from_db_for_display( |
|
| 335 | - \EEM_Transaction::instance(), |
|
| 336 | - 'TXN_paid', |
|
| 337 | - $reg_row['TransactionTable.TXN_paid'], |
|
| 338 | - 'localized_float' |
|
| 339 | - ) : '0.00'; |
|
| 340 | - $payment_methods = array(); |
|
| 341 | - $gateway_txn_ids_etc = array(); |
|
| 342 | - $payment_times = array(); |
|
| 343 | - if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) { |
|
| 344 | - $payments_info = \EEM_Payment::instance()->get_all_wpdb_results( |
|
| 345 | - array( |
|
| 346 | - array( |
|
| 347 | - 'TXN_ID' => $reg_row['TransactionTable.TXN_ID'], |
|
| 348 | - 'STS_ID' => \EEM_Payment::status_id_approved, |
|
| 349 | - ), |
|
| 350 | - 'force_join' => array('Payment_Method'), |
|
| 351 | - ), |
|
| 352 | - ARRAY_A, |
|
| 353 | - 'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time' |
|
| 354 | - ); |
|
| 355 | - foreach ($payments_info as $payment_method_and_gateway_txn_id) { |
|
| 356 | - $payment_methods[] = isset($payment_method_and_gateway_txn_id['name']) |
|
| 357 | - ? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso'); |
|
| 358 | - $gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id']) |
|
| 359 | - ? $payment_method_and_gateway_txn_id['gateway_txn_id'] : ''; |
|
| 360 | - $payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time']) |
|
| 361 | - ? $payment_method_and_gateway_txn_id['payment_time'] : ''; |
|
| 362 | - } |
|
| 363 | - } |
|
| 364 | - $reg_csv_array[ __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times); |
|
| 365 | - $reg_csv_array[ __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods); |
|
| 366 | - $reg_csv_array[ __('Gateway Transaction ID(s)', 'event_espresso') ] = implode( |
|
| 367 | - ',', |
|
| 368 | - $gateway_txn_ids_etc |
|
| 369 | - ); |
|
| 370 | - // get whether or not the user has checked in |
|
| 371 | - $reg_csv_array[ __("Check-Ins", "event_espresso") ] = $reg_model->count_related( |
|
| 372 | - $reg_row['Registration.REG_ID'], |
|
| 373 | - 'Checkin' |
|
| 374 | - ); |
|
| 375 | - // get ticket of registration and its price |
|
| 376 | - $ticket_model = \EE_Registry::instance()->load_model('Ticket'); |
|
| 377 | - if ($reg_row['Ticket.TKT_ID']) { |
|
| 378 | - $ticket_name = \EEH_Export::prepare_value_from_db_for_display( |
|
| 379 | - $ticket_model, |
|
| 380 | - 'TKT_name', |
|
| 381 | - $reg_row['Ticket.TKT_name'] |
|
| 382 | - ); |
|
| 383 | - $datetimes_strings = array(); |
|
| 384 | - foreach (\EEM_Datetime::instance()->get_all_wpdb_results( |
|
| 385 | - array( |
|
| 386 | - array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']), |
|
| 387 | - 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
| 388 | - 'default_where_conditions' => 'none', |
|
| 389 | - ) |
|
| 390 | - ) as $datetime) { |
|
| 391 | - $datetimes_strings[] = \EEH_Export::prepare_value_from_db_for_display( |
|
| 392 | - \EEM_Datetime::instance(), |
|
| 393 | - 'DTT_EVT_start', |
|
| 394 | - $datetime['Datetime.DTT_EVT_start'] |
|
| 395 | - ); |
|
| 396 | - } |
|
| 397 | - } else { |
|
| 398 | - $ticket_name = __('Unknown', 'event_espresso'); |
|
| 399 | - $datetimes_strings = array(__('Unknown', 'event_espresso')); |
|
| 400 | - } |
|
| 401 | - $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name; |
|
| 402 | - $reg_csv_array[ __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings); |
|
| 403 | - // get datetime(s) of registration |
|
| 404 | - // add attendee columns |
|
| 405 | - foreach ($att_fields_to_include as $att_field_name) { |
|
| 406 | - $field_obj = \EEM_Attendee::instance()->field_settings_for($att_field_name); |
|
| 407 | - if ($reg_row['Attendee_CPT.ID']) { |
|
| 408 | - if ($att_field_name == 'STA_ID') { |
|
| 409 | - $value = \EEM_State::instance()->get_var( |
|
| 410 | - array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])), |
|
| 411 | - 'STA_name' |
|
| 412 | - ); |
|
| 413 | - } elseif ($att_field_name == 'CNT_ISO') { |
|
| 414 | - $value = \EEM_Country::instance()->get_var( |
|
| 415 | - array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])), |
|
| 416 | - 'CNT_name' |
|
| 417 | - ); |
|
| 418 | - } else { |
|
| 419 | - $value = \EEH_Export::prepare_value_from_db_for_display( |
|
| 420 | - \EEM_Attendee::instance(), |
|
| 421 | - $att_field_name, |
|
| 422 | - $reg_row[ $field_obj->get_qualified_column() ] |
|
| 423 | - ); |
|
| 424 | - } |
|
| 425 | - } else { |
|
| 426 | - $value = ''; |
|
| 427 | - } |
|
| 428 | - $reg_csv_array[ \EEH_Export::get_column_name_for_field($field_obj) ] = $value; |
|
| 429 | - } |
|
| 430 | - // make sure each registration has the same questions in the same order |
|
| 431 | - foreach ($question_labels as $question_label) { |
|
| 432 | - if (! isset($reg_csv_array[ $question_label ])) { |
|
| 433 | - $reg_csv_array[ $question_label ] = null; |
|
| 434 | - } |
|
| 435 | - } |
|
| 436 | - $answers = \EEM_Answer::instance()->get_all_wpdb_results(array( |
|
| 437 | - array('REG_ID' => $reg_row['Registration.REG_ID']), |
|
| 438 | - 'force_join' => array('Question'), |
|
| 439 | - )); |
|
| 440 | - // now fill out the questions THEY answered |
|
| 441 | - foreach ($answers as $answer_row) { |
|
| 442 | - if ($answer_row['Question.QST_ID']) { |
|
| 443 | - $question_label = \EEH_Export::prepare_value_from_db_for_display( |
|
| 444 | - \EEM_Question::instance(), |
|
| 445 | - 'QST_admin_label', |
|
| 446 | - $answer_row['Question.QST_admin_label'] |
|
| 447 | - ); |
|
| 448 | - } else { |
|
| 449 | - $question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']); |
|
| 450 | - } |
|
| 451 | - if (isset($answer_row['Question.QST_type']) |
|
| 452 | - && $answer_row['Question.QST_type'] == \EEM_Question::QST_type_state |
|
| 453 | - ) { |
|
| 454 | - $reg_csv_array[ $question_label ] = \EEM_State::instance()->get_state_name_by_ID( |
|
| 455 | - $answer_row['Answer.ANS_value'] |
|
| 456 | - ); |
|
| 457 | - } else { |
|
| 458 | - // this isn't for html, so don't show html entities |
|
| 459 | - $reg_csv_array[ $question_label ] = html_entity_decode( |
|
| 460 | - \EEH_Export::prepare_value_from_db_for_display( |
|
| 461 | - \EEM_Answer::instance(), |
|
| 462 | - 'ANS_value', |
|
| 463 | - $answer_row['Answer.ANS_value'] |
|
| 464 | - ) |
|
| 465 | - ); |
|
| 466 | - } |
|
| 467 | - } |
|
| 213 | + /** |
|
| 214 | + * Gets the csv data for a batch of registrations |
|
| 215 | + * |
|
| 216 | + * @param int|null $event_id |
|
| 217 | + * @param int $offset |
|
| 218 | + * @param int $limit |
|
| 219 | + * @param array $question_labels the IDs for all the questions which were answered by someone in this selection |
|
| 220 | + * @param array $query_params for using where querying the model |
|
| 221 | + * @return array top-level keys are numeric, next-level keys are column headers |
|
| 222 | + */ |
|
| 223 | + public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params) |
|
| 224 | + { |
|
| 225 | + $reg_fields_to_include = array( |
|
| 226 | + 'TXN_ID', |
|
| 227 | + 'ATT_ID', |
|
| 228 | + 'REG_ID', |
|
| 229 | + 'REG_date', |
|
| 230 | + 'REG_code', |
|
| 231 | + 'REG_count', |
|
| 232 | + 'REG_final_price', |
|
| 233 | + ); |
|
| 234 | + $att_fields_to_include = array( |
|
| 235 | + 'ATT_fname', |
|
| 236 | + 'ATT_lname', |
|
| 237 | + 'ATT_email', |
|
| 238 | + 'ATT_address', |
|
| 239 | + 'ATT_address2', |
|
| 240 | + 'ATT_city', |
|
| 241 | + 'STA_ID', |
|
| 242 | + 'CNT_ISO', |
|
| 243 | + 'ATT_zip', |
|
| 244 | + 'ATT_phone', |
|
| 245 | + ); |
|
| 246 | + $registrations_csv_ready_array = array(); |
|
| 247 | + $reg_model = \EE_Registry::instance()->load_model('Registration'); |
|
| 248 | + $query_params['limit'] = array($offset, $limit); |
|
| 249 | + $registration_rows = $reg_model->get_all_wpdb_results($query_params); |
|
| 250 | + $registration_ids = array(); |
|
| 251 | + foreach ($registration_rows as $reg_row) { |
|
| 252 | + $registration_ids[] = intval($reg_row['Registration.REG_ID']); |
|
| 253 | + } |
|
| 254 | + foreach ($registration_rows as $reg_row) { |
|
| 255 | + if (is_array($reg_row)) { |
|
| 256 | + $reg_csv_array = array(); |
|
| 257 | + if (! $event_id) { |
|
| 258 | + // get the event's name and Id |
|
| 259 | + $reg_csv_array[ __('Event', 'event_espresso') ] = sprintf( |
|
| 260 | + __('%1$s (%2$s)', 'event_espresso'), |
|
| 261 | + \EEH_Export::prepare_value_from_db_for_display( |
|
| 262 | + \EEM_Event::instance(), |
|
| 263 | + 'EVT_name', |
|
| 264 | + $reg_row['Event_CPT.post_title'] |
|
| 265 | + ), |
|
| 266 | + $reg_row['Event_CPT.ID'] |
|
| 267 | + ); |
|
| 268 | + } |
|
| 269 | + $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false; |
|
| 270 | + /*@var $reg_row EE_Registration */ |
|
| 271 | + foreach ($reg_fields_to_include as $field_name) { |
|
| 272 | + $field = $reg_model->field_settings_for($field_name); |
|
| 273 | + if ($field_name == 'REG_final_price') { |
|
| 274 | + $value = \EEH_Export::prepare_value_from_db_for_display( |
|
| 275 | + $reg_model, |
|
| 276 | + $field_name, |
|
| 277 | + $reg_row['Registration.REG_final_price'], |
|
| 278 | + 'localized_float' |
|
| 279 | + ); |
|
| 280 | + } elseif ($field_name == 'REG_count') { |
|
| 281 | + $value = sprintf( |
|
| 282 | + __('%1$s of %2$s', 'event_espresso'), |
|
| 283 | + \EEH_Export::prepare_value_from_db_for_display( |
|
| 284 | + $reg_model, |
|
| 285 | + 'REG_count', |
|
| 286 | + $reg_row['Registration.REG_count'] |
|
| 287 | + ), |
|
| 288 | + \EEH_Export::prepare_value_from_db_for_display( |
|
| 289 | + $reg_model, |
|
| 290 | + 'REG_group_size', |
|
| 291 | + $reg_row['Registration.REG_group_size'] |
|
| 292 | + ) |
|
| 293 | + ); |
|
| 294 | + } elseif ($field_name == 'REG_date') { |
|
| 295 | + $value = \EEH_Export::prepare_value_from_db_for_display( |
|
| 296 | + $reg_model, |
|
| 297 | + $field_name, |
|
| 298 | + $reg_row['Registration.REG_date'], |
|
| 299 | + 'no_html' |
|
| 300 | + ); |
|
| 301 | + } else { |
|
| 302 | + $value = \EEH_Export::prepare_value_from_db_for_display( |
|
| 303 | + $reg_model, |
|
| 304 | + $field_name, |
|
| 305 | + $reg_row[ $field->get_qualified_column() ] |
|
| 306 | + ); |
|
| 307 | + } |
|
| 308 | + $reg_csv_array[ \EEH_Export::get_column_name_for_field($field) ] = $value; |
|
| 309 | + if ($field_name == 'REG_final_price') { |
|
| 310 | + // add a column named Currency after the final price |
|
| 311 | + $reg_csv_array[ __("Currency", "event_espresso") ] = \EE_Config::instance()->currency->code; |
|
| 312 | + } |
|
| 313 | + } |
|
| 314 | + // get pretty status |
|
| 315 | + $stati = \EEM_Status::instance()->localized_status( |
|
| 316 | + array( |
|
| 317 | + $reg_row['Registration.STS_ID'] => __('unknown', 'event_espresso'), |
|
| 318 | + $reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'), |
|
| 319 | + ), |
|
| 320 | + false, |
|
| 321 | + 'sentence' |
|
| 322 | + ); |
|
| 323 | + $reg_csv_array[ __("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ]; |
|
| 324 | + // get pretty transaction status |
|
| 325 | + $reg_csv_array[ __("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ]; |
|
| 326 | + $reg_csv_array[ __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg |
|
| 327 | + ? \EEH_Export::prepare_value_from_db_for_display( |
|
| 328 | + \EEM_Transaction::instance(), |
|
| 329 | + 'TXN_total', |
|
| 330 | + $reg_row['TransactionTable.TXN_total'], |
|
| 331 | + 'localized_float' |
|
| 332 | + ) : '0.00'; |
|
| 333 | + $reg_csv_array[ __('Amount Paid', 'event_espresso') ] = $is_primary_reg |
|
| 334 | + ? \EEH_Export::prepare_value_from_db_for_display( |
|
| 335 | + \EEM_Transaction::instance(), |
|
| 336 | + 'TXN_paid', |
|
| 337 | + $reg_row['TransactionTable.TXN_paid'], |
|
| 338 | + 'localized_float' |
|
| 339 | + ) : '0.00'; |
|
| 340 | + $payment_methods = array(); |
|
| 341 | + $gateway_txn_ids_etc = array(); |
|
| 342 | + $payment_times = array(); |
|
| 343 | + if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) { |
|
| 344 | + $payments_info = \EEM_Payment::instance()->get_all_wpdb_results( |
|
| 345 | + array( |
|
| 346 | + array( |
|
| 347 | + 'TXN_ID' => $reg_row['TransactionTable.TXN_ID'], |
|
| 348 | + 'STS_ID' => \EEM_Payment::status_id_approved, |
|
| 349 | + ), |
|
| 350 | + 'force_join' => array('Payment_Method'), |
|
| 351 | + ), |
|
| 352 | + ARRAY_A, |
|
| 353 | + 'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time' |
|
| 354 | + ); |
|
| 355 | + foreach ($payments_info as $payment_method_and_gateway_txn_id) { |
|
| 356 | + $payment_methods[] = isset($payment_method_and_gateway_txn_id['name']) |
|
| 357 | + ? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso'); |
|
| 358 | + $gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id']) |
|
| 359 | + ? $payment_method_and_gateway_txn_id['gateway_txn_id'] : ''; |
|
| 360 | + $payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time']) |
|
| 361 | + ? $payment_method_and_gateway_txn_id['payment_time'] : ''; |
|
| 362 | + } |
|
| 363 | + } |
|
| 364 | + $reg_csv_array[ __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times); |
|
| 365 | + $reg_csv_array[ __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods); |
|
| 366 | + $reg_csv_array[ __('Gateway Transaction ID(s)', 'event_espresso') ] = implode( |
|
| 367 | + ',', |
|
| 368 | + $gateway_txn_ids_etc |
|
| 369 | + ); |
|
| 370 | + // get whether or not the user has checked in |
|
| 371 | + $reg_csv_array[ __("Check-Ins", "event_espresso") ] = $reg_model->count_related( |
|
| 372 | + $reg_row['Registration.REG_ID'], |
|
| 373 | + 'Checkin' |
|
| 374 | + ); |
|
| 375 | + // get ticket of registration and its price |
|
| 376 | + $ticket_model = \EE_Registry::instance()->load_model('Ticket'); |
|
| 377 | + if ($reg_row['Ticket.TKT_ID']) { |
|
| 378 | + $ticket_name = \EEH_Export::prepare_value_from_db_for_display( |
|
| 379 | + $ticket_model, |
|
| 380 | + 'TKT_name', |
|
| 381 | + $reg_row['Ticket.TKT_name'] |
|
| 382 | + ); |
|
| 383 | + $datetimes_strings = array(); |
|
| 384 | + foreach (\EEM_Datetime::instance()->get_all_wpdb_results( |
|
| 385 | + array( |
|
| 386 | + array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']), |
|
| 387 | + 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
| 388 | + 'default_where_conditions' => 'none', |
|
| 389 | + ) |
|
| 390 | + ) as $datetime) { |
|
| 391 | + $datetimes_strings[] = \EEH_Export::prepare_value_from_db_for_display( |
|
| 392 | + \EEM_Datetime::instance(), |
|
| 393 | + 'DTT_EVT_start', |
|
| 394 | + $datetime['Datetime.DTT_EVT_start'] |
|
| 395 | + ); |
|
| 396 | + } |
|
| 397 | + } else { |
|
| 398 | + $ticket_name = __('Unknown', 'event_espresso'); |
|
| 399 | + $datetimes_strings = array(__('Unknown', 'event_espresso')); |
|
| 400 | + } |
|
| 401 | + $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name; |
|
| 402 | + $reg_csv_array[ __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings); |
|
| 403 | + // get datetime(s) of registration |
|
| 404 | + // add attendee columns |
|
| 405 | + foreach ($att_fields_to_include as $att_field_name) { |
|
| 406 | + $field_obj = \EEM_Attendee::instance()->field_settings_for($att_field_name); |
|
| 407 | + if ($reg_row['Attendee_CPT.ID']) { |
|
| 408 | + if ($att_field_name == 'STA_ID') { |
|
| 409 | + $value = \EEM_State::instance()->get_var( |
|
| 410 | + array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])), |
|
| 411 | + 'STA_name' |
|
| 412 | + ); |
|
| 413 | + } elseif ($att_field_name == 'CNT_ISO') { |
|
| 414 | + $value = \EEM_Country::instance()->get_var( |
|
| 415 | + array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])), |
|
| 416 | + 'CNT_name' |
|
| 417 | + ); |
|
| 418 | + } else { |
|
| 419 | + $value = \EEH_Export::prepare_value_from_db_for_display( |
|
| 420 | + \EEM_Attendee::instance(), |
|
| 421 | + $att_field_name, |
|
| 422 | + $reg_row[ $field_obj->get_qualified_column() ] |
|
| 423 | + ); |
|
| 424 | + } |
|
| 425 | + } else { |
|
| 426 | + $value = ''; |
|
| 427 | + } |
|
| 428 | + $reg_csv_array[ \EEH_Export::get_column_name_for_field($field_obj) ] = $value; |
|
| 429 | + } |
|
| 430 | + // make sure each registration has the same questions in the same order |
|
| 431 | + foreach ($question_labels as $question_label) { |
|
| 432 | + if (! isset($reg_csv_array[ $question_label ])) { |
|
| 433 | + $reg_csv_array[ $question_label ] = null; |
|
| 434 | + } |
|
| 435 | + } |
|
| 436 | + $answers = \EEM_Answer::instance()->get_all_wpdb_results(array( |
|
| 437 | + array('REG_ID' => $reg_row['Registration.REG_ID']), |
|
| 438 | + 'force_join' => array('Question'), |
|
| 439 | + )); |
|
| 440 | + // now fill out the questions THEY answered |
|
| 441 | + foreach ($answers as $answer_row) { |
|
| 442 | + if ($answer_row['Question.QST_ID']) { |
|
| 443 | + $question_label = \EEH_Export::prepare_value_from_db_for_display( |
|
| 444 | + \EEM_Question::instance(), |
|
| 445 | + 'QST_admin_label', |
|
| 446 | + $answer_row['Question.QST_admin_label'] |
|
| 447 | + ); |
|
| 448 | + } else { |
|
| 449 | + $question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']); |
|
| 450 | + } |
|
| 451 | + if (isset($answer_row['Question.QST_type']) |
|
| 452 | + && $answer_row['Question.QST_type'] == \EEM_Question::QST_type_state |
|
| 453 | + ) { |
|
| 454 | + $reg_csv_array[ $question_label ] = \EEM_State::instance()->get_state_name_by_ID( |
|
| 455 | + $answer_row['Answer.ANS_value'] |
|
| 456 | + ); |
|
| 457 | + } else { |
|
| 458 | + // this isn't for html, so don't show html entities |
|
| 459 | + $reg_csv_array[ $question_label ] = html_entity_decode( |
|
| 460 | + \EEH_Export::prepare_value_from_db_for_display( |
|
| 461 | + \EEM_Answer::instance(), |
|
| 462 | + 'ANS_value', |
|
| 463 | + $answer_row['Answer.ANS_value'] |
|
| 464 | + ) |
|
| 465 | + ); |
|
| 466 | + } |
|
| 467 | + } |
|
| 468 | 468 | |
| 469 | - /** |
|
| 470 | - * Filter to change the contents of each row of the registrations report CSV file. |
|
| 471 | - * This can be used to add or remote columns from the CSV file, or change their values. |
|
| 472 | - * Note when using: all rows in the CSV should have the same columns. |
|
| 473 | - * @param array $reg_csv_array keys are the column names, values are their cell values |
|
| 474 | - * @param array $reg_row one entry from EEM_Registration::get_all_wpdb_results() |
|
| 475 | - */ |
|
| 476 | - $registrations_csv_ready_array[] = apply_filters( |
|
| 477 | - 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array', |
|
| 478 | - $reg_csv_array, |
|
| 479 | - $reg_row |
|
| 480 | - ); |
|
| 481 | - } |
|
| 482 | - } |
|
| 483 | - // if we couldn't export anything, we want to at least show the column headers |
|
| 484 | - if (empty($registrations_csv_ready_array)) { |
|
| 485 | - $reg_csv_array = array(); |
|
| 486 | - $model_and_fields_to_include = array( |
|
| 487 | - 'Registration' => $reg_fields_to_include, |
|
| 488 | - 'Attendee' => $att_fields_to_include, |
|
| 489 | - ); |
|
| 490 | - foreach ($model_and_fields_to_include as $model_name => $field_list) { |
|
| 491 | - $model = \EE_Registry::instance()->load_model($model_name); |
|
| 492 | - foreach ($field_list as $field_name) { |
|
| 493 | - $field = $model->field_settings_for($field_name); |
|
| 494 | - $reg_csv_array[ \EEH_Export::get_column_name_for_field($field) ] = null; |
|
| 495 | - } |
|
| 496 | - } |
|
| 497 | - $registrations_csv_ready_array[] = $reg_csv_array; |
|
| 498 | - } |
|
| 499 | - return $registrations_csv_ready_array; |
|
| 500 | - } |
|
| 469 | + /** |
|
| 470 | + * Filter to change the contents of each row of the registrations report CSV file. |
|
| 471 | + * This can be used to add or remote columns from the CSV file, or change their values. |
|
| 472 | + * Note when using: all rows in the CSV should have the same columns. |
|
| 473 | + * @param array $reg_csv_array keys are the column names, values are their cell values |
|
| 474 | + * @param array $reg_row one entry from EEM_Registration::get_all_wpdb_results() |
|
| 475 | + */ |
|
| 476 | + $registrations_csv_ready_array[] = apply_filters( |
|
| 477 | + 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array', |
|
| 478 | + $reg_csv_array, |
|
| 479 | + $reg_row |
|
| 480 | + ); |
|
| 481 | + } |
|
| 482 | + } |
|
| 483 | + // if we couldn't export anything, we want to at least show the column headers |
|
| 484 | + if (empty($registrations_csv_ready_array)) { |
|
| 485 | + $reg_csv_array = array(); |
|
| 486 | + $model_and_fields_to_include = array( |
|
| 487 | + 'Registration' => $reg_fields_to_include, |
|
| 488 | + 'Attendee' => $att_fields_to_include, |
|
| 489 | + ); |
|
| 490 | + foreach ($model_and_fields_to_include as $model_name => $field_list) { |
|
| 491 | + $model = \EE_Registry::instance()->load_model($model_name); |
|
| 492 | + foreach ($field_list as $field_name) { |
|
| 493 | + $field = $model->field_settings_for($field_name); |
|
| 494 | + $reg_csv_array[ \EEH_Export::get_column_name_for_field($field) ] = null; |
|
| 495 | + } |
|
| 496 | + } |
|
| 497 | + $registrations_csv_ready_array[] = $reg_csv_array; |
|
| 498 | + } |
|
| 499 | + return $registrations_csv_ready_array; |
|
| 500 | + } |
|
| 501 | 501 | |
| 502 | 502 | |
| 503 | - /** |
|
| 504 | - * Counts total unit to process |
|
| 505 | - * |
|
| 506 | - * @deprecated since 4.9.19 |
|
| 507 | - * @param int|array $event_id |
|
| 508 | - * @return int |
|
| 509 | - */ |
|
| 510 | - public function count_units_to_process($event_id) |
|
| 511 | - { |
|
| 512 | - // use the legacy filter |
|
| 513 | - if ($event_id) { |
|
| 514 | - $query_params[0]['EVT_ID'] = $event_id; |
|
| 515 | - } else { |
|
| 516 | - $query_params['force_join'][] = 'Event'; |
|
| 517 | - } |
|
| 518 | - return \EEM_Registration::instance()->count($query_params); |
|
| 519 | - } |
|
| 503 | + /** |
|
| 504 | + * Counts total unit to process |
|
| 505 | + * |
|
| 506 | + * @deprecated since 4.9.19 |
|
| 507 | + * @param int|array $event_id |
|
| 508 | + * @return int |
|
| 509 | + */ |
|
| 510 | + public function count_units_to_process($event_id) |
|
| 511 | + { |
|
| 512 | + // use the legacy filter |
|
| 513 | + if ($event_id) { |
|
| 514 | + $query_params[0]['EVT_ID'] = $event_id; |
|
| 515 | + } else { |
|
| 516 | + $query_params['force_join'][] = 'Event'; |
|
| 517 | + } |
|
| 518 | + return \EEM_Registration::instance()->count($query_params); |
|
| 519 | + } |
|
| 520 | 520 | |
| 521 | 521 | |
| 522 | - /** |
|
| 523 | - * Performs any clean-up logic when we know the job is completed. |
|
| 524 | - * In this case, we delete the temporary file |
|
| 525 | - * |
|
| 526 | - * @param JobParameters $job_parameters |
|
| 527 | - * @return boolean |
|
| 528 | - */ |
|
| 529 | - public function cleanup_job(JobParameters $job_parameters) |
|
| 530 | - { |
|
| 531 | - $this->_file_helper->delete( |
|
| 532 | - \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')), |
|
| 533 | - true, |
|
| 534 | - 'd' |
|
| 535 | - ); |
|
| 536 | - return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso')); |
|
| 537 | - } |
|
| 522 | + /** |
|
| 523 | + * Performs any clean-up logic when we know the job is completed. |
|
| 524 | + * In this case, we delete the temporary file |
|
| 525 | + * |
|
| 526 | + * @param JobParameters $job_parameters |
|
| 527 | + * @return boolean |
|
| 528 | + */ |
|
| 529 | + public function cleanup_job(JobParameters $job_parameters) |
|
| 530 | + { |
|
| 531 | + $this->_file_helper->delete( |
|
| 532 | + \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')), |
|
| 533 | + true, |
|
| 534 | + 'd' |
|
| 535 | + ); |
|
| 536 | + return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso')); |
|
| 537 | + } |
|
| 538 | 538 | } |
@@ -38,103 +38,103 @@ |
||
| 38 | 38 | * @since 4.0 |
| 39 | 39 | */ |
| 40 | 40 | if (function_exists('espresso_version')) { |
| 41 | - if (! function_exists('espresso_duplicate_plugin_error')) { |
|
| 42 | - /** |
|
| 43 | - * espresso_duplicate_plugin_error |
|
| 44 | - * displays if more than one version of EE is activated at the same time |
|
| 45 | - */ |
|
| 46 | - function espresso_duplicate_plugin_error() |
|
| 47 | - { |
|
| 48 | - ?> |
|
| 41 | + if (! function_exists('espresso_duplicate_plugin_error')) { |
|
| 42 | + /** |
|
| 43 | + * espresso_duplicate_plugin_error |
|
| 44 | + * displays if more than one version of EE is activated at the same time |
|
| 45 | + */ |
|
| 46 | + function espresso_duplicate_plugin_error() |
|
| 47 | + { |
|
| 48 | + ?> |
|
| 49 | 49 | <div class="error"> |
| 50 | 50 | <p> |
| 51 | 51 | <?php |
| 52 | - echo esc_html__( |
|
| 53 | - 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
| 54 | - 'event_espresso' |
|
| 55 | - ); ?> |
|
| 52 | + echo esc_html__( |
|
| 53 | + 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
| 54 | + 'event_espresso' |
|
| 55 | + ); ?> |
|
| 56 | 56 | </p> |
| 57 | 57 | </div> |
| 58 | 58 | <?php |
| 59 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
| 60 | - } |
|
| 61 | - } |
|
| 62 | - add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
| 59 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
| 60 | + } |
|
| 61 | + } |
|
| 62 | + add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
| 63 | 63 | } else { |
| 64 | - define('EE_MIN_PHP_VER_REQUIRED', '5.4.0'); |
|
| 65 | - if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
| 66 | - /** |
|
| 67 | - * espresso_minimum_php_version_error |
|
| 68 | - * |
|
| 69 | - * @return void |
|
| 70 | - */ |
|
| 71 | - function espresso_minimum_php_version_error() |
|
| 72 | - { |
|
| 73 | - ?> |
|
| 64 | + define('EE_MIN_PHP_VER_REQUIRED', '5.4.0'); |
|
| 65 | + if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
| 66 | + /** |
|
| 67 | + * espresso_minimum_php_version_error |
|
| 68 | + * |
|
| 69 | + * @return void |
|
| 70 | + */ |
|
| 71 | + function espresso_minimum_php_version_error() |
|
| 72 | + { |
|
| 73 | + ?> |
|
| 74 | 74 | <div class="error"> |
| 75 | 75 | <p> |
| 76 | 76 | <?php |
| 77 | - printf( |
|
| 78 | - esc_html__( |
|
| 79 | - 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
| 80 | - 'event_espresso' |
|
| 81 | - ), |
|
| 82 | - EE_MIN_PHP_VER_REQUIRED, |
|
| 83 | - PHP_VERSION, |
|
| 84 | - '<br/>', |
|
| 85 | - '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
| 86 | - ); |
|
| 87 | - ?> |
|
| 77 | + printf( |
|
| 78 | + esc_html__( |
|
| 79 | + 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
| 80 | + 'event_espresso' |
|
| 81 | + ), |
|
| 82 | + EE_MIN_PHP_VER_REQUIRED, |
|
| 83 | + PHP_VERSION, |
|
| 84 | + '<br/>', |
|
| 85 | + '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
| 86 | + ); |
|
| 87 | + ?> |
|
| 88 | 88 | </p> |
| 89 | 89 | </div> |
| 90 | 90 | <?php |
| 91 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
| 92 | - } |
|
| 91 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
| 95 | - } else { |
|
| 96 | - define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
| 97 | - /** |
|
| 98 | - * espresso_version |
|
| 99 | - * Returns the plugin version |
|
| 100 | - * |
|
| 101 | - * @return string |
|
| 102 | - */ |
|
| 103 | - function espresso_version() |
|
| 104 | - { |
|
| 105 | - return apply_filters('FHEE__espresso__espresso_version', '4.9.69.rc.011'); |
|
| 106 | - } |
|
| 94 | + add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
| 95 | + } else { |
|
| 96 | + define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
| 97 | + /** |
|
| 98 | + * espresso_version |
|
| 99 | + * Returns the plugin version |
|
| 100 | + * |
|
| 101 | + * @return string |
|
| 102 | + */ |
|
| 103 | + function espresso_version() |
|
| 104 | + { |
|
| 105 | + return apply_filters('FHEE__espresso__espresso_version', '4.9.69.rc.011'); |
|
| 106 | + } |
|
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * espresso_plugin_activation |
|
| 110 | - * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
| 111 | - */ |
|
| 112 | - function espresso_plugin_activation() |
|
| 113 | - { |
|
| 114 | - update_option('ee_espresso_activation', true); |
|
| 115 | - } |
|
| 108 | + /** |
|
| 109 | + * espresso_plugin_activation |
|
| 110 | + * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
| 111 | + */ |
|
| 112 | + function espresso_plugin_activation() |
|
| 113 | + { |
|
| 114 | + update_option('ee_espresso_activation', true); |
|
| 115 | + } |
|
| 116 | 116 | |
| 117 | - register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
| 117 | + register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
| 118 | 118 | |
| 119 | - require_once __DIR__ . '/core/bootstrap_espresso.php'; |
|
| 120 | - bootstrap_espresso(); |
|
| 121 | - } |
|
| 119 | + require_once __DIR__ . '/core/bootstrap_espresso.php'; |
|
| 120 | + bootstrap_espresso(); |
|
| 121 | + } |
|
| 122 | 122 | } |
| 123 | 123 | if (! function_exists('espresso_deactivate_plugin')) { |
| 124 | - /** |
|
| 125 | - * deactivate_plugin |
|
| 126 | - * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
| 127 | - * |
|
| 128 | - * @access public |
|
| 129 | - * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
| 130 | - * @return void |
|
| 131 | - */ |
|
| 132 | - function espresso_deactivate_plugin($plugin_basename = '') |
|
| 133 | - { |
|
| 134 | - if (! function_exists('deactivate_plugins')) { |
|
| 135 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
| 136 | - } |
|
| 137 | - unset($_GET['activate'], $_REQUEST['activate']); |
|
| 138 | - deactivate_plugins($plugin_basename); |
|
| 139 | - } |
|
| 124 | + /** |
|
| 125 | + * deactivate_plugin |
|
| 126 | + * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
| 127 | + * |
|
| 128 | + * @access public |
|
| 129 | + * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
| 130 | + * @return void |
|
| 131 | + */ |
|
| 132 | + function espresso_deactivate_plugin($plugin_basename = '') |
|
| 133 | + { |
|
| 134 | + if (! function_exists('deactivate_plugins')) { |
|
| 135 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
| 136 | + } |
|
| 137 | + unset($_GET['activate'], $_REQUEST['activate']); |
|
| 138 | + deactivate_plugins($plugin_basename); |
|
| 139 | + } |
|
| 140 | 140 | } |
@@ -13,1355 +13,1355 @@ |
||
| 13 | 13 | class EE_Event extends EE_CPT_Base implements EEI_Line_Item_Object, EEI_Admin_Links, EEI_Has_Icon, EEI_Event |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * cached value for the the logical active status for the event |
|
| 18 | - * |
|
| 19 | - * @see get_active_status() |
|
| 20 | - * @var string |
|
| 21 | - */ |
|
| 22 | - protected $_active_status = ''; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * This is just used for caching the Primary Datetime for the Event on initial retrieval |
|
| 26 | - * |
|
| 27 | - * @var EE_Datetime |
|
| 28 | - */ |
|
| 29 | - protected $_Primary_Datetime; |
|
| 30 | - |
|
| 31 | - /** |
|
| 32 | - * @var EventSpacesCalculator $available_spaces_calculator |
|
| 33 | - */ |
|
| 34 | - protected $available_spaces_calculator; |
|
| 35 | - |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * @param array $props_n_values incoming values |
|
| 39 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
| 40 | - * used.) |
|
| 41 | - * @param array $date_formats incoming date_formats in an array where the first value is the |
|
| 42 | - * date_format and the second value is the time format |
|
| 43 | - * @return EE_Event |
|
| 44 | - * @throws EE_Error |
|
| 45 | - */ |
|
| 46 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
| 47 | - { |
|
| 48 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
| 49 | - return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
| 50 | - } |
|
| 51 | - |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * @param array $props_n_values incoming values from the database |
|
| 55 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 56 | - * the website will be used. |
|
| 57 | - * @return EE_Event |
|
| 58 | - * @throws EE_Error |
|
| 59 | - */ |
|
| 60 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
| 61 | - { |
|
| 62 | - return new self($props_n_values, true, $timezone); |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * @return EventSpacesCalculator |
|
| 68 | - * @throws \EE_Error |
|
| 69 | - */ |
|
| 70 | - public function getAvailableSpacesCalculator() |
|
| 71 | - { |
|
| 72 | - if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) { |
|
| 73 | - $this->available_spaces_calculator = new EventSpacesCalculator($this); |
|
| 74 | - } |
|
| 75 | - return $this->available_spaces_calculator; |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - |
|
| 79 | - /** |
|
| 80 | - * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods |
|
| 81 | - * |
|
| 82 | - * @param string $field_name |
|
| 83 | - * @param mixed $field_value |
|
| 84 | - * @param bool $use_default |
|
| 85 | - * @throws EE_Error |
|
| 86 | - */ |
|
| 87 | - public function set($field_name, $field_value, $use_default = false) |
|
| 88 | - { |
|
| 89 | - switch ($field_name) { |
|
| 90 | - case 'status': |
|
| 91 | - $this->set_status($field_value, $use_default); |
|
| 92 | - break; |
|
| 93 | - default: |
|
| 94 | - parent::set($field_name, $field_value, $use_default); |
|
| 95 | - } |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * set_status |
|
| 101 | - * Checks if event status is being changed to SOLD OUT |
|
| 102 | - * and updates event meta data with previous event status |
|
| 103 | - * so that we can revert things if/when the event is no longer sold out |
|
| 104 | - * |
|
| 105 | - * @access public |
|
| 106 | - * @param string $new_status |
|
| 107 | - * @param bool $use_default |
|
| 108 | - * @return void |
|
| 109 | - * @throws EE_Error |
|
| 110 | - */ |
|
| 111 | - public function set_status($new_status = null, $use_default = false) |
|
| 112 | - { |
|
| 113 | - // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave |
|
| 114 | - if (empty($new_status) && ! $use_default) { |
|
| 115 | - return; |
|
| 116 | - } |
|
| 117 | - // get current Event status |
|
| 118 | - $old_status = $this->status(); |
|
| 119 | - // if status has changed |
|
| 120 | - if ($old_status !== $new_status) { |
|
| 121 | - // TO sold_out |
|
| 122 | - if ($new_status === EEM_Event::sold_out) { |
|
| 123 | - // save the previous event status so that we can revert if the event is no longer sold out |
|
| 124 | - $this->add_post_meta('_previous_event_status', $old_status); |
|
| 125 | - do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status); |
|
| 126 | - // OR FROM sold_out |
|
| 127 | - } elseif ($old_status === EEM_Event::sold_out) { |
|
| 128 | - $this->delete_post_meta('_previous_event_status'); |
|
| 129 | - do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status); |
|
| 130 | - } |
|
| 131 | - // clear out the active status so that it gets reset the next time it is requested |
|
| 132 | - $this->_active_status = null; |
|
| 133 | - // update status |
|
| 134 | - parent::set('status', $new_status, $use_default); |
|
| 135 | - do_action('AHEE__EE_Event__set_status__after_update', $this); |
|
| 136 | - return; |
|
| 137 | - } |
|
| 138 | - // even though the old value matches the new value, it's still good to |
|
| 139 | - // allow the parent set method to have a say |
|
| 140 | - parent::set('status', $new_status, $use_default); |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * Gets all the datetimes for this event |
|
| 146 | - * |
|
| 147 | - * @param array $query_params like EEM_Base::get_all |
|
| 148 | - * @return EE_Base_Class[]|EE_Datetime[] |
|
| 149 | - * @throws EE_Error |
|
| 150 | - */ |
|
| 151 | - public function datetimes($query_params = array()) |
|
| 152 | - { |
|
| 153 | - return $this->get_many_related('Datetime', $query_params); |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order |
|
| 159 | - * |
|
| 160 | - * @return EE_Base_Class[]|EE_Datetime[] |
|
| 161 | - * @throws EE_Error |
|
| 162 | - */ |
|
| 163 | - public function datetimes_in_chronological_order() |
|
| 164 | - { |
|
| 165 | - return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC'))); |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * Gets all the datetimes for this event, ordered by the DTT_order on the datetime. |
|
| 171 | - * @darren, we should probably UNSET timezone on the EEM_Datetime model |
|
| 172 | - * after running our query, so that this timezone isn't set for EVERY query |
|
| 173 | - * on EEM_Datetime for the rest of the request, no? |
|
| 174 | - * |
|
| 175 | - * @param boolean $show_expired whether or not to include expired events |
|
| 176 | - * @param boolean $show_deleted whether or not to include deleted events |
|
| 177 | - * @param null $limit |
|
| 178 | - * @return EE_Datetime[] |
|
| 179 | - * @throws EE_Error |
|
| 180 | - */ |
|
| 181 | - public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null) |
|
| 182 | - { |
|
| 183 | - return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order( |
|
| 184 | - $this->ID(), |
|
| 185 | - $show_expired, |
|
| 186 | - $show_deleted, |
|
| 187 | - $limit |
|
| 188 | - ); |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * Returns one related datetime. Mostly only used by some legacy code. |
|
| 194 | - * |
|
| 195 | - * @return EE_Base_Class|EE_Datetime |
|
| 196 | - * @throws EE_Error |
|
| 197 | - */ |
|
| 198 | - public function first_datetime() |
|
| 199 | - { |
|
| 200 | - return $this->get_first_related('Datetime'); |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * Returns the 'primary' datetime for the event |
|
| 206 | - * |
|
| 207 | - * @param bool $try_to_exclude_expired |
|
| 208 | - * @param bool $try_to_exclude_deleted |
|
| 209 | - * @return EE_Datetime |
|
| 210 | - * @throws EE_Error |
|
| 211 | - */ |
|
| 212 | - public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true) |
|
| 213 | - { |
|
| 214 | - if (! empty($this->_Primary_Datetime)) { |
|
| 215 | - return $this->_Primary_Datetime; |
|
| 216 | - } |
|
| 217 | - $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event( |
|
| 218 | - $this->ID(), |
|
| 219 | - $try_to_exclude_expired, |
|
| 220 | - $try_to_exclude_deleted |
|
| 221 | - ); |
|
| 222 | - return $this->_Primary_Datetime; |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - |
|
| 226 | - /** |
|
| 227 | - * Gets all the tickets available for purchase of this event |
|
| 228 | - * |
|
| 229 | - * @param array $query_params like EEM_Base::get_all |
|
| 230 | - * @return EE_Base_Class[]|EE_Ticket[] |
|
| 231 | - * @throws EE_Error |
|
| 232 | - */ |
|
| 233 | - public function tickets($query_params = array()) |
|
| 234 | - { |
|
| 235 | - // first get all datetimes |
|
| 236 | - $datetimes = $this->datetimes_ordered(); |
|
| 237 | - if (! $datetimes) { |
|
| 238 | - return array(); |
|
| 239 | - } |
|
| 240 | - $datetime_ids = array(); |
|
| 241 | - foreach ($datetimes as $datetime) { |
|
| 242 | - $datetime_ids[] = $datetime->ID(); |
|
| 243 | - } |
|
| 244 | - $where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids)); |
|
| 245 | - // if incoming $query_params has where conditions let's merge but not override existing. |
|
| 246 | - if (is_array($query_params) && isset($query_params[0])) { |
|
| 247 | - $where_params = array_merge($query_params[0], $where_params); |
|
| 248 | - unset($query_params[0]); |
|
| 249 | - } |
|
| 250 | - // now add $where_params to $query_params |
|
| 251 | - $query_params[0] = $where_params; |
|
| 252 | - return EEM_Ticket::instance()->get_all($query_params); |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - |
|
| 256 | - /** |
|
| 257 | - * get all unexpired untrashed tickets |
|
| 258 | - * |
|
| 259 | - * @return EE_Ticket[] |
|
| 260 | - * @throws EE_Error |
|
| 261 | - */ |
|
| 262 | - public function active_tickets() |
|
| 263 | - { |
|
| 264 | - return $this->tickets( |
|
| 265 | - array( |
|
| 266 | - array( |
|
| 267 | - 'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')), |
|
| 268 | - 'TKT_deleted' => false, |
|
| 269 | - ), |
|
| 270 | - ) |
|
| 271 | - ); |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - |
|
| 275 | - /** |
|
| 276 | - * @return bool |
|
| 277 | - * @throws EE_Error |
|
| 278 | - */ |
|
| 279 | - public function additional_limit() |
|
| 280 | - { |
|
| 281 | - return $this->get('EVT_additional_limit'); |
|
| 282 | - } |
|
| 283 | - |
|
| 284 | - |
|
| 285 | - /** |
|
| 286 | - * @return bool |
|
| 287 | - * @throws EE_Error |
|
| 288 | - */ |
|
| 289 | - public function allow_overflow() |
|
| 290 | - { |
|
| 291 | - return $this->get('EVT_allow_overflow'); |
|
| 292 | - } |
|
| 293 | - |
|
| 294 | - |
|
| 295 | - /** |
|
| 296 | - * @return bool |
|
| 297 | - * @throws EE_Error |
|
| 298 | - */ |
|
| 299 | - public function created() |
|
| 300 | - { |
|
| 301 | - return $this->get('EVT_created'); |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - |
|
| 305 | - /** |
|
| 306 | - * @return bool |
|
| 307 | - * @throws EE_Error |
|
| 308 | - */ |
|
| 309 | - public function description() |
|
| 310 | - { |
|
| 311 | - return $this->get('EVT_desc'); |
|
| 312 | - } |
|
| 313 | - |
|
| 314 | - |
|
| 315 | - /** |
|
| 316 | - * Runs do_shortcode and wpautop on the description |
|
| 317 | - * |
|
| 318 | - * @return string of html |
|
| 319 | - * @throws EE_Error |
|
| 320 | - */ |
|
| 321 | - public function description_filtered() |
|
| 322 | - { |
|
| 323 | - return $this->get_pretty('EVT_desc'); |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - |
|
| 327 | - /** |
|
| 328 | - * @return bool |
|
| 329 | - * @throws EE_Error |
|
| 330 | - */ |
|
| 331 | - public function display_description() |
|
| 332 | - { |
|
| 333 | - return $this->get('EVT_display_desc'); |
|
| 334 | - } |
|
| 335 | - |
|
| 336 | - |
|
| 337 | - /** |
|
| 338 | - * @return bool |
|
| 339 | - * @throws EE_Error |
|
| 340 | - */ |
|
| 341 | - public function display_ticket_selector() |
|
| 342 | - { |
|
| 343 | - return (bool) $this->get('EVT_display_ticket_selector'); |
|
| 344 | - } |
|
| 345 | - |
|
| 346 | - |
|
| 347 | - /** |
|
| 348 | - * @return bool |
|
| 349 | - * @throws EE_Error |
|
| 350 | - */ |
|
| 351 | - public function external_url() |
|
| 352 | - { |
|
| 353 | - return $this->get('EVT_external_URL'); |
|
| 354 | - } |
|
| 355 | - |
|
| 356 | - |
|
| 357 | - /** |
|
| 358 | - * @return bool |
|
| 359 | - * @throws EE_Error |
|
| 360 | - */ |
|
| 361 | - public function member_only() |
|
| 362 | - { |
|
| 363 | - return $this->get('EVT_member_only'); |
|
| 364 | - } |
|
| 365 | - |
|
| 366 | - |
|
| 367 | - /** |
|
| 368 | - * @return bool |
|
| 369 | - * @throws EE_Error |
|
| 370 | - */ |
|
| 371 | - public function phone() |
|
| 372 | - { |
|
| 373 | - return $this->get('EVT_phone'); |
|
| 374 | - } |
|
| 375 | - |
|
| 376 | - |
|
| 377 | - /** |
|
| 378 | - * @return bool |
|
| 379 | - * @throws EE_Error |
|
| 380 | - */ |
|
| 381 | - public function modified() |
|
| 382 | - { |
|
| 383 | - return $this->get('EVT_modified'); |
|
| 384 | - } |
|
| 385 | - |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * @return bool |
|
| 389 | - * @throws EE_Error |
|
| 390 | - */ |
|
| 391 | - public function name() |
|
| 392 | - { |
|
| 393 | - return $this->get('EVT_name'); |
|
| 394 | - } |
|
| 395 | - |
|
| 396 | - |
|
| 397 | - /** |
|
| 398 | - * @return bool |
|
| 399 | - * @throws EE_Error |
|
| 400 | - */ |
|
| 401 | - public function order() |
|
| 402 | - { |
|
| 403 | - return $this->get('EVT_order'); |
|
| 404 | - } |
|
| 405 | - |
|
| 406 | - |
|
| 407 | - /** |
|
| 408 | - * @return bool|string |
|
| 409 | - * @throws EE_Error |
|
| 410 | - */ |
|
| 411 | - public function default_registration_status() |
|
| 412 | - { |
|
| 413 | - $event_default_registration_status = $this->get('EVT_default_registration_status'); |
|
| 414 | - return ! empty($event_default_registration_status) |
|
| 415 | - ? $event_default_registration_status |
|
| 416 | - : EE_Registry::instance()->CFG->registration->default_STS_ID; |
|
| 417 | - } |
|
| 418 | - |
|
| 419 | - |
|
| 420 | - /** |
|
| 421 | - * @param int $num_words |
|
| 422 | - * @param null $more |
|
| 423 | - * @param bool $not_full_desc |
|
| 424 | - * @return bool|string |
|
| 425 | - * @throws EE_Error |
|
| 426 | - */ |
|
| 427 | - public function short_description($num_words = 55, $more = null, $not_full_desc = false) |
|
| 428 | - { |
|
| 429 | - $short_desc = $this->get('EVT_short_desc'); |
|
| 430 | - if (! empty($short_desc) || $not_full_desc) { |
|
| 431 | - return $short_desc; |
|
| 432 | - } |
|
| 433 | - $full_desc = $this->get('EVT_desc'); |
|
| 434 | - return wp_trim_words($full_desc, $num_words, $more); |
|
| 435 | - } |
|
| 436 | - |
|
| 437 | - |
|
| 438 | - /** |
|
| 439 | - * @return bool |
|
| 440 | - * @throws EE_Error |
|
| 441 | - */ |
|
| 442 | - public function slug() |
|
| 443 | - { |
|
| 444 | - return $this->get('EVT_slug'); |
|
| 445 | - } |
|
| 446 | - |
|
| 447 | - |
|
| 448 | - /** |
|
| 449 | - * @return bool |
|
| 450 | - * @throws EE_Error |
|
| 451 | - */ |
|
| 452 | - public function timezone_string() |
|
| 453 | - { |
|
| 454 | - return $this->get('EVT_timezone_string'); |
|
| 455 | - } |
|
| 456 | - |
|
| 457 | - |
|
| 458 | - /** |
|
| 459 | - * @return bool |
|
| 460 | - * @throws EE_Error |
|
| 461 | - */ |
|
| 462 | - public function visible_on() |
|
| 463 | - { |
|
| 464 | - return $this->get('EVT_visible_on'); |
|
| 465 | - } |
|
| 466 | - |
|
| 467 | - |
|
| 468 | - /** |
|
| 469 | - * @return int |
|
| 470 | - * @throws EE_Error |
|
| 471 | - */ |
|
| 472 | - public function wp_user() |
|
| 473 | - { |
|
| 474 | - return $this->get('EVT_wp_user'); |
|
| 475 | - } |
|
| 476 | - |
|
| 477 | - |
|
| 478 | - /** |
|
| 479 | - * @return bool |
|
| 480 | - * @throws EE_Error |
|
| 481 | - */ |
|
| 482 | - public function donations() |
|
| 483 | - { |
|
| 484 | - return $this->get('EVT_donations'); |
|
| 485 | - } |
|
| 486 | - |
|
| 487 | - |
|
| 488 | - /** |
|
| 489 | - * @param $limit |
|
| 490 | - * @throws EE_Error |
|
| 491 | - */ |
|
| 492 | - public function set_additional_limit($limit) |
|
| 493 | - { |
|
| 494 | - $this->set('EVT_additional_limit', $limit); |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - |
|
| 498 | - /** |
|
| 499 | - * @param $created |
|
| 500 | - * @throws EE_Error |
|
| 501 | - */ |
|
| 502 | - public function set_created($created) |
|
| 503 | - { |
|
| 504 | - $this->set('EVT_created', $created); |
|
| 505 | - } |
|
| 506 | - |
|
| 507 | - |
|
| 508 | - /** |
|
| 509 | - * @param $desc |
|
| 510 | - * @throws EE_Error |
|
| 511 | - */ |
|
| 512 | - public function set_description($desc) |
|
| 513 | - { |
|
| 514 | - $this->set('EVT_desc', $desc); |
|
| 515 | - } |
|
| 516 | - |
|
| 517 | - |
|
| 518 | - /** |
|
| 519 | - * @param $display_desc |
|
| 520 | - * @throws EE_Error |
|
| 521 | - */ |
|
| 522 | - public function set_display_description($display_desc) |
|
| 523 | - { |
|
| 524 | - $this->set('EVT_display_desc', $display_desc); |
|
| 525 | - } |
|
| 526 | - |
|
| 527 | - |
|
| 528 | - /** |
|
| 529 | - * @param $display_ticket_selector |
|
| 530 | - * @throws EE_Error |
|
| 531 | - */ |
|
| 532 | - public function set_display_ticket_selector($display_ticket_selector) |
|
| 533 | - { |
|
| 534 | - $this->set('EVT_display_ticket_selector', $display_ticket_selector); |
|
| 535 | - } |
|
| 536 | - |
|
| 537 | - |
|
| 538 | - /** |
|
| 539 | - * @param $external_url |
|
| 540 | - * @throws EE_Error |
|
| 541 | - */ |
|
| 542 | - public function set_external_url($external_url) |
|
| 543 | - { |
|
| 544 | - $this->set('EVT_external_URL', $external_url); |
|
| 545 | - } |
|
| 546 | - |
|
| 547 | - |
|
| 548 | - /** |
|
| 549 | - * @param $member_only |
|
| 550 | - * @throws EE_Error |
|
| 551 | - */ |
|
| 552 | - public function set_member_only($member_only) |
|
| 553 | - { |
|
| 554 | - $this->set('EVT_member_only', $member_only); |
|
| 555 | - } |
|
| 556 | - |
|
| 557 | - |
|
| 558 | - /** |
|
| 559 | - * @param $event_phone |
|
| 560 | - * @throws EE_Error |
|
| 561 | - */ |
|
| 562 | - public function set_event_phone($event_phone) |
|
| 563 | - { |
|
| 564 | - $this->set('EVT_phone', $event_phone); |
|
| 565 | - } |
|
| 566 | - |
|
| 567 | - |
|
| 568 | - /** |
|
| 569 | - * @param $modified |
|
| 570 | - * @throws EE_Error |
|
| 571 | - */ |
|
| 572 | - public function set_modified($modified) |
|
| 573 | - { |
|
| 574 | - $this->set('EVT_modified', $modified); |
|
| 575 | - } |
|
| 576 | - |
|
| 577 | - |
|
| 578 | - /** |
|
| 579 | - * @param $name |
|
| 580 | - * @throws EE_Error |
|
| 581 | - */ |
|
| 582 | - public function set_name($name) |
|
| 583 | - { |
|
| 584 | - $this->set('EVT_name', $name); |
|
| 585 | - } |
|
| 586 | - |
|
| 587 | - |
|
| 588 | - /** |
|
| 589 | - * @param $order |
|
| 590 | - * @throws EE_Error |
|
| 591 | - */ |
|
| 592 | - public function set_order($order) |
|
| 593 | - { |
|
| 594 | - $this->set('EVT_order', $order); |
|
| 595 | - } |
|
| 596 | - |
|
| 597 | - |
|
| 598 | - /** |
|
| 599 | - * @param $short_desc |
|
| 600 | - * @throws EE_Error |
|
| 601 | - */ |
|
| 602 | - public function set_short_description($short_desc) |
|
| 603 | - { |
|
| 604 | - $this->set('EVT_short_desc', $short_desc); |
|
| 605 | - } |
|
| 606 | - |
|
| 607 | - |
|
| 608 | - /** |
|
| 609 | - * @param $slug |
|
| 610 | - * @throws EE_Error |
|
| 611 | - */ |
|
| 612 | - public function set_slug($slug) |
|
| 613 | - { |
|
| 614 | - $this->set('EVT_slug', $slug); |
|
| 615 | - } |
|
| 616 | - |
|
| 617 | - |
|
| 618 | - /** |
|
| 619 | - * @param $timezone_string |
|
| 620 | - * @throws EE_Error |
|
| 621 | - */ |
|
| 622 | - public function set_timezone_string($timezone_string) |
|
| 623 | - { |
|
| 624 | - $this->set('EVT_timezone_string', $timezone_string); |
|
| 625 | - } |
|
| 626 | - |
|
| 627 | - |
|
| 628 | - /** |
|
| 629 | - * @param $visible_on |
|
| 630 | - * @throws EE_Error |
|
| 631 | - */ |
|
| 632 | - public function set_visible_on($visible_on) |
|
| 633 | - { |
|
| 634 | - $this->set('EVT_visible_on', $visible_on); |
|
| 635 | - } |
|
| 636 | - |
|
| 637 | - |
|
| 638 | - /** |
|
| 639 | - * @param $wp_user |
|
| 640 | - * @throws EE_Error |
|
| 641 | - */ |
|
| 642 | - public function set_wp_user($wp_user) |
|
| 643 | - { |
|
| 644 | - $this->set('EVT_wp_user', $wp_user); |
|
| 645 | - } |
|
| 646 | - |
|
| 647 | - |
|
| 648 | - /** |
|
| 649 | - * @param $default_registration_status |
|
| 650 | - * @throws EE_Error |
|
| 651 | - */ |
|
| 652 | - public function set_default_registration_status($default_registration_status) |
|
| 653 | - { |
|
| 654 | - $this->set('EVT_default_registration_status', $default_registration_status); |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - |
|
| 658 | - /** |
|
| 659 | - * @param $donations |
|
| 660 | - * @throws EE_Error |
|
| 661 | - */ |
|
| 662 | - public function set_donations($donations) |
|
| 663 | - { |
|
| 664 | - $this->set('EVT_donations', $donations); |
|
| 665 | - } |
|
| 666 | - |
|
| 667 | - |
|
| 668 | - /** |
|
| 669 | - * Adds a venue to this event |
|
| 670 | - * |
|
| 671 | - * @param EE_Venue /int $venue_id_or_obj |
|
| 672 | - * @return EE_Base_Class|EE_Venue |
|
| 673 | - * @throws EE_Error |
|
| 674 | - */ |
|
| 675 | - public function add_venue($venue_id_or_obj) |
|
| 676 | - { |
|
| 677 | - return $this->_add_relation_to($venue_id_or_obj, 'Venue'); |
|
| 678 | - } |
|
| 679 | - |
|
| 680 | - |
|
| 681 | - /** |
|
| 682 | - * Removes a venue from the event |
|
| 683 | - * |
|
| 684 | - * @param EE_Venue /int $venue_id_or_obj |
|
| 685 | - * @return EE_Base_Class|EE_Venue |
|
| 686 | - * @throws EE_Error |
|
| 687 | - */ |
|
| 688 | - public function remove_venue($venue_id_or_obj) |
|
| 689 | - { |
|
| 690 | - return $this->_remove_relation_to($venue_id_or_obj, 'Venue'); |
|
| 691 | - } |
|
| 692 | - |
|
| 693 | - |
|
| 694 | - /** |
|
| 695 | - * Gets all the venues related ot the event. May provide additional $query_params if desired |
|
| 696 | - * |
|
| 697 | - * @param array $query_params like EEM_Base::get_all's $query_params |
|
| 698 | - * @return EE_Base_Class[]|EE_Venue[] |
|
| 699 | - * @throws EE_Error |
|
| 700 | - */ |
|
| 701 | - public function venues($query_params = array()) |
|
| 702 | - { |
|
| 703 | - return $this->get_many_related('Venue', $query_params); |
|
| 704 | - } |
|
| 705 | - |
|
| 706 | - |
|
| 707 | - /** |
|
| 708 | - * check if event id is present and if event is published |
|
| 709 | - * |
|
| 710 | - * @access public |
|
| 711 | - * @return boolean true yes, false no |
|
| 712 | - * @throws EE_Error |
|
| 713 | - */ |
|
| 714 | - private function _has_ID_and_is_published() |
|
| 715 | - { |
|
| 716 | - // first check if event id is present and not NULL, |
|
| 717 | - // then check if this event is published (or any of the equivalent "published" statuses) |
|
| 718 | - return |
|
| 719 | - $this->ID() && $this->ID() !== null |
|
| 720 | - && ( |
|
| 721 | - $this->status() === 'publish' |
|
| 722 | - || $this->status() === EEM_Event::sold_out |
|
| 723 | - || $this->status() === EEM_Event::postponed |
|
| 724 | - || $this->status() === EEM_Event::cancelled |
|
| 725 | - ); |
|
| 726 | - } |
|
| 727 | - |
|
| 728 | - |
|
| 729 | - /** |
|
| 730 | - * This simply compares the internal dates with NOW and determines if the event is upcoming or not. |
|
| 731 | - * |
|
| 732 | - * @access public |
|
| 733 | - * @return boolean true yes, false no |
|
| 734 | - * @throws EE_Error |
|
| 735 | - */ |
|
| 736 | - public function is_upcoming() |
|
| 737 | - { |
|
| 738 | - // check if event id is present and if this event is published |
|
| 739 | - if ($this->is_inactive()) { |
|
| 740 | - return false; |
|
| 741 | - } |
|
| 742 | - // set initial value |
|
| 743 | - $upcoming = false; |
|
| 744 | - // next let's get all datetimes and loop through them |
|
| 745 | - $datetimes = $this->datetimes_in_chronological_order(); |
|
| 746 | - foreach ($datetimes as $datetime) { |
|
| 747 | - if ($datetime instanceof EE_Datetime) { |
|
| 748 | - // if this dtt is expired then we continue cause one of the other datetimes might be upcoming. |
|
| 749 | - if ($datetime->is_expired()) { |
|
| 750 | - continue; |
|
| 751 | - } |
|
| 752 | - // if this dtt is active then we return false. |
|
| 753 | - if ($datetime->is_active()) { |
|
| 754 | - return false; |
|
| 755 | - } |
|
| 756 | - // otherwise let's check upcoming status |
|
| 757 | - $upcoming = $datetime->is_upcoming(); |
|
| 758 | - } |
|
| 759 | - } |
|
| 760 | - return $upcoming; |
|
| 761 | - } |
|
| 762 | - |
|
| 763 | - |
|
| 764 | - /** |
|
| 765 | - * @return bool |
|
| 766 | - * @throws EE_Error |
|
| 767 | - */ |
|
| 768 | - public function is_active() |
|
| 769 | - { |
|
| 770 | - // check if event id is present and if this event is published |
|
| 771 | - if ($this->is_inactive()) { |
|
| 772 | - return false; |
|
| 773 | - } |
|
| 774 | - // set initial value |
|
| 775 | - $active = false; |
|
| 776 | - // next let's get all datetimes and loop through them |
|
| 777 | - $datetimes = $this->datetimes_in_chronological_order(); |
|
| 778 | - foreach ($datetimes as $datetime) { |
|
| 779 | - if ($datetime instanceof EE_Datetime) { |
|
| 780 | - // if this dtt is expired then we continue cause one of the other datetimes might be active. |
|
| 781 | - if ($datetime->is_expired()) { |
|
| 782 | - continue; |
|
| 783 | - } |
|
| 784 | - // if this dtt is upcoming then we return false. |
|
| 785 | - if ($datetime->is_upcoming()) { |
|
| 786 | - return false; |
|
| 787 | - } |
|
| 788 | - // otherwise let's check active status |
|
| 789 | - $active = $datetime->is_active(); |
|
| 790 | - } |
|
| 791 | - } |
|
| 792 | - return $active; |
|
| 793 | - } |
|
| 794 | - |
|
| 795 | - |
|
| 796 | - /** |
|
| 797 | - * @return bool |
|
| 798 | - * @throws EE_Error |
|
| 799 | - */ |
|
| 800 | - public function is_expired() |
|
| 801 | - { |
|
| 802 | - // check if event id is present and if this event is published |
|
| 803 | - if ($this->is_inactive()) { |
|
| 804 | - return false; |
|
| 805 | - } |
|
| 806 | - // set initial value |
|
| 807 | - $expired = false; |
|
| 808 | - // first let's get all datetimes and loop through them |
|
| 809 | - $datetimes = $this->datetimes_in_chronological_order(); |
|
| 810 | - foreach ($datetimes as $datetime) { |
|
| 811 | - if ($datetime instanceof EE_Datetime) { |
|
| 812 | - // if this dtt is upcoming or active then we return false. |
|
| 813 | - if ($datetime->is_upcoming() || $datetime->is_active()) { |
|
| 814 | - return false; |
|
| 815 | - } |
|
| 816 | - // otherwise let's check active status |
|
| 817 | - $expired = $datetime->is_expired(); |
|
| 818 | - } |
|
| 819 | - } |
|
| 820 | - return $expired; |
|
| 821 | - } |
|
| 822 | - |
|
| 823 | - |
|
| 824 | - /** |
|
| 825 | - * @return bool |
|
| 826 | - * @throws EE_Error |
|
| 827 | - */ |
|
| 828 | - public function is_inactive() |
|
| 829 | - { |
|
| 830 | - // check if event id is present and if this event is published |
|
| 831 | - if ($this->_has_ID_and_is_published()) { |
|
| 832 | - return false; |
|
| 833 | - } |
|
| 834 | - return true; |
|
| 835 | - } |
|
| 836 | - |
|
| 837 | - |
|
| 838 | - /** |
|
| 839 | - * calculate spaces remaining based on "saleable" tickets |
|
| 840 | - * |
|
| 841 | - * @param array $tickets |
|
| 842 | - * @param bool $filtered |
|
| 843 | - * @return int|float |
|
| 844 | - * @throws EE_Error |
|
| 845 | - * @throws DomainException |
|
| 846 | - * @throws UnexpectedEntityException |
|
| 847 | - */ |
|
| 848 | - public function spaces_remaining($tickets = array(), $filtered = true) |
|
| 849 | - { |
|
| 850 | - $this->getAvailableSpacesCalculator()->setActiveTickets($tickets); |
|
| 851 | - $spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining(); |
|
| 852 | - return $filtered |
|
| 853 | - ? apply_filters( |
|
| 854 | - 'FHEE_EE_Event__spaces_remaining', |
|
| 855 | - $spaces_remaining, |
|
| 856 | - $this, |
|
| 857 | - $tickets |
|
| 858 | - ) |
|
| 859 | - : $spaces_remaining; |
|
| 860 | - } |
|
| 861 | - |
|
| 862 | - |
|
| 863 | - /** |
|
| 864 | - * perform_sold_out_status_check |
|
| 865 | - * checks all of this events's datetime reg_limit - sold values to determine if ANY datetimes have spaces |
|
| 866 | - * available... if NOT, then the event status will get toggled to 'sold_out' |
|
| 867 | - * |
|
| 868 | - * @return bool return the ACTUAL sold out state. |
|
| 869 | - * @throws EE_Error |
|
| 870 | - * @throws DomainException |
|
| 871 | - * @throws UnexpectedEntityException |
|
| 872 | - */ |
|
| 873 | - public function perform_sold_out_status_check() |
|
| 874 | - { |
|
| 875 | - // get all unexpired untrashed tickets |
|
| 876 | - $tickets = $this->tickets( |
|
| 877 | - array( |
|
| 878 | - array('TKT_deleted' => false), |
|
| 879 | - 'order_by' => array('TKT_qty' => 'ASC'), |
|
| 880 | - ) |
|
| 881 | - ); |
|
| 882 | - $all_expired = true; |
|
| 883 | - foreach ($tickets as $ticket) { |
|
| 884 | - if (! $ticket->is_expired()) { |
|
| 885 | - $all_expired = false; |
|
| 886 | - break; |
|
| 887 | - } |
|
| 888 | - } |
|
| 889 | - // if all the tickets are just expired, then don't update the event status to sold out |
|
| 890 | - if ($all_expired) { |
|
| 891 | - return true; |
|
| 892 | - } |
|
| 893 | - $spaces_remaining = $this->spaces_remaining($tickets); |
|
| 894 | - if ($spaces_remaining < 1) { |
|
| 895 | - $this->set_status(EEM_Event::sold_out); |
|
| 896 | - $this->save(); |
|
| 897 | - $sold_out = true; |
|
| 898 | - } else { |
|
| 899 | - $sold_out = false; |
|
| 900 | - // was event previously marked as sold out ? |
|
| 901 | - if ($this->status() === EEM_Event::sold_out) { |
|
| 902 | - // revert status to previous value, if it was set |
|
| 903 | - $previous_event_status = $this->get_post_meta('_previous_event_status', true); |
|
| 904 | - if ($previous_event_status) { |
|
| 905 | - $this->set_status($previous_event_status); |
|
| 906 | - $this->save(); |
|
| 907 | - } |
|
| 908 | - } |
|
| 909 | - } |
|
| 910 | - do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets); |
|
| 911 | - return $sold_out; |
|
| 912 | - } |
|
| 913 | - |
|
| 914 | - |
|
| 915 | - /** |
|
| 916 | - * This returns the total remaining spaces for sale on this event. |
|
| 917 | - * |
|
| 918 | - * @uses EE_Event::total_available_spaces() |
|
| 919 | - * @return float|int |
|
| 920 | - * @throws EE_Error |
|
| 921 | - * @throws DomainException |
|
| 922 | - * @throws UnexpectedEntityException |
|
| 923 | - */ |
|
| 924 | - public function spaces_remaining_for_sale() |
|
| 925 | - { |
|
| 926 | - return $this->total_available_spaces(true); |
|
| 927 | - } |
|
| 928 | - |
|
| 929 | - |
|
| 930 | - /** |
|
| 931 | - * This returns the total spaces available for an event |
|
| 932 | - * while considering all the qtys on the tickets and the reg limits |
|
| 933 | - * on the datetimes attached to this event. |
|
| 934 | - * |
|
| 935 | - * @param bool $consider_sold Whether to consider any tickets that have already sold in our calculation. |
|
| 936 | - * If this is false, then we return the most tickets that could ever be sold |
|
| 937 | - * for this event with the datetime and tickets setup on the event under optimal |
|
| 938 | - * selling conditions. Otherwise we return a live calculation of spaces available |
|
| 939 | - * based on tickets sold. Depending on setup and stage of sales, this |
|
| 940 | - * may appear to equal remaining tickets. However, the more tickets are |
|
| 941 | - * sold out, the more accurate the "live" total is. |
|
| 942 | - * @return float|int |
|
| 943 | - * @throws EE_Error |
|
| 944 | - * @throws DomainException |
|
| 945 | - * @throws UnexpectedEntityException |
|
| 946 | - */ |
|
| 947 | - public function total_available_spaces($consider_sold = false) |
|
| 948 | - { |
|
| 949 | - $spaces_available = $consider_sold |
|
| 950 | - ? $this->getAvailableSpacesCalculator()->spacesRemaining() |
|
| 951 | - : $this->getAvailableSpacesCalculator()->totalSpacesAvailable(); |
|
| 952 | - return apply_filters( |
|
| 953 | - 'FHEE_EE_Event__total_available_spaces__spaces_available', |
|
| 954 | - $spaces_available, |
|
| 955 | - $this, |
|
| 956 | - $this->getAvailableSpacesCalculator()->getDatetimes(), |
|
| 957 | - $this->getAvailableSpacesCalculator()->getActiveTickets() |
|
| 958 | - ); |
|
| 959 | - } |
|
| 960 | - |
|
| 961 | - |
|
| 962 | - /** |
|
| 963 | - * Checks if the event is set to sold out |
|
| 964 | - * |
|
| 965 | - * @param bool $actual whether or not to perform calculations to not only figure the |
|
| 966 | - * actual status but also to flip the status if necessary to sold |
|
| 967 | - * out If false, we just check the existing status of the event |
|
| 968 | - * @return boolean |
|
| 969 | - * @throws EE_Error |
|
| 970 | - */ |
|
| 971 | - public function is_sold_out($actual = false) |
|
| 972 | - { |
|
| 973 | - if (! $actual) { |
|
| 974 | - return $this->status() === EEM_Event::sold_out; |
|
| 975 | - } |
|
| 976 | - return $this->perform_sold_out_status_check(); |
|
| 977 | - } |
|
| 978 | - |
|
| 979 | - |
|
| 980 | - /** |
|
| 981 | - * Checks if the event is marked as postponed |
|
| 982 | - * |
|
| 983 | - * @return boolean |
|
| 984 | - */ |
|
| 985 | - public function is_postponed() |
|
| 986 | - { |
|
| 987 | - return $this->status() === EEM_Event::postponed; |
|
| 988 | - } |
|
| 989 | - |
|
| 990 | - |
|
| 991 | - /** |
|
| 992 | - * Checks if the event is marked as cancelled |
|
| 993 | - * |
|
| 994 | - * @return boolean |
|
| 995 | - */ |
|
| 996 | - public function is_cancelled() |
|
| 997 | - { |
|
| 998 | - return $this->status() === EEM_Event::cancelled; |
|
| 999 | - } |
|
| 1000 | - |
|
| 1001 | - |
|
| 1002 | - /** |
|
| 1003 | - * Get the logical active status in a hierarchical order for all the datetimes. Note |
|
| 1004 | - * Basically, we order the datetimes by EVT_start_date. Then first test on whether the event is published. If its |
|
| 1005 | - * NOT published then we test for whether its expired or not. IF it IS published then we test first on whether an |
|
| 1006 | - * event has any active dates. If no active dates then we check for any upcoming dates. If no upcoming dates then |
|
| 1007 | - * the event is considered expired. |
|
| 1008 | - * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published. Sold Out is a |
|
| 1009 | - * status set on the EVENT when it is not published and thus is done |
|
| 1010 | - * |
|
| 1011 | - * @param bool $reset |
|
| 1012 | - * @return bool | string - based on EE_Datetime active constants or FALSE if error. |
|
| 1013 | - * @throws EE_Error |
|
| 1014 | - */ |
|
| 1015 | - public function get_active_status($reset = false) |
|
| 1016 | - { |
|
| 1017 | - // if the active status has already been set, then just use that value (unless we are resetting it) |
|
| 1018 | - if (! empty($this->_active_status) && ! $reset) { |
|
| 1019 | - return $this->_active_status; |
|
| 1020 | - } |
|
| 1021 | - // first check if event id is present on this object |
|
| 1022 | - if (! $this->ID()) { |
|
| 1023 | - return false; |
|
| 1024 | - } |
|
| 1025 | - $where_params_for_event = array(array('EVT_ID' => $this->ID())); |
|
| 1026 | - // if event is published: |
|
| 1027 | - if ($this->status() === 'publish') { |
|
| 1028 | - // active? |
|
| 1029 | - if (EEM_Datetime::instance()->get_datetime_count_for_status( |
|
| 1030 | - EE_Datetime::active, |
|
| 1031 | - $where_params_for_event |
|
| 1032 | - ) > 0) { |
|
| 1033 | - $this->_active_status = EE_Datetime::active; |
|
| 1034 | - } else { |
|
| 1035 | - // upcoming? |
|
| 1036 | - if (EEM_Datetime::instance()->get_datetime_count_for_status( |
|
| 1037 | - EE_Datetime::upcoming, |
|
| 1038 | - $where_params_for_event |
|
| 1039 | - ) > 0) { |
|
| 1040 | - $this->_active_status = EE_Datetime::upcoming; |
|
| 1041 | - } else { |
|
| 1042 | - // expired? |
|
| 1043 | - if (EEM_Datetime::instance()->get_datetime_count_for_status( |
|
| 1044 | - EE_Datetime::expired, |
|
| 1045 | - $where_params_for_event |
|
| 1046 | - ) > 0 |
|
| 1047 | - ) { |
|
| 1048 | - $this->_active_status = EE_Datetime::expired; |
|
| 1049 | - } else { |
|
| 1050 | - // it would be odd if things make it this far because it basically means there are no datetime's |
|
| 1051 | - // attached to the event. So in this case it will just be considered inactive. |
|
| 1052 | - $this->_active_status = EE_Datetime::inactive; |
|
| 1053 | - } |
|
| 1054 | - } |
|
| 1055 | - } |
|
| 1056 | - } else { |
|
| 1057 | - // the event is not published, so let's just set it's active status according to its' post status |
|
| 1058 | - switch ($this->status()) { |
|
| 1059 | - case EEM_Event::sold_out: |
|
| 1060 | - $this->_active_status = EE_Datetime::sold_out; |
|
| 1061 | - break; |
|
| 1062 | - case EEM_Event::cancelled: |
|
| 1063 | - $this->_active_status = EE_Datetime::cancelled; |
|
| 1064 | - break; |
|
| 1065 | - case EEM_Event::postponed: |
|
| 1066 | - $this->_active_status = EE_Datetime::postponed; |
|
| 1067 | - break; |
|
| 1068 | - default: |
|
| 1069 | - $this->_active_status = EE_Datetime::inactive; |
|
| 1070 | - } |
|
| 1071 | - } |
|
| 1072 | - return $this->_active_status; |
|
| 1073 | - } |
|
| 1074 | - |
|
| 1075 | - |
|
| 1076 | - /** |
|
| 1077 | - * pretty_active_status |
|
| 1078 | - * |
|
| 1079 | - * @access public |
|
| 1080 | - * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE) |
|
| 1081 | - * @return mixed void|string |
|
| 1082 | - * @throws EE_Error |
|
| 1083 | - */ |
|
| 1084 | - public function pretty_active_status($echo = true) |
|
| 1085 | - { |
|
| 1086 | - $active_status = $this->get_active_status(); |
|
| 1087 | - $status = '<span class="ee-status event-active-status-' |
|
| 1088 | - . $active_status |
|
| 1089 | - . '">' |
|
| 1090 | - . EEH_Template::pretty_status($active_status, false, 'sentence') |
|
| 1091 | - . '</span>'; |
|
| 1092 | - if ($echo) { |
|
| 1093 | - echo $status; |
|
| 1094 | - return ''; |
|
| 1095 | - } |
|
| 1096 | - return $status; |
|
| 1097 | - } |
|
| 1098 | - |
|
| 1099 | - |
|
| 1100 | - /** |
|
| 1101 | - * @return bool|int |
|
| 1102 | - * @throws EE_Error |
|
| 1103 | - */ |
|
| 1104 | - public function get_number_of_tickets_sold() |
|
| 1105 | - { |
|
| 1106 | - $tkt_sold = 0; |
|
| 1107 | - if (! $this->ID()) { |
|
| 1108 | - return 0; |
|
| 1109 | - } |
|
| 1110 | - $datetimes = $this->datetimes(); |
|
| 1111 | - foreach ($datetimes as $datetime) { |
|
| 1112 | - if ($datetime instanceof EE_Datetime) { |
|
| 1113 | - $tkt_sold += $datetime->sold(); |
|
| 1114 | - } |
|
| 1115 | - } |
|
| 1116 | - return $tkt_sold; |
|
| 1117 | - } |
|
| 1118 | - |
|
| 1119 | - |
|
| 1120 | - /** |
|
| 1121 | - * This just returns a count of all the registrations for this event |
|
| 1122 | - * |
|
| 1123 | - * @access public |
|
| 1124 | - * @return int |
|
| 1125 | - * @throws EE_Error |
|
| 1126 | - */ |
|
| 1127 | - public function get_count_of_all_registrations() |
|
| 1128 | - { |
|
| 1129 | - return EEM_Event::instance()->count_related($this, 'Registration'); |
|
| 1130 | - } |
|
| 1131 | - |
|
| 1132 | - |
|
| 1133 | - /** |
|
| 1134 | - * This returns the ticket with the earliest start time that is |
|
| 1135 | - * available for this event (across all datetimes attached to the event) |
|
| 1136 | - * |
|
| 1137 | - * @return EE_Base_Class|EE_Ticket|null |
|
| 1138 | - * @throws EE_Error |
|
| 1139 | - */ |
|
| 1140 | - public function get_ticket_with_earliest_start_time() |
|
| 1141 | - { |
|
| 1142 | - $where['Datetime.EVT_ID'] = $this->ID(); |
|
| 1143 | - $query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC')); |
|
| 1144 | - return EE_Registry::instance()->load_model('Ticket')->get_one($query_params); |
|
| 1145 | - } |
|
| 1146 | - |
|
| 1147 | - |
|
| 1148 | - /** |
|
| 1149 | - * This returns the ticket with the latest end time that is available |
|
| 1150 | - * for this event (across all datetimes attached to the event) |
|
| 1151 | - * |
|
| 1152 | - * @return EE_Base_Class|EE_Ticket|null |
|
| 1153 | - * @throws EE_Error |
|
| 1154 | - */ |
|
| 1155 | - public function get_ticket_with_latest_end_time() |
|
| 1156 | - { |
|
| 1157 | - $where['Datetime.EVT_ID'] = $this->ID(); |
|
| 1158 | - $query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC')); |
|
| 1159 | - return EE_Registry::instance()->load_model('Ticket')->get_one($query_params); |
|
| 1160 | - } |
|
| 1161 | - |
|
| 1162 | - |
|
| 1163 | - /** |
|
| 1164 | - * This returns the number of different ticket types currently on sale for this event. |
|
| 1165 | - * |
|
| 1166 | - * @return int |
|
| 1167 | - * @throws EE_Error |
|
| 1168 | - */ |
|
| 1169 | - public function countTicketsOnSale() |
|
| 1170 | - { |
|
| 1171 | - $where = array( |
|
| 1172 | - 'Datetime.EVT_ID' => $this->ID(), |
|
| 1173 | - 'TKT_start_date' => array('<', time()), |
|
| 1174 | - 'TKT_end_date' => array('>', time()), |
|
| 1175 | - ); |
|
| 1176 | - return EEM_Ticket::instance()->count(array($where)); |
|
| 1177 | - } |
|
| 1178 | - |
|
| 1179 | - |
|
| 1180 | - /** |
|
| 1181 | - * This returns whether there are any tickets on sale for this event. |
|
| 1182 | - * |
|
| 1183 | - * @return bool true = YES tickets on sale. |
|
| 1184 | - * @throws EE_Error |
|
| 1185 | - */ |
|
| 1186 | - public function tickets_on_sale() |
|
| 1187 | - { |
|
| 1188 | - return $this->countTicketsOnSale() > 0; |
|
| 1189 | - } |
|
| 1190 | - |
|
| 1191 | - |
|
| 1192 | - /** |
|
| 1193 | - * Gets the URL for viewing this event on the front-end. Overrides parent |
|
| 1194 | - * to check for an external URL first |
|
| 1195 | - * |
|
| 1196 | - * @return string |
|
| 1197 | - * @throws EE_Error |
|
| 1198 | - */ |
|
| 1199 | - public function get_permalink() |
|
| 1200 | - { |
|
| 1201 | - if ($this->external_url()) { |
|
| 1202 | - return $this->external_url(); |
|
| 1203 | - } |
|
| 1204 | - return parent::get_permalink(); |
|
| 1205 | - } |
|
| 1206 | - |
|
| 1207 | - |
|
| 1208 | - /** |
|
| 1209 | - * Gets the first term for 'espresso_event_categories' we can find |
|
| 1210 | - * |
|
| 1211 | - * @param array $query_params like EEM_Base::get_all |
|
| 1212 | - * @return EE_Base_Class|EE_Term|null |
|
| 1213 | - * @throws EE_Error |
|
| 1214 | - */ |
|
| 1215 | - public function first_event_category($query_params = array()) |
|
| 1216 | - { |
|
| 1217 | - $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories'; |
|
| 1218 | - $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID(); |
|
| 1219 | - return EEM_Term::instance()->get_one($query_params); |
|
| 1220 | - } |
|
| 1221 | - |
|
| 1222 | - |
|
| 1223 | - /** |
|
| 1224 | - * Gets all terms for 'espresso_event_categories' we can find |
|
| 1225 | - * |
|
| 1226 | - * @param array $query_params |
|
| 1227 | - * @return EE_Base_Class[]|EE_Term[] |
|
| 1228 | - * @throws EE_Error |
|
| 1229 | - */ |
|
| 1230 | - public function get_all_event_categories($query_params = array()) |
|
| 1231 | - { |
|
| 1232 | - $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories'; |
|
| 1233 | - $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID(); |
|
| 1234 | - return EEM_Term::instance()->get_all($query_params); |
|
| 1235 | - } |
|
| 1236 | - |
|
| 1237 | - |
|
| 1238 | - /** |
|
| 1239 | - * Adds a question group to this event |
|
| 1240 | - * |
|
| 1241 | - * @param EE_Question_Group|int $question_group_id_or_obj |
|
| 1242 | - * @param bool $for_primary if true, the question group will be added for the primary |
|
| 1243 | - * registrant, if false will be added for others. default: false |
|
| 1244 | - * @return EE_Base_Class|EE_Question_Group |
|
| 1245 | - * @throws EE_Error |
|
| 1246 | - */ |
|
| 1247 | - public function add_question_group($question_group_id_or_obj, $for_primary = false) |
|
| 1248 | - { |
|
| 1249 | - $extra = $for_primary |
|
| 1250 | - ? array('EQG_primary' => 1) |
|
| 1251 | - : array(); |
|
| 1252 | - return $this->_add_relation_to($question_group_id_or_obj, 'Question_Group', $extra); |
|
| 1253 | - } |
|
| 1254 | - |
|
| 1255 | - |
|
| 1256 | - /** |
|
| 1257 | - * Removes a question group from the event |
|
| 1258 | - * |
|
| 1259 | - * @param EE_Question_Group|int $question_group_id_or_obj |
|
| 1260 | - * @param bool $for_primary if true, the question group will be removed from the primary |
|
| 1261 | - * registrant, if false will be removed from others. default: false |
|
| 1262 | - * @return EE_Base_Class|EE_Question_Group |
|
| 1263 | - * @throws EE_Error |
|
| 1264 | - */ |
|
| 1265 | - public function remove_question_group($question_group_id_or_obj, $for_primary = false) |
|
| 1266 | - { |
|
| 1267 | - $where = $for_primary |
|
| 1268 | - ? array('EQG_primary' => 1) |
|
| 1269 | - : array(); |
|
| 1270 | - return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group', $where); |
|
| 1271 | - } |
|
| 1272 | - |
|
| 1273 | - |
|
| 1274 | - /** |
|
| 1275 | - * Gets all the question groups, ordering them by QSG_order ascending |
|
| 1276 | - * |
|
| 1277 | - * @param array $query_params @see EEM_Base::get_all |
|
| 1278 | - * @return EE_Base_Class[]|EE_Question_Group[] |
|
| 1279 | - * @throws EE_Error |
|
| 1280 | - */ |
|
| 1281 | - public function question_groups($query_params = array()) |
|
| 1282 | - { |
|
| 1283 | - $query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC')); |
|
| 1284 | - return $this->get_many_related('Question_Group', $query_params); |
|
| 1285 | - } |
|
| 1286 | - |
|
| 1287 | - |
|
| 1288 | - /** |
|
| 1289 | - * Implementation for EEI_Has_Icon interface method. |
|
| 1290 | - * |
|
| 1291 | - * @see EEI_Visual_Representation for comments |
|
| 1292 | - * @return string |
|
| 1293 | - */ |
|
| 1294 | - public function get_icon() |
|
| 1295 | - { |
|
| 1296 | - return '<span class="dashicons dashicons-flag"></span>'; |
|
| 1297 | - } |
|
| 1298 | - |
|
| 1299 | - |
|
| 1300 | - /** |
|
| 1301 | - * Implementation for EEI_Admin_Links interface method. |
|
| 1302 | - * |
|
| 1303 | - * @see EEI_Admin_Links for comments |
|
| 1304 | - * @return string |
|
| 1305 | - * @throws EE_Error |
|
| 1306 | - */ |
|
| 1307 | - public function get_admin_details_link() |
|
| 1308 | - { |
|
| 1309 | - return $this->get_admin_edit_link(); |
|
| 1310 | - } |
|
| 1311 | - |
|
| 1312 | - |
|
| 1313 | - /** |
|
| 1314 | - * Implementation for EEI_Admin_Links interface method. |
|
| 1315 | - * |
|
| 1316 | - * @see EEI_Admin_Links for comments |
|
| 1317 | - * @return string |
|
| 1318 | - * @throws EE_Error |
|
| 1319 | - */ |
|
| 1320 | - public function get_admin_edit_link() |
|
| 1321 | - { |
|
| 1322 | - return EEH_URL::add_query_args_and_nonce( |
|
| 1323 | - array( |
|
| 1324 | - 'page' => 'espresso_events', |
|
| 1325 | - 'action' => 'edit', |
|
| 1326 | - 'post' => $this->ID(), |
|
| 1327 | - ), |
|
| 1328 | - admin_url('admin.php') |
|
| 1329 | - ); |
|
| 1330 | - } |
|
| 1331 | - |
|
| 1332 | - |
|
| 1333 | - /** |
|
| 1334 | - * Implementation for EEI_Admin_Links interface method. |
|
| 1335 | - * |
|
| 1336 | - * @see EEI_Admin_Links for comments |
|
| 1337 | - * @return string |
|
| 1338 | - */ |
|
| 1339 | - public function get_admin_settings_link() |
|
| 1340 | - { |
|
| 1341 | - return EEH_URL::add_query_args_and_nonce( |
|
| 1342 | - array( |
|
| 1343 | - 'page' => 'espresso_events', |
|
| 1344 | - 'action' => 'default_event_settings', |
|
| 1345 | - ), |
|
| 1346 | - admin_url('admin.php') |
|
| 1347 | - ); |
|
| 1348 | - } |
|
| 1349 | - |
|
| 1350 | - |
|
| 1351 | - /** |
|
| 1352 | - * Implementation for EEI_Admin_Links interface method. |
|
| 1353 | - * |
|
| 1354 | - * @see EEI_Admin_Links for comments |
|
| 1355 | - * @return string |
|
| 1356 | - */ |
|
| 1357 | - public function get_admin_overview_link() |
|
| 1358 | - { |
|
| 1359 | - return EEH_URL::add_query_args_and_nonce( |
|
| 1360 | - array( |
|
| 1361 | - 'page' => 'espresso_events', |
|
| 1362 | - 'action' => 'default', |
|
| 1363 | - ), |
|
| 1364 | - admin_url('admin.php') |
|
| 1365 | - ); |
|
| 1366 | - } |
|
| 16 | + /** |
|
| 17 | + * cached value for the the logical active status for the event |
|
| 18 | + * |
|
| 19 | + * @see get_active_status() |
|
| 20 | + * @var string |
|
| 21 | + */ |
|
| 22 | + protected $_active_status = ''; |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * This is just used for caching the Primary Datetime for the Event on initial retrieval |
|
| 26 | + * |
|
| 27 | + * @var EE_Datetime |
|
| 28 | + */ |
|
| 29 | + protected $_Primary_Datetime; |
|
| 30 | + |
|
| 31 | + /** |
|
| 32 | + * @var EventSpacesCalculator $available_spaces_calculator |
|
| 33 | + */ |
|
| 34 | + protected $available_spaces_calculator; |
|
| 35 | + |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * @param array $props_n_values incoming values |
|
| 39 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
| 40 | + * used.) |
|
| 41 | + * @param array $date_formats incoming date_formats in an array where the first value is the |
|
| 42 | + * date_format and the second value is the time format |
|
| 43 | + * @return EE_Event |
|
| 44 | + * @throws EE_Error |
|
| 45 | + */ |
|
| 46 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
| 47 | + { |
|
| 48 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
| 49 | + return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
| 50 | + } |
|
| 51 | + |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * @param array $props_n_values incoming values from the database |
|
| 55 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 56 | + * the website will be used. |
|
| 57 | + * @return EE_Event |
|
| 58 | + * @throws EE_Error |
|
| 59 | + */ |
|
| 60 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
| 61 | + { |
|
| 62 | + return new self($props_n_values, true, $timezone); |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * @return EventSpacesCalculator |
|
| 68 | + * @throws \EE_Error |
|
| 69 | + */ |
|
| 70 | + public function getAvailableSpacesCalculator() |
|
| 71 | + { |
|
| 72 | + if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) { |
|
| 73 | + $this->available_spaces_calculator = new EventSpacesCalculator($this); |
|
| 74 | + } |
|
| 75 | + return $this->available_spaces_calculator; |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + |
|
| 79 | + /** |
|
| 80 | + * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods |
|
| 81 | + * |
|
| 82 | + * @param string $field_name |
|
| 83 | + * @param mixed $field_value |
|
| 84 | + * @param bool $use_default |
|
| 85 | + * @throws EE_Error |
|
| 86 | + */ |
|
| 87 | + public function set($field_name, $field_value, $use_default = false) |
|
| 88 | + { |
|
| 89 | + switch ($field_name) { |
|
| 90 | + case 'status': |
|
| 91 | + $this->set_status($field_value, $use_default); |
|
| 92 | + break; |
|
| 93 | + default: |
|
| 94 | + parent::set($field_name, $field_value, $use_default); |
|
| 95 | + } |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * set_status |
|
| 101 | + * Checks if event status is being changed to SOLD OUT |
|
| 102 | + * and updates event meta data with previous event status |
|
| 103 | + * so that we can revert things if/when the event is no longer sold out |
|
| 104 | + * |
|
| 105 | + * @access public |
|
| 106 | + * @param string $new_status |
|
| 107 | + * @param bool $use_default |
|
| 108 | + * @return void |
|
| 109 | + * @throws EE_Error |
|
| 110 | + */ |
|
| 111 | + public function set_status($new_status = null, $use_default = false) |
|
| 112 | + { |
|
| 113 | + // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave |
|
| 114 | + if (empty($new_status) && ! $use_default) { |
|
| 115 | + return; |
|
| 116 | + } |
|
| 117 | + // get current Event status |
|
| 118 | + $old_status = $this->status(); |
|
| 119 | + // if status has changed |
|
| 120 | + if ($old_status !== $new_status) { |
|
| 121 | + // TO sold_out |
|
| 122 | + if ($new_status === EEM_Event::sold_out) { |
|
| 123 | + // save the previous event status so that we can revert if the event is no longer sold out |
|
| 124 | + $this->add_post_meta('_previous_event_status', $old_status); |
|
| 125 | + do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status); |
|
| 126 | + // OR FROM sold_out |
|
| 127 | + } elseif ($old_status === EEM_Event::sold_out) { |
|
| 128 | + $this->delete_post_meta('_previous_event_status'); |
|
| 129 | + do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status); |
|
| 130 | + } |
|
| 131 | + // clear out the active status so that it gets reset the next time it is requested |
|
| 132 | + $this->_active_status = null; |
|
| 133 | + // update status |
|
| 134 | + parent::set('status', $new_status, $use_default); |
|
| 135 | + do_action('AHEE__EE_Event__set_status__after_update', $this); |
|
| 136 | + return; |
|
| 137 | + } |
|
| 138 | + // even though the old value matches the new value, it's still good to |
|
| 139 | + // allow the parent set method to have a say |
|
| 140 | + parent::set('status', $new_status, $use_default); |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * Gets all the datetimes for this event |
|
| 146 | + * |
|
| 147 | + * @param array $query_params like EEM_Base::get_all |
|
| 148 | + * @return EE_Base_Class[]|EE_Datetime[] |
|
| 149 | + * @throws EE_Error |
|
| 150 | + */ |
|
| 151 | + public function datetimes($query_params = array()) |
|
| 152 | + { |
|
| 153 | + return $this->get_many_related('Datetime', $query_params); |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order |
|
| 159 | + * |
|
| 160 | + * @return EE_Base_Class[]|EE_Datetime[] |
|
| 161 | + * @throws EE_Error |
|
| 162 | + */ |
|
| 163 | + public function datetimes_in_chronological_order() |
|
| 164 | + { |
|
| 165 | + return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC'))); |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * Gets all the datetimes for this event, ordered by the DTT_order on the datetime. |
|
| 171 | + * @darren, we should probably UNSET timezone on the EEM_Datetime model |
|
| 172 | + * after running our query, so that this timezone isn't set for EVERY query |
|
| 173 | + * on EEM_Datetime for the rest of the request, no? |
|
| 174 | + * |
|
| 175 | + * @param boolean $show_expired whether or not to include expired events |
|
| 176 | + * @param boolean $show_deleted whether or not to include deleted events |
|
| 177 | + * @param null $limit |
|
| 178 | + * @return EE_Datetime[] |
|
| 179 | + * @throws EE_Error |
|
| 180 | + */ |
|
| 181 | + public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null) |
|
| 182 | + { |
|
| 183 | + return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order( |
|
| 184 | + $this->ID(), |
|
| 185 | + $show_expired, |
|
| 186 | + $show_deleted, |
|
| 187 | + $limit |
|
| 188 | + ); |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * Returns one related datetime. Mostly only used by some legacy code. |
|
| 194 | + * |
|
| 195 | + * @return EE_Base_Class|EE_Datetime |
|
| 196 | + * @throws EE_Error |
|
| 197 | + */ |
|
| 198 | + public function first_datetime() |
|
| 199 | + { |
|
| 200 | + return $this->get_first_related('Datetime'); |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * Returns the 'primary' datetime for the event |
|
| 206 | + * |
|
| 207 | + * @param bool $try_to_exclude_expired |
|
| 208 | + * @param bool $try_to_exclude_deleted |
|
| 209 | + * @return EE_Datetime |
|
| 210 | + * @throws EE_Error |
|
| 211 | + */ |
|
| 212 | + public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true) |
|
| 213 | + { |
|
| 214 | + if (! empty($this->_Primary_Datetime)) { |
|
| 215 | + return $this->_Primary_Datetime; |
|
| 216 | + } |
|
| 217 | + $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event( |
|
| 218 | + $this->ID(), |
|
| 219 | + $try_to_exclude_expired, |
|
| 220 | + $try_to_exclude_deleted |
|
| 221 | + ); |
|
| 222 | + return $this->_Primary_Datetime; |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + |
|
| 226 | + /** |
|
| 227 | + * Gets all the tickets available for purchase of this event |
|
| 228 | + * |
|
| 229 | + * @param array $query_params like EEM_Base::get_all |
|
| 230 | + * @return EE_Base_Class[]|EE_Ticket[] |
|
| 231 | + * @throws EE_Error |
|
| 232 | + */ |
|
| 233 | + public function tickets($query_params = array()) |
|
| 234 | + { |
|
| 235 | + // first get all datetimes |
|
| 236 | + $datetimes = $this->datetimes_ordered(); |
|
| 237 | + if (! $datetimes) { |
|
| 238 | + return array(); |
|
| 239 | + } |
|
| 240 | + $datetime_ids = array(); |
|
| 241 | + foreach ($datetimes as $datetime) { |
|
| 242 | + $datetime_ids[] = $datetime->ID(); |
|
| 243 | + } |
|
| 244 | + $where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids)); |
|
| 245 | + // if incoming $query_params has where conditions let's merge but not override existing. |
|
| 246 | + if (is_array($query_params) && isset($query_params[0])) { |
|
| 247 | + $where_params = array_merge($query_params[0], $where_params); |
|
| 248 | + unset($query_params[0]); |
|
| 249 | + } |
|
| 250 | + // now add $where_params to $query_params |
|
| 251 | + $query_params[0] = $where_params; |
|
| 252 | + return EEM_Ticket::instance()->get_all($query_params); |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + |
|
| 256 | + /** |
|
| 257 | + * get all unexpired untrashed tickets |
|
| 258 | + * |
|
| 259 | + * @return EE_Ticket[] |
|
| 260 | + * @throws EE_Error |
|
| 261 | + */ |
|
| 262 | + public function active_tickets() |
|
| 263 | + { |
|
| 264 | + return $this->tickets( |
|
| 265 | + array( |
|
| 266 | + array( |
|
| 267 | + 'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')), |
|
| 268 | + 'TKT_deleted' => false, |
|
| 269 | + ), |
|
| 270 | + ) |
|
| 271 | + ); |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + |
|
| 275 | + /** |
|
| 276 | + * @return bool |
|
| 277 | + * @throws EE_Error |
|
| 278 | + */ |
|
| 279 | + public function additional_limit() |
|
| 280 | + { |
|
| 281 | + return $this->get('EVT_additional_limit'); |
|
| 282 | + } |
|
| 283 | + |
|
| 284 | + |
|
| 285 | + /** |
|
| 286 | + * @return bool |
|
| 287 | + * @throws EE_Error |
|
| 288 | + */ |
|
| 289 | + public function allow_overflow() |
|
| 290 | + { |
|
| 291 | + return $this->get('EVT_allow_overflow'); |
|
| 292 | + } |
|
| 293 | + |
|
| 294 | + |
|
| 295 | + /** |
|
| 296 | + * @return bool |
|
| 297 | + * @throws EE_Error |
|
| 298 | + */ |
|
| 299 | + public function created() |
|
| 300 | + { |
|
| 301 | + return $this->get('EVT_created'); |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + |
|
| 305 | + /** |
|
| 306 | + * @return bool |
|
| 307 | + * @throws EE_Error |
|
| 308 | + */ |
|
| 309 | + public function description() |
|
| 310 | + { |
|
| 311 | + return $this->get('EVT_desc'); |
|
| 312 | + } |
|
| 313 | + |
|
| 314 | + |
|
| 315 | + /** |
|
| 316 | + * Runs do_shortcode and wpautop on the description |
|
| 317 | + * |
|
| 318 | + * @return string of html |
|
| 319 | + * @throws EE_Error |
|
| 320 | + */ |
|
| 321 | + public function description_filtered() |
|
| 322 | + { |
|
| 323 | + return $this->get_pretty('EVT_desc'); |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + |
|
| 327 | + /** |
|
| 328 | + * @return bool |
|
| 329 | + * @throws EE_Error |
|
| 330 | + */ |
|
| 331 | + public function display_description() |
|
| 332 | + { |
|
| 333 | + return $this->get('EVT_display_desc'); |
|
| 334 | + } |
|
| 335 | + |
|
| 336 | + |
|
| 337 | + /** |
|
| 338 | + * @return bool |
|
| 339 | + * @throws EE_Error |
|
| 340 | + */ |
|
| 341 | + public function display_ticket_selector() |
|
| 342 | + { |
|
| 343 | + return (bool) $this->get('EVT_display_ticket_selector'); |
|
| 344 | + } |
|
| 345 | + |
|
| 346 | + |
|
| 347 | + /** |
|
| 348 | + * @return bool |
|
| 349 | + * @throws EE_Error |
|
| 350 | + */ |
|
| 351 | + public function external_url() |
|
| 352 | + { |
|
| 353 | + return $this->get('EVT_external_URL'); |
|
| 354 | + } |
|
| 355 | + |
|
| 356 | + |
|
| 357 | + /** |
|
| 358 | + * @return bool |
|
| 359 | + * @throws EE_Error |
|
| 360 | + */ |
|
| 361 | + public function member_only() |
|
| 362 | + { |
|
| 363 | + return $this->get('EVT_member_only'); |
|
| 364 | + } |
|
| 365 | + |
|
| 366 | + |
|
| 367 | + /** |
|
| 368 | + * @return bool |
|
| 369 | + * @throws EE_Error |
|
| 370 | + */ |
|
| 371 | + public function phone() |
|
| 372 | + { |
|
| 373 | + return $this->get('EVT_phone'); |
|
| 374 | + } |
|
| 375 | + |
|
| 376 | + |
|
| 377 | + /** |
|
| 378 | + * @return bool |
|
| 379 | + * @throws EE_Error |
|
| 380 | + */ |
|
| 381 | + public function modified() |
|
| 382 | + { |
|
| 383 | + return $this->get('EVT_modified'); |
|
| 384 | + } |
|
| 385 | + |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * @return bool |
|
| 389 | + * @throws EE_Error |
|
| 390 | + */ |
|
| 391 | + public function name() |
|
| 392 | + { |
|
| 393 | + return $this->get('EVT_name'); |
|
| 394 | + } |
|
| 395 | + |
|
| 396 | + |
|
| 397 | + /** |
|
| 398 | + * @return bool |
|
| 399 | + * @throws EE_Error |
|
| 400 | + */ |
|
| 401 | + public function order() |
|
| 402 | + { |
|
| 403 | + return $this->get('EVT_order'); |
|
| 404 | + } |
|
| 405 | + |
|
| 406 | + |
|
| 407 | + /** |
|
| 408 | + * @return bool|string |
|
| 409 | + * @throws EE_Error |
|
| 410 | + */ |
|
| 411 | + public function default_registration_status() |
|
| 412 | + { |
|
| 413 | + $event_default_registration_status = $this->get('EVT_default_registration_status'); |
|
| 414 | + return ! empty($event_default_registration_status) |
|
| 415 | + ? $event_default_registration_status |
|
| 416 | + : EE_Registry::instance()->CFG->registration->default_STS_ID; |
|
| 417 | + } |
|
| 418 | + |
|
| 419 | + |
|
| 420 | + /** |
|
| 421 | + * @param int $num_words |
|
| 422 | + * @param null $more |
|
| 423 | + * @param bool $not_full_desc |
|
| 424 | + * @return bool|string |
|
| 425 | + * @throws EE_Error |
|
| 426 | + */ |
|
| 427 | + public function short_description($num_words = 55, $more = null, $not_full_desc = false) |
|
| 428 | + { |
|
| 429 | + $short_desc = $this->get('EVT_short_desc'); |
|
| 430 | + if (! empty($short_desc) || $not_full_desc) { |
|
| 431 | + return $short_desc; |
|
| 432 | + } |
|
| 433 | + $full_desc = $this->get('EVT_desc'); |
|
| 434 | + return wp_trim_words($full_desc, $num_words, $more); |
|
| 435 | + } |
|
| 436 | + |
|
| 437 | + |
|
| 438 | + /** |
|
| 439 | + * @return bool |
|
| 440 | + * @throws EE_Error |
|
| 441 | + */ |
|
| 442 | + public function slug() |
|
| 443 | + { |
|
| 444 | + return $this->get('EVT_slug'); |
|
| 445 | + } |
|
| 446 | + |
|
| 447 | + |
|
| 448 | + /** |
|
| 449 | + * @return bool |
|
| 450 | + * @throws EE_Error |
|
| 451 | + */ |
|
| 452 | + public function timezone_string() |
|
| 453 | + { |
|
| 454 | + return $this->get('EVT_timezone_string'); |
|
| 455 | + } |
|
| 456 | + |
|
| 457 | + |
|
| 458 | + /** |
|
| 459 | + * @return bool |
|
| 460 | + * @throws EE_Error |
|
| 461 | + */ |
|
| 462 | + public function visible_on() |
|
| 463 | + { |
|
| 464 | + return $this->get('EVT_visible_on'); |
|
| 465 | + } |
|
| 466 | + |
|
| 467 | + |
|
| 468 | + /** |
|
| 469 | + * @return int |
|
| 470 | + * @throws EE_Error |
|
| 471 | + */ |
|
| 472 | + public function wp_user() |
|
| 473 | + { |
|
| 474 | + return $this->get('EVT_wp_user'); |
|
| 475 | + } |
|
| 476 | + |
|
| 477 | + |
|
| 478 | + /** |
|
| 479 | + * @return bool |
|
| 480 | + * @throws EE_Error |
|
| 481 | + */ |
|
| 482 | + public function donations() |
|
| 483 | + { |
|
| 484 | + return $this->get('EVT_donations'); |
|
| 485 | + } |
|
| 486 | + |
|
| 487 | + |
|
| 488 | + /** |
|
| 489 | + * @param $limit |
|
| 490 | + * @throws EE_Error |
|
| 491 | + */ |
|
| 492 | + public function set_additional_limit($limit) |
|
| 493 | + { |
|
| 494 | + $this->set('EVT_additional_limit', $limit); |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + |
|
| 498 | + /** |
|
| 499 | + * @param $created |
|
| 500 | + * @throws EE_Error |
|
| 501 | + */ |
|
| 502 | + public function set_created($created) |
|
| 503 | + { |
|
| 504 | + $this->set('EVT_created', $created); |
|
| 505 | + } |
|
| 506 | + |
|
| 507 | + |
|
| 508 | + /** |
|
| 509 | + * @param $desc |
|
| 510 | + * @throws EE_Error |
|
| 511 | + */ |
|
| 512 | + public function set_description($desc) |
|
| 513 | + { |
|
| 514 | + $this->set('EVT_desc', $desc); |
|
| 515 | + } |
|
| 516 | + |
|
| 517 | + |
|
| 518 | + /** |
|
| 519 | + * @param $display_desc |
|
| 520 | + * @throws EE_Error |
|
| 521 | + */ |
|
| 522 | + public function set_display_description($display_desc) |
|
| 523 | + { |
|
| 524 | + $this->set('EVT_display_desc', $display_desc); |
|
| 525 | + } |
|
| 526 | + |
|
| 527 | + |
|
| 528 | + /** |
|
| 529 | + * @param $display_ticket_selector |
|
| 530 | + * @throws EE_Error |
|
| 531 | + */ |
|
| 532 | + public function set_display_ticket_selector($display_ticket_selector) |
|
| 533 | + { |
|
| 534 | + $this->set('EVT_display_ticket_selector', $display_ticket_selector); |
|
| 535 | + } |
|
| 536 | + |
|
| 537 | + |
|
| 538 | + /** |
|
| 539 | + * @param $external_url |
|
| 540 | + * @throws EE_Error |
|
| 541 | + */ |
|
| 542 | + public function set_external_url($external_url) |
|
| 543 | + { |
|
| 544 | + $this->set('EVT_external_URL', $external_url); |
|
| 545 | + } |
|
| 546 | + |
|
| 547 | + |
|
| 548 | + /** |
|
| 549 | + * @param $member_only |
|
| 550 | + * @throws EE_Error |
|
| 551 | + */ |
|
| 552 | + public function set_member_only($member_only) |
|
| 553 | + { |
|
| 554 | + $this->set('EVT_member_only', $member_only); |
|
| 555 | + } |
|
| 556 | + |
|
| 557 | + |
|
| 558 | + /** |
|
| 559 | + * @param $event_phone |
|
| 560 | + * @throws EE_Error |
|
| 561 | + */ |
|
| 562 | + public function set_event_phone($event_phone) |
|
| 563 | + { |
|
| 564 | + $this->set('EVT_phone', $event_phone); |
|
| 565 | + } |
|
| 566 | + |
|
| 567 | + |
|
| 568 | + /** |
|
| 569 | + * @param $modified |
|
| 570 | + * @throws EE_Error |
|
| 571 | + */ |
|
| 572 | + public function set_modified($modified) |
|
| 573 | + { |
|
| 574 | + $this->set('EVT_modified', $modified); |
|
| 575 | + } |
|
| 576 | + |
|
| 577 | + |
|
| 578 | + /** |
|
| 579 | + * @param $name |
|
| 580 | + * @throws EE_Error |
|
| 581 | + */ |
|
| 582 | + public function set_name($name) |
|
| 583 | + { |
|
| 584 | + $this->set('EVT_name', $name); |
|
| 585 | + } |
|
| 586 | + |
|
| 587 | + |
|
| 588 | + /** |
|
| 589 | + * @param $order |
|
| 590 | + * @throws EE_Error |
|
| 591 | + */ |
|
| 592 | + public function set_order($order) |
|
| 593 | + { |
|
| 594 | + $this->set('EVT_order', $order); |
|
| 595 | + } |
|
| 596 | + |
|
| 597 | + |
|
| 598 | + /** |
|
| 599 | + * @param $short_desc |
|
| 600 | + * @throws EE_Error |
|
| 601 | + */ |
|
| 602 | + public function set_short_description($short_desc) |
|
| 603 | + { |
|
| 604 | + $this->set('EVT_short_desc', $short_desc); |
|
| 605 | + } |
|
| 606 | + |
|
| 607 | + |
|
| 608 | + /** |
|
| 609 | + * @param $slug |
|
| 610 | + * @throws EE_Error |
|
| 611 | + */ |
|
| 612 | + public function set_slug($slug) |
|
| 613 | + { |
|
| 614 | + $this->set('EVT_slug', $slug); |
|
| 615 | + } |
|
| 616 | + |
|
| 617 | + |
|
| 618 | + /** |
|
| 619 | + * @param $timezone_string |
|
| 620 | + * @throws EE_Error |
|
| 621 | + */ |
|
| 622 | + public function set_timezone_string($timezone_string) |
|
| 623 | + { |
|
| 624 | + $this->set('EVT_timezone_string', $timezone_string); |
|
| 625 | + } |
|
| 626 | + |
|
| 627 | + |
|
| 628 | + /** |
|
| 629 | + * @param $visible_on |
|
| 630 | + * @throws EE_Error |
|
| 631 | + */ |
|
| 632 | + public function set_visible_on($visible_on) |
|
| 633 | + { |
|
| 634 | + $this->set('EVT_visible_on', $visible_on); |
|
| 635 | + } |
|
| 636 | + |
|
| 637 | + |
|
| 638 | + /** |
|
| 639 | + * @param $wp_user |
|
| 640 | + * @throws EE_Error |
|
| 641 | + */ |
|
| 642 | + public function set_wp_user($wp_user) |
|
| 643 | + { |
|
| 644 | + $this->set('EVT_wp_user', $wp_user); |
|
| 645 | + } |
|
| 646 | + |
|
| 647 | + |
|
| 648 | + /** |
|
| 649 | + * @param $default_registration_status |
|
| 650 | + * @throws EE_Error |
|
| 651 | + */ |
|
| 652 | + public function set_default_registration_status($default_registration_status) |
|
| 653 | + { |
|
| 654 | + $this->set('EVT_default_registration_status', $default_registration_status); |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + |
|
| 658 | + /** |
|
| 659 | + * @param $donations |
|
| 660 | + * @throws EE_Error |
|
| 661 | + */ |
|
| 662 | + public function set_donations($donations) |
|
| 663 | + { |
|
| 664 | + $this->set('EVT_donations', $donations); |
|
| 665 | + } |
|
| 666 | + |
|
| 667 | + |
|
| 668 | + /** |
|
| 669 | + * Adds a venue to this event |
|
| 670 | + * |
|
| 671 | + * @param EE_Venue /int $venue_id_or_obj |
|
| 672 | + * @return EE_Base_Class|EE_Venue |
|
| 673 | + * @throws EE_Error |
|
| 674 | + */ |
|
| 675 | + public function add_venue($venue_id_or_obj) |
|
| 676 | + { |
|
| 677 | + return $this->_add_relation_to($venue_id_or_obj, 'Venue'); |
|
| 678 | + } |
|
| 679 | + |
|
| 680 | + |
|
| 681 | + /** |
|
| 682 | + * Removes a venue from the event |
|
| 683 | + * |
|
| 684 | + * @param EE_Venue /int $venue_id_or_obj |
|
| 685 | + * @return EE_Base_Class|EE_Venue |
|
| 686 | + * @throws EE_Error |
|
| 687 | + */ |
|
| 688 | + public function remove_venue($venue_id_or_obj) |
|
| 689 | + { |
|
| 690 | + return $this->_remove_relation_to($venue_id_or_obj, 'Venue'); |
|
| 691 | + } |
|
| 692 | + |
|
| 693 | + |
|
| 694 | + /** |
|
| 695 | + * Gets all the venues related ot the event. May provide additional $query_params if desired |
|
| 696 | + * |
|
| 697 | + * @param array $query_params like EEM_Base::get_all's $query_params |
|
| 698 | + * @return EE_Base_Class[]|EE_Venue[] |
|
| 699 | + * @throws EE_Error |
|
| 700 | + */ |
|
| 701 | + public function venues($query_params = array()) |
|
| 702 | + { |
|
| 703 | + return $this->get_many_related('Venue', $query_params); |
|
| 704 | + } |
|
| 705 | + |
|
| 706 | + |
|
| 707 | + /** |
|
| 708 | + * check if event id is present and if event is published |
|
| 709 | + * |
|
| 710 | + * @access public |
|
| 711 | + * @return boolean true yes, false no |
|
| 712 | + * @throws EE_Error |
|
| 713 | + */ |
|
| 714 | + private function _has_ID_and_is_published() |
|
| 715 | + { |
|
| 716 | + // first check if event id is present and not NULL, |
|
| 717 | + // then check if this event is published (or any of the equivalent "published" statuses) |
|
| 718 | + return |
|
| 719 | + $this->ID() && $this->ID() !== null |
|
| 720 | + && ( |
|
| 721 | + $this->status() === 'publish' |
|
| 722 | + || $this->status() === EEM_Event::sold_out |
|
| 723 | + || $this->status() === EEM_Event::postponed |
|
| 724 | + || $this->status() === EEM_Event::cancelled |
|
| 725 | + ); |
|
| 726 | + } |
|
| 727 | + |
|
| 728 | + |
|
| 729 | + /** |
|
| 730 | + * This simply compares the internal dates with NOW and determines if the event is upcoming or not. |
|
| 731 | + * |
|
| 732 | + * @access public |
|
| 733 | + * @return boolean true yes, false no |
|
| 734 | + * @throws EE_Error |
|
| 735 | + */ |
|
| 736 | + public function is_upcoming() |
|
| 737 | + { |
|
| 738 | + // check if event id is present and if this event is published |
|
| 739 | + if ($this->is_inactive()) { |
|
| 740 | + return false; |
|
| 741 | + } |
|
| 742 | + // set initial value |
|
| 743 | + $upcoming = false; |
|
| 744 | + // next let's get all datetimes and loop through them |
|
| 745 | + $datetimes = $this->datetimes_in_chronological_order(); |
|
| 746 | + foreach ($datetimes as $datetime) { |
|
| 747 | + if ($datetime instanceof EE_Datetime) { |
|
| 748 | + // if this dtt is expired then we continue cause one of the other datetimes might be upcoming. |
|
| 749 | + if ($datetime->is_expired()) { |
|
| 750 | + continue; |
|
| 751 | + } |
|
| 752 | + // if this dtt is active then we return false. |
|
| 753 | + if ($datetime->is_active()) { |
|
| 754 | + return false; |
|
| 755 | + } |
|
| 756 | + // otherwise let's check upcoming status |
|
| 757 | + $upcoming = $datetime->is_upcoming(); |
|
| 758 | + } |
|
| 759 | + } |
|
| 760 | + return $upcoming; |
|
| 761 | + } |
|
| 762 | + |
|
| 763 | + |
|
| 764 | + /** |
|
| 765 | + * @return bool |
|
| 766 | + * @throws EE_Error |
|
| 767 | + */ |
|
| 768 | + public function is_active() |
|
| 769 | + { |
|
| 770 | + // check if event id is present and if this event is published |
|
| 771 | + if ($this->is_inactive()) { |
|
| 772 | + return false; |
|
| 773 | + } |
|
| 774 | + // set initial value |
|
| 775 | + $active = false; |
|
| 776 | + // next let's get all datetimes and loop through them |
|
| 777 | + $datetimes = $this->datetimes_in_chronological_order(); |
|
| 778 | + foreach ($datetimes as $datetime) { |
|
| 779 | + if ($datetime instanceof EE_Datetime) { |
|
| 780 | + // if this dtt is expired then we continue cause one of the other datetimes might be active. |
|
| 781 | + if ($datetime->is_expired()) { |
|
| 782 | + continue; |
|
| 783 | + } |
|
| 784 | + // if this dtt is upcoming then we return false. |
|
| 785 | + if ($datetime->is_upcoming()) { |
|
| 786 | + return false; |
|
| 787 | + } |
|
| 788 | + // otherwise let's check active status |
|
| 789 | + $active = $datetime->is_active(); |
|
| 790 | + } |
|
| 791 | + } |
|
| 792 | + return $active; |
|
| 793 | + } |
|
| 794 | + |
|
| 795 | + |
|
| 796 | + /** |
|
| 797 | + * @return bool |
|
| 798 | + * @throws EE_Error |
|
| 799 | + */ |
|
| 800 | + public function is_expired() |
|
| 801 | + { |
|
| 802 | + // check if event id is present and if this event is published |
|
| 803 | + if ($this->is_inactive()) { |
|
| 804 | + return false; |
|
| 805 | + } |
|
| 806 | + // set initial value |
|
| 807 | + $expired = false; |
|
| 808 | + // first let's get all datetimes and loop through them |
|
| 809 | + $datetimes = $this->datetimes_in_chronological_order(); |
|
| 810 | + foreach ($datetimes as $datetime) { |
|
| 811 | + if ($datetime instanceof EE_Datetime) { |
|
| 812 | + // if this dtt is upcoming or active then we return false. |
|
| 813 | + if ($datetime->is_upcoming() || $datetime->is_active()) { |
|
| 814 | + return false; |
|
| 815 | + } |
|
| 816 | + // otherwise let's check active status |
|
| 817 | + $expired = $datetime->is_expired(); |
|
| 818 | + } |
|
| 819 | + } |
|
| 820 | + return $expired; |
|
| 821 | + } |
|
| 822 | + |
|
| 823 | + |
|
| 824 | + /** |
|
| 825 | + * @return bool |
|
| 826 | + * @throws EE_Error |
|
| 827 | + */ |
|
| 828 | + public function is_inactive() |
|
| 829 | + { |
|
| 830 | + // check if event id is present and if this event is published |
|
| 831 | + if ($this->_has_ID_and_is_published()) { |
|
| 832 | + return false; |
|
| 833 | + } |
|
| 834 | + return true; |
|
| 835 | + } |
|
| 836 | + |
|
| 837 | + |
|
| 838 | + /** |
|
| 839 | + * calculate spaces remaining based on "saleable" tickets |
|
| 840 | + * |
|
| 841 | + * @param array $tickets |
|
| 842 | + * @param bool $filtered |
|
| 843 | + * @return int|float |
|
| 844 | + * @throws EE_Error |
|
| 845 | + * @throws DomainException |
|
| 846 | + * @throws UnexpectedEntityException |
|
| 847 | + */ |
|
| 848 | + public function spaces_remaining($tickets = array(), $filtered = true) |
|
| 849 | + { |
|
| 850 | + $this->getAvailableSpacesCalculator()->setActiveTickets($tickets); |
|
| 851 | + $spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining(); |
|
| 852 | + return $filtered |
|
| 853 | + ? apply_filters( |
|
| 854 | + 'FHEE_EE_Event__spaces_remaining', |
|
| 855 | + $spaces_remaining, |
|
| 856 | + $this, |
|
| 857 | + $tickets |
|
| 858 | + ) |
|
| 859 | + : $spaces_remaining; |
|
| 860 | + } |
|
| 861 | + |
|
| 862 | + |
|
| 863 | + /** |
|
| 864 | + * perform_sold_out_status_check |
|
| 865 | + * checks all of this events's datetime reg_limit - sold values to determine if ANY datetimes have spaces |
|
| 866 | + * available... if NOT, then the event status will get toggled to 'sold_out' |
|
| 867 | + * |
|
| 868 | + * @return bool return the ACTUAL sold out state. |
|
| 869 | + * @throws EE_Error |
|
| 870 | + * @throws DomainException |
|
| 871 | + * @throws UnexpectedEntityException |
|
| 872 | + */ |
|
| 873 | + public function perform_sold_out_status_check() |
|
| 874 | + { |
|
| 875 | + // get all unexpired untrashed tickets |
|
| 876 | + $tickets = $this->tickets( |
|
| 877 | + array( |
|
| 878 | + array('TKT_deleted' => false), |
|
| 879 | + 'order_by' => array('TKT_qty' => 'ASC'), |
|
| 880 | + ) |
|
| 881 | + ); |
|
| 882 | + $all_expired = true; |
|
| 883 | + foreach ($tickets as $ticket) { |
|
| 884 | + if (! $ticket->is_expired()) { |
|
| 885 | + $all_expired = false; |
|
| 886 | + break; |
|
| 887 | + } |
|
| 888 | + } |
|
| 889 | + // if all the tickets are just expired, then don't update the event status to sold out |
|
| 890 | + if ($all_expired) { |
|
| 891 | + return true; |
|
| 892 | + } |
|
| 893 | + $spaces_remaining = $this->spaces_remaining($tickets); |
|
| 894 | + if ($spaces_remaining < 1) { |
|
| 895 | + $this->set_status(EEM_Event::sold_out); |
|
| 896 | + $this->save(); |
|
| 897 | + $sold_out = true; |
|
| 898 | + } else { |
|
| 899 | + $sold_out = false; |
|
| 900 | + // was event previously marked as sold out ? |
|
| 901 | + if ($this->status() === EEM_Event::sold_out) { |
|
| 902 | + // revert status to previous value, if it was set |
|
| 903 | + $previous_event_status = $this->get_post_meta('_previous_event_status', true); |
|
| 904 | + if ($previous_event_status) { |
|
| 905 | + $this->set_status($previous_event_status); |
|
| 906 | + $this->save(); |
|
| 907 | + } |
|
| 908 | + } |
|
| 909 | + } |
|
| 910 | + do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets); |
|
| 911 | + return $sold_out; |
|
| 912 | + } |
|
| 913 | + |
|
| 914 | + |
|
| 915 | + /** |
|
| 916 | + * This returns the total remaining spaces for sale on this event. |
|
| 917 | + * |
|
| 918 | + * @uses EE_Event::total_available_spaces() |
|
| 919 | + * @return float|int |
|
| 920 | + * @throws EE_Error |
|
| 921 | + * @throws DomainException |
|
| 922 | + * @throws UnexpectedEntityException |
|
| 923 | + */ |
|
| 924 | + public function spaces_remaining_for_sale() |
|
| 925 | + { |
|
| 926 | + return $this->total_available_spaces(true); |
|
| 927 | + } |
|
| 928 | + |
|
| 929 | + |
|
| 930 | + /** |
|
| 931 | + * This returns the total spaces available for an event |
|
| 932 | + * while considering all the qtys on the tickets and the reg limits |
|
| 933 | + * on the datetimes attached to this event. |
|
| 934 | + * |
|
| 935 | + * @param bool $consider_sold Whether to consider any tickets that have already sold in our calculation. |
|
| 936 | + * If this is false, then we return the most tickets that could ever be sold |
|
| 937 | + * for this event with the datetime and tickets setup on the event under optimal |
|
| 938 | + * selling conditions. Otherwise we return a live calculation of spaces available |
|
| 939 | + * based on tickets sold. Depending on setup and stage of sales, this |
|
| 940 | + * may appear to equal remaining tickets. However, the more tickets are |
|
| 941 | + * sold out, the more accurate the "live" total is. |
|
| 942 | + * @return float|int |
|
| 943 | + * @throws EE_Error |
|
| 944 | + * @throws DomainException |
|
| 945 | + * @throws UnexpectedEntityException |
|
| 946 | + */ |
|
| 947 | + public function total_available_spaces($consider_sold = false) |
|
| 948 | + { |
|
| 949 | + $spaces_available = $consider_sold |
|
| 950 | + ? $this->getAvailableSpacesCalculator()->spacesRemaining() |
|
| 951 | + : $this->getAvailableSpacesCalculator()->totalSpacesAvailable(); |
|
| 952 | + return apply_filters( |
|
| 953 | + 'FHEE_EE_Event__total_available_spaces__spaces_available', |
|
| 954 | + $spaces_available, |
|
| 955 | + $this, |
|
| 956 | + $this->getAvailableSpacesCalculator()->getDatetimes(), |
|
| 957 | + $this->getAvailableSpacesCalculator()->getActiveTickets() |
|
| 958 | + ); |
|
| 959 | + } |
|
| 960 | + |
|
| 961 | + |
|
| 962 | + /** |
|
| 963 | + * Checks if the event is set to sold out |
|
| 964 | + * |
|
| 965 | + * @param bool $actual whether or not to perform calculations to not only figure the |
|
| 966 | + * actual status but also to flip the status if necessary to sold |
|
| 967 | + * out If false, we just check the existing status of the event |
|
| 968 | + * @return boolean |
|
| 969 | + * @throws EE_Error |
|
| 970 | + */ |
|
| 971 | + public function is_sold_out($actual = false) |
|
| 972 | + { |
|
| 973 | + if (! $actual) { |
|
| 974 | + return $this->status() === EEM_Event::sold_out; |
|
| 975 | + } |
|
| 976 | + return $this->perform_sold_out_status_check(); |
|
| 977 | + } |
|
| 978 | + |
|
| 979 | + |
|
| 980 | + /** |
|
| 981 | + * Checks if the event is marked as postponed |
|
| 982 | + * |
|
| 983 | + * @return boolean |
|
| 984 | + */ |
|
| 985 | + public function is_postponed() |
|
| 986 | + { |
|
| 987 | + return $this->status() === EEM_Event::postponed; |
|
| 988 | + } |
|
| 989 | + |
|
| 990 | + |
|
| 991 | + /** |
|
| 992 | + * Checks if the event is marked as cancelled |
|
| 993 | + * |
|
| 994 | + * @return boolean |
|
| 995 | + */ |
|
| 996 | + public function is_cancelled() |
|
| 997 | + { |
|
| 998 | + return $this->status() === EEM_Event::cancelled; |
|
| 999 | + } |
|
| 1000 | + |
|
| 1001 | + |
|
| 1002 | + /** |
|
| 1003 | + * Get the logical active status in a hierarchical order for all the datetimes. Note |
|
| 1004 | + * Basically, we order the datetimes by EVT_start_date. Then first test on whether the event is published. If its |
|
| 1005 | + * NOT published then we test for whether its expired or not. IF it IS published then we test first on whether an |
|
| 1006 | + * event has any active dates. If no active dates then we check for any upcoming dates. If no upcoming dates then |
|
| 1007 | + * the event is considered expired. |
|
| 1008 | + * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published. Sold Out is a |
|
| 1009 | + * status set on the EVENT when it is not published and thus is done |
|
| 1010 | + * |
|
| 1011 | + * @param bool $reset |
|
| 1012 | + * @return bool | string - based on EE_Datetime active constants or FALSE if error. |
|
| 1013 | + * @throws EE_Error |
|
| 1014 | + */ |
|
| 1015 | + public function get_active_status($reset = false) |
|
| 1016 | + { |
|
| 1017 | + // if the active status has already been set, then just use that value (unless we are resetting it) |
|
| 1018 | + if (! empty($this->_active_status) && ! $reset) { |
|
| 1019 | + return $this->_active_status; |
|
| 1020 | + } |
|
| 1021 | + // first check if event id is present on this object |
|
| 1022 | + if (! $this->ID()) { |
|
| 1023 | + return false; |
|
| 1024 | + } |
|
| 1025 | + $where_params_for_event = array(array('EVT_ID' => $this->ID())); |
|
| 1026 | + // if event is published: |
|
| 1027 | + if ($this->status() === 'publish') { |
|
| 1028 | + // active? |
|
| 1029 | + if (EEM_Datetime::instance()->get_datetime_count_for_status( |
|
| 1030 | + EE_Datetime::active, |
|
| 1031 | + $where_params_for_event |
|
| 1032 | + ) > 0) { |
|
| 1033 | + $this->_active_status = EE_Datetime::active; |
|
| 1034 | + } else { |
|
| 1035 | + // upcoming? |
|
| 1036 | + if (EEM_Datetime::instance()->get_datetime_count_for_status( |
|
| 1037 | + EE_Datetime::upcoming, |
|
| 1038 | + $where_params_for_event |
|
| 1039 | + ) > 0) { |
|
| 1040 | + $this->_active_status = EE_Datetime::upcoming; |
|
| 1041 | + } else { |
|
| 1042 | + // expired? |
|
| 1043 | + if (EEM_Datetime::instance()->get_datetime_count_for_status( |
|
| 1044 | + EE_Datetime::expired, |
|
| 1045 | + $where_params_for_event |
|
| 1046 | + ) > 0 |
|
| 1047 | + ) { |
|
| 1048 | + $this->_active_status = EE_Datetime::expired; |
|
| 1049 | + } else { |
|
| 1050 | + // it would be odd if things make it this far because it basically means there are no datetime's |
|
| 1051 | + // attached to the event. So in this case it will just be considered inactive. |
|
| 1052 | + $this->_active_status = EE_Datetime::inactive; |
|
| 1053 | + } |
|
| 1054 | + } |
|
| 1055 | + } |
|
| 1056 | + } else { |
|
| 1057 | + // the event is not published, so let's just set it's active status according to its' post status |
|
| 1058 | + switch ($this->status()) { |
|
| 1059 | + case EEM_Event::sold_out: |
|
| 1060 | + $this->_active_status = EE_Datetime::sold_out; |
|
| 1061 | + break; |
|
| 1062 | + case EEM_Event::cancelled: |
|
| 1063 | + $this->_active_status = EE_Datetime::cancelled; |
|
| 1064 | + break; |
|
| 1065 | + case EEM_Event::postponed: |
|
| 1066 | + $this->_active_status = EE_Datetime::postponed; |
|
| 1067 | + break; |
|
| 1068 | + default: |
|
| 1069 | + $this->_active_status = EE_Datetime::inactive; |
|
| 1070 | + } |
|
| 1071 | + } |
|
| 1072 | + return $this->_active_status; |
|
| 1073 | + } |
|
| 1074 | + |
|
| 1075 | + |
|
| 1076 | + /** |
|
| 1077 | + * pretty_active_status |
|
| 1078 | + * |
|
| 1079 | + * @access public |
|
| 1080 | + * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE) |
|
| 1081 | + * @return mixed void|string |
|
| 1082 | + * @throws EE_Error |
|
| 1083 | + */ |
|
| 1084 | + public function pretty_active_status($echo = true) |
|
| 1085 | + { |
|
| 1086 | + $active_status = $this->get_active_status(); |
|
| 1087 | + $status = '<span class="ee-status event-active-status-' |
|
| 1088 | + . $active_status |
|
| 1089 | + . '">' |
|
| 1090 | + . EEH_Template::pretty_status($active_status, false, 'sentence') |
|
| 1091 | + . '</span>'; |
|
| 1092 | + if ($echo) { |
|
| 1093 | + echo $status; |
|
| 1094 | + return ''; |
|
| 1095 | + } |
|
| 1096 | + return $status; |
|
| 1097 | + } |
|
| 1098 | + |
|
| 1099 | + |
|
| 1100 | + /** |
|
| 1101 | + * @return bool|int |
|
| 1102 | + * @throws EE_Error |
|
| 1103 | + */ |
|
| 1104 | + public function get_number_of_tickets_sold() |
|
| 1105 | + { |
|
| 1106 | + $tkt_sold = 0; |
|
| 1107 | + if (! $this->ID()) { |
|
| 1108 | + return 0; |
|
| 1109 | + } |
|
| 1110 | + $datetimes = $this->datetimes(); |
|
| 1111 | + foreach ($datetimes as $datetime) { |
|
| 1112 | + if ($datetime instanceof EE_Datetime) { |
|
| 1113 | + $tkt_sold += $datetime->sold(); |
|
| 1114 | + } |
|
| 1115 | + } |
|
| 1116 | + return $tkt_sold; |
|
| 1117 | + } |
|
| 1118 | + |
|
| 1119 | + |
|
| 1120 | + /** |
|
| 1121 | + * This just returns a count of all the registrations for this event |
|
| 1122 | + * |
|
| 1123 | + * @access public |
|
| 1124 | + * @return int |
|
| 1125 | + * @throws EE_Error |
|
| 1126 | + */ |
|
| 1127 | + public function get_count_of_all_registrations() |
|
| 1128 | + { |
|
| 1129 | + return EEM_Event::instance()->count_related($this, 'Registration'); |
|
| 1130 | + } |
|
| 1131 | + |
|
| 1132 | + |
|
| 1133 | + /** |
|
| 1134 | + * This returns the ticket with the earliest start time that is |
|
| 1135 | + * available for this event (across all datetimes attached to the event) |
|
| 1136 | + * |
|
| 1137 | + * @return EE_Base_Class|EE_Ticket|null |
|
| 1138 | + * @throws EE_Error |
|
| 1139 | + */ |
|
| 1140 | + public function get_ticket_with_earliest_start_time() |
|
| 1141 | + { |
|
| 1142 | + $where['Datetime.EVT_ID'] = $this->ID(); |
|
| 1143 | + $query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC')); |
|
| 1144 | + return EE_Registry::instance()->load_model('Ticket')->get_one($query_params); |
|
| 1145 | + } |
|
| 1146 | + |
|
| 1147 | + |
|
| 1148 | + /** |
|
| 1149 | + * This returns the ticket with the latest end time that is available |
|
| 1150 | + * for this event (across all datetimes attached to the event) |
|
| 1151 | + * |
|
| 1152 | + * @return EE_Base_Class|EE_Ticket|null |
|
| 1153 | + * @throws EE_Error |
|
| 1154 | + */ |
|
| 1155 | + public function get_ticket_with_latest_end_time() |
|
| 1156 | + { |
|
| 1157 | + $where['Datetime.EVT_ID'] = $this->ID(); |
|
| 1158 | + $query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC')); |
|
| 1159 | + return EE_Registry::instance()->load_model('Ticket')->get_one($query_params); |
|
| 1160 | + } |
|
| 1161 | + |
|
| 1162 | + |
|
| 1163 | + /** |
|
| 1164 | + * This returns the number of different ticket types currently on sale for this event. |
|
| 1165 | + * |
|
| 1166 | + * @return int |
|
| 1167 | + * @throws EE_Error |
|
| 1168 | + */ |
|
| 1169 | + public function countTicketsOnSale() |
|
| 1170 | + { |
|
| 1171 | + $where = array( |
|
| 1172 | + 'Datetime.EVT_ID' => $this->ID(), |
|
| 1173 | + 'TKT_start_date' => array('<', time()), |
|
| 1174 | + 'TKT_end_date' => array('>', time()), |
|
| 1175 | + ); |
|
| 1176 | + return EEM_Ticket::instance()->count(array($where)); |
|
| 1177 | + } |
|
| 1178 | + |
|
| 1179 | + |
|
| 1180 | + /** |
|
| 1181 | + * This returns whether there are any tickets on sale for this event. |
|
| 1182 | + * |
|
| 1183 | + * @return bool true = YES tickets on sale. |
|
| 1184 | + * @throws EE_Error |
|
| 1185 | + */ |
|
| 1186 | + public function tickets_on_sale() |
|
| 1187 | + { |
|
| 1188 | + return $this->countTicketsOnSale() > 0; |
|
| 1189 | + } |
|
| 1190 | + |
|
| 1191 | + |
|
| 1192 | + /** |
|
| 1193 | + * Gets the URL for viewing this event on the front-end. Overrides parent |
|
| 1194 | + * to check for an external URL first |
|
| 1195 | + * |
|
| 1196 | + * @return string |
|
| 1197 | + * @throws EE_Error |
|
| 1198 | + */ |
|
| 1199 | + public function get_permalink() |
|
| 1200 | + { |
|
| 1201 | + if ($this->external_url()) { |
|
| 1202 | + return $this->external_url(); |
|
| 1203 | + } |
|
| 1204 | + return parent::get_permalink(); |
|
| 1205 | + } |
|
| 1206 | + |
|
| 1207 | + |
|
| 1208 | + /** |
|
| 1209 | + * Gets the first term for 'espresso_event_categories' we can find |
|
| 1210 | + * |
|
| 1211 | + * @param array $query_params like EEM_Base::get_all |
|
| 1212 | + * @return EE_Base_Class|EE_Term|null |
|
| 1213 | + * @throws EE_Error |
|
| 1214 | + */ |
|
| 1215 | + public function first_event_category($query_params = array()) |
|
| 1216 | + { |
|
| 1217 | + $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories'; |
|
| 1218 | + $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID(); |
|
| 1219 | + return EEM_Term::instance()->get_one($query_params); |
|
| 1220 | + } |
|
| 1221 | + |
|
| 1222 | + |
|
| 1223 | + /** |
|
| 1224 | + * Gets all terms for 'espresso_event_categories' we can find |
|
| 1225 | + * |
|
| 1226 | + * @param array $query_params |
|
| 1227 | + * @return EE_Base_Class[]|EE_Term[] |
|
| 1228 | + * @throws EE_Error |
|
| 1229 | + */ |
|
| 1230 | + public function get_all_event_categories($query_params = array()) |
|
| 1231 | + { |
|
| 1232 | + $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories'; |
|
| 1233 | + $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID(); |
|
| 1234 | + return EEM_Term::instance()->get_all($query_params); |
|
| 1235 | + } |
|
| 1236 | + |
|
| 1237 | + |
|
| 1238 | + /** |
|
| 1239 | + * Adds a question group to this event |
|
| 1240 | + * |
|
| 1241 | + * @param EE_Question_Group|int $question_group_id_or_obj |
|
| 1242 | + * @param bool $for_primary if true, the question group will be added for the primary |
|
| 1243 | + * registrant, if false will be added for others. default: false |
|
| 1244 | + * @return EE_Base_Class|EE_Question_Group |
|
| 1245 | + * @throws EE_Error |
|
| 1246 | + */ |
|
| 1247 | + public function add_question_group($question_group_id_or_obj, $for_primary = false) |
|
| 1248 | + { |
|
| 1249 | + $extra = $for_primary |
|
| 1250 | + ? array('EQG_primary' => 1) |
|
| 1251 | + : array(); |
|
| 1252 | + return $this->_add_relation_to($question_group_id_or_obj, 'Question_Group', $extra); |
|
| 1253 | + } |
|
| 1254 | + |
|
| 1255 | + |
|
| 1256 | + /** |
|
| 1257 | + * Removes a question group from the event |
|
| 1258 | + * |
|
| 1259 | + * @param EE_Question_Group|int $question_group_id_or_obj |
|
| 1260 | + * @param bool $for_primary if true, the question group will be removed from the primary |
|
| 1261 | + * registrant, if false will be removed from others. default: false |
|
| 1262 | + * @return EE_Base_Class|EE_Question_Group |
|
| 1263 | + * @throws EE_Error |
|
| 1264 | + */ |
|
| 1265 | + public function remove_question_group($question_group_id_or_obj, $for_primary = false) |
|
| 1266 | + { |
|
| 1267 | + $where = $for_primary |
|
| 1268 | + ? array('EQG_primary' => 1) |
|
| 1269 | + : array(); |
|
| 1270 | + return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group', $where); |
|
| 1271 | + } |
|
| 1272 | + |
|
| 1273 | + |
|
| 1274 | + /** |
|
| 1275 | + * Gets all the question groups, ordering them by QSG_order ascending |
|
| 1276 | + * |
|
| 1277 | + * @param array $query_params @see EEM_Base::get_all |
|
| 1278 | + * @return EE_Base_Class[]|EE_Question_Group[] |
|
| 1279 | + * @throws EE_Error |
|
| 1280 | + */ |
|
| 1281 | + public function question_groups($query_params = array()) |
|
| 1282 | + { |
|
| 1283 | + $query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC')); |
|
| 1284 | + return $this->get_many_related('Question_Group', $query_params); |
|
| 1285 | + } |
|
| 1286 | + |
|
| 1287 | + |
|
| 1288 | + /** |
|
| 1289 | + * Implementation for EEI_Has_Icon interface method. |
|
| 1290 | + * |
|
| 1291 | + * @see EEI_Visual_Representation for comments |
|
| 1292 | + * @return string |
|
| 1293 | + */ |
|
| 1294 | + public function get_icon() |
|
| 1295 | + { |
|
| 1296 | + return '<span class="dashicons dashicons-flag"></span>'; |
|
| 1297 | + } |
|
| 1298 | + |
|
| 1299 | + |
|
| 1300 | + /** |
|
| 1301 | + * Implementation for EEI_Admin_Links interface method. |
|
| 1302 | + * |
|
| 1303 | + * @see EEI_Admin_Links for comments |
|
| 1304 | + * @return string |
|
| 1305 | + * @throws EE_Error |
|
| 1306 | + */ |
|
| 1307 | + public function get_admin_details_link() |
|
| 1308 | + { |
|
| 1309 | + return $this->get_admin_edit_link(); |
|
| 1310 | + } |
|
| 1311 | + |
|
| 1312 | + |
|
| 1313 | + /** |
|
| 1314 | + * Implementation for EEI_Admin_Links interface method. |
|
| 1315 | + * |
|
| 1316 | + * @see EEI_Admin_Links for comments |
|
| 1317 | + * @return string |
|
| 1318 | + * @throws EE_Error |
|
| 1319 | + */ |
|
| 1320 | + public function get_admin_edit_link() |
|
| 1321 | + { |
|
| 1322 | + return EEH_URL::add_query_args_and_nonce( |
|
| 1323 | + array( |
|
| 1324 | + 'page' => 'espresso_events', |
|
| 1325 | + 'action' => 'edit', |
|
| 1326 | + 'post' => $this->ID(), |
|
| 1327 | + ), |
|
| 1328 | + admin_url('admin.php') |
|
| 1329 | + ); |
|
| 1330 | + } |
|
| 1331 | + |
|
| 1332 | + |
|
| 1333 | + /** |
|
| 1334 | + * Implementation for EEI_Admin_Links interface method. |
|
| 1335 | + * |
|
| 1336 | + * @see EEI_Admin_Links for comments |
|
| 1337 | + * @return string |
|
| 1338 | + */ |
|
| 1339 | + public function get_admin_settings_link() |
|
| 1340 | + { |
|
| 1341 | + return EEH_URL::add_query_args_and_nonce( |
|
| 1342 | + array( |
|
| 1343 | + 'page' => 'espresso_events', |
|
| 1344 | + 'action' => 'default_event_settings', |
|
| 1345 | + ), |
|
| 1346 | + admin_url('admin.php') |
|
| 1347 | + ); |
|
| 1348 | + } |
|
| 1349 | + |
|
| 1350 | + |
|
| 1351 | + /** |
|
| 1352 | + * Implementation for EEI_Admin_Links interface method. |
|
| 1353 | + * |
|
| 1354 | + * @see EEI_Admin_Links for comments |
|
| 1355 | + * @return string |
|
| 1356 | + */ |
|
| 1357 | + public function get_admin_overview_link() |
|
| 1358 | + { |
|
| 1359 | + return EEH_URL::add_query_args_and_nonce( |
|
| 1360 | + array( |
|
| 1361 | + 'page' => 'espresso_events', |
|
| 1362 | + 'action' => 'default', |
|
| 1363 | + ), |
|
| 1364 | + admin_url('admin.php') |
|
| 1365 | + ); |
|
| 1366 | + } |
|
| 1367 | 1367 | } |
@@ -69,7 +69,7 @@ discard block |
||
| 69 | 69 | */ |
| 70 | 70 | public function getAvailableSpacesCalculator() |
| 71 | 71 | { |
| 72 | - if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) { |
|
| 72 | + if ( ! $this->available_spaces_calculator instanceof EventSpacesCalculator) { |
|
| 73 | 73 | $this->available_spaces_calculator = new EventSpacesCalculator($this); |
| 74 | 74 | } |
| 75 | 75 | return $this->available_spaces_calculator; |
@@ -211,7 +211,7 @@ discard block |
||
| 211 | 211 | */ |
| 212 | 212 | public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true) |
| 213 | 213 | { |
| 214 | - if (! empty($this->_Primary_Datetime)) { |
|
| 214 | + if ( ! empty($this->_Primary_Datetime)) { |
|
| 215 | 215 | return $this->_Primary_Datetime; |
| 216 | 216 | } |
| 217 | 217 | $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event( |
@@ -234,7 +234,7 @@ discard block |
||
| 234 | 234 | { |
| 235 | 235 | // first get all datetimes |
| 236 | 236 | $datetimes = $this->datetimes_ordered(); |
| 237 | - if (! $datetimes) { |
|
| 237 | + if ( ! $datetimes) { |
|
| 238 | 238 | return array(); |
| 239 | 239 | } |
| 240 | 240 | $datetime_ids = array(); |
@@ -427,7 +427,7 @@ discard block |
||
| 427 | 427 | public function short_description($num_words = 55, $more = null, $not_full_desc = false) |
| 428 | 428 | { |
| 429 | 429 | $short_desc = $this->get('EVT_short_desc'); |
| 430 | - if (! empty($short_desc) || $not_full_desc) { |
|
| 430 | + if ( ! empty($short_desc) || $not_full_desc) { |
|
| 431 | 431 | return $short_desc; |
| 432 | 432 | } |
| 433 | 433 | $full_desc = $this->get('EVT_desc'); |
@@ -881,7 +881,7 @@ discard block |
||
| 881 | 881 | ); |
| 882 | 882 | $all_expired = true; |
| 883 | 883 | foreach ($tickets as $ticket) { |
| 884 | - if (! $ticket->is_expired()) { |
|
| 884 | + if ( ! $ticket->is_expired()) { |
|
| 885 | 885 | $all_expired = false; |
| 886 | 886 | break; |
| 887 | 887 | } |
@@ -970,7 +970,7 @@ discard block |
||
| 970 | 970 | */ |
| 971 | 971 | public function is_sold_out($actual = false) |
| 972 | 972 | { |
| 973 | - if (! $actual) { |
|
| 973 | + if ( ! $actual) { |
|
| 974 | 974 | return $this->status() === EEM_Event::sold_out; |
| 975 | 975 | } |
| 976 | 976 | return $this->perform_sold_out_status_check(); |
@@ -1015,11 +1015,11 @@ discard block |
||
| 1015 | 1015 | public function get_active_status($reset = false) |
| 1016 | 1016 | { |
| 1017 | 1017 | // if the active status has already been set, then just use that value (unless we are resetting it) |
| 1018 | - if (! empty($this->_active_status) && ! $reset) { |
|
| 1018 | + if ( ! empty($this->_active_status) && ! $reset) { |
|
| 1019 | 1019 | return $this->_active_status; |
| 1020 | 1020 | } |
| 1021 | 1021 | // first check if event id is present on this object |
| 1022 | - if (! $this->ID()) { |
|
| 1022 | + if ( ! $this->ID()) { |
|
| 1023 | 1023 | return false; |
| 1024 | 1024 | } |
| 1025 | 1025 | $where_params_for_event = array(array('EVT_ID' => $this->ID())); |
@@ -1104,7 +1104,7 @@ discard block |
||
| 1104 | 1104 | public function get_number_of_tickets_sold() |
| 1105 | 1105 | { |
| 1106 | 1106 | $tkt_sold = 0; |
| 1107 | - if (! $this->ID()) { |
|
| 1107 | + if ( ! $this->ID()) { |
|
| 1108 | 1108 | return 0; |
| 1109 | 1109 | } |
| 1110 | 1110 | $datetimes = $this->datetimes(); |