@@ -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 | } |
@@ -16,75 +16,75 @@ |
||
16 | 16 | class EE_URL_Validation_Strategy extends EE_Validation_Strategy_Base |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @var @boolean whether we should check if the file exists or not |
|
21 | - */ |
|
22 | - protected $check_file_exists; |
|
19 | + /** |
|
20 | + * @var @boolean whether we should check if the file exists or not |
|
21 | + */ |
|
22 | + protected $check_file_exists; |
|
23 | 23 | |
24 | - /** |
|
25 | - * @var URLValidator |
|
26 | - */ |
|
27 | - protected $url_validator; |
|
24 | + /** |
|
25 | + * @var URLValidator |
|
26 | + */ |
|
27 | + protected $url_validator; |
|
28 | 28 | |
29 | - /** |
|
30 | - * @param null $validation_error_message |
|
31 | - * @param boolean $check_file_exists |
|
32 | - * @param URLValidator $url_validator |
|
33 | - * @throws InvalidArgumentException |
|
34 | - * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
35 | - * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
36 | - */ |
|
37 | - public function __construct( |
|
38 | - $validation_error_message = null, |
|
39 | - $check_file_exists = false, |
|
40 | - URLValidator $url_validator = null |
|
41 | - ) { |
|
42 | - if (! $url_validator instanceof URLValidator) { |
|
43 | - $url_validator = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\validators\URLValidator'); |
|
44 | - } |
|
45 | - $this->url_validator = $url_validator; |
|
46 | - if (! $validation_error_message) { |
|
47 | - $validation_error_message = __("Please enter a valid URL. Eg https://eventespresso.com", "event_espresso"); |
|
48 | - } |
|
49 | - $this->check_file_exists = $check_file_exists; |
|
50 | - parent::__construct($validation_error_message); |
|
51 | - } |
|
29 | + /** |
|
30 | + * @param null $validation_error_message |
|
31 | + * @param boolean $check_file_exists |
|
32 | + * @param URLValidator $url_validator |
|
33 | + * @throws InvalidArgumentException |
|
34 | + * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
35 | + * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
36 | + */ |
|
37 | + public function __construct( |
|
38 | + $validation_error_message = null, |
|
39 | + $check_file_exists = false, |
|
40 | + URLValidator $url_validator = null |
|
41 | + ) { |
|
42 | + if (! $url_validator instanceof URLValidator) { |
|
43 | + $url_validator = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\validators\URLValidator'); |
|
44 | + } |
|
45 | + $this->url_validator = $url_validator; |
|
46 | + if (! $validation_error_message) { |
|
47 | + $validation_error_message = __("Please enter a valid URL. Eg https://eventespresso.com", "event_espresso"); |
|
48 | + } |
|
49 | + $this->check_file_exists = $check_file_exists; |
|
50 | + parent::__construct($validation_error_message); |
|
51 | + } |
|
52 | 52 | |
53 | 53 | |
54 | 54 | |
55 | - /** |
|
56 | - * just checks the field isn't blank |
|
57 | - * |
|
58 | - * @param $normalized_value |
|
59 | - * @return bool |
|
60 | - * @throws \EE_Validation_Error |
|
61 | - */ |
|
62 | - public function validate($normalized_value) |
|
63 | - { |
|
64 | - if ($normalized_value) { |
|
65 | - if (! $this->url_validator->isValid($normalized_value)) { |
|
66 | - throw new EE_Validation_Error($this->get_validation_error_message(), 'invalid_url'); |
|
67 | - } elseif (apply_filters('FHEE__EE_URL_Validation_Strategy__validate__check_remote_file_exists', $this->check_file_exists, $this->_input)) { |
|
68 | - if (! EEH_URL::remote_file_exists( |
|
69 | - $normalized_value, |
|
70 | - array( |
|
71 | - 'sslverify' => false, |
|
72 | - 'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block |
|
73 | - ) |
|
74 | - )) { |
|
75 | - throw new EE_Validation_Error(sprintf(__("That URL seems to be broken. Please enter a valid URL", "event_espresso"))); |
|
76 | - } |
|
77 | - } |
|
78 | - } |
|
79 | - } |
|
55 | + /** |
|
56 | + * just checks the field isn't blank |
|
57 | + * |
|
58 | + * @param $normalized_value |
|
59 | + * @return bool |
|
60 | + * @throws \EE_Validation_Error |
|
61 | + */ |
|
62 | + public function validate($normalized_value) |
|
63 | + { |
|
64 | + if ($normalized_value) { |
|
65 | + if (! $this->url_validator->isValid($normalized_value)) { |
|
66 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'invalid_url'); |
|
67 | + } elseif (apply_filters('FHEE__EE_URL_Validation_Strategy__validate__check_remote_file_exists', $this->check_file_exists, $this->_input)) { |
|
68 | + if (! EEH_URL::remote_file_exists( |
|
69 | + $normalized_value, |
|
70 | + array( |
|
71 | + 'sslverify' => false, |
|
72 | + 'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block |
|
73 | + ) |
|
74 | + )) { |
|
75 | + throw new EE_Validation_Error(sprintf(__("That URL seems to be broken. Please enter a valid URL", "event_espresso"))); |
|
76 | + } |
|
77 | + } |
|
78 | + } |
|
79 | + } |
|
80 | 80 | |
81 | 81 | |
82 | 82 | |
83 | - /** |
|
84 | - * @return array |
|
85 | - */ |
|
86 | - public function get_jquery_validation_rule_array() |
|
87 | - { |
|
88 | - return array( 'validUrl'=>true, 'messages' => array( 'validUrl' => $this->get_validation_error_message() ) ); |
|
89 | - } |
|
83 | + /** |
|
84 | + * @return array |
|
85 | + */ |
|
86 | + public function get_jquery_validation_rule_array() |
|
87 | + { |
|
88 | + return array( 'validUrl'=>true, 'messages' => array( 'validUrl' => $this->get_validation_error_message() ) ); |
|
89 | + } |
|
90 | 90 | } |
@@ -39,11 +39,11 @@ discard block |
||
39 | 39 | $check_file_exists = false, |
40 | 40 | URLValidator $url_validator = null |
41 | 41 | ) { |
42 | - if (! $url_validator instanceof URLValidator) { |
|
42 | + if ( ! $url_validator instanceof URLValidator) { |
|
43 | 43 | $url_validator = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\validators\URLValidator'); |
44 | 44 | } |
45 | 45 | $this->url_validator = $url_validator; |
46 | - if (! $validation_error_message) { |
|
46 | + if ( ! $validation_error_message) { |
|
47 | 47 | $validation_error_message = __("Please enter a valid URL. Eg https://eventespresso.com", "event_espresso"); |
48 | 48 | } |
49 | 49 | $this->check_file_exists = $check_file_exists; |
@@ -62,14 +62,14 @@ discard block |
||
62 | 62 | public function validate($normalized_value) |
63 | 63 | { |
64 | 64 | if ($normalized_value) { |
65 | - if (! $this->url_validator->isValid($normalized_value)) { |
|
65 | + if ( ! $this->url_validator->isValid($normalized_value)) { |
|
66 | 66 | throw new EE_Validation_Error($this->get_validation_error_message(), 'invalid_url'); |
67 | 67 | } elseif (apply_filters('FHEE__EE_URL_Validation_Strategy__validate__check_remote_file_exists', $this->check_file_exists, $this->_input)) { |
68 | - if (! EEH_URL::remote_file_exists( |
|
68 | + if ( ! EEH_URL::remote_file_exists( |
|
69 | 69 | $normalized_value, |
70 | 70 | array( |
71 | 71 | 'sslverify' => false, |
72 | - 'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block |
|
72 | + 'limit_response_size' => 4095, // we don't really care for a full response, but we do want headers at least. Lets just ask for a one block |
|
73 | 73 | ) |
74 | 74 | )) { |
75 | 75 | throw new EE_Validation_Error(sprintf(__("That URL seems to be broken. Please enter a valid URL", "event_espresso"))); |
@@ -85,6 +85,6 @@ discard block |
||
85 | 85 | */ |
86 | 86 | public function get_jquery_validation_rule_array() |
87 | 87 | { |
88 | - return array( 'validUrl'=>true, 'messages' => array( 'validUrl' => $this->get_validation_error_message() ) ); |
|
88 | + return array('validUrl'=>true, 'messages' => array('validUrl' => $this->get_validation_error_message())); |
|
89 | 89 | } |
90 | 90 | } |
@@ -76,22 +76,22 @@ discard block |
||
76 | 76 | public function getModelSchemaForFields(array $model_fields, array $schema) |
77 | 77 | { |
78 | 78 | foreach ($model_fields as $field => $model_field) { |
79 | - if (! $model_field instanceof EE_Model_Field_Base) { |
|
79 | + if ( ! $model_field instanceof EE_Model_Field_Base) { |
|
80 | 80 | continue; |
81 | 81 | } |
82 | - $schema['properties'][ $field ] = $model_field->getSchema(); |
|
82 | + $schema['properties'][$field] = $model_field->getSchema(); |
|
83 | 83 | |
84 | 84 | // if this is a primary key field add the primary key item |
85 | 85 | if ($model_field instanceof EE_Primary_Key_Field_Base) { |
86 | - $schema['properties'][ $field ]['primary_key'] = true; |
|
86 | + $schema['properties'][$field]['primary_key'] = true; |
|
87 | 87 | if ($model_field instanceof EE_Primary_Key_Int_Field) { |
88 | - $schema['properties'][ $field ]['readonly'] = true; |
|
88 | + $schema['properties'][$field]['readonly'] = true; |
|
89 | 89 | } |
90 | 90 | } |
91 | 91 | |
92 | 92 | // if this is a foreign key field add the foreign key item |
93 | 93 | if ($model_field instanceof EE_Foreign_Key_Field_Base) { |
94 | - $schema['properties'][ $field ]['foreign_key'] = array( |
|
94 | + $schema['properties'][$field]['foreign_key'] = array( |
|
95 | 95 | 'description' => esc_html__( |
96 | 96 | 'This is a foreign key the points to the given models.', |
97 | 97 | 'event_espresso' |
@@ -115,18 +115,18 @@ discard block |
||
115 | 115 | public function getModelSchemaForRelations(array $relations_on_model, array $schema) |
116 | 116 | { |
117 | 117 | foreach ($relations_on_model as $model_name => $relation) { |
118 | - if (! $relation instanceof EE_Model_Relation_Base) { |
|
118 | + if ( ! $relation instanceof EE_Model_Relation_Base) { |
|
119 | 119 | continue; |
120 | 120 | } |
121 | 121 | $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation |
122 | 122 | ? strtolower($model_name) |
123 | 123 | : EEH_Inflector::pluralize_and_lower($model_name); |
124 | - $schema['properties'][ $model_name_for_schema ] = $relation->getSchema(); |
|
125 | - $schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name; |
|
124 | + $schema['properties'][$model_name_for_schema] = $relation->getSchema(); |
|
125 | + $schema['properties'][$model_name_for_schema]['relation_model'] = $model_name; |
|
126 | 126 | |
127 | 127 | // links schema |
128 | - $links_key = 'https://api.eventespresso.com/' . strtolower($model_name); |
|
129 | - $schema['properties']['_links']['properties'][ $links_key ] = array( |
|
128 | + $links_key = 'https://api.eventespresso.com/'.strtolower($model_name); |
|
129 | + $schema['properties']['_links']['properties'][$links_key] = array( |
|
130 | 130 | 'description' => esc_html__( |
131 | 131 | 'Array of objects describing the link(s) for this relation resource.', |
132 | 132 | 'event_espresso' |
@@ -25,256 +25,256 @@ |
||
25 | 25 | class JsonModelSchema |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @var EEM_Base |
|
30 | - */ |
|
31 | - protected $model; |
|
28 | + /** |
|
29 | + * @var EEM_Base |
|
30 | + */ |
|
31 | + protected $model; |
|
32 | 32 | |
33 | - /** |
|
34 | - * @var CalculatedModelFields |
|
35 | - */ |
|
36 | - protected $fields_calculator; |
|
33 | + /** |
|
34 | + * @var CalculatedModelFields |
|
35 | + */ |
|
36 | + protected $fields_calculator; |
|
37 | 37 | |
38 | 38 | |
39 | - /** |
|
40 | - * JsonModelSchema constructor. |
|
41 | - * |
|
42 | - * @param EEM_Base $model |
|
43 | - * @param CalculatedModelFields $fields_calculator |
|
44 | - */ |
|
45 | - public function __construct(EEM_Base $model, CalculatedModelFields $fields_calculator) |
|
46 | - { |
|
47 | - $this->model = $model; |
|
48 | - $this->fields_calculator = $fields_calculator; |
|
49 | - } |
|
39 | + /** |
|
40 | + * JsonModelSchema constructor. |
|
41 | + * |
|
42 | + * @param EEM_Base $model |
|
43 | + * @param CalculatedModelFields $fields_calculator |
|
44 | + */ |
|
45 | + public function __construct(EEM_Base $model, CalculatedModelFields $fields_calculator) |
|
46 | + { |
|
47 | + $this->model = $model; |
|
48 | + $this->fields_calculator = $fields_calculator; |
|
49 | + } |
|
50 | 50 | |
51 | 51 | |
52 | - /** |
|
53 | - * Return the schema for a given model from a given model. |
|
54 | - * |
|
55 | - * @return array |
|
56 | - */ |
|
57 | - public function getModelSchema() |
|
58 | - { |
|
59 | - return $this->getModelSchemaForRelations( |
|
60 | - $this->model->relation_settings(), |
|
61 | - $this->getModelSchemaForFields( |
|
62 | - $this->model->field_settings(), |
|
63 | - $this->getInitialSchemaStructure() |
|
64 | - ) |
|
65 | - ); |
|
66 | - } |
|
52 | + /** |
|
53 | + * Return the schema for a given model from a given model. |
|
54 | + * |
|
55 | + * @return array |
|
56 | + */ |
|
57 | + public function getModelSchema() |
|
58 | + { |
|
59 | + return $this->getModelSchemaForRelations( |
|
60 | + $this->model->relation_settings(), |
|
61 | + $this->getModelSchemaForFields( |
|
62 | + $this->model->field_settings(), |
|
63 | + $this->getInitialSchemaStructure() |
|
64 | + ) |
|
65 | + ); |
|
66 | + } |
|
67 | 67 | |
68 | 68 | |
69 | - /** |
|
70 | - * Get the schema for a given set of model fields. |
|
71 | - * |
|
72 | - * @param EE_Model_Field_Base[] $model_fields |
|
73 | - * @param array $schema |
|
74 | - * @return array |
|
75 | - */ |
|
76 | - public function getModelSchemaForFields(array $model_fields, array $schema) |
|
77 | - { |
|
78 | - foreach ($model_fields as $field => $model_field) { |
|
79 | - if (! $model_field instanceof EE_Model_Field_Base) { |
|
80 | - continue; |
|
81 | - } |
|
82 | - $schema['properties'][ $field ] = $model_field->getSchema(); |
|
69 | + /** |
|
70 | + * Get the schema for a given set of model fields. |
|
71 | + * |
|
72 | + * @param EE_Model_Field_Base[] $model_fields |
|
73 | + * @param array $schema |
|
74 | + * @return array |
|
75 | + */ |
|
76 | + public function getModelSchemaForFields(array $model_fields, array $schema) |
|
77 | + { |
|
78 | + foreach ($model_fields as $field => $model_field) { |
|
79 | + if (! $model_field instanceof EE_Model_Field_Base) { |
|
80 | + continue; |
|
81 | + } |
|
82 | + $schema['properties'][ $field ] = $model_field->getSchema(); |
|
83 | 83 | |
84 | - // if this is a primary key field add the primary key item |
|
85 | - if ($model_field instanceof EE_Primary_Key_Field_Base) { |
|
86 | - $schema['properties'][ $field ]['primary_key'] = true; |
|
87 | - if ($model_field instanceof EE_Primary_Key_Int_Field) { |
|
88 | - $schema['properties'][ $field ]['readonly'] = true; |
|
89 | - } |
|
90 | - } |
|
84 | + // if this is a primary key field add the primary key item |
|
85 | + if ($model_field instanceof EE_Primary_Key_Field_Base) { |
|
86 | + $schema['properties'][ $field ]['primary_key'] = true; |
|
87 | + if ($model_field instanceof EE_Primary_Key_Int_Field) { |
|
88 | + $schema['properties'][ $field ]['readonly'] = true; |
|
89 | + } |
|
90 | + } |
|
91 | 91 | |
92 | - // if this is a foreign key field add the foreign key item |
|
93 | - if ($model_field instanceof EE_Foreign_Key_Field_Base) { |
|
94 | - $schema['properties'][ $field ]['foreign_key'] = array( |
|
95 | - 'description' => esc_html__( |
|
96 | - 'This is a foreign key the points to the given models.', |
|
97 | - 'event_espresso' |
|
98 | - ), |
|
99 | - 'type' => 'array', |
|
100 | - 'enum' => $model_field->get_model_class_names_pointed_to(), |
|
101 | - ); |
|
102 | - } |
|
103 | - } |
|
104 | - return $schema; |
|
105 | - } |
|
92 | + // if this is a foreign key field add the foreign key item |
|
93 | + if ($model_field instanceof EE_Foreign_Key_Field_Base) { |
|
94 | + $schema['properties'][ $field ]['foreign_key'] = array( |
|
95 | + 'description' => esc_html__( |
|
96 | + 'This is a foreign key the points to the given models.', |
|
97 | + 'event_espresso' |
|
98 | + ), |
|
99 | + 'type' => 'array', |
|
100 | + 'enum' => $model_field->get_model_class_names_pointed_to(), |
|
101 | + ); |
|
102 | + } |
|
103 | + } |
|
104 | + return $schema; |
|
105 | + } |
|
106 | 106 | |
107 | 107 | |
108 | - /** |
|
109 | - * Get the schema for a given set of model relations |
|
110 | - * |
|
111 | - * @param EE_Model_Relation_Base[] $relations_on_model |
|
112 | - * @param array $schema |
|
113 | - * @return array |
|
114 | - */ |
|
115 | - public function getModelSchemaForRelations(array $relations_on_model, array $schema) |
|
116 | - { |
|
117 | - foreach ($relations_on_model as $model_name => $relation) { |
|
118 | - if (! $relation instanceof EE_Model_Relation_Base) { |
|
119 | - continue; |
|
120 | - } |
|
121 | - $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation |
|
122 | - ? strtolower($model_name) |
|
123 | - : EEH_Inflector::pluralize_and_lower($model_name); |
|
124 | - $schema['properties'][ $model_name_for_schema ] = $relation->getSchema(); |
|
125 | - $schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name; |
|
108 | + /** |
|
109 | + * Get the schema for a given set of model relations |
|
110 | + * |
|
111 | + * @param EE_Model_Relation_Base[] $relations_on_model |
|
112 | + * @param array $schema |
|
113 | + * @return array |
|
114 | + */ |
|
115 | + public function getModelSchemaForRelations(array $relations_on_model, array $schema) |
|
116 | + { |
|
117 | + foreach ($relations_on_model as $model_name => $relation) { |
|
118 | + if (! $relation instanceof EE_Model_Relation_Base) { |
|
119 | + continue; |
|
120 | + } |
|
121 | + $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation |
|
122 | + ? strtolower($model_name) |
|
123 | + : EEH_Inflector::pluralize_and_lower($model_name); |
|
124 | + $schema['properties'][ $model_name_for_schema ] = $relation->getSchema(); |
|
125 | + $schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name; |
|
126 | 126 | |
127 | - // links schema |
|
128 | - $links_key = 'https://api.eventespresso.com/' . strtolower($model_name); |
|
129 | - $schema['properties']['_links']['properties'][ $links_key ] = array( |
|
130 | - 'description' => esc_html__( |
|
131 | - 'Array of objects describing the link(s) for this relation resource.', |
|
132 | - 'event_espresso' |
|
133 | - ), |
|
134 | - 'type' => 'array', |
|
135 | - 'readonly' => true, |
|
136 | - 'items' => array( |
|
137 | - 'type' => 'object', |
|
138 | - 'properties' => array( |
|
139 | - 'href' => array( |
|
140 | - 'type' => 'string', |
|
141 | - 'description' => sprintf( |
|
142 | - // translators: placeholder is the model name for the relation. |
|
143 | - esc_html__( |
|
144 | - 'The link to the resource for the %s relation(s) to this entity', |
|
145 | - 'event_espresso' |
|
146 | - ), |
|
147 | - $model_name |
|
148 | - ), |
|
149 | - ), |
|
150 | - 'single' => array( |
|
151 | - 'type' => 'boolean', |
|
152 | - 'description' => sprintf( |
|
153 | - // translators: placeholder is the model name for the relation. |
|
154 | - esc_html__( |
|
155 | - 'Whether or not there is only a single %s relation to this entity', |
|
156 | - 'event_espresso' |
|
157 | - ), |
|
158 | - $model_name |
|
159 | - ), |
|
160 | - ), |
|
161 | - ), |
|
162 | - 'additionalProperties' => false |
|
163 | - ), |
|
164 | - ); |
|
165 | - } |
|
166 | - return $schema; |
|
167 | - } |
|
127 | + // links schema |
|
128 | + $links_key = 'https://api.eventespresso.com/' . strtolower($model_name); |
|
129 | + $schema['properties']['_links']['properties'][ $links_key ] = array( |
|
130 | + 'description' => esc_html__( |
|
131 | + 'Array of objects describing the link(s) for this relation resource.', |
|
132 | + 'event_espresso' |
|
133 | + ), |
|
134 | + 'type' => 'array', |
|
135 | + 'readonly' => true, |
|
136 | + 'items' => array( |
|
137 | + 'type' => 'object', |
|
138 | + 'properties' => array( |
|
139 | + 'href' => array( |
|
140 | + 'type' => 'string', |
|
141 | + 'description' => sprintf( |
|
142 | + // translators: placeholder is the model name for the relation. |
|
143 | + esc_html__( |
|
144 | + 'The link to the resource for the %s relation(s) to this entity', |
|
145 | + 'event_espresso' |
|
146 | + ), |
|
147 | + $model_name |
|
148 | + ), |
|
149 | + ), |
|
150 | + 'single' => array( |
|
151 | + 'type' => 'boolean', |
|
152 | + 'description' => sprintf( |
|
153 | + // translators: placeholder is the model name for the relation. |
|
154 | + esc_html__( |
|
155 | + 'Whether or not there is only a single %s relation to this entity', |
|
156 | + 'event_espresso' |
|
157 | + ), |
|
158 | + $model_name |
|
159 | + ), |
|
160 | + ), |
|
161 | + ), |
|
162 | + 'additionalProperties' => false |
|
163 | + ), |
|
164 | + ); |
|
165 | + } |
|
166 | + return $schema; |
|
167 | + } |
|
168 | 168 | |
169 | 169 | |
170 | - /** |
|
171 | - * Outputs the schema header for a model. |
|
172 | - * |
|
173 | - * @return array |
|
174 | - */ |
|
175 | - public function getInitialSchemaStructure() |
|
176 | - { |
|
177 | - return array( |
|
178 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
179 | - 'title' => $this->model->get_this_model_name(), |
|
180 | - 'type' => 'object', |
|
181 | - 'properties' => array( |
|
182 | - 'link' => array( |
|
183 | - 'description' => esc_html__( |
|
184 | - 'Link to event on WordPress site hosting events.', |
|
185 | - 'event_espresso' |
|
186 | - ), |
|
187 | - 'type' => 'string', |
|
188 | - 'readonly' => true, |
|
189 | - ), |
|
190 | - '_links' => array( |
|
191 | - 'description' => esc_html__( |
|
192 | - 'Various links for resources related to the entity.', |
|
193 | - 'event_espresso' |
|
194 | - ), |
|
195 | - 'type' => 'object', |
|
196 | - 'readonly' => true, |
|
197 | - 'properties' => array( |
|
198 | - 'self' => array( |
|
199 | - 'description' => esc_html__( |
|
200 | - 'Link to this entities resource.', |
|
201 | - 'event_espresso' |
|
202 | - ), |
|
203 | - 'type' => 'array', |
|
204 | - 'items' => array( |
|
205 | - 'type' => 'object', |
|
206 | - 'properties' => array( |
|
207 | - 'href' => array( |
|
208 | - 'type' => 'string', |
|
209 | - ), |
|
210 | - ), |
|
211 | - 'additionalProperties' => false |
|
212 | - ), |
|
213 | - 'readonly' => true |
|
214 | - ), |
|
215 | - 'collection' => array( |
|
216 | - 'description' => esc_html__( |
|
217 | - 'Link to this entities collection resource.', |
|
218 | - 'event_espresso' |
|
219 | - ), |
|
220 | - 'type' => 'array', |
|
221 | - 'items' => array( |
|
222 | - 'type' => 'object', |
|
223 | - 'properties' => array( |
|
224 | - 'href' => array( |
|
225 | - 'type' => 'string' |
|
226 | - ), |
|
227 | - ), |
|
228 | - 'additionalProperties' => false |
|
229 | - ), |
|
230 | - 'readonly' => true |
|
231 | - ), |
|
232 | - ), |
|
233 | - 'additionalProperties' => false, |
|
234 | - ), |
|
235 | - '_calculated_fields' => array_merge( |
|
236 | - $this->fields_calculator->getJsonSchemaForModel($this->model), |
|
237 | - array( |
|
238 | - '_protected' => $this->getProtectedFieldsSchema() |
|
239 | - ) |
|
240 | - ), |
|
241 | - '_protected' => $this->getProtectedFieldsSchema() |
|
242 | - ), |
|
243 | - 'additionalProperties' => false, |
|
244 | - ); |
|
245 | - } |
|
170 | + /** |
|
171 | + * Outputs the schema header for a model. |
|
172 | + * |
|
173 | + * @return array |
|
174 | + */ |
|
175 | + public function getInitialSchemaStructure() |
|
176 | + { |
|
177 | + return array( |
|
178 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
179 | + 'title' => $this->model->get_this_model_name(), |
|
180 | + 'type' => 'object', |
|
181 | + 'properties' => array( |
|
182 | + 'link' => array( |
|
183 | + 'description' => esc_html__( |
|
184 | + 'Link to event on WordPress site hosting events.', |
|
185 | + 'event_espresso' |
|
186 | + ), |
|
187 | + 'type' => 'string', |
|
188 | + 'readonly' => true, |
|
189 | + ), |
|
190 | + '_links' => array( |
|
191 | + 'description' => esc_html__( |
|
192 | + 'Various links for resources related to the entity.', |
|
193 | + 'event_espresso' |
|
194 | + ), |
|
195 | + 'type' => 'object', |
|
196 | + 'readonly' => true, |
|
197 | + 'properties' => array( |
|
198 | + 'self' => array( |
|
199 | + 'description' => esc_html__( |
|
200 | + 'Link to this entities resource.', |
|
201 | + 'event_espresso' |
|
202 | + ), |
|
203 | + 'type' => 'array', |
|
204 | + 'items' => array( |
|
205 | + 'type' => 'object', |
|
206 | + 'properties' => array( |
|
207 | + 'href' => array( |
|
208 | + 'type' => 'string', |
|
209 | + ), |
|
210 | + ), |
|
211 | + 'additionalProperties' => false |
|
212 | + ), |
|
213 | + 'readonly' => true |
|
214 | + ), |
|
215 | + 'collection' => array( |
|
216 | + 'description' => esc_html__( |
|
217 | + 'Link to this entities collection resource.', |
|
218 | + 'event_espresso' |
|
219 | + ), |
|
220 | + 'type' => 'array', |
|
221 | + 'items' => array( |
|
222 | + 'type' => 'object', |
|
223 | + 'properties' => array( |
|
224 | + 'href' => array( |
|
225 | + 'type' => 'string' |
|
226 | + ), |
|
227 | + ), |
|
228 | + 'additionalProperties' => false |
|
229 | + ), |
|
230 | + 'readonly' => true |
|
231 | + ), |
|
232 | + ), |
|
233 | + 'additionalProperties' => false, |
|
234 | + ), |
|
235 | + '_calculated_fields' => array_merge( |
|
236 | + $this->fields_calculator->getJsonSchemaForModel($this->model), |
|
237 | + array( |
|
238 | + '_protected' => $this->getProtectedFieldsSchema() |
|
239 | + ) |
|
240 | + ), |
|
241 | + '_protected' => $this->getProtectedFieldsSchema() |
|
242 | + ), |
|
243 | + 'additionalProperties' => false, |
|
244 | + ); |
|
245 | + } |
|
246 | 246 | |
247 | - /** |
|
248 | - * Returns an array of JSON schema to describe the _protected property on responses |
|
249 | - * @since 4.9.74.p |
|
250 | - * @return array |
|
251 | - */ |
|
252 | - protected function getProtectedFieldsSchema() |
|
253 | - { |
|
254 | - return array( |
|
255 | - 'description' => esc_html__('Array of property names whose values were replaced with their default (because they are related to a password-protected entity.)', 'event_espresso'), |
|
256 | - 'type' => 'array', |
|
257 | - 'items' => array( |
|
258 | - 'description' => esc_html__('Each name corresponds to a property that is protected by password for this entity and has its default value returned in the response.', 'event_espresso'), |
|
259 | - 'type' => 'string', |
|
260 | - 'readonly' => true, |
|
261 | - ), |
|
262 | - 'readonly' => true |
|
263 | - ); |
|
264 | - } |
|
247 | + /** |
|
248 | + * Returns an array of JSON schema to describe the _protected property on responses |
|
249 | + * @since 4.9.74.p |
|
250 | + * @return array |
|
251 | + */ |
|
252 | + protected function getProtectedFieldsSchema() |
|
253 | + { |
|
254 | + return array( |
|
255 | + 'description' => esc_html__('Array of property names whose values were replaced with their default (because they are related to a password-protected entity.)', 'event_espresso'), |
|
256 | + 'type' => 'array', |
|
257 | + 'items' => array( |
|
258 | + 'description' => esc_html__('Each name corresponds to a property that is protected by password for this entity and has its default value returned in the response.', 'event_espresso'), |
|
259 | + 'type' => 'string', |
|
260 | + 'readonly' => true, |
|
261 | + ), |
|
262 | + 'readonly' => true |
|
263 | + ); |
|
264 | + } |
|
265 | 265 | |
266 | 266 | |
267 | - /** |
|
268 | - * Allows one to just use the object as a string to get the json. |
|
269 | - * eg. |
|
270 | - * $json_schema = new JsonModelSchema(EEM_Event::instance(), new CalculatedModelFields); |
|
271 | - * echo $json_schema; //outputs the schema as a json formatted string. |
|
272 | - * |
|
273 | - * @return string |
|
274 | - */ |
|
275 | - public function __toString() |
|
276 | - { |
|
277 | - $schema = wp_json_encode($this->getModelSchema()); |
|
278 | - return is_string($schema) ? $schema : ''; |
|
279 | - } |
|
267 | + /** |
|
268 | + * Allows one to just use the object as a string to get the json. |
|
269 | + * eg. |
|
270 | + * $json_schema = new JsonModelSchema(EEM_Event::instance(), new CalculatedModelFields); |
|
271 | + * echo $json_schema; //outputs the schema as a json formatted string. |
|
272 | + * |
|
273 | + * @return string |
|
274 | + */ |
|
275 | + public function __toString() |
|
276 | + { |
|
277 | + $schema = wp_json_encode($this->getModelSchema()); |
|
278 | + return is_string($schema) ? $schema : ''; |
|
279 | + } |
|
280 | 280 | } |
@@ -43,7 +43,7 @@ discard block |
||
43 | 43 | } else { |
44 | 44 | $reg = null; |
45 | 45 | } |
46 | - if (! $reg instanceof EE_Registration |
|
46 | + if ( ! $reg instanceof EE_Registration |
|
47 | 47 | ) { |
48 | 48 | throw new EE_Error( |
49 | 49 | sprintf( |
@@ -81,7 +81,7 @@ discard block |
||
81 | 81 | $status_pretty = 'NEVER'; |
82 | 82 | break; |
83 | 83 | } |
84 | - $checkin_stati[ $datetime_id ] = $status_pretty; |
|
84 | + $checkin_stati[$datetime_id] = $status_pretty; |
|
85 | 85 | } |
86 | 86 | return $checkin_stati; |
87 | 87 | } |
@@ -24,108 +24,108 @@ |
||
24 | 24 | */ |
25 | 25 | class Registration extends RegistrationCalculationBase |
26 | 26 | { |
27 | - /** |
|
28 | - * @var EEM_Registration |
|
29 | - */ |
|
30 | - protected $registration_model; |
|
27 | + /** |
|
28 | + * @var EEM_Registration |
|
29 | + */ |
|
30 | + protected $registration_model; |
|
31 | 31 | |
32 | - /** |
|
33 | - * Registration constructor. |
|
34 | - * @param EEM_Registration $registration_model |
|
35 | - */ |
|
36 | - public function __construct(EEM_Registration $registration_model) |
|
37 | - { |
|
38 | - $this->registration_model = $registration_model; |
|
39 | - } |
|
32 | + /** |
|
33 | + * Registration constructor. |
|
34 | + * @param EEM_Registration $registration_model |
|
35 | + */ |
|
36 | + public function __construct(EEM_Registration $registration_model) |
|
37 | + { |
|
38 | + $this->registration_model = $registration_model; |
|
39 | + } |
|
40 | 40 | |
41 | - /** |
|
42 | - * Calculates the checkin status for each datetime this registration has access to |
|
43 | - * |
|
44 | - * @param array $wpdb_row |
|
45 | - * @param WP_REST_Request $request |
|
46 | - * @param RegistrationControllerBase $controller |
|
47 | - * @return array |
|
48 | - * @throws EE_Error |
|
49 | - * @throws InvalidDataTypeException |
|
50 | - * @throws InvalidInterfaceException |
|
51 | - * @throws InvalidArgumentException |
|
52 | - */ |
|
53 | - public function datetimeCheckinStati($wpdb_row, $request, $controller) |
|
54 | - { |
|
55 | - if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) { |
|
56 | - $reg = $this->registration_model->get_one_by_ID($wpdb_row['Registration.REG_ID']); |
|
57 | - } else { |
|
58 | - $reg = null; |
|
59 | - } |
|
60 | - if (! $reg instanceof EE_Registration |
|
61 | - ) { |
|
62 | - throw new EE_Error( |
|
63 | - sprintf( |
|
64 | - __( |
|
65 | - // @codingStandardsIgnoreStart |
|
66 | - 'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found', |
|
67 | - // @codingStandardsIgnoreEnd |
|
68 | - 'event_espresso' |
|
69 | - ), |
|
70 | - $wpdb_row['Registration.REG_ID'], |
|
71 | - print_r($wpdb_row, true) |
|
72 | - ) |
|
73 | - ); |
|
74 | - } |
|
75 | - $datetime_ids = EEM_Datetime::instance()->get_col( |
|
76 | - [ |
|
77 | - [ |
|
78 | - 'Ticket.TKT_ID' => $reg->ticket_ID(), |
|
79 | - ], |
|
80 | - 'default_where_conditions' => EEM_Base::default_where_conditions_minimum_all, |
|
81 | - ] |
|
82 | - ); |
|
83 | - $checkin_stati = array(); |
|
84 | - foreach ($datetime_ids as $datetime_id) { |
|
85 | - $status = $reg->check_in_status_for_datetime($datetime_id); |
|
86 | - switch ($status) { |
|
87 | - case EE_Checkin::status_checked_out: |
|
88 | - $status_pretty = 'OUT'; |
|
89 | - break; |
|
90 | - case EE_Checkin::status_checked_in: |
|
91 | - $status_pretty = 'IN'; |
|
92 | - break; |
|
93 | - case EE_Checkin::status_checked_never: |
|
94 | - default: |
|
95 | - $status_pretty = 'NEVER'; |
|
96 | - break; |
|
97 | - } |
|
98 | - $checkin_stati[ $datetime_id ] = $status_pretty; |
|
99 | - } |
|
100 | - return $checkin_stati; |
|
101 | - } |
|
41 | + /** |
|
42 | + * Calculates the checkin status for each datetime this registration has access to |
|
43 | + * |
|
44 | + * @param array $wpdb_row |
|
45 | + * @param WP_REST_Request $request |
|
46 | + * @param RegistrationControllerBase $controller |
|
47 | + * @return array |
|
48 | + * @throws EE_Error |
|
49 | + * @throws InvalidDataTypeException |
|
50 | + * @throws InvalidInterfaceException |
|
51 | + * @throws InvalidArgumentException |
|
52 | + */ |
|
53 | + public function datetimeCheckinStati($wpdb_row, $request, $controller) |
|
54 | + { |
|
55 | + if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) { |
|
56 | + $reg = $this->registration_model->get_one_by_ID($wpdb_row['Registration.REG_ID']); |
|
57 | + } else { |
|
58 | + $reg = null; |
|
59 | + } |
|
60 | + if (! $reg instanceof EE_Registration |
|
61 | + ) { |
|
62 | + throw new EE_Error( |
|
63 | + sprintf( |
|
64 | + __( |
|
65 | + // @codingStandardsIgnoreStart |
|
66 | + 'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found', |
|
67 | + // @codingStandardsIgnoreEnd |
|
68 | + 'event_espresso' |
|
69 | + ), |
|
70 | + $wpdb_row['Registration.REG_ID'], |
|
71 | + print_r($wpdb_row, true) |
|
72 | + ) |
|
73 | + ); |
|
74 | + } |
|
75 | + $datetime_ids = EEM_Datetime::instance()->get_col( |
|
76 | + [ |
|
77 | + [ |
|
78 | + 'Ticket.TKT_ID' => $reg->ticket_ID(), |
|
79 | + ], |
|
80 | + 'default_where_conditions' => EEM_Base::default_where_conditions_minimum_all, |
|
81 | + ] |
|
82 | + ); |
|
83 | + $checkin_stati = array(); |
|
84 | + foreach ($datetime_ids as $datetime_id) { |
|
85 | + $status = $reg->check_in_status_for_datetime($datetime_id); |
|
86 | + switch ($status) { |
|
87 | + case EE_Checkin::status_checked_out: |
|
88 | + $status_pretty = 'OUT'; |
|
89 | + break; |
|
90 | + case EE_Checkin::status_checked_in: |
|
91 | + $status_pretty = 'IN'; |
|
92 | + break; |
|
93 | + case EE_Checkin::status_checked_never: |
|
94 | + default: |
|
95 | + $status_pretty = 'NEVER'; |
|
96 | + break; |
|
97 | + } |
|
98 | + $checkin_stati[ $datetime_id ] = $status_pretty; |
|
99 | + } |
|
100 | + return $checkin_stati; |
|
101 | + } |
|
102 | 102 | |
103 | 103 | |
104 | - /** |
|
105 | - * Provides an array for all the calculations possible that outlines a json schema for those calculations. |
|
106 | - * Array is indexed by calculation (snake case) and value is the schema for that calculation. |
|
107 | - * |
|
108 | - * @since 4.9.68.p |
|
109 | - * @return array |
|
110 | - */ |
|
111 | - public function schemaForCalculations() |
|
112 | - { |
|
113 | - return array( |
|
114 | - 'datetime_checkin_stati' => array( |
|
115 | - 'description' => esc_html__( |
|
116 | - 'Returns the checkin status for each datetime this registration has access to.', |
|
117 | - 'event_espresso' |
|
118 | - ), |
|
119 | - 'type' => 'object', |
|
120 | - 'properties' => array(), |
|
121 | - 'additionalProperties' => array( |
|
122 | - 'description' => esc_html__( |
|
123 | - 'Keys are date-time ids and values are the check-in status', |
|
124 | - 'event_espresso' |
|
125 | - ), |
|
126 | - 'type' => 'string' |
|
127 | - ), |
|
128 | - ), |
|
129 | - ); |
|
130 | - } |
|
104 | + /** |
|
105 | + * Provides an array for all the calculations possible that outlines a json schema for those calculations. |
|
106 | + * Array is indexed by calculation (snake case) and value is the schema for that calculation. |
|
107 | + * |
|
108 | + * @since 4.9.68.p |
|
109 | + * @return array |
|
110 | + */ |
|
111 | + public function schemaForCalculations() |
|
112 | + { |
|
113 | + return array( |
|
114 | + 'datetime_checkin_stati' => array( |
|
115 | + 'description' => esc_html__( |
|
116 | + 'Returns the checkin status for each datetime this registration has access to.', |
|
117 | + 'event_espresso' |
|
118 | + ), |
|
119 | + 'type' => 'object', |
|
120 | + 'properties' => array(), |
|
121 | + 'additionalProperties' => array( |
|
122 | + 'description' => esc_html__( |
|
123 | + 'Keys are date-time ids and values are the check-in status', |
|
124 | + 'event_espresso' |
|
125 | + ), |
|
126 | + 'type' => 'string' |
|
127 | + ), |
|
128 | + ), |
|
129 | + ); |
|
130 | + } |
|
131 | 131 | } |
@@ -5,9 +5,8 @@ |
||
5 | 5 | use EEM_Base; |
6 | 6 | use EventEspresso\core\exceptions\UnexpectedEntityException; |
7 | 7 | use EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory; |
8 | -use EventEspresso\core\libraries\rest_api\controllers\Base; |
|
9 | -use EEH_Inflector; |
|
10 | 8 | use EventEspresso\core\libraries\rest_api\controllers\Base as BaseController; |
9 | +use EEH_Inflector; |
|
11 | 10 | |
12 | 11 | /** |
13 | 12 | * Class CalculatedModelFields |
@@ -57,7 +57,7 @@ discard block |
||
57 | 57 | */ |
58 | 58 | public function mapping($refresh = false) |
59 | 59 | { |
60 | - if (! $this->mapping || $refresh) { |
|
60 | + if ( ! $this->mapping || $refresh) { |
|
61 | 61 | $this->mapping = $this->generateNewMapping(); |
62 | 62 | } |
63 | 63 | return $this->mapping; |
@@ -84,7 +84,7 @@ discard block |
||
84 | 84 | foreach ($models_with_calculated_fields as $model_name) { |
85 | 85 | $calculator = $this->factory->createFromModel($model_name); |
86 | 86 | foreach (array_keys(call_user_func(array($calculator, 'schemaForCalculations'))) as $field_name) { |
87 | - $mapping[ $model_name ][ $field_name ] = get_class($calculator); |
|
87 | + $mapping[$model_name][$field_name] = get_class($calculator); |
|
88 | 88 | } |
89 | 89 | } |
90 | 90 | return apply_filters( |
@@ -113,8 +113,8 @@ discard block |
||
113 | 113 | foreach ($map_for_model as $calculation_index => $calculations_class) { |
114 | 114 | $calculator = $this->factory->createFromClassname($calculations_class); |
115 | 115 | $schema = call_user_func(array($calculator, 'schemaForCalculation'), $calculation_index); |
116 | - if (! empty($schema)) { |
|
117 | - $schema_map[ $map_model ][ $calculation_index ] = $schema; |
|
116 | + if ( ! empty($schema)) { |
|
117 | + $schema_map[$map_model][$calculation_index] = $schema; |
|
118 | 118 | } |
119 | 119 | } |
120 | 120 | } |
@@ -131,8 +131,8 @@ discard block |
||
131 | 131 | public function retrieveCalculatedFieldsForModel(EEM_Base $model) |
132 | 132 | { |
133 | 133 | $mapping = $this->mapping(); |
134 | - if (isset($mapping[ $model->get_this_model_name() ])) { |
|
135 | - return array_keys($mapping[ $model->get_this_model_name() ]); |
|
134 | + if (isset($mapping[$model->get_this_model_name()])) { |
|
135 | + return array_keys($mapping[$model->get_this_model_name()]); |
|
136 | 136 | } |
137 | 137 | return array(); |
138 | 138 | } |
@@ -145,7 +145,7 @@ discard block |
||
145 | 145 | */ |
146 | 146 | public function getJsonSchemaForModel(EEM_Base $model) |
147 | 147 | { |
148 | - if (! $this->mapping_schema) { |
|
148 | + if ( ! $this->mapping_schema) { |
|
149 | 149 | $this->mapping_schema = $this->generateNewMappingSchema(); |
150 | 150 | } |
151 | 151 | return array( |
@@ -154,8 +154,8 @@ discard block |
||
154 | 154 | 'event_espresso' |
155 | 155 | ), |
156 | 156 | 'type' => 'object', |
157 | - 'properties' => isset($this->mapping_schema[ $model->get_this_model_name() ]) |
|
158 | - ? $this->mapping_schema[ $model->get_this_model_name() ] |
|
157 | + 'properties' => isset($this->mapping_schema[$model->get_this_model_name()]) |
|
158 | + ? $this->mapping_schema[$model->get_this_model_name()] |
|
159 | 159 | : array(), |
160 | 160 | 'additionalProperties' => false, |
161 | 161 | 'readonly' => true, |
@@ -183,10 +183,10 @@ discard block |
||
183 | 183 | Base $controller |
184 | 184 | ) { |
185 | 185 | $mapping = $this->mapping(); |
186 | - if (isset($mapping[ $model->get_this_model_name() ]) |
|
187 | - && isset($mapping[ $model->get_this_model_name() ][ $field_name ]) |
|
186 | + if (isset($mapping[$model->get_this_model_name()]) |
|
187 | + && isset($mapping[$model->get_this_model_name()][$field_name]) |
|
188 | 188 | ) { |
189 | - $classname = $mapping[ $model->get_this_model_name() ][ $field_name ]; |
|
189 | + $classname = $mapping[$model->get_this_model_name()][$field_name]; |
|
190 | 190 | $calculator = $this->factory->createFromClassname($classname); |
191 | 191 | $class_method_name = EEH_Inflector::camelize_all_but_first($field_name); |
192 | 192 | return call_user_func(array($calculator, $class_method_name), $wpdb_row, $rest_request, $controller); |
@@ -22,177 +22,177 @@ |
||
22 | 22 | class CalculatedModelFields |
23 | 23 | { |
24 | 24 | |
25 | - /** |
|
26 | - * @var array |
|
27 | - */ |
|
28 | - protected $mapping; |
|
29 | - |
|
30 | - /** |
|
31 | - * @var array |
|
32 | - */ |
|
33 | - protected $mapping_schema; |
|
34 | - |
|
35 | - /** |
|
36 | - * @var CalculatedModelFieldsFactory |
|
37 | - */ |
|
38 | - private $factory; |
|
39 | - |
|
40 | - /** |
|
41 | - * CalculatedModelFields constructor. |
|
42 | - * @param CalculatedModelFieldsFactory $factory |
|
43 | - */ |
|
44 | - public function __construct(CalculatedModelFieldsFactory $factory) |
|
45 | - { |
|
46 | - $this->factory = $factory; |
|
47 | - } |
|
48 | - /** |
|
49 | - * @param bool $refresh |
|
50 | - * @return array top-level-keys are model names (eg "Event") |
|
51 | - * next-level are the calculated field names AND method names on classes |
|
52 | - * which perform calculations, values are the fully qualified classnames which do the calculations |
|
53 | - * These callbacks should accept as arguments: |
|
54 | - * the wpdb row results, |
|
55 | - * the WP_Request object, |
|
56 | - * the controller object |
|
57 | - */ |
|
58 | - public function mapping($refresh = false) |
|
59 | - { |
|
60 | - if (! $this->mapping || $refresh) { |
|
61 | - $this->mapping = $this->generateNewMapping(); |
|
62 | - } |
|
63 | - return $this->mapping; |
|
64 | - } |
|
65 | - |
|
66 | - |
|
67 | - /** |
|
68 | - * Generates a new mapping between model calculated fields and their callbacks |
|
69 | - * |
|
70 | - * @return array |
|
71 | - */ |
|
72 | - protected function generateNewMapping() |
|
73 | - { |
|
74 | - $mapping = array(); |
|
75 | - $models_with_calculated_fields = array( |
|
76 | - 'Attendee', |
|
77 | - 'Datetime', |
|
78 | - 'Event', |
|
79 | - 'Registration' |
|
80 | - ); |
|
81 | - foreach ($models_with_calculated_fields as $model_name) { |
|
82 | - $calculator = $this->factory->createFromModel($model_name); |
|
83 | - foreach (array_keys(call_user_func(array($calculator, 'schemaForCalculations'))) as $field_name) { |
|
84 | - $mapping[ $model_name ][ $field_name ] = get_class($calculator); |
|
85 | - } |
|
86 | - } |
|
87 | - return apply_filters( |
|
88 | - 'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping', |
|
89 | - $mapping |
|
90 | - ); |
|
91 | - } |
|
92 | - |
|
93 | - |
|
94 | - /** |
|
95 | - * Generates the schema for each calculation index in the calculation map. |
|
96 | - * |
|
97 | - * @return array |
|
98 | - * @throws UnexpectedEntityException |
|
99 | - */ |
|
100 | - protected function generateNewMappingSchema() |
|
101 | - { |
|
102 | - $schema_map = array(); |
|
103 | - foreach ($this->mapping() as $map_model => $map_for_model) { |
|
104 | - /** |
|
105 | - * @var string $calculation_index |
|
106 | - * @var string $calculations_class |
|
107 | - */ |
|
108 | - foreach ($map_for_model as $calculation_index => $calculations_class) { |
|
109 | - $calculator = $this->factory->createFromClassname($calculations_class); |
|
110 | - $schema = call_user_func(array($calculator, 'schemaForCalculation'), $calculation_index); |
|
111 | - if (! empty($schema)) { |
|
112 | - $schema_map[ $map_model ][ $calculation_index ] = $schema; |
|
113 | - } |
|
114 | - } |
|
115 | - } |
|
116 | - return $schema_map; |
|
117 | - } |
|
118 | - |
|
119 | - |
|
120 | - /** |
|
121 | - * Gets the known calculated fields for model |
|
122 | - * |
|
123 | - * @param EEM_Base $model |
|
124 | - * @return array allowable values for this field |
|
125 | - */ |
|
126 | - public function retrieveCalculatedFieldsForModel(EEM_Base $model) |
|
127 | - { |
|
128 | - $mapping = $this->mapping(); |
|
129 | - if (isset($mapping[ $model->get_this_model_name() ])) { |
|
130 | - return array_keys($mapping[ $model->get_this_model_name() ]); |
|
131 | - } |
|
132 | - return array(); |
|
133 | - } |
|
134 | - |
|
135 | - |
|
136 | - /** |
|
137 | - * Returns the JsonSchema for the calculated fields on the given model. |
|
138 | - * @param EEM_Base $model |
|
139 | - * @return array |
|
140 | - */ |
|
141 | - public function getJsonSchemaForModel(EEM_Base $model) |
|
142 | - { |
|
143 | - if (! $this->mapping_schema) { |
|
144 | - $this->mapping_schema = $this->generateNewMappingSchema(); |
|
145 | - } |
|
146 | - return array( |
|
147 | - 'description' => esc_html__( |
|
148 | - 'Available calculated fields for this model. Fields are only present in the response if explicitly requested', |
|
149 | - 'event_espresso' |
|
150 | - ), |
|
151 | - 'type' => 'object', |
|
152 | - 'properties' => isset($this->mapping_schema[ $model->get_this_model_name() ]) |
|
153 | - ? $this->mapping_schema[ $model->get_this_model_name() ] |
|
154 | - : array(), |
|
155 | - 'additionalProperties' => false, |
|
156 | - 'readonly' => true, |
|
157 | - ); |
|
158 | - } |
|
159 | - |
|
160 | - |
|
161 | - /** |
|
162 | - * Retrieves the value for this calculation |
|
163 | - * |
|
164 | - * @param EEM_Base $model |
|
165 | - * @param string $field_name |
|
166 | - * @param array $wpdb_row |
|
167 | - * @param $rest_request |
|
168 | - * @param BaseController $controller |
|
169 | - * @return mixed|null |
|
170 | - * @throws RestException |
|
171 | - * @throws UnexpectedEntityException |
|
172 | - */ |
|
173 | - public function retrieveCalculatedFieldValue( |
|
174 | - EEM_Base $model, |
|
175 | - $field_name, |
|
176 | - $wpdb_row, |
|
177 | - $rest_request, |
|
178 | - Base $controller |
|
179 | - ) { |
|
180 | - $mapping = $this->mapping(); |
|
181 | - if (isset($mapping[ $model->get_this_model_name() ]) |
|
182 | - && isset($mapping[ $model->get_this_model_name() ][ $field_name ]) |
|
183 | - ) { |
|
184 | - $classname = $mapping[ $model->get_this_model_name() ][ $field_name ]; |
|
185 | - $calculator = $this->factory->createFromClassname($classname); |
|
186 | - $class_method_name = EEH_Inflector::camelize_all_but_first($field_name); |
|
187 | - return call_user_func(array($calculator, $class_method_name), $wpdb_row, $rest_request, $controller); |
|
188 | - } |
|
189 | - throw new RestException( |
|
190 | - 'calculated_field_does_not_exist', |
|
191 | - sprintf( |
|
192 | - __('There is no calculated field %1$s on resource %2$s', 'event_espresso'), |
|
193 | - $field_name, |
|
194 | - $model->get_this_model_name() |
|
195 | - ) |
|
196 | - ); |
|
197 | - } |
|
25 | + /** |
|
26 | + * @var array |
|
27 | + */ |
|
28 | + protected $mapping; |
|
29 | + |
|
30 | + /** |
|
31 | + * @var array |
|
32 | + */ |
|
33 | + protected $mapping_schema; |
|
34 | + |
|
35 | + /** |
|
36 | + * @var CalculatedModelFieldsFactory |
|
37 | + */ |
|
38 | + private $factory; |
|
39 | + |
|
40 | + /** |
|
41 | + * CalculatedModelFields constructor. |
|
42 | + * @param CalculatedModelFieldsFactory $factory |
|
43 | + */ |
|
44 | + public function __construct(CalculatedModelFieldsFactory $factory) |
|
45 | + { |
|
46 | + $this->factory = $factory; |
|
47 | + } |
|
48 | + /** |
|
49 | + * @param bool $refresh |
|
50 | + * @return array top-level-keys are model names (eg "Event") |
|
51 | + * next-level are the calculated field names AND method names on classes |
|
52 | + * which perform calculations, values are the fully qualified classnames which do the calculations |
|
53 | + * These callbacks should accept as arguments: |
|
54 | + * the wpdb row results, |
|
55 | + * the WP_Request object, |
|
56 | + * the controller object |
|
57 | + */ |
|
58 | + public function mapping($refresh = false) |
|
59 | + { |
|
60 | + if (! $this->mapping || $refresh) { |
|
61 | + $this->mapping = $this->generateNewMapping(); |
|
62 | + } |
|
63 | + return $this->mapping; |
|
64 | + } |
|
65 | + |
|
66 | + |
|
67 | + /** |
|
68 | + * Generates a new mapping between model calculated fields and their callbacks |
|
69 | + * |
|
70 | + * @return array |
|
71 | + */ |
|
72 | + protected function generateNewMapping() |
|
73 | + { |
|
74 | + $mapping = array(); |
|
75 | + $models_with_calculated_fields = array( |
|
76 | + 'Attendee', |
|
77 | + 'Datetime', |
|
78 | + 'Event', |
|
79 | + 'Registration' |
|
80 | + ); |
|
81 | + foreach ($models_with_calculated_fields as $model_name) { |
|
82 | + $calculator = $this->factory->createFromModel($model_name); |
|
83 | + foreach (array_keys(call_user_func(array($calculator, 'schemaForCalculations'))) as $field_name) { |
|
84 | + $mapping[ $model_name ][ $field_name ] = get_class($calculator); |
|
85 | + } |
|
86 | + } |
|
87 | + return apply_filters( |
|
88 | + 'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping', |
|
89 | + $mapping |
|
90 | + ); |
|
91 | + } |
|
92 | + |
|
93 | + |
|
94 | + /** |
|
95 | + * Generates the schema for each calculation index in the calculation map. |
|
96 | + * |
|
97 | + * @return array |
|
98 | + * @throws UnexpectedEntityException |
|
99 | + */ |
|
100 | + protected function generateNewMappingSchema() |
|
101 | + { |
|
102 | + $schema_map = array(); |
|
103 | + foreach ($this->mapping() as $map_model => $map_for_model) { |
|
104 | + /** |
|
105 | + * @var string $calculation_index |
|
106 | + * @var string $calculations_class |
|
107 | + */ |
|
108 | + foreach ($map_for_model as $calculation_index => $calculations_class) { |
|
109 | + $calculator = $this->factory->createFromClassname($calculations_class); |
|
110 | + $schema = call_user_func(array($calculator, 'schemaForCalculation'), $calculation_index); |
|
111 | + if (! empty($schema)) { |
|
112 | + $schema_map[ $map_model ][ $calculation_index ] = $schema; |
|
113 | + } |
|
114 | + } |
|
115 | + } |
|
116 | + return $schema_map; |
|
117 | + } |
|
118 | + |
|
119 | + |
|
120 | + /** |
|
121 | + * Gets the known calculated fields for model |
|
122 | + * |
|
123 | + * @param EEM_Base $model |
|
124 | + * @return array allowable values for this field |
|
125 | + */ |
|
126 | + public function retrieveCalculatedFieldsForModel(EEM_Base $model) |
|
127 | + { |
|
128 | + $mapping = $this->mapping(); |
|
129 | + if (isset($mapping[ $model->get_this_model_name() ])) { |
|
130 | + return array_keys($mapping[ $model->get_this_model_name() ]); |
|
131 | + } |
|
132 | + return array(); |
|
133 | + } |
|
134 | + |
|
135 | + |
|
136 | + /** |
|
137 | + * Returns the JsonSchema for the calculated fields on the given model. |
|
138 | + * @param EEM_Base $model |
|
139 | + * @return array |
|
140 | + */ |
|
141 | + public function getJsonSchemaForModel(EEM_Base $model) |
|
142 | + { |
|
143 | + if (! $this->mapping_schema) { |
|
144 | + $this->mapping_schema = $this->generateNewMappingSchema(); |
|
145 | + } |
|
146 | + return array( |
|
147 | + 'description' => esc_html__( |
|
148 | + 'Available calculated fields for this model. Fields are only present in the response if explicitly requested', |
|
149 | + 'event_espresso' |
|
150 | + ), |
|
151 | + 'type' => 'object', |
|
152 | + 'properties' => isset($this->mapping_schema[ $model->get_this_model_name() ]) |
|
153 | + ? $this->mapping_schema[ $model->get_this_model_name() ] |
|
154 | + : array(), |
|
155 | + 'additionalProperties' => false, |
|
156 | + 'readonly' => true, |
|
157 | + ); |
|
158 | + } |
|
159 | + |
|
160 | + |
|
161 | + /** |
|
162 | + * Retrieves the value for this calculation |
|
163 | + * |
|
164 | + * @param EEM_Base $model |
|
165 | + * @param string $field_name |
|
166 | + * @param array $wpdb_row |
|
167 | + * @param $rest_request |
|
168 | + * @param BaseController $controller |
|
169 | + * @return mixed|null |
|
170 | + * @throws RestException |
|
171 | + * @throws UnexpectedEntityException |
|
172 | + */ |
|
173 | + public function retrieveCalculatedFieldValue( |
|
174 | + EEM_Base $model, |
|
175 | + $field_name, |
|
176 | + $wpdb_row, |
|
177 | + $rest_request, |
|
178 | + Base $controller |
|
179 | + ) { |
|
180 | + $mapping = $this->mapping(); |
|
181 | + if (isset($mapping[ $model->get_this_model_name() ]) |
|
182 | + && isset($mapping[ $model->get_this_model_name() ][ $field_name ]) |
|
183 | + ) { |
|
184 | + $classname = $mapping[ $model->get_this_model_name() ][ $field_name ]; |
|
185 | + $calculator = $this->factory->createFromClassname($classname); |
|
186 | + $class_method_name = EEH_Inflector::camelize_all_but_first($field_name); |
|
187 | + return call_user_func(array($calculator, $class_method_name), $wpdb_row, $rest_request, $controller); |
|
188 | + } |
|
189 | + throw new RestException( |
|
190 | + 'calculated_field_does_not_exist', |
|
191 | + sprintf( |
|
192 | + __('There is no calculated field %1$s on resource %2$s', 'event_espresso'), |
|
193 | + $field_name, |
|
194 | + $model->get_this_model_name() |
|
195 | + ) |
|
196 | + ); |
|
197 | + } |
|
198 | 198 | } |
@@ -40,7 +40,7 @@ discard block |
||
40 | 40 | */ |
41 | 41 | public function createFromModel($model_name) |
42 | 42 | { |
43 | - return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\' . $model_name); |
|
43 | + return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\'.$model_name); |
|
44 | 44 | } |
45 | 45 | |
46 | 46 | /** |
@@ -51,7 +51,7 @@ discard block |
||
51 | 51 | public function createFromClassname($calculator_classname) |
52 | 52 | { |
53 | 53 | $calculator = $this->loader->getShared($calculator_classname); |
54 | - if (!$calculator instanceof Base) { |
|
54 | + if ( ! $calculator instanceof Base) { |
|
55 | 55 | throw new UnexpectedEntityException( |
56 | 56 | $calculator_classname, |
57 | 57 | 'EventEspresso\core\libraries\rest_api\calculations\Base' |
@@ -18,46 +18,46 @@ |
||
18 | 18 | */ |
19 | 19 | class CalculatedModelFieldsFactory |
20 | 20 | { |
21 | - private $loader; |
|
21 | + private $loader; |
|
22 | 22 | |
23 | - /** |
|
24 | - * CalculatedModelFieldsFactory constructor. |
|
25 | - * @param LoaderInterface $loader |
|
26 | - */ |
|
27 | - public function __construct(LoaderInterface $loader) |
|
28 | - { |
|
29 | - $this->loader = $loader; |
|
30 | - } |
|
23 | + /** |
|
24 | + * CalculatedModelFieldsFactory constructor. |
|
25 | + * @param LoaderInterface $loader |
|
26 | + */ |
|
27 | + public function __construct(LoaderInterface $loader) |
|
28 | + { |
|
29 | + $this->loader = $loader; |
|
30 | + } |
|
31 | 31 | |
32 | - /** |
|
33 | - * Creates the calculator class that corresponds to that particular model |
|
34 | - * @since 4.9.68.p |
|
35 | - * @param string $model_name |
|
36 | - * @return Base |
|
37 | - * @throws UnexpectedEntityException |
|
38 | - */ |
|
39 | - public function createFromModel($model_name) |
|
40 | - { |
|
41 | - return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\' . $model_name); |
|
42 | - } |
|
32 | + /** |
|
33 | + * Creates the calculator class that corresponds to that particular model |
|
34 | + * @since 4.9.68.p |
|
35 | + * @param string $model_name |
|
36 | + * @return Base |
|
37 | + * @throws UnexpectedEntityException |
|
38 | + */ |
|
39 | + public function createFromModel($model_name) |
|
40 | + { |
|
41 | + return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\' . $model_name); |
|
42 | + } |
|
43 | 43 | |
44 | - /** |
|
45 | - * Creates the calculator class that corresponds to that classname and verifies it's of the correct type |
|
46 | - * @param string $calculator_classname |
|
47 | - * @return Base |
|
48 | - * @throws UnexpectedEntityException |
|
49 | - */ |
|
50 | - public function createFromClassname($calculator_classname) |
|
51 | - { |
|
52 | - $calculator = $this->loader->getShared($calculator_classname); |
|
53 | - if (!$calculator instanceof Base) { |
|
54 | - throw new UnexpectedEntityException( |
|
55 | - $calculator_classname, |
|
56 | - 'EventEspresso\core\libraries\rest_api\calculations\Base' |
|
57 | - ); |
|
58 | - } |
|
59 | - return $calculator; |
|
60 | - } |
|
44 | + /** |
|
45 | + * Creates the calculator class that corresponds to that classname and verifies it's of the correct type |
|
46 | + * @param string $calculator_classname |
|
47 | + * @return Base |
|
48 | + * @throws UnexpectedEntityException |
|
49 | + */ |
|
50 | + public function createFromClassname($calculator_classname) |
|
51 | + { |
|
52 | + $calculator = $this->loader->getShared($calculator_classname); |
|
53 | + if (!$calculator instanceof Base) { |
|
54 | + throw new UnexpectedEntityException( |
|
55 | + $calculator_classname, |
|
56 | + 'EventEspresso\core\libraries\rest_api\calculations\Base' |
|
57 | + ); |
|
58 | + } |
|
59 | + return $calculator; |
|
60 | + } |
|
61 | 61 | } |
62 | 62 | // End of file CalculationsFactory.php |
63 | 63 | // Location: EventEspresso\core\libraries\rest_api\calculations/CalculationsFactory.php |
@@ -87,7 +87,7 @@ discard block |
||
87 | 87 | */ |
88 | 88 | public function registrationsCheckedInCount($wpdb_row, $request, $controller) |
89 | 89 | { |
90 | - if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
90 | + if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
91 | 91 | throw new EE_Error( |
92 | 92 | sprintf( |
93 | 93 | __( |
@@ -121,7 +121,7 @@ discard block |
||
121 | 121 | */ |
122 | 122 | public function registrationsCheckedOutCount($wpdb_row, $request, $controller) |
123 | 123 | { |
124 | - if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
124 | + if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
125 | 125 | throw new EE_Error( |
126 | 126 | sprintf( |
127 | 127 | __( |
@@ -156,7 +156,7 @@ discard block |
||
156 | 156 | */ |
157 | 157 | public function spotsTakenPendingPayment($wpdb_row, $request, $controller) |
158 | 158 | { |
159 | - if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
159 | + if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
160 | 160 | throw new EE_Error( |
161 | 161 | sprintf( |
162 | 162 | __( |
@@ -17,214 +17,214 @@ |
||
17 | 17 | |
18 | 18 | class Datetime extends DatetimeCalculationBase |
19 | 19 | { |
20 | - /** |
|
21 | - * @var EEM_Datetime |
|
22 | - */ |
|
23 | - protected $datetime_model; |
|
20 | + /** |
|
21 | + * @var EEM_Datetime |
|
22 | + */ |
|
23 | + protected $datetime_model; |
|
24 | 24 | |
25 | - /** |
|
26 | - * @var EEM_Registration |
|
27 | - */ |
|
28 | - protected $registration_model; |
|
29 | - public function __construct(EEM_Datetime $datetime_model, EEM_Registration $registration_model) |
|
30 | - { |
|
31 | - $this->datetime_model = $datetime_model; |
|
32 | - $this->registration_model = $registration_model; |
|
33 | - } |
|
25 | + /** |
|
26 | + * @var EEM_Registration |
|
27 | + */ |
|
28 | + protected $registration_model; |
|
29 | + public function __construct(EEM_Datetime $datetime_model, EEM_Registration $registration_model) |
|
30 | + { |
|
31 | + $this->datetime_model = $datetime_model; |
|
32 | + $this->registration_model = $registration_model; |
|
33 | + } |
|
34 | 34 | |
35 | - /** |
|
36 | - * Calculates the total spaces available on the datetime, taking into account |
|
37 | - * ticket limits too. |
|
38 | - * |
|
39 | - * @see EE_Datetime::spaces_remaining( true ) |
|
40 | - * @param array $wpdb_row |
|
41 | - * @param WP_REST_Request $request |
|
42 | - * @param DatetimeControllerBase $controller |
|
43 | - * @return int |
|
44 | - * @throws EE_Error |
|
45 | - * @throws InvalidDataTypeException |
|
46 | - * @throws InvalidInterfaceException |
|
47 | - * @throws InvalidArgumentException |
|
48 | - * @throws ReflectionException |
|
49 | - */ |
|
50 | - public function spacesRemainingConsideringTickets($wpdb_row, $request, $controller) |
|
51 | - { |
|
52 | - if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) { |
|
53 | - $dtt_obj = $this->datetime_model->get_one_by_ID($wpdb_row['Datetime.DTT_ID']); |
|
54 | - } else { |
|
55 | - $dtt_obj = null; |
|
56 | - } |
|
57 | - if ($dtt_obj instanceof EE_Datetime) { |
|
58 | - return $dtt_obj->spaces_remaining(true); |
|
59 | - } |
|
60 | - throw new EE_Error( |
|
61 | - sprintf( |
|
62 | - __( |
|
63 | - // @codingStandardsIgnoreStart |
|
64 | - 'Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found', |
|
65 | - // @codingStandardsIgnoreEnd |
|
66 | - 'event_espresso' |
|
67 | - ), |
|
68 | - $wpdb_row['Datetime.DTT_ID'], |
|
69 | - print_r($wpdb_row, true) |
|
70 | - ) |
|
71 | - ); |
|
72 | - } |
|
35 | + /** |
|
36 | + * Calculates the total spaces available on the datetime, taking into account |
|
37 | + * ticket limits too. |
|
38 | + * |
|
39 | + * @see EE_Datetime::spaces_remaining( true ) |
|
40 | + * @param array $wpdb_row |
|
41 | + * @param WP_REST_Request $request |
|
42 | + * @param DatetimeControllerBase $controller |
|
43 | + * @return int |
|
44 | + * @throws EE_Error |
|
45 | + * @throws InvalidDataTypeException |
|
46 | + * @throws InvalidInterfaceException |
|
47 | + * @throws InvalidArgumentException |
|
48 | + * @throws ReflectionException |
|
49 | + */ |
|
50 | + public function spacesRemainingConsideringTickets($wpdb_row, $request, $controller) |
|
51 | + { |
|
52 | + if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) { |
|
53 | + $dtt_obj = $this->datetime_model->get_one_by_ID($wpdb_row['Datetime.DTT_ID']); |
|
54 | + } else { |
|
55 | + $dtt_obj = null; |
|
56 | + } |
|
57 | + if ($dtt_obj instanceof EE_Datetime) { |
|
58 | + return $dtt_obj->spaces_remaining(true); |
|
59 | + } |
|
60 | + throw new EE_Error( |
|
61 | + sprintf( |
|
62 | + __( |
|
63 | + // @codingStandardsIgnoreStart |
|
64 | + 'Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found', |
|
65 | + // @codingStandardsIgnoreEnd |
|
66 | + 'event_espresso' |
|
67 | + ), |
|
68 | + $wpdb_row['Datetime.DTT_ID'], |
|
69 | + print_r($wpdb_row, true) |
|
70 | + ) |
|
71 | + ); |
|
72 | + } |
|
73 | 73 | |
74 | 74 | |
75 | - /** |
|
76 | - * Counts registrations who have checked into this datetime |
|
77 | - * |
|
78 | - * @param array $wpdb_row |
|
79 | - * @param WP_REST_Request $request |
|
80 | - * @param DatetimeControllerBase $controller |
|
81 | - * @return int |
|
82 | - * @throws EE_Error |
|
83 | - * @throws InvalidArgumentException |
|
84 | - * @throws InvalidDataTypeException |
|
85 | - * @throws InvalidInterfaceException |
|
86 | - * @throws RestException |
|
87 | - */ |
|
88 | - public function registrationsCheckedInCount($wpdb_row, $request, $controller) |
|
89 | - { |
|
90 | - if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
91 | - throw new EE_Error( |
|
92 | - sprintf( |
|
93 | - __( |
|
94 | - // @codingStandardsIgnoreStart |
|
95 | - 'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"', |
|
96 | - // @codingStandardsIgnoreEnd |
|
97 | - 'event_espresso' |
|
98 | - ), |
|
99 | - print_r($wpdb_row, true) |
|
100 | - ) |
|
101 | - ); |
|
102 | - } |
|
103 | - $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count'); |
|
104 | - return $this->registration_model |
|
105 | - ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true); |
|
106 | - } |
|
75 | + /** |
|
76 | + * Counts registrations who have checked into this datetime |
|
77 | + * |
|
78 | + * @param array $wpdb_row |
|
79 | + * @param WP_REST_Request $request |
|
80 | + * @param DatetimeControllerBase $controller |
|
81 | + * @return int |
|
82 | + * @throws EE_Error |
|
83 | + * @throws InvalidArgumentException |
|
84 | + * @throws InvalidDataTypeException |
|
85 | + * @throws InvalidInterfaceException |
|
86 | + * @throws RestException |
|
87 | + */ |
|
88 | + public function registrationsCheckedInCount($wpdb_row, $request, $controller) |
|
89 | + { |
|
90 | + if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
91 | + throw new EE_Error( |
|
92 | + sprintf( |
|
93 | + __( |
|
94 | + // @codingStandardsIgnoreStart |
|
95 | + 'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"', |
|
96 | + // @codingStandardsIgnoreEnd |
|
97 | + 'event_espresso' |
|
98 | + ), |
|
99 | + print_r($wpdb_row, true) |
|
100 | + ) |
|
101 | + ); |
|
102 | + } |
|
103 | + $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count'); |
|
104 | + return $this->registration_model |
|
105 | + ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true); |
|
106 | + } |
|
107 | 107 | |
108 | 108 | |
109 | - /** |
|
110 | - * Counts registrations who have checked out of this datetime |
|
111 | - * |
|
112 | - * @param array $wpdb_row |
|
113 | - * @param WP_REST_Request $request |
|
114 | - * @param DatetimeControllerBase $controller |
|
115 | - * @return int |
|
116 | - * @throws EE_Error |
|
117 | - * @throws InvalidArgumentException |
|
118 | - * @throws InvalidDataTypeException |
|
119 | - * @throws InvalidInterfaceException |
|
120 | - * @throws RestException |
|
121 | - */ |
|
122 | - public function registrationsCheckedOutCount($wpdb_row, $request, $controller) |
|
123 | - { |
|
124 | - if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
125 | - throw new EE_Error( |
|
126 | - sprintf( |
|
127 | - __( |
|
128 | - // @codingStandardsIgnoreStart |
|
129 | - 'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"', |
|
130 | - // @codingStandardsIgnoreEnd |
|
131 | - 'event_espresso' |
|
132 | - ), |
|
133 | - print_r($wpdb_row, true) |
|
134 | - ) |
|
135 | - ); |
|
136 | - } |
|
137 | - $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count'); |
|
138 | - return $this->registration_model |
|
139 | - ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false); |
|
140 | - } |
|
109 | + /** |
|
110 | + * Counts registrations who have checked out of this datetime |
|
111 | + * |
|
112 | + * @param array $wpdb_row |
|
113 | + * @param WP_REST_Request $request |
|
114 | + * @param DatetimeControllerBase $controller |
|
115 | + * @return int |
|
116 | + * @throws EE_Error |
|
117 | + * @throws InvalidArgumentException |
|
118 | + * @throws InvalidDataTypeException |
|
119 | + * @throws InvalidInterfaceException |
|
120 | + * @throws RestException |
|
121 | + */ |
|
122 | + public function registrationsCheckedOutCount($wpdb_row, $request, $controller) |
|
123 | + { |
|
124 | + if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
125 | + throw new EE_Error( |
|
126 | + sprintf( |
|
127 | + __( |
|
128 | + // @codingStandardsIgnoreStart |
|
129 | + 'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"', |
|
130 | + // @codingStandardsIgnoreEnd |
|
131 | + 'event_espresso' |
|
132 | + ), |
|
133 | + print_r($wpdb_row, true) |
|
134 | + ) |
|
135 | + ); |
|
136 | + } |
|
137 | + $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count'); |
|
138 | + return $this->registration_model |
|
139 | + ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false); |
|
140 | + } |
|
141 | 141 | |
142 | 142 | |
143 | - /** |
|
144 | - * Counts the number of pending-payment registrations for this event (regardless |
|
145 | - * of how many datetimes each registrations' ticket purchase is for) |
|
146 | - * |
|
147 | - * @param array $wpdb_row |
|
148 | - * @param WP_REST_Request $request |
|
149 | - * @param DatetimeControllerBase $controller |
|
150 | - * @return int |
|
151 | - * @throws EE_Error |
|
152 | - * @throws InvalidArgumentException |
|
153 | - * @throws InvalidDataTypeException |
|
154 | - * @throws InvalidInterfaceException |
|
155 | - * @throws RestException |
|
156 | - */ |
|
157 | - public function spotsTakenPendingPayment($wpdb_row, $request, $controller) |
|
158 | - { |
|
159 | - if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
160 | - throw new EE_Error( |
|
161 | - sprintf( |
|
162 | - __( |
|
163 | - // @codingStandardsIgnoreStart |
|
164 | - 'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"', |
|
165 | - // @codingStandardsIgnoreEnd |
|
166 | - 'event_espresso' |
|
167 | - ), |
|
168 | - print_r($wpdb_row, true) |
|
169 | - ) |
|
170 | - ); |
|
171 | - } |
|
172 | - $this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment'); |
|
173 | - return $this->registration_model->count( |
|
174 | - array( |
|
175 | - array( |
|
176 | - 'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'], |
|
177 | - 'STS_ID' => EEM_Registration::status_id_pending_payment, |
|
178 | - ), |
|
179 | - ), |
|
180 | - 'REG_ID', |
|
181 | - true |
|
182 | - ); |
|
183 | - } |
|
143 | + /** |
|
144 | + * Counts the number of pending-payment registrations for this event (regardless |
|
145 | + * of how many datetimes each registrations' ticket purchase is for) |
|
146 | + * |
|
147 | + * @param array $wpdb_row |
|
148 | + * @param WP_REST_Request $request |
|
149 | + * @param DatetimeControllerBase $controller |
|
150 | + * @return int |
|
151 | + * @throws EE_Error |
|
152 | + * @throws InvalidArgumentException |
|
153 | + * @throws InvalidDataTypeException |
|
154 | + * @throws InvalidInterfaceException |
|
155 | + * @throws RestException |
|
156 | + */ |
|
157 | + public function spotsTakenPendingPayment($wpdb_row, $request, $controller) |
|
158 | + { |
|
159 | + if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) { |
|
160 | + throw new EE_Error( |
|
161 | + sprintf( |
|
162 | + __( |
|
163 | + // @codingStandardsIgnoreStart |
|
164 | + 'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"', |
|
165 | + // @codingStandardsIgnoreEnd |
|
166 | + 'event_espresso' |
|
167 | + ), |
|
168 | + print_r($wpdb_row, true) |
|
169 | + ) |
|
170 | + ); |
|
171 | + } |
|
172 | + $this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment'); |
|
173 | + return $this->registration_model->count( |
|
174 | + array( |
|
175 | + array( |
|
176 | + 'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'], |
|
177 | + 'STS_ID' => EEM_Registration::status_id_pending_payment, |
|
178 | + ), |
|
179 | + ), |
|
180 | + 'REG_ID', |
|
181 | + true |
|
182 | + ); |
|
183 | + } |
|
184 | 184 | |
185 | 185 | |
186 | - /** |
|
187 | - * Provides an array for all the calculations possible that outlines a json schema for those calculations. |
|
188 | - * Array is indexed by calculation (snake case) and value is the schema for that calculation. |
|
189 | - * |
|
190 | - * @since 4.9.68.p |
|
191 | - * @return array |
|
192 | - */ |
|
193 | - public function schemaForCalculations() |
|
194 | - { |
|
195 | - return array( |
|
196 | - 'spaces_remaining_considering_tickets' => array( |
|
197 | - 'description' => esc_html__( |
|
198 | - 'Calculates the total spaces available on the datetime, taking into account ticket limits too.', |
|
199 | - 'event_espresso' |
|
200 | - ), |
|
201 | - 'type' => 'number', |
|
202 | - 'protected' => true, |
|
203 | - ), |
|
204 | - 'registrations_checked_in_count' => array( |
|
205 | - 'description' => esc_html__( |
|
206 | - 'Counts registrations who have checked into this datetime.', |
|
207 | - 'event_espresso' |
|
208 | - ), |
|
209 | - 'type' => 'number', |
|
210 | - 'protected' => true, |
|
211 | - ), |
|
212 | - 'registrations_checked_out_count' => array( |
|
213 | - 'description' => esc_html__( |
|
214 | - 'Counts registrations who have checked out of this datetime.', |
|
215 | - 'event_espresso' |
|
216 | - ), |
|
217 | - 'type' => 'number', |
|
218 | - 'protected' => true, |
|
219 | - ), |
|
220 | - 'spots_taken_pending_payment' => array( |
|
221 | - 'description' => esc_html__( |
|
222 | - 'The count of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for', |
|
223 | - 'event_espresso' |
|
224 | - ), |
|
225 | - 'type' => 'number', |
|
226 | - 'protected' => true, |
|
227 | - ), |
|
228 | - ); |
|
229 | - } |
|
186 | + /** |
|
187 | + * Provides an array for all the calculations possible that outlines a json schema for those calculations. |
|
188 | + * Array is indexed by calculation (snake case) and value is the schema for that calculation. |
|
189 | + * |
|
190 | + * @since 4.9.68.p |
|
191 | + * @return array |
|
192 | + */ |
|
193 | + public function schemaForCalculations() |
|
194 | + { |
|
195 | + return array( |
|
196 | + 'spaces_remaining_considering_tickets' => array( |
|
197 | + 'description' => esc_html__( |
|
198 | + 'Calculates the total spaces available on the datetime, taking into account ticket limits too.', |
|
199 | + 'event_espresso' |
|
200 | + ), |
|
201 | + 'type' => 'number', |
|
202 | + 'protected' => true, |
|
203 | + ), |
|
204 | + 'registrations_checked_in_count' => array( |
|
205 | + 'description' => esc_html__( |
|
206 | + 'Counts registrations who have checked into this datetime.', |
|
207 | + 'event_espresso' |
|
208 | + ), |
|
209 | + 'type' => 'number', |
|
210 | + 'protected' => true, |
|
211 | + ), |
|
212 | + 'registrations_checked_out_count' => array( |
|
213 | + 'description' => esc_html__( |
|
214 | + 'Counts registrations who have checked out of this datetime.', |
|
215 | + 'event_espresso' |
|
216 | + ), |
|
217 | + 'type' => 'number', |
|
218 | + 'protected' => true, |
|
219 | + ), |
|
220 | + 'spots_taken_pending_payment' => array( |
|
221 | + 'description' => esc_html__( |
|
222 | + 'The count of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for', |
|
223 | + 'event_espresso' |
|
224 | + ), |
|
225 | + 'type' => 'number', |
|
226 | + 'protected' => true, |
|
227 | + ), |
|
228 | + ); |
|
229 | + } |
|
230 | 230 | } |
@@ -23,7 +23,7 @@ discard block |
||
23 | 23 | */ |
24 | 24 | protected function verifyCurrentUserCan($required_permission, $attempted_calculation) |
25 | 25 | { |
26 | - if (! current_user_can($required_permission)) { |
|
26 | + if ( ! current_user_can($required_permission)) { |
|
27 | 27 | throw new RestException( |
28 | 28 | 'permission_denied', |
29 | 29 | sprintf( |
@@ -75,6 +75,6 @@ discard block |
||
75 | 75 | public function schemaForCalculation($calculation_index) |
76 | 76 | { |
77 | 77 | $schema_map = $this->schemaForCalculations(); |
78 | - return isset($schema_map[ $calculation_index ]) ? $schema_map[ $calculation_index ] : array(); |
|
78 | + return isset($schema_map[$calculation_index]) ? $schema_map[$calculation_index] : array(); |
|
79 | 79 | } |
80 | 80 | } |
@@ -16,65 +16,65 @@ |
||
16 | 16 | class Base |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @param $required_permission |
|
21 | - * @param $attempted_calculation |
|
22 | - * @throws RestException |
|
23 | - */ |
|
24 | - protected function verifyCurrentUserCan($required_permission, $attempted_calculation) |
|
25 | - { |
|
26 | - if (! current_user_can($required_permission)) { |
|
27 | - throw new RestException( |
|
28 | - 'permission_denied', |
|
29 | - sprintf( |
|
30 | - __( |
|
31 | - // @codingStandardsIgnoreStart |
|
32 | - 'Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"', |
|
33 | - // @codingStandardsIgnoreEnd |
|
34 | - 'event_espresso' |
|
35 | - ), |
|
36 | - $attempted_calculation, |
|
37 | - EEH_Inflector::pluralize_and_lower($this->getResourceName()), |
|
38 | - $required_permission |
|
39 | - ) |
|
40 | - ); |
|
41 | - } |
|
42 | - } |
|
19 | + /** |
|
20 | + * @param $required_permission |
|
21 | + * @param $attempted_calculation |
|
22 | + * @throws RestException |
|
23 | + */ |
|
24 | + protected function verifyCurrentUserCan($required_permission, $attempted_calculation) |
|
25 | + { |
|
26 | + if (! current_user_can($required_permission)) { |
|
27 | + throw new RestException( |
|
28 | + 'permission_denied', |
|
29 | + sprintf( |
|
30 | + __( |
|
31 | + // @codingStandardsIgnoreStart |
|
32 | + 'Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"', |
|
33 | + // @codingStandardsIgnoreEnd |
|
34 | + 'event_espresso' |
|
35 | + ), |
|
36 | + $attempted_calculation, |
|
37 | + EEH_Inflector::pluralize_and_lower($this->getResourceName()), |
|
38 | + $required_permission |
|
39 | + ) |
|
40 | + ); |
|
41 | + } |
|
42 | + } |
|
43 | 43 | |
44 | 44 | |
45 | - /** |
|
46 | - * Gets the name of the resource of the called class |
|
47 | - * |
|
48 | - * @return string |
|
49 | - */ |
|
50 | - public function getResourceName() |
|
51 | - { |
|
52 | - return substr(__CLASS__, strrpos(__CLASS__, '\\') + 1); |
|
53 | - } |
|
45 | + /** |
|
46 | + * Gets the name of the resource of the called class |
|
47 | + * |
|
48 | + * @return string |
|
49 | + */ |
|
50 | + public function getResourceName() |
|
51 | + { |
|
52 | + return substr(__CLASS__, strrpos(__CLASS__, '\\') + 1); |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * Returns an array to be used for the schema for the calculated fields. |
|
57 | - * @since 4.9.68.p |
|
58 | - * @return array keys are calculated field names (eg "optimum_sales_at_start") values are arrays { |
|
59 | - * @type string $description |
|
60 | - * @type string $type, eg "string", "int", "boolean", "object", "array", etc |
|
61 | - * } |
|
62 | - */ |
|
63 | - public function schemaForCalculations() |
|
64 | - { |
|
65 | - return array(); |
|
66 | - } |
|
55 | + /** |
|
56 | + * Returns an array to be used for the schema for the calculated fields. |
|
57 | + * @since 4.9.68.p |
|
58 | + * @return array keys are calculated field names (eg "optimum_sales_at_start") values are arrays { |
|
59 | + * @type string $description |
|
60 | + * @type string $type, eg "string", "int", "boolean", "object", "array", etc |
|
61 | + * } |
|
62 | + */ |
|
63 | + public function schemaForCalculations() |
|
64 | + { |
|
65 | + return array(); |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * Returns the json schema for the given calculation index. |
|
70 | - * |
|
71 | - * @since 4.9.68.p |
|
72 | - * @param $calculation_index |
|
73 | - * @return array |
|
74 | - */ |
|
75 | - public function schemaForCalculation($calculation_index) |
|
76 | - { |
|
77 | - $schema_map = $this->schemaForCalculations(); |
|
78 | - return isset($schema_map[ $calculation_index ]) ? $schema_map[ $calculation_index ] : array(); |
|
79 | - } |
|
68 | + /** |
|
69 | + * Returns the json schema for the given calculation index. |
|
70 | + * |
|
71 | + * @since 4.9.68.p |
|
72 | + * @param $calculation_index |
|
73 | + * @return array |
|
74 | + */ |
|
75 | + public function schemaForCalculation($calculation_index) |
|
76 | + { |
|
77 | + $schema_map = $this->schemaForCalculations(); |
|
78 | + return isset($schema_map[ $calculation_index ]) ? $schema_map[ $calculation_index ] : array(); |
|
79 | + } |
|
80 | 80 | } |
@@ -175,7 +175,7 @@ discard block |
||
175 | 175 | */ |
176 | 176 | public function spotsTaken($wpdb_row, $request, $controller) |
177 | 177 | { |
178 | - if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
178 | + if ( ! Event::wpdbRowHasEventId($wpdb_row)) { |
|
179 | 179 | throw new EE_Error( |
180 | 180 | sprintf( |
181 | 181 | __( |
@@ -217,7 +217,7 @@ discard block |
||
217 | 217 | */ |
218 | 218 | public function spotsTakenPendingPayment($wpdb_row, $request, $controller) |
219 | 219 | { |
220 | - if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
220 | + if ( ! Event::wpdbRowHasEventId($wpdb_row)) { |
|
221 | 221 | throw new EE_Error( |
222 | 222 | sprintf( |
223 | 223 | __( |
@@ -260,7 +260,7 @@ discard block |
||
260 | 260 | */ |
261 | 261 | public function registrationsCheckedInCount($wpdb_row, $request, $controller) |
262 | 262 | { |
263 | - if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
263 | + if ( ! Event::wpdbRowHasEventId($wpdb_row)) { |
|
264 | 264 | throw new EE_Error( |
265 | 265 | sprintf( |
266 | 266 | __( |
@@ -294,7 +294,7 @@ discard block |
||
294 | 294 | */ |
295 | 295 | public function registrationsCheckedOutCount($wpdb_row, $request, $controller) |
296 | 296 | { |
297 | - if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
297 | + if ( ! Event::wpdbRowHasEventId($wpdb_row)) { |
|
298 | 298 | throw new EE_Error( |
299 | 299 | sprintf( |
300 | 300 | __( |
@@ -413,7 +413,7 @@ discard block |
||
413 | 413 | */ |
414 | 414 | protected function calculateImageData($wpdb_row, $image_size) |
415 | 415 | { |
416 | - if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
416 | + if ( ! Event::wpdbRowHasEventId($wpdb_row)) { |
|
417 | 417 | throw new EE_Error( |
418 | 418 | sprintf( |
419 | 419 | __( |
@@ -429,7 +429,7 @@ discard block |
||
429 | 429 | $EVT_ID = $wpdb_row['Event_CPT.ID']; |
430 | 430 | $attachment_id = get_post_thumbnail_id($EVT_ID); |
431 | 431 | $data = wp_get_attachment_image_src($attachment_id, $image_size); |
432 | - if (! $data) { |
|
432 | + if ( ! $data) { |
|
433 | 433 | return null; |
434 | 434 | } |
435 | 435 | $generated = true; |
@@ -26,571 +26,571 @@ |
||
26 | 26 | */ |
27 | 27 | class Event extends EventCalculationBase |
28 | 28 | { |
29 | - /** |
|
30 | - * @var EEM_Event |
|
31 | - */ |
|
32 | - protected $event_model; |
|
33 | - |
|
34 | - /** |
|
35 | - * @var EEM_Registration |
|
36 | - */ |
|
37 | - protected $registration_model; |
|
38 | - public function __construct(EEM_Event $event_model, EEM_Registration $registration_model) |
|
39 | - { |
|
40 | - $this->event_model = $event_model; |
|
41 | - $this->registration_model = $registration_model; |
|
42 | - } |
|
43 | - |
|
44 | - /** |
|
45 | - * Calculates the total spaces on the event (not subtracting sales, but taking |
|
46 | - * sales into account; so this is the optimum sales that CAN still be achieved) |
|
47 | - * See EE_Event::total_available_spaces( true ); |
|
48 | - * |
|
49 | - * @param array $wpdb_row |
|
50 | - * @param WP_REST_Request $request |
|
51 | - * @param EventControllerBase $controller |
|
52 | - * @return int |
|
53 | - * @throws EE_Error |
|
54 | - * @throws DomainException |
|
55 | - * @throws InvalidDataTypeException |
|
56 | - * @throws InvalidInterfaceException |
|
57 | - * @throws UnexpectedEntityException |
|
58 | - * @throws InvalidArgumentException |
|
59 | - */ |
|
60 | - public function optimumSalesAtStart($wpdb_row, $request, $controller) |
|
61 | - { |
|
62 | - $event_obj = null; |
|
63 | - if (Event::wpdbRowHasEventId($wpdb_row)) { |
|
64 | - $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']); |
|
65 | - } |
|
66 | - if ($event_obj instanceof EE_Event) { |
|
67 | - return $event_obj->total_available_spaces(); |
|
68 | - } |
|
69 | - throw new EE_Error( |
|
70 | - sprintf( |
|
71 | - __( |
|
72 | - // @codingStandardsIgnoreStart |
|
73 | - 'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found', |
|
74 | - // @codingStandardsIgnoreEnd |
|
75 | - 'event_espresso' |
|
76 | - ), |
|
77 | - $wpdb_row['Event_CPT.ID'], |
|
78 | - print_r($wpdb_row, true) |
|
79 | - ) |
|
80 | - ); |
|
81 | - } |
|
82 | - |
|
83 | - |
|
84 | - /** |
|
85 | - * Calculates the total spaces on the event (ignoring all sales; so this is the optimum |
|
86 | - * sales that COULD have been achieved) |
|
87 | - * See EE_Event::total_available_spaces( true ); |
|
88 | - * |
|
89 | - * @param array $wpdb_row |
|
90 | - * @param WP_REST_Request $request |
|
91 | - * @param EventControllerBase $controller |
|
92 | - * @return int |
|
93 | - * @throws DomainException |
|
94 | - * @throws EE_Error |
|
95 | - * @throws InvalidArgumentException |
|
96 | - * @throws InvalidDataTypeException |
|
97 | - * @throws InvalidInterfaceException |
|
98 | - * @throws UnexpectedEntityException |
|
99 | - */ |
|
100 | - public function optimumSalesNow($wpdb_row, $request, $controller) |
|
101 | - { |
|
102 | - $event_obj = null; |
|
103 | - if (Event::wpdbRowHasEventId($wpdb_row)) { |
|
104 | - $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']); |
|
105 | - } |
|
106 | - if ($event_obj instanceof EE_Event) { |
|
107 | - return $event_obj->total_available_spaces(true); |
|
108 | - } |
|
109 | - throw new EE_Error( |
|
110 | - sprintf( |
|
111 | - __( |
|
112 | - // @codingStandardsIgnoreStart |
|
113 | - 'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found', |
|
114 | - // @codingStandardsIgnoreEnd |
|
115 | - 'event_espresso' |
|
116 | - ), |
|
117 | - $wpdb_row['Event_CPT.ID'], |
|
118 | - print_r($wpdb_row, true) |
|
119 | - ) |
|
120 | - ); |
|
121 | - } |
|
122 | - |
|
123 | - |
|
124 | - /** |
|
125 | - * Like optimum_sales_now, but minus total sales so far. |
|
126 | - * See EE_Event::spaces_remaining_for_sale( true ); |
|
127 | - * |
|
128 | - * @param array $wpdb_row |
|
129 | - * @param WP_REST_Request $request |
|
130 | - * @param EventControllerBase $controller |
|
131 | - * @return int |
|
132 | - * @throws DomainException |
|
133 | - * @throws EE_Error |
|
134 | - * @throws InvalidArgumentException |
|
135 | - * @throws InvalidDataTypeException |
|
136 | - * @throws InvalidInterfaceException |
|
137 | - * @throws UnexpectedEntityException |
|
138 | - */ |
|
139 | - public function spacesRemaining($wpdb_row, $request, $controller) |
|
140 | - { |
|
141 | - $event_obj = null; |
|
142 | - if (Event::wpdbRowHasEventId($wpdb_row)) { |
|
143 | - $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']); |
|
144 | - } |
|
145 | - if ($event_obj instanceof EE_Event) { |
|
146 | - return $event_obj->spaces_remaining_for_sale(); |
|
147 | - } |
|
148 | - throw new EE_Error( |
|
149 | - sprintf( |
|
150 | - __( |
|
151 | - // @codingStandardsIgnoreStart |
|
152 | - 'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found', |
|
153 | - // @codingStandardsIgnoreEnd |
|
154 | - 'event_espresso' |
|
155 | - ), |
|
156 | - $wpdb_row['Event_CPT.ID'], |
|
157 | - print_r($wpdb_row, true) |
|
158 | - ) |
|
159 | - ); |
|
160 | - } |
|
161 | - |
|
162 | - |
|
163 | - /** |
|
164 | - * Counts the number of approved registrations for this event (regardless |
|
165 | - * of how many datetimes each registrations' ticket purchase is for) |
|
166 | - * |
|
167 | - * @param array $wpdb_row |
|
168 | - * @param WP_REST_Request $request |
|
169 | - * @param EventControllerBase $controller |
|
170 | - * @return int |
|
171 | - * @throws EE_Error |
|
172 | - * @throws InvalidArgumentException |
|
173 | - * @throws InvalidDataTypeException |
|
174 | - * @throws InvalidInterfaceException |
|
175 | - */ |
|
176 | - public function spotsTaken($wpdb_row, $request, $controller) |
|
177 | - { |
|
178 | - if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
179 | - throw new EE_Error( |
|
180 | - sprintf( |
|
181 | - __( |
|
182 | - // @codingStandardsIgnoreStart |
|
183 | - 'Cannot calculate spots_taken because the database row %1$s does not have a valid entry for "Event_CPT.ID"', |
|
184 | - // @codingStandardsIgnoreEnd |
|
185 | - 'event_espresso' |
|
186 | - ), |
|
187 | - print_r($wpdb_row, true) |
|
188 | - ) |
|
189 | - ); |
|
190 | - } |
|
191 | - return $this->registration_model->count( |
|
192 | - array( |
|
193 | - array( |
|
194 | - 'EVT_ID' => $wpdb_row['Event_CPT.ID'], |
|
195 | - 'STS_ID' => EEM_Registration::status_id_approved, |
|
196 | - ), |
|
197 | - ), |
|
198 | - 'REG_ID', |
|
199 | - true |
|
200 | - ); |
|
201 | - } |
|
202 | - |
|
203 | - |
|
204 | - /** |
|
205 | - * Counts the number of pending-payment registrations for this event (regardless |
|
206 | - * of how many datetimes each registrations' ticket purchase is for) |
|
207 | - * |
|
208 | - * @param array $wpdb_row |
|
209 | - * @param WP_REST_Request $request |
|
210 | - * @param EventControllerBase $controller |
|
211 | - * @return int |
|
212 | - * @throws EE_Error |
|
213 | - * @throws InvalidArgumentException |
|
214 | - * @throws InvalidDataTypeException |
|
215 | - * @throws InvalidInterfaceException |
|
216 | - * @throws RestException |
|
217 | - */ |
|
218 | - public function spotsTakenPendingPayment($wpdb_row, $request, $controller) |
|
219 | - { |
|
220 | - if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
221 | - throw new EE_Error( |
|
222 | - sprintf( |
|
223 | - __( |
|
224 | - // @codingStandardsIgnoreStart |
|
225 | - 'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"', |
|
226 | - // @codingStandardsIgnoreEnd |
|
227 | - 'event_espresso' |
|
228 | - ), |
|
229 | - print_r($wpdb_row, true) |
|
230 | - ) |
|
231 | - ); |
|
232 | - } |
|
233 | - $this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment'); |
|
234 | - return $this->registration_model->count( |
|
235 | - array( |
|
236 | - array( |
|
237 | - 'EVT_ID' => $wpdb_row['Event_CPT.ID'], |
|
238 | - 'STS_ID' => EEM_Registration::status_id_pending_payment, |
|
239 | - ), |
|
240 | - ), |
|
241 | - 'REG_ID', |
|
242 | - true |
|
243 | - ); |
|
244 | - } |
|
245 | - |
|
246 | - |
|
247 | - /** |
|
248 | - * Counts all the registrations who have checked into one of this events' datetimes |
|
249 | - * See EE_Event::total_available_spaces( false ); |
|
250 | - * |
|
251 | - * @param array $wpdb_row |
|
252 | - * @param WP_REST_Request $request |
|
253 | - * @param EventControllerBase $controller |
|
254 | - * @return int|null if permission denied |
|
255 | - * @throws EE_Error |
|
256 | - * @throws InvalidArgumentException |
|
257 | - * @throws InvalidDataTypeException |
|
258 | - * @throws InvalidInterfaceException |
|
259 | - * @throws RestException |
|
260 | - */ |
|
261 | - public function registrationsCheckedInCount($wpdb_row, $request, $controller) |
|
262 | - { |
|
263 | - if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
264 | - throw new EE_Error( |
|
265 | - sprintf( |
|
266 | - __( |
|
267 | - // @codingStandardsIgnoreStart |
|
268 | - 'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"', |
|
269 | - // @codingStandardsIgnoreEnd |
|
270 | - 'event_espresso' |
|
271 | - ), |
|
272 | - print_r($wpdb_row, true) |
|
273 | - ) |
|
274 | - ); |
|
275 | - } |
|
276 | - $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count'); |
|
277 | - return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true); |
|
278 | - } |
|
279 | - |
|
280 | - |
|
281 | - /** |
|
282 | - * Counts all the registrations who have checked out of one of this events' datetimes |
|
283 | - * See EE_Event::total_available_spaces( false ); |
|
284 | - * |
|
285 | - * @param array $wpdb_row |
|
286 | - * @param WP_REST_Request $request |
|
287 | - * @param EventControllerBase $controller |
|
288 | - * @return int |
|
289 | - * @throws EE_Error |
|
290 | - * @throws InvalidArgumentException |
|
291 | - * @throws InvalidDataTypeException |
|
292 | - * @throws InvalidInterfaceException |
|
293 | - * @throws RestException |
|
294 | - */ |
|
295 | - public function registrationsCheckedOutCount($wpdb_row, $request, $controller) |
|
296 | - { |
|
297 | - if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
298 | - throw new EE_Error( |
|
299 | - sprintf( |
|
300 | - __( |
|
301 | - // @codingStandardsIgnoreStart |
|
302 | - 'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"', |
|
303 | - // @codingStandardsIgnoreEnd |
|
304 | - 'event_espresso' |
|
305 | - ), |
|
306 | - print_r($wpdb_row, true) |
|
307 | - ) |
|
308 | - ); |
|
309 | - } |
|
310 | - $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count'); |
|
311 | - return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false); |
|
312 | - } |
|
313 | - |
|
314 | - |
|
315 | - /** |
|
316 | - * Gets the thumbnail image |
|
317 | - * |
|
318 | - * @param array $wpdb_row |
|
319 | - * @param WP_REST_Request $request |
|
320 | - * @param EventControllerBase $controller |
|
321 | - * @return array |
|
322 | - * @throws EE_Error |
|
323 | - */ |
|
324 | - public function imageThumbnail($wpdb_row, $request, $controller) |
|
325 | - { |
|
326 | - return self::calculateImageData($wpdb_row, 'thumbnail'); |
|
327 | - } |
|
328 | - |
|
329 | - |
|
330 | - /** |
|
331 | - * Gets the medium image |
|
332 | - * |
|
333 | - * @param array $wpdb_row |
|
334 | - * @param WP_REST_Request $request |
|
335 | - * @param EventControllerBase $controller |
|
336 | - * @return array |
|
337 | - * @throws EE_Error |
|
338 | - */ |
|
339 | - public function imageMedium($wpdb_row, $request, $controller) |
|
340 | - { |
|
341 | - return self::calculateImageData($wpdb_row, 'medium'); |
|
342 | - } |
|
343 | - |
|
344 | - |
|
345 | - /** |
|
346 | - * Gets the medium-large image |
|
347 | - * |
|
348 | - * @param array $wpdb_row |
|
349 | - * @param WP_REST_Request $request |
|
350 | - * @param EventControllerBase $controller |
|
351 | - * @return array |
|
352 | - * @throws EE_Error |
|
353 | - */ |
|
354 | - public function imageMediumLarge($wpdb_row, $request, $controller) |
|
355 | - { |
|
356 | - return self::calculateImageData($wpdb_row, 'medium_large'); |
|
357 | - } |
|
358 | - |
|
359 | - |
|
360 | - /** |
|
361 | - * Gets the large image |
|
362 | - * |
|
363 | - * @param array $wpdb_row |
|
364 | - * @param WP_REST_Request $request |
|
365 | - * @param EventControllerBase $controller |
|
366 | - * @return array |
|
367 | - * @throws EE_Error |
|
368 | - */ |
|
369 | - public function imageLarge($wpdb_row, $request, $controller) |
|
370 | - { |
|
371 | - return self::calculateImageData($wpdb_row, 'large'); |
|
372 | - } |
|
373 | - |
|
374 | - |
|
375 | - /** |
|
376 | - * Gets the post-thumbnail image |
|
377 | - * |
|
378 | - * @param array $wpdb_row |
|
379 | - * @param WP_REST_Request $request |
|
380 | - * @param EventControllerBase $controller |
|
381 | - * @return array |
|
382 | - * @throws EE_Error |
|
383 | - */ |
|
384 | - public function imagePostThumbnail($wpdb_row, $request, $controller) |
|
385 | - { |
|
386 | - return self::calculateImageData($wpdb_row, 'post-thumbnail'); |
|
387 | - } |
|
388 | - |
|
389 | - |
|
390 | - /** |
|
391 | - * Gets the full size image |
|
392 | - * |
|
393 | - * @param array $wpdb_row |
|
394 | - * @param WP_REST_Request $request |
|
395 | - * @param EventControllerBase $controller |
|
396 | - * @return array |
|
397 | - * @throws EE_Error |
|
398 | - */ |
|
399 | - public function imageFull($wpdb_row, $request, $controller) |
|
400 | - { |
|
401 | - return self::calculateImageData($wpdb_row, 'full'); |
|
402 | - } |
|
403 | - |
|
404 | - |
|
405 | - /** |
|
406 | - * Gets image specs and formats them for the display in the API, |
|
407 | - * according to the image size requested |
|
408 | - * |
|
409 | - * @param array $wpdb_row |
|
410 | - * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full |
|
411 | - * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original' |
|
412 | - * @throws EE_Error |
|
413 | - */ |
|
414 | - protected function calculateImageData($wpdb_row, $image_size) |
|
415 | - { |
|
416 | - if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
417 | - throw new EE_Error( |
|
418 | - sprintf( |
|
419 | - __( |
|
420 | - // @codingStandardsIgnoreStart |
|
421 | - 'Cannot calculate image because the database row %1$s does not have an entry for "Event_CPT.ID"', |
|
422 | - // @codingStandardsIgnoreEnd |
|
423 | - 'event_espresso' |
|
424 | - ), |
|
425 | - print_r($wpdb_row, true) |
|
426 | - ) |
|
427 | - ); |
|
428 | - } |
|
429 | - $EVT_ID = $wpdb_row['Event_CPT.ID']; |
|
430 | - $attachment_id = get_post_thumbnail_id($EVT_ID); |
|
431 | - $data = wp_get_attachment_image_src($attachment_id, $image_size); |
|
432 | - if (! $data) { |
|
433 | - return null; |
|
434 | - } |
|
435 | - $generated = true; |
|
436 | - if (isset($data[3])) { |
|
437 | - $generated = $data[3]; |
|
438 | - } |
|
439 | - return array( |
|
440 | - 'url' => $data[0], |
|
441 | - 'width' => $data[1], |
|
442 | - 'height' => $data[2], |
|
443 | - 'generated' => $generated, |
|
444 | - ); |
|
445 | - } |
|
446 | - |
|
447 | - |
|
448 | - /** |
|
449 | - * Returns true if the array of data contains 'Event_CPT.ID'. False otherwise |
|
450 | - * |
|
451 | - * @param array $wpdb_row |
|
452 | - * @return bool |
|
453 | - */ |
|
454 | - protected function wpdbRowHasEventId($wpdb_row) |
|
455 | - { |
|
456 | - return (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID']) && absint($wpdb_row['Event_CPT.ID'])); |
|
457 | - } |
|
458 | - |
|
459 | - |
|
460 | - /** |
|
461 | - * Provides an array for all the calculations possible that outlines a json schema for those calculations. |
|
462 | - * Array is indexed by calculation (snake case) and value is the schema for that calculation. |
|
463 | - * |
|
464 | - * @since 4.9.68.p |
|
465 | - * @return array |
|
466 | - */ |
|
467 | - public function schemaForCalculations() |
|
468 | - { |
|
469 | - $image_object_properties = array( |
|
470 | - 'url' => array( |
|
471 | - 'type' => 'string', |
|
472 | - ), |
|
473 | - 'width' => array( |
|
474 | - 'type' => 'number', |
|
475 | - ), |
|
476 | - 'height' => array( |
|
477 | - 'type' => 'number', |
|
478 | - ), |
|
479 | - 'generated' => array( |
|
480 | - 'type' => 'boolean', |
|
481 | - ), |
|
482 | - ); |
|
483 | - return array( |
|
484 | - 'optimum_sales_at_start' => array( |
|
485 | - 'description' => esc_html__( |
|
486 | - 'The total spaces on the event (not subtracting sales, but taking sales into account; so this is the optimum sales that CAN still be achieved.', |
|
487 | - 'event_espresso' |
|
488 | - ), |
|
489 | - 'type' => 'number', |
|
490 | - 'protected' => true, |
|
491 | - ), |
|
492 | - 'optimum_sales_now' => array( |
|
493 | - 'description' => esc_html__( |
|
494 | - 'The total spaces on the event (ignoring all sales; so this is the optimum sales that could have been achieved.', |
|
495 | - 'event_espresso' |
|
496 | - ), |
|
497 | - 'type' => 'number', |
|
498 | - 'protected' => true, |
|
499 | - ), |
|
500 | - 'spaces_remaining' => array( |
|
501 | - 'description' => esc_html__( |
|
502 | - 'The optimum_sales_number result, minus total sales so far.', |
|
503 | - 'event_espresso' |
|
504 | - ), |
|
505 | - 'type' => 'number', |
|
506 | - 'protected' => true, |
|
507 | - ), |
|
508 | - 'spots_taken' => array( |
|
509 | - 'description' => esc_html__( |
|
510 | - 'The number of approved registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)', |
|
511 | - 'event_espresso' |
|
512 | - ), |
|
513 | - 'type' => 'number', |
|
514 | - 'protected' => true, |
|
515 | - ), |
|
516 | - 'spots_taken_pending_payment' => array( |
|
517 | - 'description' => esc_html__( |
|
518 | - 'The number of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)', |
|
519 | - 'event_espresso' |
|
520 | - ), |
|
521 | - 'type' => 'number', |
|
522 | - 'protected' => true, |
|
523 | - ), |
|
524 | - 'registrations_checked_in_count' => array( |
|
525 | - 'description' => esc_html__( |
|
526 | - 'The count of all the registrations who have checked into one of this event\'s datetimes.', |
|
527 | - 'event_espresso' |
|
528 | - ), |
|
529 | - 'type' => 'number', |
|
530 | - 'protected' => true, |
|
531 | - ), |
|
532 | - 'registrations_checked_out_count' => array( |
|
533 | - 'description' => esc_html__( |
|
534 | - 'The count of all registrations who have checked out of one of this event\'s datetimes.', |
|
535 | - 'event_espresso' |
|
536 | - ), |
|
537 | - 'type' => 'number', |
|
538 | - 'protected' => true, |
|
539 | - ), |
|
540 | - 'image_thumbnail' => array( |
|
541 | - 'description' => esc_html__( |
|
542 | - 'The thumbnail image data.', |
|
543 | - 'event_espresso' |
|
544 | - ), |
|
545 | - 'type' => 'object', |
|
546 | - 'properties' => $image_object_properties, |
|
547 | - 'additionalProperties' => false, |
|
548 | - ), |
|
549 | - 'image_medium' => array( |
|
550 | - 'description' => esc_html__( |
|
551 | - 'The medium image data.', |
|
552 | - 'event_espresso' |
|
553 | - ), |
|
554 | - 'type' => 'object', |
|
555 | - 'properties' => $image_object_properties, |
|
556 | - 'additionalProperties' => false, |
|
557 | - ), |
|
558 | - 'image_medium_large' => array( |
|
559 | - 'description' => esc_html__( |
|
560 | - 'The medium-large image data.', |
|
561 | - 'event_espresso' |
|
562 | - ), |
|
563 | - 'type' => 'object', |
|
564 | - 'properties' => $image_object_properties, |
|
565 | - 'additionalProperties' => false, |
|
566 | - ), |
|
567 | - 'image_large' => array( |
|
568 | - 'description' => esc_html__( |
|
569 | - 'The large image data.', |
|
570 | - 'event_espresso' |
|
571 | - ), |
|
572 | - 'type' => 'object', |
|
573 | - 'properties' => $image_object_properties, |
|
574 | - 'additionalProperties' => false, |
|
575 | - ), |
|
576 | - 'image_post_thumbnail' => array( |
|
577 | - 'description' => esc_html__( |
|
578 | - 'The post-thumbnail image data.', |
|
579 | - 'event_espresso' |
|
580 | - ), |
|
581 | - 'type' => 'object', |
|
582 | - 'properties' => $image_object_properties, |
|
583 | - 'additionalProperties' => false, |
|
584 | - ), |
|
585 | - 'image_full' => array( |
|
586 | - 'description' => esc_html__( |
|
587 | - 'The full size image data', |
|
588 | - 'event_espresso' |
|
589 | - ), |
|
590 | - 'type' => 'object', |
|
591 | - 'properties' => $image_object_properties, |
|
592 | - 'additionalProperties' => false, |
|
593 | - ), |
|
594 | - ); |
|
595 | - } |
|
29 | + /** |
|
30 | + * @var EEM_Event |
|
31 | + */ |
|
32 | + protected $event_model; |
|
33 | + |
|
34 | + /** |
|
35 | + * @var EEM_Registration |
|
36 | + */ |
|
37 | + protected $registration_model; |
|
38 | + public function __construct(EEM_Event $event_model, EEM_Registration $registration_model) |
|
39 | + { |
|
40 | + $this->event_model = $event_model; |
|
41 | + $this->registration_model = $registration_model; |
|
42 | + } |
|
43 | + |
|
44 | + /** |
|
45 | + * Calculates the total spaces on the event (not subtracting sales, but taking |
|
46 | + * sales into account; so this is the optimum sales that CAN still be achieved) |
|
47 | + * See EE_Event::total_available_spaces( true ); |
|
48 | + * |
|
49 | + * @param array $wpdb_row |
|
50 | + * @param WP_REST_Request $request |
|
51 | + * @param EventControllerBase $controller |
|
52 | + * @return int |
|
53 | + * @throws EE_Error |
|
54 | + * @throws DomainException |
|
55 | + * @throws InvalidDataTypeException |
|
56 | + * @throws InvalidInterfaceException |
|
57 | + * @throws UnexpectedEntityException |
|
58 | + * @throws InvalidArgumentException |
|
59 | + */ |
|
60 | + public function optimumSalesAtStart($wpdb_row, $request, $controller) |
|
61 | + { |
|
62 | + $event_obj = null; |
|
63 | + if (Event::wpdbRowHasEventId($wpdb_row)) { |
|
64 | + $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']); |
|
65 | + } |
|
66 | + if ($event_obj instanceof EE_Event) { |
|
67 | + return $event_obj->total_available_spaces(); |
|
68 | + } |
|
69 | + throw new EE_Error( |
|
70 | + sprintf( |
|
71 | + __( |
|
72 | + // @codingStandardsIgnoreStart |
|
73 | + 'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found', |
|
74 | + // @codingStandardsIgnoreEnd |
|
75 | + 'event_espresso' |
|
76 | + ), |
|
77 | + $wpdb_row['Event_CPT.ID'], |
|
78 | + print_r($wpdb_row, true) |
|
79 | + ) |
|
80 | + ); |
|
81 | + } |
|
82 | + |
|
83 | + |
|
84 | + /** |
|
85 | + * Calculates the total spaces on the event (ignoring all sales; so this is the optimum |
|
86 | + * sales that COULD have been achieved) |
|
87 | + * See EE_Event::total_available_spaces( true ); |
|
88 | + * |
|
89 | + * @param array $wpdb_row |
|
90 | + * @param WP_REST_Request $request |
|
91 | + * @param EventControllerBase $controller |
|
92 | + * @return int |
|
93 | + * @throws DomainException |
|
94 | + * @throws EE_Error |
|
95 | + * @throws InvalidArgumentException |
|
96 | + * @throws InvalidDataTypeException |
|
97 | + * @throws InvalidInterfaceException |
|
98 | + * @throws UnexpectedEntityException |
|
99 | + */ |
|
100 | + public function optimumSalesNow($wpdb_row, $request, $controller) |
|
101 | + { |
|
102 | + $event_obj = null; |
|
103 | + if (Event::wpdbRowHasEventId($wpdb_row)) { |
|
104 | + $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']); |
|
105 | + } |
|
106 | + if ($event_obj instanceof EE_Event) { |
|
107 | + return $event_obj->total_available_spaces(true); |
|
108 | + } |
|
109 | + throw new EE_Error( |
|
110 | + sprintf( |
|
111 | + __( |
|
112 | + // @codingStandardsIgnoreStart |
|
113 | + 'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found', |
|
114 | + // @codingStandardsIgnoreEnd |
|
115 | + 'event_espresso' |
|
116 | + ), |
|
117 | + $wpdb_row['Event_CPT.ID'], |
|
118 | + print_r($wpdb_row, true) |
|
119 | + ) |
|
120 | + ); |
|
121 | + } |
|
122 | + |
|
123 | + |
|
124 | + /** |
|
125 | + * Like optimum_sales_now, but minus total sales so far. |
|
126 | + * See EE_Event::spaces_remaining_for_sale( true ); |
|
127 | + * |
|
128 | + * @param array $wpdb_row |
|
129 | + * @param WP_REST_Request $request |
|
130 | + * @param EventControllerBase $controller |
|
131 | + * @return int |
|
132 | + * @throws DomainException |
|
133 | + * @throws EE_Error |
|
134 | + * @throws InvalidArgumentException |
|
135 | + * @throws InvalidDataTypeException |
|
136 | + * @throws InvalidInterfaceException |
|
137 | + * @throws UnexpectedEntityException |
|
138 | + */ |
|
139 | + public function spacesRemaining($wpdb_row, $request, $controller) |
|
140 | + { |
|
141 | + $event_obj = null; |
|
142 | + if (Event::wpdbRowHasEventId($wpdb_row)) { |
|
143 | + $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']); |
|
144 | + } |
|
145 | + if ($event_obj instanceof EE_Event) { |
|
146 | + return $event_obj->spaces_remaining_for_sale(); |
|
147 | + } |
|
148 | + throw new EE_Error( |
|
149 | + sprintf( |
|
150 | + __( |
|
151 | + // @codingStandardsIgnoreStart |
|
152 | + 'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found', |
|
153 | + // @codingStandardsIgnoreEnd |
|
154 | + 'event_espresso' |
|
155 | + ), |
|
156 | + $wpdb_row['Event_CPT.ID'], |
|
157 | + print_r($wpdb_row, true) |
|
158 | + ) |
|
159 | + ); |
|
160 | + } |
|
161 | + |
|
162 | + |
|
163 | + /** |
|
164 | + * Counts the number of approved registrations for this event (regardless |
|
165 | + * of how many datetimes each registrations' ticket purchase is for) |
|
166 | + * |
|
167 | + * @param array $wpdb_row |
|
168 | + * @param WP_REST_Request $request |
|
169 | + * @param EventControllerBase $controller |
|
170 | + * @return int |
|
171 | + * @throws EE_Error |
|
172 | + * @throws InvalidArgumentException |
|
173 | + * @throws InvalidDataTypeException |
|
174 | + * @throws InvalidInterfaceException |
|
175 | + */ |
|
176 | + public function spotsTaken($wpdb_row, $request, $controller) |
|
177 | + { |
|
178 | + if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
179 | + throw new EE_Error( |
|
180 | + sprintf( |
|
181 | + __( |
|
182 | + // @codingStandardsIgnoreStart |
|
183 | + 'Cannot calculate spots_taken because the database row %1$s does not have a valid entry for "Event_CPT.ID"', |
|
184 | + // @codingStandardsIgnoreEnd |
|
185 | + 'event_espresso' |
|
186 | + ), |
|
187 | + print_r($wpdb_row, true) |
|
188 | + ) |
|
189 | + ); |
|
190 | + } |
|
191 | + return $this->registration_model->count( |
|
192 | + array( |
|
193 | + array( |
|
194 | + 'EVT_ID' => $wpdb_row['Event_CPT.ID'], |
|
195 | + 'STS_ID' => EEM_Registration::status_id_approved, |
|
196 | + ), |
|
197 | + ), |
|
198 | + 'REG_ID', |
|
199 | + true |
|
200 | + ); |
|
201 | + } |
|
202 | + |
|
203 | + |
|
204 | + /** |
|
205 | + * Counts the number of pending-payment registrations for this event (regardless |
|
206 | + * of how many datetimes each registrations' ticket purchase is for) |
|
207 | + * |
|
208 | + * @param array $wpdb_row |
|
209 | + * @param WP_REST_Request $request |
|
210 | + * @param EventControllerBase $controller |
|
211 | + * @return int |
|
212 | + * @throws EE_Error |
|
213 | + * @throws InvalidArgumentException |
|
214 | + * @throws InvalidDataTypeException |
|
215 | + * @throws InvalidInterfaceException |
|
216 | + * @throws RestException |
|
217 | + */ |
|
218 | + public function spotsTakenPendingPayment($wpdb_row, $request, $controller) |
|
219 | + { |
|
220 | + if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
221 | + throw new EE_Error( |
|
222 | + sprintf( |
|
223 | + __( |
|
224 | + // @codingStandardsIgnoreStart |
|
225 | + 'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"', |
|
226 | + // @codingStandardsIgnoreEnd |
|
227 | + 'event_espresso' |
|
228 | + ), |
|
229 | + print_r($wpdb_row, true) |
|
230 | + ) |
|
231 | + ); |
|
232 | + } |
|
233 | + $this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment'); |
|
234 | + return $this->registration_model->count( |
|
235 | + array( |
|
236 | + array( |
|
237 | + 'EVT_ID' => $wpdb_row['Event_CPT.ID'], |
|
238 | + 'STS_ID' => EEM_Registration::status_id_pending_payment, |
|
239 | + ), |
|
240 | + ), |
|
241 | + 'REG_ID', |
|
242 | + true |
|
243 | + ); |
|
244 | + } |
|
245 | + |
|
246 | + |
|
247 | + /** |
|
248 | + * Counts all the registrations who have checked into one of this events' datetimes |
|
249 | + * See EE_Event::total_available_spaces( false ); |
|
250 | + * |
|
251 | + * @param array $wpdb_row |
|
252 | + * @param WP_REST_Request $request |
|
253 | + * @param EventControllerBase $controller |
|
254 | + * @return int|null if permission denied |
|
255 | + * @throws EE_Error |
|
256 | + * @throws InvalidArgumentException |
|
257 | + * @throws InvalidDataTypeException |
|
258 | + * @throws InvalidInterfaceException |
|
259 | + * @throws RestException |
|
260 | + */ |
|
261 | + public function registrationsCheckedInCount($wpdb_row, $request, $controller) |
|
262 | + { |
|
263 | + if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
264 | + throw new EE_Error( |
|
265 | + sprintf( |
|
266 | + __( |
|
267 | + // @codingStandardsIgnoreStart |
|
268 | + 'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"', |
|
269 | + // @codingStandardsIgnoreEnd |
|
270 | + 'event_espresso' |
|
271 | + ), |
|
272 | + print_r($wpdb_row, true) |
|
273 | + ) |
|
274 | + ); |
|
275 | + } |
|
276 | + $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count'); |
|
277 | + return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true); |
|
278 | + } |
|
279 | + |
|
280 | + |
|
281 | + /** |
|
282 | + * Counts all the registrations who have checked out of one of this events' datetimes |
|
283 | + * See EE_Event::total_available_spaces( false ); |
|
284 | + * |
|
285 | + * @param array $wpdb_row |
|
286 | + * @param WP_REST_Request $request |
|
287 | + * @param EventControllerBase $controller |
|
288 | + * @return int |
|
289 | + * @throws EE_Error |
|
290 | + * @throws InvalidArgumentException |
|
291 | + * @throws InvalidDataTypeException |
|
292 | + * @throws InvalidInterfaceException |
|
293 | + * @throws RestException |
|
294 | + */ |
|
295 | + public function registrationsCheckedOutCount($wpdb_row, $request, $controller) |
|
296 | + { |
|
297 | + if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
298 | + throw new EE_Error( |
|
299 | + sprintf( |
|
300 | + __( |
|
301 | + // @codingStandardsIgnoreStart |
|
302 | + 'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"', |
|
303 | + // @codingStandardsIgnoreEnd |
|
304 | + 'event_espresso' |
|
305 | + ), |
|
306 | + print_r($wpdb_row, true) |
|
307 | + ) |
|
308 | + ); |
|
309 | + } |
|
310 | + $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count'); |
|
311 | + return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false); |
|
312 | + } |
|
313 | + |
|
314 | + |
|
315 | + /** |
|
316 | + * Gets the thumbnail image |
|
317 | + * |
|
318 | + * @param array $wpdb_row |
|
319 | + * @param WP_REST_Request $request |
|
320 | + * @param EventControllerBase $controller |
|
321 | + * @return array |
|
322 | + * @throws EE_Error |
|
323 | + */ |
|
324 | + public function imageThumbnail($wpdb_row, $request, $controller) |
|
325 | + { |
|
326 | + return self::calculateImageData($wpdb_row, 'thumbnail'); |
|
327 | + } |
|
328 | + |
|
329 | + |
|
330 | + /** |
|
331 | + * Gets the medium image |
|
332 | + * |
|
333 | + * @param array $wpdb_row |
|
334 | + * @param WP_REST_Request $request |
|
335 | + * @param EventControllerBase $controller |
|
336 | + * @return array |
|
337 | + * @throws EE_Error |
|
338 | + */ |
|
339 | + public function imageMedium($wpdb_row, $request, $controller) |
|
340 | + { |
|
341 | + return self::calculateImageData($wpdb_row, 'medium'); |
|
342 | + } |
|
343 | + |
|
344 | + |
|
345 | + /** |
|
346 | + * Gets the medium-large image |
|
347 | + * |
|
348 | + * @param array $wpdb_row |
|
349 | + * @param WP_REST_Request $request |
|
350 | + * @param EventControllerBase $controller |
|
351 | + * @return array |
|
352 | + * @throws EE_Error |
|
353 | + */ |
|
354 | + public function imageMediumLarge($wpdb_row, $request, $controller) |
|
355 | + { |
|
356 | + return self::calculateImageData($wpdb_row, 'medium_large'); |
|
357 | + } |
|
358 | + |
|
359 | + |
|
360 | + /** |
|
361 | + * Gets the large image |
|
362 | + * |
|
363 | + * @param array $wpdb_row |
|
364 | + * @param WP_REST_Request $request |
|
365 | + * @param EventControllerBase $controller |
|
366 | + * @return array |
|
367 | + * @throws EE_Error |
|
368 | + */ |
|
369 | + public function imageLarge($wpdb_row, $request, $controller) |
|
370 | + { |
|
371 | + return self::calculateImageData($wpdb_row, 'large'); |
|
372 | + } |
|
373 | + |
|
374 | + |
|
375 | + /** |
|
376 | + * Gets the post-thumbnail image |
|
377 | + * |
|
378 | + * @param array $wpdb_row |
|
379 | + * @param WP_REST_Request $request |
|
380 | + * @param EventControllerBase $controller |
|
381 | + * @return array |
|
382 | + * @throws EE_Error |
|
383 | + */ |
|
384 | + public function imagePostThumbnail($wpdb_row, $request, $controller) |
|
385 | + { |
|
386 | + return self::calculateImageData($wpdb_row, 'post-thumbnail'); |
|
387 | + } |
|
388 | + |
|
389 | + |
|
390 | + /** |
|
391 | + * Gets the full size image |
|
392 | + * |
|
393 | + * @param array $wpdb_row |
|
394 | + * @param WP_REST_Request $request |
|
395 | + * @param EventControllerBase $controller |
|
396 | + * @return array |
|
397 | + * @throws EE_Error |
|
398 | + */ |
|
399 | + public function imageFull($wpdb_row, $request, $controller) |
|
400 | + { |
|
401 | + return self::calculateImageData($wpdb_row, 'full'); |
|
402 | + } |
|
403 | + |
|
404 | + |
|
405 | + /** |
|
406 | + * Gets image specs and formats them for the display in the API, |
|
407 | + * according to the image size requested |
|
408 | + * |
|
409 | + * @param array $wpdb_row |
|
410 | + * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full |
|
411 | + * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original' |
|
412 | + * @throws EE_Error |
|
413 | + */ |
|
414 | + protected function calculateImageData($wpdb_row, $image_size) |
|
415 | + { |
|
416 | + if (! Event::wpdbRowHasEventId($wpdb_row)) { |
|
417 | + throw new EE_Error( |
|
418 | + sprintf( |
|
419 | + __( |
|
420 | + // @codingStandardsIgnoreStart |
|
421 | + 'Cannot calculate image because the database row %1$s does not have an entry for "Event_CPT.ID"', |
|
422 | + // @codingStandardsIgnoreEnd |
|
423 | + 'event_espresso' |
|
424 | + ), |
|
425 | + print_r($wpdb_row, true) |
|
426 | + ) |
|
427 | + ); |
|
428 | + } |
|
429 | + $EVT_ID = $wpdb_row['Event_CPT.ID']; |
|
430 | + $attachment_id = get_post_thumbnail_id($EVT_ID); |
|
431 | + $data = wp_get_attachment_image_src($attachment_id, $image_size); |
|
432 | + if (! $data) { |
|
433 | + return null; |
|
434 | + } |
|
435 | + $generated = true; |
|
436 | + if (isset($data[3])) { |
|
437 | + $generated = $data[3]; |
|
438 | + } |
|
439 | + return array( |
|
440 | + 'url' => $data[0], |
|
441 | + 'width' => $data[1], |
|
442 | + 'height' => $data[2], |
|
443 | + 'generated' => $generated, |
|
444 | + ); |
|
445 | + } |
|
446 | + |
|
447 | + |
|
448 | + /** |
|
449 | + * Returns true if the array of data contains 'Event_CPT.ID'. False otherwise |
|
450 | + * |
|
451 | + * @param array $wpdb_row |
|
452 | + * @return bool |
|
453 | + */ |
|
454 | + protected function wpdbRowHasEventId($wpdb_row) |
|
455 | + { |
|
456 | + return (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID']) && absint($wpdb_row['Event_CPT.ID'])); |
|
457 | + } |
|
458 | + |
|
459 | + |
|
460 | + /** |
|
461 | + * Provides an array for all the calculations possible that outlines a json schema for those calculations. |
|
462 | + * Array is indexed by calculation (snake case) and value is the schema for that calculation. |
|
463 | + * |
|
464 | + * @since 4.9.68.p |
|
465 | + * @return array |
|
466 | + */ |
|
467 | + public function schemaForCalculations() |
|
468 | + { |
|
469 | + $image_object_properties = array( |
|
470 | + 'url' => array( |
|
471 | + 'type' => 'string', |
|
472 | + ), |
|
473 | + 'width' => array( |
|
474 | + 'type' => 'number', |
|
475 | + ), |
|
476 | + 'height' => array( |
|
477 | + 'type' => 'number', |
|
478 | + ), |
|
479 | + 'generated' => array( |
|
480 | + 'type' => 'boolean', |
|
481 | + ), |
|
482 | + ); |
|
483 | + return array( |
|
484 | + 'optimum_sales_at_start' => array( |
|
485 | + 'description' => esc_html__( |
|
486 | + 'The total spaces on the event (not subtracting sales, but taking sales into account; so this is the optimum sales that CAN still be achieved.', |
|
487 | + 'event_espresso' |
|
488 | + ), |
|
489 | + 'type' => 'number', |
|
490 | + 'protected' => true, |
|
491 | + ), |
|
492 | + 'optimum_sales_now' => array( |
|
493 | + 'description' => esc_html__( |
|
494 | + 'The total spaces on the event (ignoring all sales; so this is the optimum sales that could have been achieved.', |
|
495 | + 'event_espresso' |
|
496 | + ), |
|
497 | + 'type' => 'number', |
|
498 | + 'protected' => true, |
|
499 | + ), |
|
500 | + 'spaces_remaining' => array( |
|
501 | + 'description' => esc_html__( |
|
502 | + 'The optimum_sales_number result, minus total sales so far.', |
|
503 | + 'event_espresso' |
|
504 | + ), |
|
505 | + 'type' => 'number', |
|
506 | + 'protected' => true, |
|
507 | + ), |
|
508 | + 'spots_taken' => array( |
|
509 | + 'description' => esc_html__( |
|
510 | + 'The number of approved registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)', |
|
511 | + 'event_espresso' |
|
512 | + ), |
|
513 | + 'type' => 'number', |
|
514 | + 'protected' => true, |
|
515 | + ), |
|
516 | + 'spots_taken_pending_payment' => array( |
|
517 | + 'description' => esc_html__( |
|
518 | + 'The number of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)', |
|
519 | + 'event_espresso' |
|
520 | + ), |
|
521 | + 'type' => 'number', |
|
522 | + 'protected' => true, |
|
523 | + ), |
|
524 | + 'registrations_checked_in_count' => array( |
|
525 | + 'description' => esc_html__( |
|
526 | + 'The count of all the registrations who have checked into one of this event\'s datetimes.', |
|
527 | + 'event_espresso' |
|
528 | + ), |
|
529 | + 'type' => 'number', |
|
530 | + 'protected' => true, |
|
531 | + ), |
|
532 | + 'registrations_checked_out_count' => array( |
|
533 | + 'description' => esc_html__( |
|
534 | + 'The count of all registrations who have checked out of one of this event\'s datetimes.', |
|
535 | + 'event_espresso' |
|
536 | + ), |
|
537 | + 'type' => 'number', |
|
538 | + 'protected' => true, |
|
539 | + ), |
|
540 | + 'image_thumbnail' => array( |
|
541 | + 'description' => esc_html__( |
|
542 | + 'The thumbnail image data.', |
|
543 | + 'event_espresso' |
|
544 | + ), |
|
545 | + 'type' => 'object', |
|
546 | + 'properties' => $image_object_properties, |
|
547 | + 'additionalProperties' => false, |
|
548 | + ), |
|
549 | + 'image_medium' => array( |
|
550 | + 'description' => esc_html__( |
|
551 | + 'The medium image data.', |
|
552 | + 'event_espresso' |
|
553 | + ), |
|
554 | + 'type' => 'object', |
|
555 | + 'properties' => $image_object_properties, |
|
556 | + 'additionalProperties' => false, |
|
557 | + ), |
|
558 | + 'image_medium_large' => array( |
|
559 | + 'description' => esc_html__( |
|
560 | + 'The medium-large image data.', |
|
561 | + 'event_espresso' |
|
562 | + ), |
|
563 | + 'type' => 'object', |
|
564 | + 'properties' => $image_object_properties, |
|
565 | + 'additionalProperties' => false, |
|
566 | + ), |
|
567 | + 'image_large' => array( |
|
568 | + 'description' => esc_html__( |
|
569 | + 'The large image data.', |
|
570 | + 'event_espresso' |
|
571 | + ), |
|
572 | + 'type' => 'object', |
|
573 | + 'properties' => $image_object_properties, |
|
574 | + 'additionalProperties' => false, |
|
575 | + ), |
|
576 | + 'image_post_thumbnail' => array( |
|
577 | + 'description' => esc_html__( |
|
578 | + 'The post-thumbnail image data.', |
|
579 | + 'event_espresso' |
|
580 | + ), |
|
581 | + 'type' => 'object', |
|
582 | + 'properties' => $image_object_properties, |
|
583 | + 'additionalProperties' => false, |
|
584 | + ), |
|
585 | + 'image_full' => array( |
|
586 | + 'description' => esc_html__( |
|
587 | + 'The full size image data', |
|
588 | + 'event_espresso' |
|
589 | + ), |
|
590 | + 'type' => 'object', |
|
591 | + 'properties' => $image_object_properties, |
|
592 | + 'additionalProperties' => false, |
|
593 | + ), |
|
594 | + ); |
|
595 | + } |
|
596 | 596 | } |