Completed
Branch FET/update-docs-for-gutenberg-... (ee954a)
by
unknown
62:44 queued 53:37
created
core/db_models/relations/EE_HABTM_Relation.php 1 patch
Indentation   +234 added lines, -234 removed lines patch added patch discarded remove patch
@@ -9,261 +9,261 @@
 block discarded – undo
9 9
  */
10 10
 class EE_HABTM_Relation extends EE_Model_Relation_Base
11 11
 {
12
-    /**
13
-     * Model which defines the relation between two other models. Eg, the EE_Event_Question_Group model,
14
-     * which joins EE_Event and EE_Question_Group
15
-     *
16
-     * @var EEM_Base
17
-     */
18
-    protected $_joining_model_name;
12
+	/**
13
+	 * Model which defines the relation between two other models. Eg, the EE_Event_Question_Group model,
14
+	 * which joins EE_Event and EE_Question_Group
15
+	 *
16
+	 * @var EEM_Base
17
+	 */
18
+	protected $_joining_model_name;
19 19
 
20
-    protected $_model_relation_chain_to_join_model;
20
+	protected $_model_relation_chain_to_join_model;
21 21
 
22 22
 
23
-    /**
24
-     * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
25
-     * (and an ee joining-model.) This knows how to join the models,
26
-     * get related models across the relation, and add-and-remove the relationships.
27
-     *
28
-     * @param bool    $joining_model_name
29
-     * @param boolean $block_deletes                 for this type of relation, we block by default for now. if there
30
-     *                                               are related models across this relation, block (prevent and add an
31
-     *                                               error) the deletion of this model
32
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
33
-     *                                               default
34
-     */
35
-    public function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '')
36
-    {
37
-        $this->_joining_model_name = $joining_model_name;
38
-        parent::__construct($block_deletes, $blocking_delete_error_message);
39
-    }
23
+	/**
24
+	 * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
25
+	 * (and an ee joining-model.) This knows how to join the models,
26
+	 * get related models across the relation, and add-and-remove the relationships.
27
+	 *
28
+	 * @param bool    $joining_model_name
29
+	 * @param boolean $block_deletes                 for this type of relation, we block by default for now. if there
30
+	 *                                               are related models across this relation, block (prevent and add an
31
+	 *                                               error) the deletion of this model
32
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
33
+	 *                                               default
34
+	 */
35
+	public function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '')
36
+	{
37
+		$this->_joining_model_name = $joining_model_name;
38
+		parent::__construct($block_deletes, $blocking_delete_error_message);
39
+	}
40 40
 
41
-    /**
42
-     * Gets the joining model's object
43
-     *
44
-     * @return EEM_Base
45
-     */
46
-    public function get_join_model()
47
-    {
48
-        return $this->_get_model($this->_joining_model_name);
49
-    }
41
+	/**
42
+	 * Gets the joining model's object
43
+	 *
44
+	 * @return EEM_Base
45
+	 */
46
+	public function get_join_model()
47
+	{
48
+		return $this->_get_model($this->_joining_model_name);
49
+	}
50 50
 
51 51
 
52
-    /**
53
-     * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
54
-     * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
55
-     *
56
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
57
-     * @return string of SQL
58
-     * @throws \EE_Error
59
-     */
60
-    public function get_join_to_intermediate_model_statement($model_relation_chain)
61
-    {
62
-        // create sql like
63
-        // LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
64
-        // LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
65
-        // remember the model relation chain to the JOIN model, because we'll
66
-        // need it for get_join_statement()
67
-        $this->_model_relation_chain_to_join_model = $model_relation_chain;
68
-        $this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();// get_foreign_key_to($this->get_other_model()->get_this_model_name());
69
-        $join_table_fk_field_to_this_table         = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
70
-        $this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
71
-            $model_relation_chain,
72
-            $this->get_this_model()->get_this_model_name()
73
-        ) . $this_table_pk_field->get_table_alias();
52
+	/**
53
+	 * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
54
+	 * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
55
+	 *
56
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
57
+	 * @return string of SQL
58
+	 * @throws \EE_Error
59
+	 */
60
+	public function get_join_to_intermediate_model_statement($model_relation_chain)
61
+	{
62
+		// create sql like
63
+		// LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
64
+		// LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
65
+		// remember the model relation chain to the JOIN model, because we'll
66
+		// need it for get_join_statement()
67
+		$this->_model_relation_chain_to_join_model = $model_relation_chain;
68
+		$this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();// get_foreign_key_to($this->get_other_model()->get_this_model_name());
69
+		$join_table_fk_field_to_this_table         = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
70
+		$this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
71
+			$model_relation_chain,
72
+			$this->get_this_model()->get_this_model_name()
73
+		) . $this_table_pk_field->get_table_alias();
74 74
 
75
-        $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
76
-            $model_relation_chain,
77
-            $this->get_join_model()->get_this_model_name()
78
-        ) . $join_table_fk_field_to_this_table->get_table_alias();
79
-        $join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
80
-        // phew! ok, we have all the info we need, now we can create the SQL join string
81
-        $SQL = $this->_left_join(
82
-            $join_table,
83
-            $join_table_alias,
84
-            $join_table_fk_field_to_this_table->get_table_column(),
85
-            $this_table_alias,
86
-            $this_table_pk_field->get_table_column()
87
-        ) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
75
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
76
+			$model_relation_chain,
77
+			$this->get_join_model()->get_this_model_name()
78
+		) . $join_table_fk_field_to_this_table->get_table_alias();
79
+		$join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
80
+		// phew! ok, we have all the info we need, now we can create the SQL join string
81
+		$SQL = $this->_left_join(
82
+			$join_table,
83
+			$join_table_alias,
84
+			$join_table_fk_field_to_this_table->get_table_column(),
85
+			$this_table_alias,
86
+			$this_table_pk_field->get_table_column()
87
+		) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
88 88
 
89
-        return $SQL;
90
-    }
89
+		return $SQL;
90
+	}
91 91
 
92 92
 
93
-    /**
94
-     * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
95
-     * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
96
-     * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
97
-     * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
98
-     * the intermediate join table, and then to the other model's pk's table
99
-     *
100
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
101
-     * @return string of SQL
102
-     * @throws \EE_Error
103
-     */
104
-    public function get_join_statement($model_relation_chain)
105
-    {
106
-        if ($this->_model_relation_chain_to_join_model === null) {
107
-            throw new EE_Error(sprintf(__(
108
-                'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
109
-                'event_espresso'
110
-            )));
111
-        }
112
-        $join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
113
-        $join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
114
-            $this->_model_relation_chain_to_join_model,
115
-            $this->get_join_model()->get_this_model_name()
116
-        ) . $join_table_fk_field_to_this_table->get_table_alias();
117
-        $other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
118
-        $join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
119
-        $other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
120
-            $model_relation_chain,
121
-            $this->get_other_model()->get_this_model_name()
122
-        ) . $other_table_pk_field->get_table_alias();
123
-        $other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
93
+	/**
94
+	 * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
95
+	 * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
96
+	 * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
97
+	 * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
98
+	 * the intermediate join table, and then to the other model's pk's table
99
+	 *
100
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
101
+	 * @return string of SQL
102
+	 * @throws \EE_Error
103
+	 */
104
+	public function get_join_statement($model_relation_chain)
105
+	{
106
+		if ($this->_model_relation_chain_to_join_model === null) {
107
+			throw new EE_Error(sprintf(__(
108
+				'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
109
+				'event_espresso'
110
+			)));
111
+		}
112
+		$join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
113
+		$join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
114
+			$this->_model_relation_chain_to_join_model,
115
+			$this->get_join_model()->get_this_model_name()
116
+		) . $join_table_fk_field_to_this_table->get_table_alias();
117
+		$other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
118
+		$join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
119
+		$other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
120
+			$model_relation_chain,
121
+			$this->get_other_model()->get_this_model_name()
122
+		) . $other_table_pk_field->get_table_alias();
123
+		$other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
124 124
 
125
-        $SQL = $this->_left_join(
126
-            $other_table,
127
-            $other_table_alias,
128
-            $other_table_pk_field->get_table_column(),
129
-            $join_table_alias,
130
-            $join_table_fk_field_to_other_table->get_table_column()
131
-        ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
132
-        return $SQL;
133
-    }
125
+		$SQL = $this->_left_join(
126
+			$other_table,
127
+			$other_table_alias,
128
+			$other_table_pk_field->get_table_column(),
129
+			$join_table_alias,
130
+			$join_table_fk_field_to_other_table->get_table_column()
131
+		) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
132
+		return $SQL;
133
+	}
134 134
 
135 135
 
136
-    /**
137
-     * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
138
-     * If the join table has additional columns (eg, the Event_Question_Group table has a is_primary column), then
139
-     * you'll want to directly use the EEM_Event_Question_Group model to add the entry to the table and set those extra
140
-     * columns' values
141
-     *
142
-     * @param EE_Base_Class|int $this_obj_or_id
143
-     * @param EE_Base_Class|int $other_obj_or_id
144
-     * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
145
-     *                                                            checking existing values and for setting new rows if
146
-     *                                                            no exact matches.
147
-     * @return EE_Base_Class
148
-     * @throws \EE_Error
149
-     */
150
-    public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
151
-    {
152
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
153
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
154
-        // check if such a relationship already exists
155
-        $join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
156
-        $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
136
+	/**
137
+	 * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
138
+	 * If the join table has additional columns (eg, the Event_Question_Group table has a is_primary column), then
139
+	 * you'll want to directly use the EEM_Event_Question_Group model to add the entry to the table and set those extra
140
+	 * columns' values
141
+	 *
142
+	 * @param EE_Base_Class|int $this_obj_or_id
143
+	 * @param EE_Base_Class|int $other_obj_or_id
144
+	 * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
145
+	 *                                                            checking existing values and for setting new rows if
146
+	 *                                                            no exact matches.
147
+	 * @return EE_Base_Class
148
+	 * @throws \EE_Error
149
+	 */
150
+	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
151
+	{
152
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
153
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
154
+		// check if such a relationship already exists
155
+		$join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
156
+		$join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
157 157
 
158
-        $foreign_keys = $all_fields = array(
159
-            $join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
160
-            $join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
161
-        );
158
+		$foreign_keys = $all_fields = array(
159
+			$join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
160
+			$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
161
+		);
162 162
 
163
-        // if $where_query exists lets add them to the query_params.
164
-        if (! empty($extra_join_model_fields_n_values)) {
165
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
166
-            // make sure we strip THIS models name from the query param
167
-            $parsed_query = array();
168
-            foreach ($extra_join_model_fields_n_values as $query_param => $val) {
169
-                $query_param                = str_replace(
170
-                    $this->get_join_model()->get_this_model_name() . ".",
171
-                    "",
172
-                    $query_param
173
-                );
174
-                $parsed_query[ $query_param ] = $val;
175
-            }
176
-            $all_fields = array_merge($foreign_keys, $parsed_query);
177
-        }
163
+		// if $where_query exists lets add them to the query_params.
164
+		if (! empty($extra_join_model_fields_n_values)) {
165
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
166
+			// make sure we strip THIS models name from the query param
167
+			$parsed_query = array();
168
+			foreach ($extra_join_model_fields_n_values as $query_param => $val) {
169
+				$query_param                = str_replace(
170
+					$this->get_join_model()->get_this_model_name() . ".",
171
+					"",
172
+					$query_param
173
+				);
174
+				$parsed_query[ $query_param ] = $val;
175
+			}
176
+			$all_fields = array_merge($foreign_keys, $parsed_query);
177
+		}
178 178
 
179
-        $existing_entry_in_join_table = $this->get_join_model()->get_one(array($all_fields));
180
-        // If there is already an entry in the join table, indicating a relationship, update it instead of adding a
181
-        // new row.
182
-        // Again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
183
-        // the other tables) use the joining model directly!
184
-        if (! $existing_entry_in_join_table) {
185
-            $this->get_join_model()->insert($all_fields);
186
-        }
187
-        return $other_model_obj;
188
-    }
179
+		$existing_entry_in_join_table = $this->get_join_model()->get_one(array($all_fields));
180
+		// If there is already an entry in the join table, indicating a relationship, update it instead of adding a
181
+		// new row.
182
+		// Again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
183
+		// the other tables) use the joining model directly!
184
+		if (! $existing_entry_in_join_table) {
185
+			$this->get_join_model()->insert($all_fields);
186
+		}
187
+		return $other_model_obj;
188
+	}
189 189
 
190 190
 
191
-    /**
192
-     * Deletes any rows in the join table that have foreign keys matching the other model objects specified
193
-     *
194
-     * @param EE_Base_Class|int $this_obj_or_id
195
-     * @param EE_Base_Class|int $other_obj_or_id
196
-     * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
197
-     *                                       values and for removing existing rows if exact matches exist.
198
-     * @return EE_Base_Class
199
-     * @throws \EE_Error
200
-     */
201
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
202
-    {
203
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
204
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
205
-        // check if such a relationship already exists
206
-        $join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
207
-        $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
191
+	/**
192
+	 * Deletes any rows in the join table that have foreign keys matching the other model objects specified
193
+	 *
194
+	 * @param EE_Base_Class|int $this_obj_or_id
195
+	 * @param EE_Base_Class|int $other_obj_or_id
196
+	 * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
197
+	 *                                       values and for removing existing rows if exact matches exist.
198
+	 * @return EE_Base_Class
199
+	 * @throws \EE_Error
200
+	 */
201
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
202
+	{
203
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
204
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
205
+		// check if such a relationship already exists
206
+		$join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
207
+		$join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
208 208
 
209
-        $cols_n_values = array(
210
-            $join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
211
-            $join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
212
-        );
209
+		$cols_n_values = array(
210
+			$join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
211
+			$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
212
+		);
213 213
 
214
-        // if $where_query exists lets add them to the query_params.
215
-        if (! empty($where_query)) {
216
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
217
-            // make sure we strip THIS models name from the query param
218
-            $parsed_query = array();
219
-            foreach ($where_query as $query_param => $val) {
220
-                $query_param                = str_replace(
221
-                    $this->get_join_model()->get_this_model_name() . ".",
222
-                    "",
223
-                    $query_param
224
-                );
225
-                $parsed_query[ $query_param ] = $val;
226
-            }
227
-            $cols_n_values = array_merge($cols_n_values, $parsed_query);
228
-        }
214
+		// if $where_query exists lets add them to the query_params.
215
+		if (! empty($where_query)) {
216
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
217
+			// make sure we strip THIS models name from the query param
218
+			$parsed_query = array();
219
+			foreach ($where_query as $query_param => $val) {
220
+				$query_param                = str_replace(
221
+					$this->get_join_model()->get_this_model_name() . ".",
222
+					"",
223
+					$query_param
224
+				);
225
+				$parsed_query[ $query_param ] = $val;
226
+			}
227
+			$cols_n_values = array_merge($cols_n_values, $parsed_query);
228
+		}
229 229
 
230
-        $this->get_join_model()->delete(array($cols_n_values));
231
-        return $other_model_obj;
232
-    }
230
+		$this->get_join_model()->delete(array($cols_n_values));
231
+		return $other_model_obj;
232
+	}
233 233
 
234
-    /**
235
-     * Gets all the non-key fields (ie, not the primary key and not foreign keys) on the join model.
236
-     * @since 4.9.76.p
237
-     * @return EE_Model_Field_Base[]
238
-     * @throws EE_Error
239
-     */
240
-    public function getNonKeyFields()
241
-    {
242
-        // all fields besides the primary key and two foreign keys should be parameters
243
-        $join_model = $this->get_join_model();
244
-        $standard_fields = array();
245
-        if ($join_model->has_primary_key_field()) {
246
-            $standard_fields[] = $join_model->primary_key_name();
247
-        }
248
-        if ($this->get_this_model()->has_primary_key_field()) {
249
-            $standard_fields[] = $this->get_this_model()->primary_key_name();
250
-        }
251
-        if ($this->get_other_model()->has_primary_key_field()) {
252
-            $standard_fields[] = $this->get_other_model()->primary_key_name();
253
-        }
254
-        return array_diff_key(
255
-            $join_model->field_settings(),
256
-            array_flip($standard_fields)
257
-        );
258
-    }
234
+	/**
235
+	 * Gets all the non-key fields (ie, not the primary key and not foreign keys) on the join model.
236
+	 * @since 4.9.76.p
237
+	 * @return EE_Model_Field_Base[]
238
+	 * @throws EE_Error
239
+	 */
240
+	public function getNonKeyFields()
241
+	{
242
+		// all fields besides the primary key and two foreign keys should be parameters
243
+		$join_model = $this->get_join_model();
244
+		$standard_fields = array();
245
+		if ($join_model->has_primary_key_field()) {
246
+			$standard_fields[] = $join_model->primary_key_name();
247
+		}
248
+		if ($this->get_this_model()->has_primary_key_field()) {
249
+			$standard_fields[] = $this->get_this_model()->primary_key_name();
250
+		}
251
+		if ($this->get_other_model()->has_primary_key_field()) {
252
+			$standard_fields[] = $this->get_other_model()->primary_key_name();
253
+		}
254
+		return array_diff_key(
255
+			$join_model->field_settings(),
256
+			array_flip($standard_fields)
257
+		);
258
+	}
259 259
 
260
-    /**
261
-     * Returns true if the join model has non-key fields (ie, fields that aren't the primary key or foreign keys.)
262
-     * @since 4.9.76.p
263
-     * @return boolean
264
-     */
265
-    public function hasNonKeyFields()
266
-    {
267
-        return count($this->get_join_model()->field_settings()) > 3;
268
-    }
260
+	/**
261
+	 * Returns true if the join model has non-key fields (ie, fields that aren't the primary key or foreign keys.)
262
+	 * @since 4.9.76.p
263
+	 * @return boolean
264
+	 */
265
+	public function hasNonKeyFields()
266
+	{
267
+		return count($this->get_join_model()->field_settings()) > 3;
268
+	}
269 269
 }
Please login to merge, or discard this patch.
core/libraries/rest_api/controllers/model/Write.php 1 patch
Indentation   +546 added lines, -546 removed lines patch added patch discarded remove patch
@@ -39,573 +39,573 @@
 block discarded – undo
39 39
 {
40 40
 
41 41
 
42
-    public function __construct()
43
-    {
44
-        parent::__construct();
45
-        EE_Registry::instance()->load_helper('Inflector');
46
-    }
42
+	public function __construct()
43
+	{
44
+		parent::__construct();
45
+		EE_Registry::instance()->load_helper('Inflector');
46
+	}
47 47
 
48 48
 
49
-    /**
50
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
51
-     *
52
-     * @param WP_REST_Request $request
53
-     * @param string          $version
54
-     * @param string          $model_name
55
-     * @return WP_REST_Response|\WP_Error
56
-     */
57
-    public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name)
58
-    {
59
-        $controller = new Write();
60
-        try {
61
-            $controller->setRequestedVersion($version);
62
-            return $controller->sendResponse(
63
-                $controller->insert(
64
-                    $controller->getModelVersionInfo()->loadModel($model_name),
65
-                    $request
66
-                )
67
-            );
68
-        } catch (Exception $e) {
69
-            return $controller->sendResponse($e);
70
-        }
71
-    }
49
+	/**
50
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
51
+	 *
52
+	 * @param WP_REST_Request $request
53
+	 * @param string          $version
54
+	 * @param string          $model_name
55
+	 * @return WP_REST_Response|\WP_Error
56
+	 */
57
+	public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name)
58
+	{
59
+		$controller = new Write();
60
+		try {
61
+			$controller->setRequestedVersion($version);
62
+			return $controller->sendResponse(
63
+				$controller->insert(
64
+					$controller->getModelVersionInfo()->loadModel($model_name),
65
+					$request
66
+				)
67
+			);
68
+		} catch (Exception $e) {
69
+			return $controller->sendResponse($e);
70
+		}
71
+	}
72 72
 
73 73
 
74
-    /**
75
-     * Handles a request from \WP_REST_Server to update an EE model
76
-     *
77
-     * @param WP_REST_Request $request
78
-     * @param string          $version
79
-     * @param string          $model_name
80
-     * @return WP_REST_Response|\WP_Error
81
-     */
82
-    public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name)
83
-    {
84
-        $controller = new Write();
85
-        try {
86
-            $controller->setRequestedVersion($version);
87
-            return $controller->sendResponse(
88
-                $controller->update(
89
-                    $controller->getModelVersionInfo()->loadModel($model_name),
90
-                    $request
91
-                )
92
-            );
93
-        } catch (Exception $e) {
94
-            return $controller->sendResponse($e);
95
-        }
96
-    }
74
+	/**
75
+	 * Handles a request from \WP_REST_Server to update an EE model
76
+	 *
77
+	 * @param WP_REST_Request $request
78
+	 * @param string          $version
79
+	 * @param string          $model_name
80
+	 * @return WP_REST_Response|\WP_Error
81
+	 */
82
+	public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name)
83
+	{
84
+		$controller = new Write();
85
+		try {
86
+			$controller->setRequestedVersion($version);
87
+			return $controller->sendResponse(
88
+				$controller->update(
89
+					$controller->getModelVersionInfo()->loadModel($model_name),
90
+					$request
91
+				)
92
+			);
93
+		} catch (Exception $e) {
94
+			return $controller->sendResponse($e);
95
+		}
96
+	}
97 97
 
98 98
 
99
-    /**
100
-     * Deletes a single model object and returns it. Unless
101
-     *
102
-     * @param WP_REST_Request $request
103
-     * @param string          $version
104
-     * @param string          $model_name
105
-     * @return WP_REST_Response|\WP_Error
106
-     */
107
-    public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name)
108
-    {
109
-        $controller = new Write();
110
-        try {
111
-            $controller->setRequestedVersion($version);
112
-            return $controller->sendResponse(
113
-                $controller->delete(
114
-                    $controller->getModelVersionInfo()->loadModel($model_name),
115
-                    $request
116
-                )
117
-            );
118
-        } catch (Exception $e) {
119
-            return $controller->sendResponse($e);
120
-        }
121
-    }
99
+	/**
100
+	 * Deletes a single model object and returns it. Unless
101
+	 *
102
+	 * @param WP_REST_Request $request
103
+	 * @param string          $version
104
+	 * @param string          $model_name
105
+	 * @return WP_REST_Response|\WP_Error
106
+	 */
107
+	public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name)
108
+	{
109
+		$controller = new Write();
110
+		try {
111
+			$controller->setRequestedVersion($version);
112
+			return $controller->sendResponse(
113
+				$controller->delete(
114
+					$controller->getModelVersionInfo()->loadModel($model_name),
115
+					$request
116
+				)
117
+			);
118
+		} catch (Exception $e) {
119
+			return $controller->sendResponse($e);
120
+		}
121
+	}
122 122
 
123 123
 
124
-    /**
125
-     * Inserts a new model object according to the $request
126
-     *
127
-     * @param EEM_Base        $model
128
-     * @param WP_REST_Request $request
129
-     * @return array
130
-     * @throws EE_Error
131
-     * @throws RestException
132
-     */
133
-    public function insert(EEM_Base $model, WP_REST_Request $request)
134
-    {
135
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
136
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
137
-        if (! current_user_can($default_cap_to_check_for)) {
138
-            throw new RestException(
139
-                'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
140
-                sprintf(
141
-                    esc_html__(
142
-                    // @codingStandardsIgnoreStart
143
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.',
144
-                        // @codingStandardsIgnoreEnd
145
-                        'event_espresso'
146
-                    ),
147
-                    $default_cap_to_check_for
148
-                ),
149
-                array('status' => 403)
150
-            );
151
-        }
152
-        $submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params());
153
-        $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
154
-            $submitted_json_data,
155
-            $model,
156
-            $this->getModelVersionInfo()->requestedVersion(),
157
-            true
158
-        );
159
-        $model_obj = EE_Registry::instance()->load_class(
160
-            $model->get_this_model_name(),
161
-            array($model_data, $model->get_timezone()),
162
-            false,
163
-            false
164
-        );
165
-        $model_obj->save();
166
-        $new_id = $model_obj->ID();
167
-        if (! $new_id) {
168
-            throw new RestException(
169
-                'rest_insertion_failed',
170
-                sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
171
-            );
172
-        }
173
-        return $this->returnModelObjAsJsonResponse($model_obj, $request);
174
-    }
124
+	/**
125
+	 * Inserts a new model object according to the $request
126
+	 *
127
+	 * @param EEM_Base        $model
128
+	 * @param WP_REST_Request $request
129
+	 * @return array
130
+	 * @throws EE_Error
131
+	 * @throws RestException
132
+	 */
133
+	public function insert(EEM_Base $model, WP_REST_Request $request)
134
+	{
135
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
136
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
137
+		if (! current_user_can($default_cap_to_check_for)) {
138
+			throw new RestException(
139
+				'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
140
+				sprintf(
141
+					esc_html__(
142
+					// @codingStandardsIgnoreStart
143
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.',
144
+						// @codingStandardsIgnoreEnd
145
+						'event_espresso'
146
+					),
147
+					$default_cap_to_check_for
148
+				),
149
+				array('status' => 403)
150
+			);
151
+		}
152
+		$submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params());
153
+		$model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
154
+			$submitted_json_data,
155
+			$model,
156
+			$this->getModelVersionInfo()->requestedVersion(),
157
+			true
158
+		);
159
+		$model_obj = EE_Registry::instance()->load_class(
160
+			$model->get_this_model_name(),
161
+			array($model_data, $model->get_timezone()),
162
+			false,
163
+			false
164
+		);
165
+		$model_obj->save();
166
+		$new_id = $model_obj->ID();
167
+		if (! $new_id) {
168
+			throw new RestException(
169
+				'rest_insertion_failed',
170
+				sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
171
+			);
172
+		}
173
+		return $this->returnModelObjAsJsonResponse($model_obj, $request);
174
+	}
175 175
 
176 176
 
177
-    /**
178
-     * Updates an existing model object according to the $request
179
-     *
180
-     * @param EEM_Base        $model
181
-     * @param WP_REST_Request $request
182
-     * @return array
183
-     * @throws EE_Error
184
-     */
185
-    public function update(EEM_Base $model, WP_REST_Request $request)
186
-    {
187
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
188
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
189
-        if (! current_user_can($default_cap_to_check_for)) {
190
-            throw new RestException(
191
-                'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
192
-                sprintf(
193
-                    esc_html__(
194
-                    // @codingStandardsIgnoreStart
195
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.',
196
-                        // @codingStandardsIgnoreEnd
197
-                        'event_espresso'
198
-                    ),
199
-                    $default_cap_to_check_for
200
-                ),
201
-                array('status' => 403)
202
-            );
203
-        }
204
-        $obj_id = $request->get_param('id');
205
-        if (! $obj_id) {
206
-            throw new RestException(
207
-                'rest_edit_failed',
208
-                sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
209
-            );
210
-        }
211
-        $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
212
-            $this->getBodyParams($request),
213
-            $model,
214
-            $this->getModelVersionInfo()->requestedVersion(),
215
-            true
216
-        );
217
-        $model_obj = $model->get_one_by_ID($obj_id);
218
-        if (! $model_obj instanceof EE_Base_Class) {
219
-            $lowercase_model_name = strtolower($model->get_this_model_name());
220
-            throw new RestException(
221
-                sprintf('rest_%s_invalid_id', $lowercase_model_name),
222
-                sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
223
-                array('status' => 404)
224
-            );
225
-        }
226
-        $model_obj->save($model_data);
227
-        return $this->returnModelObjAsJsonResponse($model_obj, $request);
228
-    }
177
+	/**
178
+	 * Updates an existing model object according to the $request
179
+	 *
180
+	 * @param EEM_Base        $model
181
+	 * @param WP_REST_Request $request
182
+	 * @return array
183
+	 * @throws EE_Error
184
+	 */
185
+	public function update(EEM_Base $model, WP_REST_Request $request)
186
+	{
187
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
188
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
189
+		if (! current_user_can($default_cap_to_check_for)) {
190
+			throw new RestException(
191
+				'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
192
+				sprintf(
193
+					esc_html__(
194
+					// @codingStandardsIgnoreStart
195
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.',
196
+						// @codingStandardsIgnoreEnd
197
+						'event_espresso'
198
+					),
199
+					$default_cap_to_check_for
200
+				),
201
+				array('status' => 403)
202
+			);
203
+		}
204
+		$obj_id = $request->get_param('id');
205
+		if (! $obj_id) {
206
+			throw new RestException(
207
+				'rest_edit_failed',
208
+				sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
209
+			);
210
+		}
211
+		$model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
212
+			$this->getBodyParams($request),
213
+			$model,
214
+			$this->getModelVersionInfo()->requestedVersion(),
215
+			true
216
+		);
217
+		$model_obj = $model->get_one_by_ID($obj_id);
218
+		if (! $model_obj instanceof EE_Base_Class) {
219
+			$lowercase_model_name = strtolower($model->get_this_model_name());
220
+			throw new RestException(
221
+				sprintf('rest_%s_invalid_id', $lowercase_model_name),
222
+				sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
223
+				array('status' => 404)
224
+			);
225
+		}
226
+		$model_obj->save($model_data);
227
+		return $this->returnModelObjAsJsonResponse($model_obj, $request);
228
+	}
229 229
 
230 230
 
231
-    /**
232
-     * Updates an existing model object according to the $request
233
-     *
234
-     * @param EEM_Base        $model
235
-     * @param WP_REST_Request $request
236
-     * @return array of either the soft-deleted item, or
237
-     * @throws EE_Error
238
-     */
239
-    public function delete(EEM_Base $model, WP_REST_Request $request)
240
-    {
241
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
242
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
243
-        if (! current_user_can($default_cap_to_check_for)) {
244
-            throw new RestException(
245
-                'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
246
-                sprintf(
247
-                    esc_html__(
248
-                    // @codingStandardsIgnoreStart
249
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.',
250
-                        // @codingStandardsIgnoreEnd
251
-                        'event_espresso'
252
-                    ),
253
-                    $default_cap_to_check_for
254
-                ),
255
-                array('status' => 403)
256
-            );
257
-        }
258
-        $obj_id = $request->get_param('id');
259
-        // this is where we would apply more fine-grained caps
260
-        $model_obj = $model->get_one_by_ID($obj_id);
261
-        if (! $model_obj instanceof EE_Base_Class) {
262
-            $lowercase_model_name = strtolower($model->get_this_model_name());
263
-            throw new RestException(
264
-                sprintf('rest_%s_invalid_id', $lowercase_model_name),
265
-                sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
266
-                array('status' => 404)
267
-            );
268
-        }
269
-        $requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN);
270
-        $requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
271
-        if ($requested_permanent_delete) {
272
-            $previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
273
-            $deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
274
-            return array(
275
-                'deleted'  => $deleted,
276
-                'previous' => $previous,
277
-            );
278
-        } else {
279
-            if ($model instanceof EEM_Soft_Delete_Base) {
280
-                $model->delete_by_ID($obj_id, $requested_allow_blocking);
281
-                return $this->returnModelObjAsJsonResponse($model_obj, $request);
282
-            } else {
283
-                throw new RestException(
284
-                    'rest_trash_not_supported',
285
-                    501,
286
-                    sprintf(
287
-                        esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'),
288
-                        EEH_Inflector::pluralize($model->get_this_model_name())
289
-                    )
290
-                );
291
-            }
292
-        }
293
-    }
231
+	/**
232
+	 * Updates an existing model object according to the $request
233
+	 *
234
+	 * @param EEM_Base        $model
235
+	 * @param WP_REST_Request $request
236
+	 * @return array of either the soft-deleted item, or
237
+	 * @throws EE_Error
238
+	 */
239
+	public function delete(EEM_Base $model, WP_REST_Request $request)
240
+	{
241
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
242
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
243
+		if (! current_user_can($default_cap_to_check_for)) {
244
+			throw new RestException(
245
+				'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
246
+				sprintf(
247
+					esc_html__(
248
+					// @codingStandardsIgnoreStart
249
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.',
250
+						// @codingStandardsIgnoreEnd
251
+						'event_espresso'
252
+					),
253
+					$default_cap_to_check_for
254
+				),
255
+				array('status' => 403)
256
+			);
257
+		}
258
+		$obj_id = $request->get_param('id');
259
+		// this is where we would apply more fine-grained caps
260
+		$model_obj = $model->get_one_by_ID($obj_id);
261
+		if (! $model_obj instanceof EE_Base_Class) {
262
+			$lowercase_model_name = strtolower($model->get_this_model_name());
263
+			throw new RestException(
264
+				sprintf('rest_%s_invalid_id', $lowercase_model_name),
265
+				sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
266
+				array('status' => 404)
267
+			);
268
+		}
269
+		$requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN);
270
+		$requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
271
+		if ($requested_permanent_delete) {
272
+			$previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
273
+			$deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
274
+			return array(
275
+				'deleted'  => $deleted,
276
+				'previous' => $previous,
277
+			);
278
+		} else {
279
+			if ($model instanceof EEM_Soft_Delete_Base) {
280
+				$model->delete_by_ID($obj_id, $requested_allow_blocking);
281
+				return $this->returnModelObjAsJsonResponse($model_obj, $request);
282
+			} else {
283
+				throw new RestException(
284
+					'rest_trash_not_supported',
285
+					501,
286
+					sprintf(
287
+						esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'),
288
+						EEH_Inflector::pluralize($model->get_this_model_name())
289
+					)
290
+				);
291
+			}
292
+		}
293
+	}
294 294
 
295 295
 
296
-    /**
297
-     * Returns an array ready to be converted into a JSON response, based solely on the model object
298
-     *
299
-     * @param EE_Base_Class   $model_obj
300
-     * @param WP_REST_Request $request
301
-     * @return array ready for a response
302
-     */
303
-    protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request)
304
-    {
305
-        $model = $model_obj->get_model();
306
-        // create an array exactly like the wpdb results row,
307
-        // so we can pass it to controllers/model/Read::create_entity_from_wpdb_result()
308
-        $simulated_db_row = array();
309
-        foreach ($model->field_settings(true) as $field_name => $field_obj) {
310
-            // we need to reconstruct the normal wpdb results, including the db-only fields
311
-            // like a secondary table's primary key. The models expect those (but don't care what value they have)
312
-            if ($field_obj instanceof EE_DB_Only_Field_Base) {
313
-                $raw_value = true;
314
-            } elseif ($field_obj instanceof EE_Datetime_Field) {
315
-                $raw_value = $model_obj->get_DateTime_object($field_name);
316
-            } else {
317
-                $raw_value = $model_obj->get_raw($field_name);
318
-            }
319
-            $simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value);
320
-        }
321
-        $read_controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
322
-        $read_controller->setRequestedVersion($this->getRequestedVersion());
323
-        // the simulates request really doesn't need any info downstream
324
-        $simulated_request = new WP_REST_Request('GET');
325
-        // set the caps context on the simulated according to the original request.
326
-        switch ($request->get_method()) {
327
-            case 'POST':
328
-            case 'PUT':
329
-                $caps_context = EEM_Base::caps_edit;
330
-                break;
331
-            case 'DELETE':
332
-                $caps_context = EEM_Base::caps_delete;
333
-                break;
334
-            default:
335
-                $caps_context = EEM_Base::caps_read_admin;
336
-        }
337
-        $simulated_request->set_param('caps', $caps_context);
338
-        return $read_controller->createEntityFromWpdbResult(
339
-            $model_obj->get_model(),
340
-            $simulated_db_row,
341
-            $simulated_request
342
-        );
343
-    }
296
+	/**
297
+	 * Returns an array ready to be converted into a JSON response, based solely on the model object
298
+	 *
299
+	 * @param EE_Base_Class   $model_obj
300
+	 * @param WP_REST_Request $request
301
+	 * @return array ready for a response
302
+	 */
303
+	protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request)
304
+	{
305
+		$model = $model_obj->get_model();
306
+		// create an array exactly like the wpdb results row,
307
+		// so we can pass it to controllers/model/Read::create_entity_from_wpdb_result()
308
+		$simulated_db_row = array();
309
+		foreach ($model->field_settings(true) as $field_name => $field_obj) {
310
+			// we need to reconstruct the normal wpdb results, including the db-only fields
311
+			// like a secondary table's primary key. The models expect those (but don't care what value they have)
312
+			if ($field_obj instanceof EE_DB_Only_Field_Base) {
313
+				$raw_value = true;
314
+			} elseif ($field_obj instanceof EE_Datetime_Field) {
315
+				$raw_value = $model_obj->get_DateTime_object($field_name);
316
+			} else {
317
+				$raw_value = $model_obj->get_raw($field_name);
318
+			}
319
+			$simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value);
320
+		}
321
+		$read_controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
322
+		$read_controller->setRequestedVersion($this->getRequestedVersion());
323
+		// the simulates request really doesn't need any info downstream
324
+		$simulated_request = new WP_REST_Request('GET');
325
+		// set the caps context on the simulated according to the original request.
326
+		switch ($request->get_method()) {
327
+			case 'POST':
328
+			case 'PUT':
329
+				$caps_context = EEM_Base::caps_edit;
330
+				break;
331
+			case 'DELETE':
332
+				$caps_context = EEM_Base::caps_delete;
333
+				break;
334
+			default:
335
+				$caps_context = EEM_Base::caps_read_admin;
336
+		}
337
+		$simulated_request->set_param('caps', $caps_context);
338
+		return $read_controller->createEntityFromWpdbResult(
339
+			$model_obj->get_model(),
340
+			$simulated_db_row,
341
+			$simulated_request
342
+		);
343
+	}
344 344
 
345 345
 
346
-    /**
347
-     * Gets the item affected by this request
348
-     *
349
-     * @param EEM_Base        $model
350
-     * @param WP_REST_Request $request
351
-     * @param  int|string     $obj_id
352
-     * @return \WP_Error|array
353
-     */
354
-    protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id)
355
-    {
356
-        $requested_version = $this->getRequestedVersion($request->get_route());
357
-        $get_request = new WP_REST_Request(
358
-            'GET',
359
-            EED_Core_Rest_Api::ee_api_namespace
360
-            . $requested_version
361
-            . '/'
362
-            . EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
363
-            . '/'
364
-            . $obj_id
365
-        );
366
-        $get_request->set_url_params(
367
-            array(
368
-                'id'      => $obj_id,
369
-                'include' => $request->get_param('include'),
370
-            )
371
-        );
372
-        $read_controller = new Read();
373
-        $read_controller->setRequestedVersion($this->getRequestedVersion());
374
-        return $read_controller->getEntityFromModel($model, $get_request);
375
-    }
346
+	/**
347
+	 * Gets the item affected by this request
348
+	 *
349
+	 * @param EEM_Base        $model
350
+	 * @param WP_REST_Request $request
351
+	 * @param  int|string     $obj_id
352
+	 * @return \WP_Error|array
353
+	 */
354
+	protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id)
355
+	{
356
+		$requested_version = $this->getRequestedVersion($request->get_route());
357
+		$get_request = new WP_REST_Request(
358
+			'GET',
359
+			EED_Core_Rest_Api::ee_api_namespace
360
+			. $requested_version
361
+			. '/'
362
+			. EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
363
+			. '/'
364
+			. $obj_id
365
+		);
366
+		$get_request->set_url_params(
367
+			array(
368
+				'id'      => $obj_id,
369
+				'include' => $request->get_param('include'),
370
+			)
371
+		);
372
+		$read_controller = new Read();
373
+		$read_controller->setRequestedVersion($this->getRequestedVersion());
374
+		return $read_controller->getEntityFromModel($model, $get_request);
375
+	}
376 376
 
377
-    /**
378
-     * Adds a relation between the specified models (if it doesn't already exist.)
379
-     * @since 4.9.76.p
380
-     * @param WP_REST_Request $request
381
-     * @return WP_REST_Response
382
-     */
383
-    public static function handleRequestAddRelation(WP_REST_Request $request, $version, $model_name, $related_model_name)
384
-    {
385
-        $controller = new Write();
386
-        try {
387
-            $controller->setRequestedVersion($version);
388
-            $main_model = $controller->validateModel($model_name);
389
-            $controller->validateModel($related_model_name);
390
-            return $controller->sendResponse(
391
-                $controller->addRelation(
392
-                    $main_model,
393
-                    $main_model->related_settings_for($related_model_name),
394
-                    $request
395
-                )
396
-            );
397
-        } catch (Exception $e) {
398
-            return $controller->sendResponse($e);
399
-        }
400
-    }
377
+	/**
378
+	 * Adds a relation between the specified models (if it doesn't already exist.)
379
+	 * @since 4.9.76.p
380
+	 * @param WP_REST_Request $request
381
+	 * @return WP_REST_Response
382
+	 */
383
+	public static function handleRequestAddRelation(WP_REST_Request $request, $version, $model_name, $related_model_name)
384
+	{
385
+		$controller = new Write();
386
+		try {
387
+			$controller->setRequestedVersion($version);
388
+			$main_model = $controller->validateModel($model_name);
389
+			$controller->validateModel($related_model_name);
390
+			return $controller->sendResponse(
391
+				$controller->addRelation(
392
+					$main_model,
393
+					$main_model->related_settings_for($related_model_name),
394
+					$request
395
+				)
396
+			);
397
+		} catch (Exception $e) {
398
+			return $controller->sendResponse($e);
399
+		}
400
+	}
401 401
 
402
-    /**
403
-     * Adds a relation between the two model specified model objects.
404
-     * @since 4.9.76.p
405
-     * @param EEM_Base $model
406
-     * @param EE_Model_Relation_Base $relation
407
-     * @param WP_REST_Request $request
408
-     * @return array
409
-     * @throws EE_Error
410
-     * @throws InvalidArgumentException
411
-     * @throws InvalidDataTypeException
412
-     * @throws InvalidInterfaceException
413
-     * @throws RestException
414
-     * @throws DomainException
415
-     */
416
-    public function addRelation(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
417
-    {
418
-        list($model_obj, $other_obj) = $this->getBothModelObjects($model, $relation, $request);
419
-        $extra_params = array();
420
-        if ($relation instanceof EE_HABTM_Relation) {
421
-            $extra_params = array_intersect_key(
422
-                ModelDataTranslator::prepareConditionsQueryParamsForModels(
423
-                    $request->get_body_params(),
424
-                    $relation->get_join_model(),
425
-                    $this->getModelVersionInfo()->requestedVersion(),
426
-                    true
427
-                ),
428
-                $relation->getNonKeyFields()
429
-            );
430
-        }
431
-        // Add a relation.
432
-        $related_obj = $model_obj->_add_relation_to(
433
-            $other_obj,
434
-            $relation->get_other_model()->get_this_model_name(),
435
-            $extra_params
436
-        );
437
-        $response = array(
438
-            strtolower($model->get_this_model_name()) => $this->returnModelObjAsJsonResponse($model_obj, $request),
439
-            strtolower($relation->get_other_model()->get_this_model_name()) => $this->returnModelObjAsJsonResponse($related_obj, $request),
440
-        );
441
-        if ($relation instanceof EE_HABTM_Relation) {
442
-            $join_model_obj = $relation->get_join_model()->get_one(
443
-                array(
444
-                    array(
445
-                        $model->primary_key_name() => $model_obj->ID(),
446
-                        $relation->get_other_model()->primary_key_name() => $related_obj->ID()
447
-                    )
448
-                )
449
-            );
450
-            $response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = $this->returnModelObjAsJsonResponse($join_model_obj, $request);
451
-        }
452
-        return $response;
453
-    }
402
+	/**
403
+	 * Adds a relation between the two model specified model objects.
404
+	 * @since 4.9.76.p
405
+	 * @param EEM_Base $model
406
+	 * @param EE_Model_Relation_Base $relation
407
+	 * @param WP_REST_Request $request
408
+	 * @return array
409
+	 * @throws EE_Error
410
+	 * @throws InvalidArgumentException
411
+	 * @throws InvalidDataTypeException
412
+	 * @throws InvalidInterfaceException
413
+	 * @throws RestException
414
+	 * @throws DomainException
415
+	 */
416
+	public function addRelation(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
417
+	{
418
+		list($model_obj, $other_obj) = $this->getBothModelObjects($model, $relation, $request);
419
+		$extra_params = array();
420
+		if ($relation instanceof EE_HABTM_Relation) {
421
+			$extra_params = array_intersect_key(
422
+				ModelDataTranslator::prepareConditionsQueryParamsForModels(
423
+					$request->get_body_params(),
424
+					$relation->get_join_model(),
425
+					$this->getModelVersionInfo()->requestedVersion(),
426
+					true
427
+				),
428
+				$relation->getNonKeyFields()
429
+			);
430
+		}
431
+		// Add a relation.
432
+		$related_obj = $model_obj->_add_relation_to(
433
+			$other_obj,
434
+			$relation->get_other_model()->get_this_model_name(),
435
+			$extra_params
436
+		);
437
+		$response = array(
438
+			strtolower($model->get_this_model_name()) => $this->returnModelObjAsJsonResponse($model_obj, $request),
439
+			strtolower($relation->get_other_model()->get_this_model_name()) => $this->returnModelObjAsJsonResponse($related_obj, $request),
440
+		);
441
+		if ($relation instanceof EE_HABTM_Relation) {
442
+			$join_model_obj = $relation->get_join_model()->get_one(
443
+				array(
444
+					array(
445
+						$model->primary_key_name() => $model_obj->ID(),
446
+						$relation->get_other_model()->primary_key_name() => $related_obj->ID()
447
+					)
448
+				)
449
+			);
450
+			$response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = $this->returnModelObjAsJsonResponse($join_model_obj, $request);
451
+		}
452
+		return $response;
453
+	}
454 454
 
455 455
 
456
-    /**
457
-     * Removes the relation between the specified models (if it exists).
458
-     * @since 4.9.76.p
459
-     * @param WP_REST_Request $request
460
-     * @return WP_REST_Response
461
-     */
462
-    public static function handleRequestRemoveRelation(WP_REST_Request $request, $version, $model_name, $related_model_name)
463
-    {
464
-        $controller = new Write();
465
-        try {
466
-            $controller->setRequestedVersion($version);
467
-            $main_model = $controller->getModelVersionInfo()->loadModel($model_name);
468
-            return $controller->sendResponse(
469
-                $controller->removeRelation(
470
-                    $main_model,
471
-                    $main_model->related_settings_for($related_model_name),
472
-                    $request
473
-                )
474
-            );
475
-        } catch (Exception $e) {
476
-            return $controller->sendResponse($e);
477
-        }
478
-    }
456
+	/**
457
+	 * Removes the relation between the specified models (if it exists).
458
+	 * @since 4.9.76.p
459
+	 * @param WP_REST_Request $request
460
+	 * @return WP_REST_Response
461
+	 */
462
+	public static function handleRequestRemoveRelation(WP_REST_Request $request, $version, $model_name, $related_model_name)
463
+	{
464
+		$controller = new Write();
465
+		try {
466
+			$controller->setRequestedVersion($version);
467
+			$main_model = $controller->getModelVersionInfo()->loadModel($model_name);
468
+			return $controller->sendResponse(
469
+				$controller->removeRelation(
470
+					$main_model,
471
+					$main_model->related_settings_for($related_model_name),
472
+					$request
473
+				)
474
+			);
475
+		} catch (Exception $e) {
476
+			return $controller->sendResponse($e);
477
+		}
478
+	}
479 479
 
480
-    /**
481
-     * Adds a relation between the two model specified model objects.
482
-     * @since 4.9.76.p
483
-     * @param EEM_Base $model
484
-     * @param EE_Model_Relation_Base $relation
485
-     * @param WP_REST_Request $request
486
-     * @return array
487
-     * @throws DomainException
488
-     * @throws EE_Error
489
-     * @throws InvalidArgumentException
490
-     * @throws InvalidDataTypeException
491
-     * @throws InvalidInterfaceException
492
-     * @throws RestException
493
-     */
494
-    public function removeRelation(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
495
-    {
496
-        // This endpoint doesn't accept body parameters (it's understandable to think it might, so let developers know
497
-        // up-front that it doesn't.)
498
-        if (!empty($request->get_body_params())) {
499
-            $body_params = $request->get_body_params();
500
-            throw new RestException(
501
-                'invalid_field',
502
-                sprintf(
503
-                    esc_html__('This endpoint doesn\'t accept post body arguments, you sent in %1$s', 'event_espresso'),
504
-                    implode(array_keys($body_params))
505
-                )
506
-            );
507
-        }
508
-        list($model_obj, $other_obj) = $this->getBothModelObjects($model, $relation, $request);
509
-        // Remember the old relation, if it used a join entry.
510
-        $join_model_obj = null;
511
-        if ($relation instanceof EE_HABTM_Relation) {
512
-            $join_model_obj = $relation->get_join_model()->get_one(
513
-                array(
514
-                    array(
515
-                        $model->primary_key_name() => $model_obj->ID(),
516
-                        $relation->get_other_model()->primary_key_name() => $other_obj->ID()
517
-                    )
518
-                )
519
-            );
520
-        }
521
-        // Remove the relation.
522
-        $related_obj = $model_obj->_remove_relation_to(
523
-            $other_obj,
524
-            $relation->get_other_model()->get_this_model_name()
525
-        );
526
-        $response = array(
527
-            strtolower($model->get_this_model_name()) => $this->returnModelObjAsJsonResponse($model_obj, $request),
528
-            strtolower($relation->get_other_model()->get_this_model_name()) => $this->returnModelObjAsJsonResponse($related_obj, $request),
529
-        );
530
-        if ($relation instanceof EE_HABTM_Relation) {
531
-            $join_model_obj_after_removal = $relation->get_join_model()->get_one(
532
-                array(
533
-                    array(
534
-                        $model->primary_key_name() => $model_obj->ID(),
535
-                        $relation->get_other_model()->primary_key_name() => $other_obj->ID()
536
-                    )
537
-                )
538
-            );
539
-            if ($join_model_obj instanceof EE_Base_Class) {
540
-                $response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = $this->returnModelObjAsJsonResponse($join_model_obj, $request);
541
-            } else {
542
-                $response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = null;
543
-            }
544
-        }
545
-        return $response;
546
-    }
480
+	/**
481
+	 * Adds a relation between the two model specified model objects.
482
+	 * @since 4.9.76.p
483
+	 * @param EEM_Base $model
484
+	 * @param EE_Model_Relation_Base $relation
485
+	 * @param WP_REST_Request $request
486
+	 * @return array
487
+	 * @throws DomainException
488
+	 * @throws EE_Error
489
+	 * @throws InvalidArgumentException
490
+	 * @throws InvalidDataTypeException
491
+	 * @throws InvalidInterfaceException
492
+	 * @throws RestException
493
+	 */
494
+	public function removeRelation(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
495
+	{
496
+		// This endpoint doesn't accept body parameters (it's understandable to think it might, so let developers know
497
+		// up-front that it doesn't.)
498
+		if (!empty($request->get_body_params())) {
499
+			$body_params = $request->get_body_params();
500
+			throw new RestException(
501
+				'invalid_field',
502
+				sprintf(
503
+					esc_html__('This endpoint doesn\'t accept post body arguments, you sent in %1$s', 'event_espresso'),
504
+					implode(array_keys($body_params))
505
+				)
506
+			);
507
+		}
508
+		list($model_obj, $other_obj) = $this->getBothModelObjects($model, $relation, $request);
509
+		// Remember the old relation, if it used a join entry.
510
+		$join_model_obj = null;
511
+		if ($relation instanceof EE_HABTM_Relation) {
512
+			$join_model_obj = $relation->get_join_model()->get_one(
513
+				array(
514
+					array(
515
+						$model->primary_key_name() => $model_obj->ID(),
516
+						$relation->get_other_model()->primary_key_name() => $other_obj->ID()
517
+					)
518
+				)
519
+			);
520
+		}
521
+		// Remove the relation.
522
+		$related_obj = $model_obj->_remove_relation_to(
523
+			$other_obj,
524
+			$relation->get_other_model()->get_this_model_name()
525
+		);
526
+		$response = array(
527
+			strtolower($model->get_this_model_name()) => $this->returnModelObjAsJsonResponse($model_obj, $request),
528
+			strtolower($relation->get_other_model()->get_this_model_name()) => $this->returnModelObjAsJsonResponse($related_obj, $request),
529
+		);
530
+		if ($relation instanceof EE_HABTM_Relation) {
531
+			$join_model_obj_after_removal = $relation->get_join_model()->get_one(
532
+				array(
533
+					array(
534
+						$model->primary_key_name() => $model_obj->ID(),
535
+						$relation->get_other_model()->primary_key_name() => $other_obj->ID()
536
+					)
537
+				)
538
+			);
539
+			if ($join_model_obj instanceof EE_Base_Class) {
540
+				$response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = $this->returnModelObjAsJsonResponse($join_model_obj, $request);
541
+			} else {
542
+				$response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = null;
543
+			}
544
+		}
545
+		return $response;
546
+	}
547 547
 
548
-    /**
549
-     * Gets the model objects indicated by the model, relation object, and request.
550
-     * Throws an exception if the first object doesn't exist, and currently if the related object also doesn't exist.
551
-     * However, this behaviour may change, as we may add support for simultaneously creating and relating data.
552
-     * @since 4.9.76.p
553
-     * @param EEM_Base $model
554
-     * @param EE_Model_Relation_Base $relation
555
-     * @param WP_REST_Request $request
556
-     * @return array {
557
-     * @type EE_Base_Class $model_obj
558
-     * @type EE_Base_Class|null $other_model_obj
559
-     * }
560
-     * @throws RestException
561
-     */
562
-    protected function getBothModelObjects(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
563
-    {
564
-        // Check generic caps. For now, we're only allowing access to this endpoint to full admins.
565
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
566
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
567
-        if (! current_user_can($default_cap_to_check_for)) {
568
-            throw new RestException(
569
-                'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
570
-                sprintf(
571
-                    esc_html__(
572
-                        // @codingStandardsIgnoreStart
573
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to add relations in Event Espresso.',
574
-                        // @codingStandardsIgnoreEnd
575
-                        'event_espresso'
576
-                    ),
577
-                    $default_cap_to_check_for
578
-                ),
579
-                array('status' => 403)
580
-            );
581
-        }
582
-        // Get the main model object.
583
-        $model_obj = $this->getOneOrThrowException($model, $request->get_param('id'));
584
-        // For now, we require the other model object to exist too. This might be relaxed later.
585
-        $other_obj = $this->getOneOrThrowException($relation->get_other_model(), $request->get_param('related_id'));
586
-        return array($model_obj,$other_obj);
587
-    }
548
+	/**
549
+	 * Gets the model objects indicated by the model, relation object, and request.
550
+	 * Throws an exception if the first object doesn't exist, and currently if the related object also doesn't exist.
551
+	 * However, this behaviour may change, as we may add support for simultaneously creating and relating data.
552
+	 * @since 4.9.76.p
553
+	 * @param EEM_Base $model
554
+	 * @param EE_Model_Relation_Base $relation
555
+	 * @param WP_REST_Request $request
556
+	 * @return array {
557
+	 * @type EE_Base_Class $model_obj
558
+	 * @type EE_Base_Class|null $other_model_obj
559
+	 * }
560
+	 * @throws RestException
561
+	 */
562
+	protected function getBothModelObjects(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
563
+	{
564
+		// Check generic caps. For now, we're only allowing access to this endpoint to full admins.
565
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
566
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
567
+		if (! current_user_can($default_cap_to_check_for)) {
568
+			throw new RestException(
569
+				'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
570
+				sprintf(
571
+					esc_html__(
572
+						// @codingStandardsIgnoreStart
573
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to add relations in Event Espresso.',
574
+						// @codingStandardsIgnoreEnd
575
+						'event_espresso'
576
+					),
577
+					$default_cap_to_check_for
578
+				),
579
+				array('status' => 403)
580
+			);
581
+		}
582
+		// Get the main model object.
583
+		$model_obj = $this->getOneOrThrowException($model, $request->get_param('id'));
584
+		// For now, we require the other model object to exist too. This might be relaxed later.
585
+		$other_obj = $this->getOneOrThrowException($relation->get_other_model(), $request->get_param('related_id'));
586
+		return array($model_obj,$other_obj);
587
+	}
588 588
 
589
-    /**
590
-     * Gets the model with that ID or throws a REST exception.
591
-     * @since 4.9.76.p
592
-     * @param EEM_Base $model
593
-     * @param $id
594
-     * @return EE_Base_Class
595
-     * @throws RestException
596
-     */
597
-    protected function getOneOrThrowException(EEM_Base $model, $id)
598
-    {
599
-        $model_obj = $model->get_one_by_ID($id);
600
-        // @todo: check they can permission for it. For now unnecessary because only full admins can use this endpoint.
601
-        if ($model_obj instanceof EE_Base_Class) {
602
-            return $model_obj;
603
-        }
604
-        $lowercase_model_name = strtolower($model->get_this_model_name());
605
-        throw new RestException(
606
-            sprintf('rest_%s_invalid_id', $lowercase_model_name),
607
-            sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
608
-            array('status' => 404)
609
-        );
610
-    }
589
+	/**
590
+	 * Gets the model with that ID or throws a REST exception.
591
+	 * @since 4.9.76.p
592
+	 * @param EEM_Base $model
593
+	 * @param $id
594
+	 * @return EE_Base_Class
595
+	 * @throws RestException
596
+	 */
597
+	protected function getOneOrThrowException(EEM_Base $model, $id)
598
+	{
599
+		$model_obj = $model->get_one_by_ID($id);
600
+		// @todo: check they can permission for it. For now unnecessary because only full admins can use this endpoint.
601
+		if ($model_obj instanceof EE_Base_Class) {
602
+			return $model_obj;
603
+		}
604
+		$lowercase_model_name = strtolower($model->get_this_model_name());
605
+		throw new RestException(
606
+			sprintf('rest_%s_invalid_id', $lowercase_model_name),
607
+			sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
608
+			array('status' => 404)
609
+		);
610
+	}
611 611
 }
Please login to merge, or discard this patch.
core/libraries/rest_api/controllers/model/Base.php 1 patch
Indentation   +80 added lines, -80 removed lines patch added patch discarded remove patch
@@ -18,95 +18,95 @@
 block discarded – undo
18 18
 class Base extends Controller_Base
19 19
 {
20 20
 
21
-    /**
22
-     * Holds reference to the model version info, which knows the requested version
23
-     *
24
-     * @var ModelVersionInfo
25
-     */
26
-    protected $model_version_info;
21
+	/**
22
+	 * Holds reference to the model version info, which knows the requested version
23
+	 *
24
+	 * @var ModelVersionInfo
25
+	 */
26
+	protected $model_version_info;
27 27
 
28 28
 
29 29
 
30
-    /**
31
-     * Sets the version the user requested
32
-     *
33
-     * @param string $version eg '4.8'
34
-     */
35
-    public function setRequestedVersion($version)
36
-    {
37
-        parent::setRequestedVersion($version);
38
-        $this->model_version_info = new ModelVersionInfo($version);
39
-    }
30
+	/**
31
+	 * Sets the version the user requested
32
+	 *
33
+	 * @param string $version eg '4.8'
34
+	 */
35
+	public function setRequestedVersion($version)
36
+	{
37
+		parent::setRequestedVersion($version);
38
+		$this->model_version_info = new ModelVersionInfo($version);
39
+	}
40 40
 
41 41
 
42 42
 
43
-    /**
44
-     * Gets the object that should be used for getting any info from the models,
45
-     * because it's takes the requested and current core version into account
46
-     *
47
-     * @return \EventEspresso\core\libraries\rest_api\ModelVersionInfo
48
-     * @throws EE_Error
49
-     */
50
-    public function getModelVersionInfo()
51
-    {
52
-        if (! $this->model_version_info) {
53
-            throw new EE_Error(
54
-                sprintf(
55
-                    __(
56
-                        'Cannot use model version info before setting the requested version in the controller',
57
-                        'event_espresso'
58
-                    )
59
-                )
60
-            );
61
-        }
62
-        return $this->model_version_info;
63
-    }
43
+	/**
44
+	 * Gets the object that should be used for getting any info from the models,
45
+	 * because it's takes the requested and current core version into account
46
+	 *
47
+	 * @return \EventEspresso\core\libraries\rest_api\ModelVersionInfo
48
+	 * @throws EE_Error
49
+	 */
50
+	public function getModelVersionInfo()
51
+	{
52
+		if (! $this->model_version_info) {
53
+			throw new EE_Error(
54
+				sprintf(
55
+					__(
56
+						'Cannot use model version info before setting the requested version in the controller',
57
+						'event_espresso'
58
+					)
59
+				)
60
+			);
61
+		}
62
+		return $this->model_version_info;
63
+	}
64 64
 
65 65
 
66 66
 
67
-    /**
68
-     * Determines if $object is of one of the classes of $classes. Similar to
69
-     * in_array(), except this checks if $object is a subclass of the classnames provided
70
-     * in $classnames
71
-     *
72
-     * @param object $object
73
-     * @param array  $classnames
74
-     * @return boolean
75
-     */
76
-    public function isSubclassOfOne($object, $classnames)
77
-    {
78
-        foreach ($classnames as $classname) {
79
-            if (is_a($object, $classname)) {
80
-                return true;
81
-            }
82
-        }
83
-        return false;
84
-    }
67
+	/**
68
+	 * Determines if $object is of one of the classes of $classes. Similar to
69
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
70
+	 * in $classnames
71
+	 *
72
+	 * @param object $object
73
+	 * @param array  $classnames
74
+	 * @return boolean
75
+	 */
76
+	public function isSubclassOfOne($object, $classnames)
77
+	{
78
+		foreach ($classnames as $classname) {
79
+			if (is_a($object, $classname)) {
80
+				return true;
81
+			}
82
+		}
83
+		return false;
84
+	}
85 85
 
86
-    /**
87
-     * Verifies the model name provided was valid. If so, returns the model (as an object). Otherwise, throws an
88
-     * exception. Must be called after `setRequestedVersion()`.
89
-     * @since 4.9.76.p
90
-     * @param $model_name
91
-     * @return EEM_Base
92
-     * @throws EE_Error
93
-     * @throws RestException
94
-     */
95
-    protected function validateModel($model_name)
96
-    {
97
-        if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
98
-            throw new RestException(
99
-                'endpoint_parsing_error',
100
-                sprintf(
101
-                    __(
102
-                        'There is no model for endpoint %s. Please contact event espresso support',
103
-                        'event_espresso'
104
-                    ),
105
-                    $model_name
106
-                )
107
-            );
108
-        }
109
-        return $this->getModelVersionInfo()->loadModel($model_name);
110
-    }
86
+	/**
87
+	 * Verifies the model name provided was valid. If so, returns the model (as an object). Otherwise, throws an
88
+	 * exception. Must be called after `setRequestedVersion()`.
89
+	 * @since 4.9.76.p
90
+	 * @param $model_name
91
+	 * @return EEM_Base
92
+	 * @throws EE_Error
93
+	 * @throws RestException
94
+	 */
95
+	protected function validateModel($model_name)
96
+	{
97
+		if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
98
+			throw new RestException(
99
+				'endpoint_parsing_error',
100
+				sprintf(
101
+					__(
102
+						'There is no model for endpoint %s. Please contact event espresso support',
103
+						'event_espresso'
104
+					),
105
+					$model_name
106
+				)
107
+			);
108
+		}
109
+		return $this->getModelVersionInfo()->loadModel($model_name);
110
+	}
111 111
 }
112 112
 // End of file Base.php
Please login to merge, or discard this patch.
core/domain/services/admin/ajax/WordpressHeartbeat.php 1 patch
Indentation   +41 added lines, -41 removed lines patch added patch discarded remove patch
@@ -17,50 +17,50 @@
 block discarded – undo
17 17
 class WordpressHeartbeat
18 18
 {
19 19
 
20
-    /**
21
-     * @var LoaderInterface $loader
22
-     */
23
-    protected $loader;
20
+	/**
21
+	 * @var LoaderInterface $loader
22
+	 */
23
+	protected $loader;
24 24
 
25
-    /**
26
-     * @var RequestInterface $request
27
-     */
28
-    protected $request;
25
+	/**
26
+	 * @var RequestInterface $request
27
+	 */
28
+	protected $request;
29 29
 
30 30
 
31
-    /**
32
-     * WordpressHeartbeat constructor.
33
-     *
34
-     * @param LoaderInterface  $loader
35
-     * @param RequestInterface $request
36
-     */
37
-    public function __construct(
38
-        LoaderInterface $loader,
39
-        RequestInterface $request
40
-    ) {
41
-        $this->loader = $loader;
42
-        $this->request = $request;
43
-        do_action('AHEE__EventEspresso_core_domain_services_admin_ajax_WordpressHeartbeat__constructor', $this);
44
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'resolveRoutes'));
45
-    }
31
+	/**
32
+	 * WordpressHeartbeat constructor.
33
+	 *
34
+	 * @param LoaderInterface  $loader
35
+	 * @param RequestInterface $request
36
+	 */
37
+	public function __construct(
38
+		LoaderInterface $loader,
39
+		RequestInterface $request
40
+	) {
41
+		$this->loader = $loader;
42
+		$this->request = $request;
43
+		do_action('AHEE__EventEspresso_core_domain_services_admin_ajax_WordpressHeartbeat__constructor', $this);
44
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'resolveRoutes'));
45
+	}
46 46
 
47 47
 
48
-    /**
49
-     * @since 4.9.76.p
50
-     * @throws InvalidClassException
51
-     */
52
-    public function resolveRoutes()
53
-    {
54
-        $screenID = $this->request->getRequestParam('screen_id');
55
-        $heartbeat_data = $this->request->getRequestParam('data', []);
56
-        if ($screenID === 'espresso_events') {
57
-            $this->loader->getShared(
58
-                'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat'
59
-            );
60
-        } elseif ($screenID === 'front' && ! empty($heartbeat_data['espresso_thank_you_page'])) {
61
-            $this->loader->getShared(
62
-                'EventEspresso\core\domain\services\admin\ajax\ThankYouPageIpnMonitor'
63
-            );
64
-        }
65
-    }
48
+	/**
49
+	 * @since 4.9.76.p
50
+	 * @throws InvalidClassException
51
+	 */
52
+	public function resolveRoutes()
53
+	{
54
+		$screenID = $this->request->getRequestParam('screen_id');
55
+		$heartbeat_data = $this->request->getRequestParam('data', []);
56
+		if ($screenID === 'espresso_events') {
57
+			$this->loader->getShared(
58
+				'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat'
59
+			);
60
+		} elseif ($screenID === 'front' && ! empty($heartbeat_data['espresso_thank_you_page'])) {
61
+			$this->loader->getShared(
62
+				'EventEspresso\core\domain\services\admin\ajax\ThankYouPageIpnMonitor'
63
+			);
64
+		}
65
+	}
66 66
 }
Please login to merge, or discard this patch.
core/services/address/CountrySubRegionDao.php 1 patch
Indentation   +223 added lines, -223 removed lines patch added patch discarded remove patch
@@ -26,248 +26,248 @@
 block discarded – undo
26 26
 class CountrySubRegionDao
27 27
 {
28 28
 
29
-    const REPO_URL = 'https://raw.githubusercontent.com/eventespresso/countries-and-subregions/master/';
29
+	const REPO_URL = 'https://raw.githubusercontent.com/eventespresso/countries-and-subregions/master/';
30 30
 
31
-    const OPTION_NAME_COUNTRY_DATA_VERSION = 'espresso-country-sub-region-data-version';
31
+	const OPTION_NAME_COUNTRY_DATA_VERSION = 'espresso-country-sub-region-data-version';
32 32
 
33
-    /**
34
-     * @var EEM_State $state_model
35
-     */
36
-    private $state_model;
33
+	/**
34
+	 * @var EEM_State $state_model
35
+	 */
36
+	private $state_model;
37 37
 
38
-    /**
39
-     * @var JsonValidator $json_validator
40
-     */
41
-    private $json_validator;
38
+	/**
39
+	 * @var JsonValidator $json_validator
40
+	 */
41
+	private $json_validator;
42 42
 
43
-    /**
44
-     * @var string $data_version
45
-     */
46
-    private $data_version;
43
+	/**
44
+	 * @var string $data_version
45
+	 */
46
+	private $data_version;
47 47
 
48
-    /**
49
-     * @var array $countries
50
-     */
51
-    private $countries = array();
48
+	/**
49
+	 * @var array $countries
50
+	 */
51
+	private $countries = array();
52 52
 
53 53
 
54
-    /**
55
-     * CountrySubRegionDao constructor.
56
-     *
57
-     * @param EEM_State     $state_model
58
-     * @param JsonValidator $json_validator
59
-     */
60
-    public function __construct(EEM_State $state_model, JsonValidator $json_validator)
61
-    {
62
-        $this->state_model = $state_model;
63
-        $this->json_validator = $json_validator;
64
-    }
54
+	/**
55
+	 * CountrySubRegionDao constructor.
56
+	 *
57
+	 * @param EEM_State     $state_model
58
+	 * @param JsonValidator $json_validator
59
+	 */
60
+	public function __construct(EEM_State $state_model, JsonValidator $json_validator)
61
+	{
62
+		$this->state_model = $state_model;
63
+		$this->json_validator = $json_validator;
64
+	}
65 65
 
66 66
 
67
-    /**
68
-     * @param EE_Country $country_object
69
-     * @return bool
70
-     * @throws EE_Error
71
-     * @throws InvalidArgumentException
72
-     * @throws InvalidDataTypeException
73
-     * @throws InvalidInterfaceException
74
-     * @throws ReflectionException
75
-     */
76
-    public function saveCountrySubRegions(EE_Country $country_object)
77
-    {
78
-        $CNT_ISO = $country_object->ID();
79
-        $has_sub_regions = $this->state_model->count(array(array('Country.CNT_ISO' => $CNT_ISO)));
80
-        $data = [];
81
-        if (empty($this->countries)) {
82
-            $this->data_version = $this->getCountrySubRegionDataVersion();
83
-            $data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
84
-        }
85
-        if (empty($data)) {
86
-            EE_Error::add_error(
87
-                'Country Subregion Data could not be retrieved',
88
-                __FILE__,
89
-                __METHOD__,
90
-                __LINE__
91
-            );
92
-        }
93
-        if (! $has_sub_regions
94
-            || (isset($data->version) && version_compare($data->version, $this->data_version))
95
-        ) {
96
-            if (isset($data->countries)
97
-                && $this->processCountryData($CNT_ISO, $data->countries) > 0
98
-            ) {
99
-                $this->countries = $data->countries;
100
-                $this->updateCountrySubRegionDataVersion($data->version);
101
-                return true;
102
-            }
103
-        }
104
-        return false;
105
-    }
67
+	/**
68
+	 * @param EE_Country $country_object
69
+	 * @return bool
70
+	 * @throws EE_Error
71
+	 * @throws InvalidArgumentException
72
+	 * @throws InvalidDataTypeException
73
+	 * @throws InvalidInterfaceException
74
+	 * @throws ReflectionException
75
+	 */
76
+	public function saveCountrySubRegions(EE_Country $country_object)
77
+	{
78
+		$CNT_ISO = $country_object->ID();
79
+		$has_sub_regions = $this->state_model->count(array(array('Country.CNT_ISO' => $CNT_ISO)));
80
+		$data = [];
81
+		if (empty($this->countries)) {
82
+			$this->data_version = $this->getCountrySubRegionDataVersion();
83
+			$data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
84
+		}
85
+		if (empty($data)) {
86
+			EE_Error::add_error(
87
+				'Country Subregion Data could not be retrieved',
88
+				__FILE__,
89
+				__METHOD__,
90
+				__LINE__
91
+			);
92
+		}
93
+		if (! $has_sub_regions
94
+			|| (isset($data->version) && version_compare($data->version, $this->data_version))
95
+		) {
96
+			if (isset($data->countries)
97
+				&& $this->processCountryData($CNT_ISO, $data->countries) > 0
98
+			) {
99
+				$this->countries = $data->countries;
100
+				$this->updateCountrySubRegionDataVersion($data->version);
101
+				return true;
102
+			}
103
+		}
104
+		return false;
105
+	}
106 106
 
107 107
 
108
-    /**
109
-     * @since 4.9.70.p
110
-     * @return string
111
-     */
112
-    private function getCountrySubRegionDataVersion()
113
-    {
114
-        return get_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, null);
115
-    }
108
+	/**
109
+	 * @since 4.9.70.p
110
+	 * @return string
111
+	 */
112
+	private function getCountrySubRegionDataVersion()
113
+	{
114
+		return get_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, null);
115
+	}
116 116
 
117 117
 
118
-    /**
119
-     * @param string $version
120
-     */
121
-    private function updateCountrySubRegionDataVersion($version = '')
122
-    {
123
-        // add version option if it has never been added before, or update existing
124
-        if ($this->data_version === null) {
125
-            add_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version, '', false);
126
-        } else {
127
-            update_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version);
128
-        }
129
-    }
118
+	/**
119
+	 * @param string $version
120
+	 */
121
+	private function updateCountrySubRegionDataVersion($version = '')
122
+	{
123
+		// add version option if it has never been added before, or update existing
124
+		if ($this->data_version === null) {
125
+			add_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version, '', false);
126
+		} else {
127
+			update_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version);
128
+		}
129
+	}
130 130
 
131 131
 
132
-    /**
133
-     * @param string $CNT_ISO
134
-     * @param array  $countries
135
-     * @return int
136
-     * @throws EE_Error
137
-     * @throws InvalidArgumentException
138
-     * @throws InvalidDataTypeException
139
-     * @throws InvalidInterfaceException
140
-     * @throws ReflectionException
141
-     * @since 4.9.70.p
142
-     */
143
-    private function processCountryData($CNT_ISO, $countries = array())
144
-    {
145
-        if (! empty($countries)) {
146
-            foreach ($countries as $key => $country) {
147
-                if ($country instanceof stdClass
148
-                    && $country->code === $CNT_ISO
149
-                    && empty($country->sub_regions)
150
-                    && ! empty($country->filename)
151
-                ) {
152
-                    $country->sub_regions = $this->retrieveJsonData(
153
-                        self::REPO_URL . 'countries/' . $country->filename . '.json'
154
-                    );
155
-                    return $this->saveSubRegionData($country, $country->sub_regions);
156
-                }
157
-            }
158
-        }
159
-        return 0;
160
-    }
132
+	/**
133
+	 * @param string $CNT_ISO
134
+	 * @param array  $countries
135
+	 * @return int
136
+	 * @throws EE_Error
137
+	 * @throws InvalidArgumentException
138
+	 * @throws InvalidDataTypeException
139
+	 * @throws InvalidInterfaceException
140
+	 * @throws ReflectionException
141
+	 * @since 4.9.70.p
142
+	 */
143
+	private function processCountryData($CNT_ISO, $countries = array())
144
+	{
145
+		if (! empty($countries)) {
146
+			foreach ($countries as $key => $country) {
147
+				if ($country instanceof stdClass
148
+					&& $country->code === $CNT_ISO
149
+					&& empty($country->sub_regions)
150
+					&& ! empty($country->filename)
151
+				) {
152
+					$country->sub_regions = $this->retrieveJsonData(
153
+						self::REPO_URL . 'countries/' . $country->filename . '.json'
154
+					);
155
+					return $this->saveSubRegionData($country, $country->sub_regions);
156
+				}
157
+			}
158
+		}
159
+		return 0;
160
+	}
161 161
 
162 162
 
163
-    /**
164
-     * @param string $url
165
-     * @return array
166
-     */
167
-    private function retrieveJsonData($url)
168
-    {
169
-        if (empty($url)) {
170
-            EE_Error::add_error(
171
-                'No URL was provided!',
172
-                __FILE__,
173
-                __METHOD__,
174
-                __LINE__
175
-            );
176
-            return array();
177
-        }
178
-        $request = wp_safe_remote_get($url);
179
-        if ($request instanceof WP_Error) {
180
-            EE_Error::add_error(
181
-                $request->get_error_message(),
182
-                __FILE__,
183
-                __METHOD__,
184
-                __LINE__
185
-            );
186
-            return array();
187
-        }
188
-        $body = wp_remote_retrieve_body($request);
189
-        $json = json_decode($body);
190
-        if ($this->json_validator->isValid(__FILE__, __METHOD__, __LINE__)) {
191
-            return $json;
192
-        }
193
-        return array();
194
-    }
163
+	/**
164
+	 * @param string $url
165
+	 * @return array
166
+	 */
167
+	private function retrieveJsonData($url)
168
+	{
169
+		if (empty($url)) {
170
+			EE_Error::add_error(
171
+				'No URL was provided!',
172
+				__FILE__,
173
+				__METHOD__,
174
+				__LINE__
175
+			);
176
+			return array();
177
+		}
178
+		$request = wp_safe_remote_get($url);
179
+		if ($request instanceof WP_Error) {
180
+			EE_Error::add_error(
181
+				$request->get_error_message(),
182
+				__FILE__,
183
+				__METHOD__,
184
+				__LINE__
185
+			);
186
+			return array();
187
+		}
188
+		$body = wp_remote_retrieve_body($request);
189
+		$json = json_decode($body);
190
+		if ($this->json_validator->isValid(__FILE__, __METHOD__, __LINE__)) {
191
+			return $json;
192
+		}
193
+		return array();
194
+	}
195 195
 
196 196
 
197
-    /**
198
-     * @param stdClass $country
199
-     * @param array    $sub_regions
200
-     * @return int
201
-     * @throws EE_Error
202
-     * @throws InvalidArgumentException
203
-     * @throws InvalidDataTypeException
204
-     * @throws InvalidInterfaceException
205
-     * @throws ReflectionException
206
-     */
207
-    private function saveSubRegionData(stdClass $country, $sub_regions = array())
208
-    {
209
-        $results = 0;
210
-        if (is_array($sub_regions)) {
211
-            $existing_sub_regions = $this->getExistingStateAbbreviations($country->code);
212
-            foreach ($sub_regions as $sub_region) {
213
-                // remove country code from sub region code
214
-                $abbrev = str_replace(
215
-                    $country->code . '-',
216
-                    '',
217
-                    sanitize_text_field($sub_region->code)
218
-                );
219
-                // but NOT if sub region code results in only a number
220
-                if (absint($abbrev) !== 0) {
221
-                    $abbrev = sanitize_text_field($sub_region->code);
222
-                }
223
-                if (! in_array($abbrev, $existing_sub_regions, true)
224
-                    && $this->state_model->insert(
225
-                        [
226
-                            // STA_ID CNT_ISO STA_abbrev STA_name STA_active
227
-                            'CNT_ISO'    => $country->code,
228
-                            'STA_abbrev' => $abbrev,
229
-                            'STA_name'   => sanitize_text_field($sub_region->name),
230
-                            'STA_active' => 1,
231
-                        ]
232
-                    )
233
-                ) {
234
-                    $results++;
235
-                }
236
-            }
237
-        }
238
-        return $results;
239
-    }
197
+	/**
198
+	 * @param stdClass $country
199
+	 * @param array    $sub_regions
200
+	 * @return int
201
+	 * @throws EE_Error
202
+	 * @throws InvalidArgumentException
203
+	 * @throws InvalidDataTypeException
204
+	 * @throws InvalidInterfaceException
205
+	 * @throws ReflectionException
206
+	 */
207
+	private function saveSubRegionData(stdClass $country, $sub_regions = array())
208
+	{
209
+		$results = 0;
210
+		if (is_array($sub_regions)) {
211
+			$existing_sub_regions = $this->getExistingStateAbbreviations($country->code);
212
+			foreach ($sub_regions as $sub_region) {
213
+				// remove country code from sub region code
214
+				$abbrev = str_replace(
215
+					$country->code . '-',
216
+					'',
217
+					sanitize_text_field($sub_region->code)
218
+				);
219
+				// but NOT if sub region code results in only a number
220
+				if (absint($abbrev) !== 0) {
221
+					$abbrev = sanitize_text_field($sub_region->code);
222
+				}
223
+				if (! in_array($abbrev, $existing_sub_regions, true)
224
+					&& $this->state_model->insert(
225
+						[
226
+							// STA_ID CNT_ISO STA_abbrev STA_name STA_active
227
+							'CNT_ISO'    => $country->code,
228
+							'STA_abbrev' => $abbrev,
229
+							'STA_name'   => sanitize_text_field($sub_region->name),
230
+							'STA_active' => 1,
231
+						]
232
+					)
233
+				) {
234
+					$results++;
235
+				}
236
+			}
237
+		}
238
+		return $results;
239
+	}
240 240
 
241 241
 
242
-    /**
243
-     * @param string $CNT_ISO
244
-     * @since 4.9.76.p
245
-     * @return array
246
-     * @throws EE_Error
247
-     * @throws InvalidArgumentException
248
-     * @throws InvalidDataTypeException
249
-     * @throws InvalidInterfaceException
250
-     * @throws ReflectionException
251
-     */
252
-    private function getExistingStateAbbreviations($CNT_ISO)
253
-    {
254
-        $existing_sub_region_IDs = [];
255
-        $existing_sub_regions = $this->state_model->get_all(array(
256
-            array(
257
-                'Country.CNT_ISO' => array(
258
-                    'IN',
259
-                    [$CNT_ISO]
260
-                )
261
-            ),
262
-            'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')
263
-        ));
264
-        if (is_array($existing_sub_regions)) {
265
-            foreach ($existing_sub_regions as $existing_sub_region) {
266
-                if ($existing_sub_region instanceof EE_State) {
267
-                    $existing_sub_region_IDs[] = $existing_sub_region->abbrev();
268
-                }
269
-            }
270
-        }
271
-        return $existing_sub_region_IDs;
272
-    }
242
+	/**
243
+	 * @param string $CNT_ISO
244
+	 * @since 4.9.76.p
245
+	 * @return array
246
+	 * @throws EE_Error
247
+	 * @throws InvalidArgumentException
248
+	 * @throws InvalidDataTypeException
249
+	 * @throws InvalidInterfaceException
250
+	 * @throws ReflectionException
251
+	 */
252
+	private function getExistingStateAbbreviations($CNT_ISO)
253
+	{
254
+		$existing_sub_region_IDs = [];
255
+		$existing_sub_regions = $this->state_model->get_all(array(
256
+			array(
257
+				'Country.CNT_ISO' => array(
258
+					'IN',
259
+					[$CNT_ISO]
260
+				)
261
+			),
262
+			'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')
263
+		));
264
+		if (is_array($existing_sub_regions)) {
265
+			foreach ($existing_sub_regions as $existing_sub_region) {
266
+				if ($existing_sub_region instanceof EE_State) {
267
+					$existing_sub_region_IDs[] = $existing_sub_region->abbrev();
268
+				}
269
+			}
270
+		}
271
+		return $existing_sub_region_IDs;
272
+	}
273 273
 }
Please login to merge, or discard this patch.
modules/core_rest_api/EED_Core_Rest_Api.module.php 1 patch
Indentation   +1328 added lines, -1328 removed lines patch added patch discarded remove patch
@@ -23,1332 +23,1332 @@
 block discarded – undo
23 23
 class EED_Core_Rest_Api extends \EED_Module
24 24
 {
25 25
 
26
-    const ee_api_namespace = Domain::API_NAMESPACE;
27
-
28
-    const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
29
-
30
-    const saved_routes_option_names = 'ee_core_routes';
31
-
32
-    /**
33
-     * string used in _links response bodies to make them globally unique.
34
-     *
35
-     * @see http://v2.wp-api.org/extending/linking/
36
-     */
37
-    const ee_api_link_namespace = 'https://api.eventespresso.com/';
38
-
39
-    /**
40
-     * @var CalculatedModelFields
41
-     */
42
-    protected static $_field_calculator;
43
-
44
-
45
-    /**
46
-     * @return EED_Core_Rest_Api|EED_Module
47
-     */
48
-    public static function instance()
49
-    {
50
-        self::$_field_calculator = LoaderFactory::getLoader()->load('EventEspresso\core\libraries\rest_api\CalculatedModelFields');
51
-        return parent::get_instance(__CLASS__);
52
-    }
53
-
54
-
55
-    /**
56
-     *    set_hooks - for hooking into EE Core, other modules, etc
57
-     *
58
-     * @access    public
59
-     * @return    void
60
-     */
61
-    public static function set_hooks()
62
-    {
63
-        self::set_hooks_both();
64
-    }
65
-
66
-
67
-    /**
68
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
69
-     *
70
-     * @access    public
71
-     * @return    void
72
-     */
73
-    public static function set_hooks_admin()
74
-    {
75
-        self::set_hooks_both();
76
-    }
77
-
78
-
79
-    public static function set_hooks_both()
80
-    {
81
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
82
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
83
-        add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
84
-        add_filter(
85
-            'rest_index',
86
-            array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex')
87
-        );
88
-        EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
89
-    }
90
-
91
-
92
-    /**
93
-     * sets up hooks which only need to be included as part of REST API requests;
94
-     * other requests like to the frontend or admin etc don't need them
95
-     *
96
-     * @throws \EE_Error
97
-     */
98
-    public static function set_hooks_rest_api()
99
-    {
100
-        // set hooks which account for changes made to the API
101
-        EED_Core_Rest_Api::_set_hooks_for_changes();
102
-    }
103
-
104
-
105
-    /**
106
-     * public wrapper of _set_hooks_for_changes.
107
-     * Loads all the hooks which make requests to old versions of the API
108
-     * appear the same as they always did
109
-     *
110
-     * @throws EE_Error
111
-     */
112
-    public static function set_hooks_for_changes()
113
-    {
114
-        self::_set_hooks_for_changes();
115
-    }
116
-
117
-
118
-    /**
119
-     * Loads all the hooks which make requests to old versions of the API
120
-     * appear the same as they always did
121
-     *
122
-     * @throws EE_Error
123
-     */
124
-    protected static function _set_hooks_for_changes()
125
-    {
126
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
127
-        foreach ($folder_contents as $classname_in_namespace => $filepath) {
128
-            // ignore the base parent class
129
-            // and legacy named classes
130
-            if ($classname_in_namespace === 'ChangesInBase'
131
-                || strpos($classname_in_namespace, 'Changes_In_') === 0
132
-            ) {
133
-                continue;
134
-            }
135
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
136
-            if (class_exists($full_classname)) {
137
-                $instance_of_class = new $full_classname;
138
-                if ($instance_of_class instanceof ChangesInBase) {
139
-                    $instance_of_class->setHooks();
140
-                }
141
-            }
142
-        }
143
-    }
144
-
145
-
146
-    /**
147
-     * Filters the WP routes to add our EE-related ones. This takes a bit of time
148
-     * so we actually prefer to only do it when an EE plugin is activated or upgraded
149
-     *
150
-     * @throws \EE_Error
151
-     */
152
-    public static function register_routes()
153
-    {
154
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
155
-            foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
156
-                /**
157
-                 * @var array     $data_for_multiple_endpoints numerically indexed array
158
-                 *                                         but can also contain route options like {
159
-                 * @type array    $schema                      {
160
-                 * @type callable $schema_callback
161
-                 * @type array    $callback_args               arguments that will be passed to the callback, after the
162
-                 * WP_REST_Request of course
163
-                 * }
164
-                 * }
165
-                 */
166
-                // when registering routes, register all the endpoints' data at the same time
167
-                $multiple_endpoint_args = array();
168
-                foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
169
-                    /**
170
-                     * @var array     $data_for_single_endpoint {
171
-                     * @type callable $callback
172
-                     * @type string methods
173
-                     * @type array args
174
-                     * @type array _links
175
-                     * @type array    $callback_args            arguments that will be passed to the callback, after the
176
-                     * WP_REST_Request of course
177
-                     * }
178
-                     */
179
-                    // skip route options
180
-                    if (! is_numeric($endpoint_key)) {
181
-                        continue;
182
-                    }
183
-                    if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
184
-                        throw new EE_Error(
185
-                            esc_html__(
186
-                            // @codingStandardsIgnoreStart
187
-                                'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
188
-                                // @codingStandardsIgnoreEnd
189
-                                'event_espresso'
190
-                            )
191
-                        );
192
-                    }
193
-                    $callback = $data_for_single_endpoint['callback'];
194
-                    $single_endpoint_args = array(
195
-                        'methods' => $data_for_single_endpoint['methods'],
196
-                        'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
197
-                            : array(),
198
-                    );
199
-                    if (isset($data_for_single_endpoint['_links'])) {
200
-                        $single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
201
-                    }
202
-                    if (isset($data_for_single_endpoint['callback_args'])) {
203
-                        $callback_args = $data_for_single_endpoint['callback_args'];
204
-                        $single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
205
-                            $callback,
206
-                            $callback_args
207
-                        ) {
208
-                            array_unshift($callback_args, $request);
209
-                            return call_user_func_array(
210
-                                $callback,
211
-                                $callback_args
212
-                            );
213
-                        };
214
-                    } else {
215
-                        $single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
216
-                    }
217
-                    $multiple_endpoint_args[] = $single_endpoint_args;
218
-                }
219
-                if (isset($data_for_multiple_endpoints['schema'])) {
220
-                    $schema_route_data = $data_for_multiple_endpoints['schema'];
221
-                    $schema_callback = $schema_route_data['schema_callback'];
222
-                    $callback_args = $schema_route_data['callback_args'];
223
-                    $multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
224
-                        return call_user_func_array(
225
-                            $schema_callback,
226
-                            $callback_args
227
-                        );
228
-                    };
229
-                }
230
-                register_rest_route(
231
-                    $namespace,
232
-                    $relative_route,
233
-                    $multiple_endpoint_args
234
-                );
235
-            }
236
-        }
237
-    }
238
-
239
-
240
-    /**
241
-     * Checks if there was a version change or something that merits invalidating the cached
242
-     * route data. If so, invalidates the cached route data so that it gets refreshed
243
-     * next time the WP API is used
244
-     */
245
-    public static function invalidate_cached_route_data_on_version_change()
246
-    {
247
-        if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
248
-            EED_Core_Rest_Api::invalidate_cached_route_data();
249
-        }
250
-        foreach (EE_Registry::instance()->addons as $addon) {
251
-            if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
252
-                EED_Core_Rest_Api::invalidate_cached_route_data();
253
-            }
254
-        }
255
-    }
256
-
257
-
258
-    /**
259
-     * Removes the cached route data so it will get refreshed next time the WP API is used
260
-     */
261
-    public static function invalidate_cached_route_data()
262
-    {
263
-        // delete the saved EE REST API routes
264
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
265
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
266
-        }
267
-    }
268
-
269
-
270
-    /**
271
-     * Gets the EE route data
272
-     *
273
-     * @return array top-level key is the namespace, next-level key is the route and its value is array{
274
-     * @throws \EE_Error
275
-     * @type string|array $callback
276
-     * @type string       $methods
277
-     * @type boolean      $hidden_endpoint
278
-     * }
279
-     */
280
-    public static function get_ee_route_data()
281
-    {
282
-        $ee_routes = array();
283
-        foreach (self::versions_served() as $version => $hidden_endpoints) {
284
-            $ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version(
285
-                $version,
286
-                $hidden_endpoints
287
-            );
288
-        }
289
-        return $ee_routes;
290
-    }
291
-
292
-
293
-    /**
294
-     * Gets the EE route data from the wp options if it exists already,
295
-     * otherwise re-generates it and saves it to the option
296
-     *
297
-     * @param string  $version
298
-     * @param boolean $hidden_endpoints
299
-     * @return array
300
-     * @throws \EE_Error
301
-     */
302
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
303
-    {
304
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
305
-        if (! $ee_routes || EED_Core_Rest_Api::debugMode()) {
306
-            $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
307
-        }
308
-        return $ee_routes;
309
-    }
310
-
311
-
312
-    /**
313
-     * Saves the EE REST API route data to a wp option and returns it
314
-     *
315
-     * @param string  $version
316
-     * @param boolean $hidden_endpoints
317
-     * @return mixed|null
318
-     * @throws \EE_Error
319
-     */
320
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
321
-    {
322
-        $instance = self::instance();
323
-        $routes = apply_filters(
324
-            'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
325
-            array_replace_recursive(
326
-                $instance->_get_config_route_data_for_version($version, $hidden_endpoints),
327
-                $instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
328
-                $instance->_get_model_route_data_for_version($version, $hidden_endpoints),
329
-                $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
330
-            )
331
-        );
332
-        $option_name = self::saved_routes_option_names . $version;
333
-        if (get_option($option_name)) {
334
-            update_option($option_name, $routes, true);
335
-        } else {
336
-            add_option($option_name, $routes, null, 'no');
337
-        }
338
-        return $routes;
339
-    }
340
-
341
-
342
-    /**
343
-     * Calculates all the EE routes and saves it to a WordPress option so we don't
344
-     * need to calculate it on every request
345
-     *
346
-     * @deprecated since version 4.9.1
347
-     * @return void
348
-     */
349
-    public static function save_ee_routes()
350
-    {
351
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
352
-            $instance = self::instance();
353
-            $routes = apply_filters(
354
-                'EED_Core_Rest_Api__save_ee_routes__routes',
355
-                array_replace_recursive(
356
-                    $instance->_register_config_routes(),
357
-                    $instance->_register_meta_routes(),
358
-                    $instance->_register_model_routes(),
359
-                    $instance->_register_rpc_routes()
360
-                )
361
-            );
362
-            update_option(self::saved_routes_option_names, $routes, true);
363
-        }
364
-    }
365
-
366
-
367
-    /**
368
-     * Gets all the route information relating to EE models
369
-     *
370
-     * @return array @see get_ee_route_data
371
-     * @deprecated since version 4.9.1
372
-     */
373
-    protected function _register_model_routes()
374
-    {
375
-        $model_routes = array();
376
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
377
-            $model_routes[ EED_Core_Rest_Api::ee_api_namespace
378
-                           . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
379
-        }
380
-        return $model_routes;
381
-    }
382
-
383
-
384
-    /**
385
-     * Decides whether or not to add write endpoints for this model.
386
-     *
387
-     * Currently, this defaults to exclude all global tables and models
388
-     * which would allow inserting WP core data (we don't want to duplicate
389
-     * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
390
-     *
391
-     * @param EEM_Base $model
392
-     * @return bool
393
-     */
394
-    public static function should_have_write_endpoints(EEM_Base $model)
395
-    {
396
-        if ($model->is_wp_core_model()) {
397
-            return false;
398
-        }
399
-        foreach ($model->get_tables() as $table) {
400
-            if ($table->is_global()) {
401
-                return false;
402
-            }
403
-        }
404
-        return true;
405
-    }
406
-
407
-
408
-    /**
409
-     * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
410
-     * in this versioned namespace of EE4
411
-     *
412
-     * @param $version
413
-     * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
414
-     */
415
-    public static function model_names_with_plural_routes($version)
416
-    {
417
-        $model_version_info = new ModelVersionInfo($version);
418
-        $models_to_register = $model_version_info->modelsForRequestedVersion();
419
-        // let's not bother having endpoints for extra metas
420
-        unset(
421
-            $models_to_register['Extra_Meta'],
422
-            $models_to_register['Extra_Join'],
423
-            $models_to_register['Post_Meta']
424
-        );
425
-        return apply_filters(
426
-            'FHEE__EED_Core_REST_API___register_model_routes',
427
-            $models_to_register
428
-        );
429
-    }
430
-
431
-
432
-    /**
433
-     * Gets the route data for EE models in the specified version
434
-     *
435
-     * @param string  $version
436
-     * @param boolean $hidden_endpoint
437
-     * @return array
438
-     * @throws EE_Error
439
-     */
440
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
441
-    {
442
-        $model_routes = array();
443
-        $model_version_info = new ModelVersionInfo($version);
444
-        foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
445
-            $model = \EE_Registry::instance()->load_model($model_name);
446
-            // if this isn't a valid model then let's skip iterate to the next item in the loop.
447
-            if (! $model instanceof EEM_Base) {
448
-                continue;
449
-            }
450
-            // yes we could just register one route for ALL models, but then they wouldn't show up in the index
451
-            $plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
452
-            $singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
453
-            $model_routes[ $plural_model_route ] = array(
454
-                array(
455
-                    'callback'        => array(
456
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
457
-                        'handleRequestGetAll',
458
-                    ),
459
-                    'callback_args'   => array($version, $model_name),
460
-                    'methods'         => WP_REST_Server::READABLE,
461
-                    'hidden_endpoint' => $hidden_endpoint,
462
-                    'args'            => $this->_get_read_query_params($model, $version),
463
-                    '_links'          => array(
464
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
465
-                    ),
466
-                ),
467
-                'schema' => array(
468
-                    'schema_callback' => array(
469
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
470
-                        'handleSchemaRequest',
471
-                    ),
472
-                    'callback_args'   => array($version, $model_name),
473
-                ),
474
-            );
475
-            $model_routes[ $singular_model_route ] = array(
476
-                array(
477
-                    'callback'        => array(
478
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
479
-                        'handleRequestGetOne',
480
-                    ),
481
-                    'callback_args'   => array($version, $model_name),
482
-                    'methods'         => WP_REST_Server::READABLE,
483
-                    'hidden_endpoint' => $hidden_endpoint,
484
-                    'args'            => $this->_get_response_selection_query_params($model, $version, true),
485
-                ),
486
-            );
487
-            if (apply_filters(
488
-                'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
489
-                EED_Core_Rest_Api::should_have_write_endpoints($model),
490
-                $model
491
-            )) {
492
-                $model_routes[ $plural_model_route ][] = array(
493
-                    'callback'        => array(
494
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Write',
495
-                        'handleRequestInsert',
496
-                    ),
497
-                    'callback_args'   => array($version, $model_name),
498
-                    'methods'         => WP_REST_Server::CREATABLE,
499
-                    'hidden_endpoint' => $hidden_endpoint,
500
-                    'args'            => $this->_get_write_params($model_name, $model_version_info, true),
501
-                );
502
-                $model_routes[ $singular_model_route ] = array_merge(
503
-                    $model_routes[ $singular_model_route ],
504
-                    array(
505
-                        array(
506
-                            'callback'        => array(
507
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
508
-                                'handleRequestUpdate',
509
-                            ),
510
-                            'callback_args'   => array($version, $model_name),
511
-                            'methods'         => WP_REST_Server::EDITABLE,
512
-                            'hidden_endpoint' => $hidden_endpoint,
513
-                            'args'            => $this->_get_write_params($model_name, $model_version_info),
514
-                        ),
515
-                        array(
516
-                            'callback'        => array(
517
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
518
-                                'handleRequestDelete',
519
-                            ),
520
-                            'callback_args'   => array($version, $model_name),
521
-                            'methods'         => WP_REST_Server::DELETABLE,
522
-                            'hidden_endpoint' => $hidden_endpoint,
523
-                            'args'            => $this->_get_delete_query_params($model, $version),
524
-                        ),
525
-                    )
526
-                );
527
-            }
528
-            foreach ($model->relation_settings() as $relation_name => $relation_obj) {
529
-                $related_route = EED_Core_Rest_Api::get_relation_route_via(
530
-                    $model,
531
-                    '(?P<id>[^\/]+)',
532
-                    $relation_obj
533
-                );
534
-                $model_routes[ $related_route ] = array(
535
-                    array(
536
-                        'callback'        => array(
537
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
538
-                            'handleRequestGetRelated',
539
-                        ),
540
-                        'callback_args'   => array($version, $model_name, $relation_name),
541
-                        'methods'         => WP_REST_Server::READABLE,
542
-                        'hidden_endpoint' => $hidden_endpoint,
543
-                        'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
544
-                    ),
545
-                );
546
-
547
-                $related_write_route = $related_route . '/' . '(?P<related_id>[^\/]+)';
548
-                $model_routes[ $related_write_route ] = array(
549
-                    array(
550
-                        'callback'        => array(
551
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Write',
552
-                            'handleRequestAddRelation',
553
-                        ),
554
-                        'callback_args'   => array($version, $model_name, $relation_name),
555
-                        'methods'         => WP_REST_Server::EDITABLE,
556
-                        'hidden_endpoint' => $hidden_endpoint,
557
-                        'args'            => $this->_get_add_relation_query_params($model, $relation_obj->get_other_model(), $version)
558
-                    ),
559
-                    array(
560
-                        'callback'        => array(
561
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Write',
562
-                            'handleRequestRemoveRelation',
563
-                        ),
564
-                        'callback_args'   => array($version, $model_name, $relation_name),
565
-                        'methods'         => WP_REST_Server::DELETABLE,
566
-                        'hidden_endpoint' => $hidden_endpoint,
567
-                        'args'            => array()
568
-                    ),
569
-                );
570
-            }
571
-        }
572
-        return $model_routes;
573
-    }
574
-
575
-
576
-    /**
577
-     * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
578
-     * excluding the preceding slash.
579
-     * Eg you pass get_plural_route_to('Event') = 'events'
580
-     *
581
-     * @param EEM_Base $model
582
-     * @return string
583
-     */
584
-    public static function get_collection_route(EEM_Base $model)
585
-    {
586
-        return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
587
-    }
588
-
589
-
590
-    /**
591
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
592
-     * excluding the preceding slash.
593
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
594
-     *
595
-     * @param EEM_Base $model eg Event or Venue
596
-     * @param string   $id
597
-     * @return string
598
-     */
599
-    public static function get_entity_route($model, $id)
600
-    {
601
-        return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
602
-    }
603
-
604
-
605
-    /**
606
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
607
-     * excluding the preceding slash.
608
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
609
-     *
610
-     * @param EEM_Base               $model eg Event or Venue
611
-     * @param string                 $id
612
-     * @param EE_Model_Relation_Base $relation_obj
613
-     * @return string
614
-     */
615
-    public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
616
-    {
617
-        $related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
618
-            $relation_obj->get_other_model()->get_this_model_name(),
619
-            $relation_obj
620
-        );
621
-        return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
622
-    }
623
-
624
-
625
-    /**
626
-     * Adds onto the $relative_route the EE4 REST API versioned namespace.
627
-     * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
628
-     *
629
-     * @param string $relative_route
630
-     * @param string $version
631
-     * @return string
632
-     */
633
-    public static function get_versioned_route_to($relative_route, $version = '4.8.36')
634
-    {
635
-        return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
636
-    }
637
-
638
-
639
-    /**
640
-     * Adds all the RPC-style routes (remote procedure call-like routes, ie
641
-     * routes that don't conform to the traditional REST CRUD-style).
642
-     *
643
-     * @deprecated since 4.9.1
644
-     */
645
-    protected function _register_rpc_routes()
646
-    {
647
-        $routes = array();
648
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
649
-            $routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
650
-                $version,
651
-                $hidden_endpoint
652
-            );
653
-        }
654
-        return $routes;
655
-    }
656
-
657
-
658
-    /**
659
-     * @param string  $version
660
-     * @param boolean $hidden_endpoint
661
-     * @return array
662
-     */
663
-    protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
664
-    {
665
-        $this_versions_routes = array();
666
-        // checkin endpoint
667
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
668
-            array(
669
-                'callback'        => array(
670
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
671
-                    'handleRequestToggleCheckin',
672
-                ),
673
-                'methods'         => WP_REST_Server::CREATABLE,
674
-                'hidden_endpoint' => $hidden_endpoint,
675
-                'args'            => array(
676
-                    'force' => array(
677
-                        'required'    => false,
678
-                        'default'     => false,
679
-                        'description' => __(
680
-                        // @codingStandardsIgnoreStart
681
-                            'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
682
-                            // @codingStandardsIgnoreEnd
683
-                            'event_espresso'
684
-                        ),
685
-                    ),
686
-                ),
687
-                'callback_args'   => array($version),
688
-            ),
689
-        );
690
-        return apply_filters(
691
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
692
-            $this_versions_routes,
693
-            $version,
694
-            $hidden_endpoint
695
-        );
696
-    }
697
-
698
-
699
-    /**
700
-     * Gets the query params that can be used when request one or many
701
-     *
702
-     * @param EEM_Base $model
703
-     * @param string   $version
704
-     * @return array
705
-     */
706
-    protected function _get_response_selection_query_params(\EEM_Base $model, $version, $single_only = false)
707
-    {
708
-        $query_params = array(
709
-            'include'   => array(
710
-                'required' => false,
711
-                'default'  => '*',
712
-                'type'     => 'string',
713
-            ),
714
-            'calculate' => array(
715
-                'required'          => false,
716
-                'default'           => '',
717
-                'enum'              => self::$_field_calculator->retrieveCalculatedFieldsForModel($model),
718
-                'type'              => 'string',
719
-                // because we accept a CSV'd list of the enumerated strings, WP core validation and sanitization
720
-                // freaks out. We'll just validate this argument while handling the request
721
-                'validate_callback' => null,
722
-                'sanitize_callback' => null,
723
-            ),
724
-            'password' => array(
725
-                'required' => false,
726
-                'default' => '',
727
-                'type' => 'string'
728
-            )
729
-        );
730
-        return apply_filters(
731
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
732
-            $query_params,
733
-            $model,
734
-            $version
735
-        );
736
-    }
737
-
738
-
739
-    /**
740
-     * Gets the parameters acceptable for delete requests
741
-     *
742
-     * @param \EEM_Base $model
743
-     * @param string    $version
744
-     * @return array
745
-     */
746
-    protected function _get_delete_query_params(\EEM_Base $model, $version)
747
-    {
748
-        $params_for_delete = array(
749
-            'allow_blocking' => array(
750
-                'required' => false,
751
-                'default'  => true,
752
-                'type'     => 'boolean',
753
-            ),
754
-        );
755
-        $params_for_delete['force'] = array(
756
-            'required' => false,
757
-            'default'  => false,
758
-            'type'     => 'boolean',
759
-        );
760
-        return apply_filters(
761
-            'FHEE__EED_Core_Rest_Api___get_delete_query_params',
762
-            $params_for_delete,
763
-            $model,
764
-            $version
765
-        );
766
-    }
767
-
768
-    protected function _get_add_relation_query_params(\EEM_Base $source_model, \EEM_Base $related_model, $version)
769
-    {
770
-        // if they're related through a HABTM relation, check for any non-FKs
771
-        $all_relation_settings = $source_model->relation_settings();
772
-        $relation_settings = $all_relation_settings[ $related_model->get_this_model_name() ];
773
-        $params = array();
774
-        if ($relation_settings instanceof EE_HABTM_Relation && $relation_settings->hasNonKeyFields()) {
775
-            foreach ($relation_settings->getNonKeyFields() as $field) {
776
-                /* @var $field EE_Model_Field_Base */
777
-                $params[ $field->get_name() ] = array(
778
-                    'required' => ! $field->is_nullable(),
779
-                    'default' => ModelDataTranslator::prepareFieldValueForJson($field, $field->get_default_value(), $version),
780
-                    'type' => $field->getSchemaType(),
781
-                    'validate_callbaack' => null,
782
-                    'sanitize_callback' => null
783
-                );
784
-            }
785
-        }
786
-        return $params;
787
-    }
788
-
789
-
790
-    /**
791
-     * Gets info about reading query params that are acceptable
792
-     *
793
-     * @param \EEM_Base $model eg 'Event' or 'Venue'
794
-     * @param  string   $version
795
-     * @return array    describing the args acceptable when querying this model
796
-     * @throws EE_Error
797
-     */
798
-    protected function _get_read_query_params(\EEM_Base $model, $version)
799
-    {
800
-        $default_orderby = array();
801
-        foreach ($model->get_combined_primary_key_fields() as $key_field) {
802
-            $default_orderby[ $key_field->get_name() ] = 'ASC';
803
-        }
804
-        return array_merge(
805
-            $this->_get_response_selection_query_params($model, $version),
806
-            array(
807
-                'where'    => array(
808
-                    'required'          => false,
809
-                    'default'           => array(),
810
-                    'type'              => 'object',
811
-                    // because we accept an almost infinite list of possible where conditions, WP
812
-                    // core validation and sanitization freaks out. We'll just validate this argument
813
-                    // while handling the request
814
-                    'validate_callback' => null,
815
-                    'sanitize_callback' => null,
816
-                ),
817
-                'limit'    => array(
818
-                    'required'          => false,
819
-                    'default'           => EED_Core_Rest_Api::get_default_query_limit(),
820
-                    'type'              => array(
821
-                        'array',
822
-                        'string',
823
-                        'integer',
824
-                    ),
825
-                    // because we accept a variety of types, WP core validation and sanitization
826
-                    // freaks out. We'll just validate this argument while handling the request
827
-                    'validate_callback' => null,
828
-                    'sanitize_callback' => null,
829
-                ),
830
-                'order_by' => array(
831
-                    'required'          => false,
832
-                    'default'           => $default_orderby,
833
-                    'type'              => array(
834
-                        'object',
835
-                        'string',
836
-                    ),// because we accept a variety of types, WP core validation and sanitization
837
-                    // freaks out. We'll just validate this argument while handling the request
838
-                    'validate_callback' => null,
839
-                    'sanitize_callback' => null,
840
-                ),
841
-                'group_by' => array(
842
-                    'required'          => false,
843
-                    'default'           => null,
844
-                    'type'              => array(
845
-                        'object',
846
-                        'string',
847
-                    ),
848
-                    // because we accept  an almost infinite list of possible groupings,
849
-                    // WP core validation and sanitization
850
-                    // freaks out. We'll just validate this argument while handling the request
851
-                    'validate_callback' => null,
852
-                    'sanitize_callback' => null,
853
-                ),
854
-                'having'   => array(
855
-                    'required'          => false,
856
-                    'default'           => null,
857
-                    'type'              => 'object',
858
-                    // because we accept an almost infinite list of possible where conditions, WP
859
-                    // core validation and sanitization freaks out. We'll just validate this argument
860
-                    // while handling the request
861
-                    'validate_callback' => null,
862
-                    'sanitize_callback' => null,
863
-                ),
864
-                'caps'     => array(
865
-                    'required' => false,
866
-                    'default'  => EEM_Base::caps_read,
867
-                    'type'     => 'string',
868
-                    'enum'     => array(
869
-                        EEM_Base::caps_read,
870
-                        EEM_Base::caps_read_admin,
871
-                        EEM_Base::caps_edit,
872
-                        EEM_Base::caps_delete,
873
-                    ),
874
-                ),
875
-            )
876
-        );
877
-    }
878
-
879
-
880
-    /**
881
-     * Gets parameter information for a model regarding writing data
882
-     *
883
-     * @param string           $model_name
884
-     * @param ModelVersionInfo $model_version_info
885
-     * @param boolean          $create                                       whether this is for request to create (in
886
-     *                                                                       which case we need all required params) or
887
-     *                                                                       just to update (in which case we don't
888
-     *                                                                       need those on every request)
889
-     * @return array
890
-     */
891
-    protected function _get_write_params(
892
-        $model_name,
893
-        ModelVersionInfo $model_version_info,
894
-        $create = false
895
-    ) {
896
-        $model = EE_Registry::instance()->load_model($model_name);
897
-        $fields = $model_version_info->fieldsOnModelInThisVersion($model);
898
-        $args_info = array();
899
-        foreach ($fields as $field_name => $field_obj) {
900
-            if ($field_obj->is_auto_increment()) {
901
-                // totally ignore auto increment IDs
902
-                continue;
903
-            }
904
-            $arg_info = $field_obj->getSchema();
905
-            $required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
906
-            $arg_info['required'] = $required;
907
-            // remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
908
-            unset($arg_info['readonly']);
909
-            $schema_properties = $field_obj->getSchemaProperties();
910
-            if (isset($schema_properties['raw'])
911
-                && $field_obj->getSchemaType() === 'object'
912
-            ) {
913
-                // if there's a "raw" form of this argument, use those properties instead
914
-                $arg_info = array_replace(
915
-                    $arg_info,
916
-                    $schema_properties['raw']
917
-                );
918
-            }
919
-            $arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
920
-                $field_obj,
921
-                $field_obj->get_default_value(),
922
-                $model_version_info->requestedVersion()
923
-            );
924
-            // we do our own validation and sanitization within the controller
925
-            if (function_exists('rest_validate_value_from_schema')) {
926
-                $sanitize_callback = array(
927
-                    'EED_Core_Rest_Api',
928
-                    'default_sanitize_callback',
929
-                );
930
-            } else {
931
-                $sanitize_callback = null;
932
-            }
933
-            $arg_info['sanitize_callback'] = $sanitize_callback;
934
-            $args_info[ $field_name ] = $arg_info;
935
-            if ($field_obj instanceof EE_Datetime_Field) {
936
-                $gmt_arg_info = $arg_info;
937
-                $gmt_arg_info['description'] = sprintf(
938
-                    esc_html__(
939
-                        '%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
940
-                        'event_espresso'
941
-                    ),
942
-                    $field_obj->get_nicename(),
943
-                    $field_name
944
-                );
945
-                $args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
946
-            }
947
-        }
948
-        return $args_info;
949
-    }
950
-
951
-
952
-    /**
953
-     * Replacement for WP API's 'rest_parse_request_arg'.
954
-     * If the value is blank but not required, don't bother validating it.
955
-     * Also, it uses our email validation instead of WP API's default.
956
-     *
957
-     * @param                 $value
958
-     * @param WP_REST_Request $request
959
-     * @param                 $param
960
-     * @return bool|true|WP_Error
961
-     * @throws InvalidArgumentException
962
-     * @throws InvalidInterfaceException
963
-     * @throws InvalidDataTypeException
964
-     */
965
-    public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
966
-    {
967
-        $attributes = $request->get_attributes();
968
-        if (! isset($attributes['args'][ $param ])
969
-            || ! is_array($attributes['args'][ $param ])) {
970
-            $validation_result = true;
971
-        } else {
972
-            $args = $attributes['args'][ $param ];
973
-            if ((
974
-                    $value === ''
975
-                    || $value === null
976
-                )
977
-                && (! isset($args['required'])
978
-                    || $args['required'] === false
979
-                )
980
-            ) {
981
-                // not required and not provided? that's cool
982
-                $validation_result = true;
983
-            } elseif (isset($args['format'])
984
-                      && $args['format'] === 'email'
985
-            ) {
986
-                $validation_result = true;
987
-                if (! self::_validate_email($value)) {
988
-                    $validation_result = new WP_Error(
989
-                        'rest_invalid_param',
990
-                        esc_html__(
991
-                            'The email address is not valid or does not exist.',
992
-                            'event_espresso'
993
-                        )
994
-                    );
995
-                }
996
-            } else {
997
-                $validation_result = rest_validate_value_from_schema($value, $args, $param);
998
-            }
999
-        }
1000
-        if (is_wp_error($validation_result)) {
1001
-            return $validation_result;
1002
-        }
1003
-        return rest_sanitize_request_arg($value, $request, $param);
1004
-    }
1005
-
1006
-
1007
-    /**
1008
-     * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
1009
-     *
1010
-     * @param $email
1011
-     * @return bool
1012
-     * @throws InvalidArgumentException
1013
-     * @throws InvalidInterfaceException
1014
-     * @throws InvalidDataTypeException
1015
-     */
1016
-    protected static function _validate_email($email)
1017
-    {
1018
-        try {
1019
-            EmailAddressFactory::create($email);
1020
-            return true;
1021
-        } catch (EmailValidationException $e) {
1022
-            return false;
1023
-        }
1024
-    }
1025
-
1026
-
1027
-    /**
1028
-     * Gets routes for the config
1029
-     *
1030
-     * @return array @see _register_model_routes
1031
-     * @deprecated since version 4.9.1
1032
-     */
1033
-    protected function _register_config_routes()
1034
-    {
1035
-        $config_routes = array();
1036
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
1037
-            $config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
1038
-                $version,
1039
-                $hidden_endpoint
1040
-            );
1041
-        }
1042
-        return $config_routes;
1043
-    }
1044
-
1045
-
1046
-    /**
1047
-     * Gets routes for the config for the specified version
1048
-     *
1049
-     * @param string  $version
1050
-     * @param boolean $hidden_endpoint
1051
-     * @return array
1052
-     */
1053
-    protected function _get_config_route_data_for_version($version, $hidden_endpoint)
1054
-    {
1055
-        return array(
1056
-            'config'    => array(
1057
-                array(
1058
-                    'callback'        => array(
1059
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1060
-                        'handleRequest',
1061
-                    ),
1062
-                    'methods'         => WP_REST_Server::READABLE,
1063
-                    'hidden_endpoint' => $hidden_endpoint,
1064
-                    'callback_args'   => array($version),
1065
-                ),
1066
-            ),
1067
-            'site_info' => array(
1068
-                array(
1069
-                    'callback'        => array(
1070
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1071
-                        'handleRequestSiteInfo',
1072
-                    ),
1073
-                    'methods'         => WP_REST_Server::READABLE,
1074
-                    'hidden_endpoint' => $hidden_endpoint,
1075
-                    'callback_args'   => array($version),
1076
-                ),
1077
-            ),
1078
-        );
1079
-    }
1080
-
1081
-
1082
-    /**
1083
-     * Gets the meta info routes
1084
-     *
1085
-     * @return array @see _register_model_routes
1086
-     * @deprecated since version 4.9.1
1087
-     */
1088
-    protected function _register_meta_routes()
1089
-    {
1090
-        $meta_routes = array();
1091
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
1092
-            $meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
1093
-                $version,
1094
-                $hidden_endpoint
1095
-            );
1096
-        }
1097
-        return $meta_routes;
1098
-    }
1099
-
1100
-
1101
-    /**
1102
-     * @param string  $version
1103
-     * @param boolean $hidden_endpoint
1104
-     * @return array
1105
-     */
1106
-    protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
1107
-    {
1108
-        return array(
1109
-            'resources' => array(
1110
-                array(
1111
-                    'callback'        => array(
1112
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
1113
-                        'handleRequestModelsMeta',
1114
-                    ),
1115
-                    'methods'         => WP_REST_Server::READABLE,
1116
-                    'hidden_endpoint' => $hidden_endpoint,
1117
-                    'callback_args'   => array($version),
1118
-                ),
1119
-            ),
1120
-        );
1121
-    }
1122
-
1123
-
1124
-    /**
1125
-     * Tries to hide old 4.6 endpoints from the
1126
-     *
1127
-     * @param array $route_data
1128
-     * @return array
1129
-     * @throws \EE_Error
1130
-     */
1131
-    public static function hide_old_endpoints($route_data)
1132
-    {
1133
-        // allow API clients to override which endpoints get hidden, in case
1134
-        // they want to discover particular endpoints
1135
-        // also, we don't have access to the request so we have to just grab it from the superglobal
1136
-        $force_show_ee_namespace = ltrim(
1137
-            EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
1138
-            '/'
1139
-        );
1140
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
1141
-            foreach ($relative_urls as $resource_name => $endpoints) {
1142
-                foreach ($endpoints as $key => $endpoint) {
1143
-                    // skip schema and other route options
1144
-                    if (! is_numeric($key)) {
1145
-                        continue;
1146
-                    }
1147
-                    // by default, hide "hidden_endpoint"s, unless the request indicates
1148
-                    // to $force_show_ee_namespace, in which case only show that one
1149
-                    // namespace's endpoints (and hide all others)
1150
-                    if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
1151
-                        || ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
1152
-                    ) {
1153
-                        $full_route = '/' . ltrim($namespace, '/');
1154
-                        $full_route .= '/' . ltrim($resource_name, '/');
1155
-                        unset($route_data[ $full_route ]);
1156
-                    }
1157
-                }
1158
-            }
1159
-        }
1160
-        return $route_data;
1161
-    }
1162
-
1163
-
1164
-    /**
1165
-     * Returns an array describing which versions of core support serving requests for.
1166
-     * Keys are core versions' major and minor version, and values are the
1167
-     * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
1168
-     * data by just removing a few models and fields from the responses. However, 4.15 might remove
1169
-     * the answers table entirely, in which case it would be very difficult for
1170
-     * it to serve 4.6-style responses.
1171
-     * Versions of core that are missing from this array are unknowns.
1172
-     * previous ver
1173
-     *
1174
-     * @return array
1175
-     */
1176
-    public static function version_compatibilities()
1177
-    {
1178
-        return apply_filters(
1179
-            'FHEE__EED_Core_REST_API__version_compatibilities',
1180
-            array(
1181
-                '4.8.29' => '4.8.29',
1182
-                '4.8.33' => '4.8.29',
1183
-                '4.8.34' => '4.8.29',
1184
-                '4.8.36' => '4.8.29',
1185
-            )
1186
-        );
1187
-    }
1188
-
1189
-
1190
-    /**
1191
-     * Gets the latest API version served. Eg if there
1192
-     * are two versions served of the API, 4.8.29 and 4.8.32, and
1193
-     * we are on core version 4.8.34, it will return the string "4.8.32"
1194
-     *
1195
-     * @return string
1196
-     */
1197
-    public static function latest_rest_api_version()
1198
-    {
1199
-        $versions_served = \EED_Core_Rest_Api::versions_served();
1200
-        $versions_served_keys = array_keys($versions_served);
1201
-        return end($versions_served_keys);
1202
-    }
1203
-
1204
-
1205
-    /**
1206
-     * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
1207
-     * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
1208
-     * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
1209
-     * We also indicate whether or not this version should be put in the index or not
1210
-     *
1211
-     * @return array keys are API version numbers (just major and minor numbers), and values
1212
-     * are whether or not they should be hidden
1213
-     */
1214
-    public static function versions_served()
1215
-    {
1216
-        $versions_served = array();
1217
-        $possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
1218
-        $lowest_compatible_version = end($possibly_served_versions);
1219
-        reset($possibly_served_versions);
1220
-        $versions_served_historically = array_keys($possibly_served_versions);
1221
-        $latest_version = end($versions_served_historically);
1222
-        reset($versions_served_historically);
1223
-        // for each version of core we have ever served:
1224
-        foreach ($versions_served_historically as $key_versioned_endpoint) {
1225
-            // if it's not above the current core version, and it's compatible with the current version of core
1226
-            if ($key_versioned_endpoint === $latest_version) {
1227
-                // don't hide the latest version in the index
1228
-                $versions_served[ $key_versioned_endpoint ] = false;
1229
-            } elseif ($key_versioned_endpoint >= $lowest_compatible_version
1230
-                && $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
1231
-            ) {
1232
-                // include, but hide, previous versions which are still supported
1233
-                $versions_served[ $key_versioned_endpoint ] = true;
1234
-            } elseif (apply_filters(
1235
-                'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
1236
-                false,
1237
-                $possibly_served_versions
1238
-            )) {
1239
-                // if a version is no longer supported, don't include it in index or list of versions served
1240
-                $versions_served[ $key_versioned_endpoint ] = true;
1241
-            }
1242
-        }
1243
-        return $versions_served;
1244
-    }
1245
-
1246
-
1247
-    /**
1248
-     * Gets the major and minor version of EE core's version string
1249
-     *
1250
-     * @return string
1251
-     */
1252
-    public static function core_version()
1253
-    {
1254
-        return apply_filters(
1255
-            'FHEE__EED_Core_REST_API__core_version',
1256
-            implode(
1257
-                '.',
1258
-                array_slice(
1259
-                    explode(
1260
-                        '.',
1261
-                        espresso_version()
1262
-                    ),
1263
-                    0,
1264
-                    3
1265
-                )
1266
-            )
1267
-        );
1268
-    }
1269
-
1270
-
1271
-    /**
1272
-     * Gets the default limit that should be used when querying for resources
1273
-     *
1274
-     * @return int
1275
-     */
1276
-    public static function get_default_query_limit()
1277
-    {
1278
-        // we actually don't use a const because we want folks to always use
1279
-        // this method, not the const directly
1280
-        return apply_filters(
1281
-            'FHEE__EED_Core_Rest_Api__get_default_query_limit',
1282
-            50
1283
-        );
1284
-    }
1285
-
1286
-
1287
-    /**
1288
-     *
1289
-     * @param string $version api version string (i.e. '4.8.36')
1290
-     * @return array
1291
-     */
1292
-    public static function getCollectionRoutesIndexedByModelName($version = '')
1293
-    {
1294
-        $version = empty($version) ? self::latest_rest_api_version() : $version;
1295
-        $model_names = self::model_names_with_plural_routes($version);
1296
-        $collection_routes = array();
1297
-        foreach ($model_names as $model_name => $model_class_name) {
1298
-            $collection_routes[ strtolower($model_name) ] = '/' . self::ee_api_namespace . $version . '/'
1299
-                                                            . EEH_Inflector::pluralize_and_lower($model_name);
1300
-        }
1301
-        return $collection_routes;
1302
-    }
1303
-
1304
-
1305
-    /**
1306
-     * Returns an array of primary key names indexed by model names.
1307
-     * @param string $version
1308
-     * @return array
1309
-     */
1310
-    public static function getPrimaryKeyNamesIndexedByModelName($version = '')
1311
-    {
1312
-        $version = empty($version) ? self::latest_rest_api_version() : $version;
1313
-        $model_names = self::model_names_with_plural_routes($version);
1314
-        $primary_key_items = array();
1315
-        foreach ($model_names as $model_name => $model_class_name) {
1316
-            $primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
1317
-            foreach ($primary_keys as $primary_key_name => $primary_key_field) {
1318
-                if (count($primary_keys) > 1) {
1319
-                    $primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
1320
-                } else {
1321
-                    $primary_key_items[ strtolower($model_name) ] = $primary_key_name;
1322
-                }
1323
-            }
1324
-        }
1325
-        return $primary_key_items;
1326
-    }
1327
-
1328
-    /**
1329
-     * Determines the EE REST API debug mode is activated, or not.
1330
-     * @since 4.9.76.p
1331
-     * @return bool
1332
-     */
1333
-    public static function debugMode()
1334
-    {
1335
-        static $debug_mode = null; // could be class prop
1336
-        if ($debug_mode === null) {
1337
-            $debug_mode = defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE;
1338
-        }
1339
-        return $debug_mode;
1340
-    }
1341
-
1342
-
1343
-
1344
-    /**
1345
-     *    run - initial module setup
1346
-     *
1347
-     * @access    public
1348
-     * @param  WP $WP
1349
-     * @return    void
1350
-     */
1351
-    public function run($WP)
1352
-    {
1353
-    }
26
+	const ee_api_namespace = Domain::API_NAMESPACE;
27
+
28
+	const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
29
+
30
+	const saved_routes_option_names = 'ee_core_routes';
31
+
32
+	/**
33
+	 * string used in _links response bodies to make them globally unique.
34
+	 *
35
+	 * @see http://v2.wp-api.org/extending/linking/
36
+	 */
37
+	const ee_api_link_namespace = 'https://api.eventespresso.com/';
38
+
39
+	/**
40
+	 * @var CalculatedModelFields
41
+	 */
42
+	protected static $_field_calculator;
43
+
44
+
45
+	/**
46
+	 * @return EED_Core_Rest_Api|EED_Module
47
+	 */
48
+	public static function instance()
49
+	{
50
+		self::$_field_calculator = LoaderFactory::getLoader()->load('EventEspresso\core\libraries\rest_api\CalculatedModelFields');
51
+		return parent::get_instance(__CLASS__);
52
+	}
53
+
54
+
55
+	/**
56
+	 *    set_hooks - for hooking into EE Core, other modules, etc
57
+	 *
58
+	 * @access    public
59
+	 * @return    void
60
+	 */
61
+	public static function set_hooks()
62
+	{
63
+		self::set_hooks_both();
64
+	}
65
+
66
+
67
+	/**
68
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
69
+	 *
70
+	 * @access    public
71
+	 * @return    void
72
+	 */
73
+	public static function set_hooks_admin()
74
+	{
75
+		self::set_hooks_both();
76
+	}
77
+
78
+
79
+	public static function set_hooks_both()
80
+	{
81
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
82
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
83
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
84
+		add_filter(
85
+			'rest_index',
86
+			array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex')
87
+		);
88
+		EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
89
+	}
90
+
91
+
92
+	/**
93
+	 * sets up hooks which only need to be included as part of REST API requests;
94
+	 * other requests like to the frontend or admin etc don't need them
95
+	 *
96
+	 * @throws \EE_Error
97
+	 */
98
+	public static function set_hooks_rest_api()
99
+	{
100
+		// set hooks which account for changes made to the API
101
+		EED_Core_Rest_Api::_set_hooks_for_changes();
102
+	}
103
+
104
+
105
+	/**
106
+	 * public wrapper of _set_hooks_for_changes.
107
+	 * Loads all the hooks which make requests to old versions of the API
108
+	 * appear the same as they always did
109
+	 *
110
+	 * @throws EE_Error
111
+	 */
112
+	public static function set_hooks_for_changes()
113
+	{
114
+		self::_set_hooks_for_changes();
115
+	}
116
+
117
+
118
+	/**
119
+	 * Loads all the hooks which make requests to old versions of the API
120
+	 * appear the same as they always did
121
+	 *
122
+	 * @throws EE_Error
123
+	 */
124
+	protected static function _set_hooks_for_changes()
125
+	{
126
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
127
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
128
+			// ignore the base parent class
129
+			// and legacy named classes
130
+			if ($classname_in_namespace === 'ChangesInBase'
131
+				|| strpos($classname_in_namespace, 'Changes_In_') === 0
132
+			) {
133
+				continue;
134
+			}
135
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
136
+			if (class_exists($full_classname)) {
137
+				$instance_of_class = new $full_classname;
138
+				if ($instance_of_class instanceof ChangesInBase) {
139
+					$instance_of_class->setHooks();
140
+				}
141
+			}
142
+		}
143
+	}
144
+
145
+
146
+	/**
147
+	 * Filters the WP routes to add our EE-related ones. This takes a bit of time
148
+	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
149
+	 *
150
+	 * @throws \EE_Error
151
+	 */
152
+	public static function register_routes()
153
+	{
154
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
155
+			foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
156
+				/**
157
+				 * @var array     $data_for_multiple_endpoints numerically indexed array
158
+				 *                                         but can also contain route options like {
159
+				 * @type array    $schema                      {
160
+				 * @type callable $schema_callback
161
+				 * @type array    $callback_args               arguments that will be passed to the callback, after the
162
+				 * WP_REST_Request of course
163
+				 * }
164
+				 * }
165
+				 */
166
+				// when registering routes, register all the endpoints' data at the same time
167
+				$multiple_endpoint_args = array();
168
+				foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
169
+					/**
170
+					 * @var array     $data_for_single_endpoint {
171
+					 * @type callable $callback
172
+					 * @type string methods
173
+					 * @type array args
174
+					 * @type array _links
175
+					 * @type array    $callback_args            arguments that will be passed to the callback, after the
176
+					 * WP_REST_Request of course
177
+					 * }
178
+					 */
179
+					// skip route options
180
+					if (! is_numeric($endpoint_key)) {
181
+						continue;
182
+					}
183
+					if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
184
+						throw new EE_Error(
185
+							esc_html__(
186
+							// @codingStandardsIgnoreStart
187
+								'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
188
+								// @codingStandardsIgnoreEnd
189
+								'event_espresso'
190
+							)
191
+						);
192
+					}
193
+					$callback = $data_for_single_endpoint['callback'];
194
+					$single_endpoint_args = array(
195
+						'methods' => $data_for_single_endpoint['methods'],
196
+						'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
197
+							: array(),
198
+					);
199
+					if (isset($data_for_single_endpoint['_links'])) {
200
+						$single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
201
+					}
202
+					if (isset($data_for_single_endpoint['callback_args'])) {
203
+						$callback_args = $data_for_single_endpoint['callback_args'];
204
+						$single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
205
+							$callback,
206
+							$callback_args
207
+						) {
208
+							array_unshift($callback_args, $request);
209
+							return call_user_func_array(
210
+								$callback,
211
+								$callback_args
212
+							);
213
+						};
214
+					} else {
215
+						$single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
216
+					}
217
+					$multiple_endpoint_args[] = $single_endpoint_args;
218
+				}
219
+				if (isset($data_for_multiple_endpoints['schema'])) {
220
+					$schema_route_data = $data_for_multiple_endpoints['schema'];
221
+					$schema_callback = $schema_route_data['schema_callback'];
222
+					$callback_args = $schema_route_data['callback_args'];
223
+					$multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
224
+						return call_user_func_array(
225
+							$schema_callback,
226
+							$callback_args
227
+						);
228
+					};
229
+				}
230
+				register_rest_route(
231
+					$namespace,
232
+					$relative_route,
233
+					$multiple_endpoint_args
234
+				);
235
+			}
236
+		}
237
+	}
238
+
239
+
240
+	/**
241
+	 * Checks if there was a version change or something that merits invalidating the cached
242
+	 * route data. If so, invalidates the cached route data so that it gets refreshed
243
+	 * next time the WP API is used
244
+	 */
245
+	public static function invalidate_cached_route_data_on_version_change()
246
+	{
247
+		if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
248
+			EED_Core_Rest_Api::invalidate_cached_route_data();
249
+		}
250
+		foreach (EE_Registry::instance()->addons as $addon) {
251
+			if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
252
+				EED_Core_Rest_Api::invalidate_cached_route_data();
253
+			}
254
+		}
255
+	}
256
+
257
+
258
+	/**
259
+	 * Removes the cached route data so it will get refreshed next time the WP API is used
260
+	 */
261
+	public static function invalidate_cached_route_data()
262
+	{
263
+		// delete the saved EE REST API routes
264
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
265
+			delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
266
+		}
267
+	}
268
+
269
+
270
+	/**
271
+	 * Gets the EE route data
272
+	 *
273
+	 * @return array top-level key is the namespace, next-level key is the route and its value is array{
274
+	 * @throws \EE_Error
275
+	 * @type string|array $callback
276
+	 * @type string       $methods
277
+	 * @type boolean      $hidden_endpoint
278
+	 * }
279
+	 */
280
+	public static function get_ee_route_data()
281
+	{
282
+		$ee_routes = array();
283
+		foreach (self::versions_served() as $version => $hidden_endpoints) {
284
+			$ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version(
285
+				$version,
286
+				$hidden_endpoints
287
+			);
288
+		}
289
+		return $ee_routes;
290
+	}
291
+
292
+
293
+	/**
294
+	 * Gets the EE route data from the wp options if it exists already,
295
+	 * otherwise re-generates it and saves it to the option
296
+	 *
297
+	 * @param string  $version
298
+	 * @param boolean $hidden_endpoints
299
+	 * @return array
300
+	 * @throws \EE_Error
301
+	 */
302
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
303
+	{
304
+		$ee_routes = get_option(self::saved_routes_option_names . $version, null);
305
+		if (! $ee_routes || EED_Core_Rest_Api::debugMode()) {
306
+			$ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
307
+		}
308
+		return $ee_routes;
309
+	}
310
+
311
+
312
+	/**
313
+	 * Saves the EE REST API route data to a wp option and returns it
314
+	 *
315
+	 * @param string  $version
316
+	 * @param boolean $hidden_endpoints
317
+	 * @return mixed|null
318
+	 * @throws \EE_Error
319
+	 */
320
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
321
+	{
322
+		$instance = self::instance();
323
+		$routes = apply_filters(
324
+			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
325
+			array_replace_recursive(
326
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
327
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
328
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
329
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
330
+			)
331
+		);
332
+		$option_name = self::saved_routes_option_names . $version;
333
+		if (get_option($option_name)) {
334
+			update_option($option_name, $routes, true);
335
+		} else {
336
+			add_option($option_name, $routes, null, 'no');
337
+		}
338
+		return $routes;
339
+	}
340
+
341
+
342
+	/**
343
+	 * Calculates all the EE routes and saves it to a WordPress option so we don't
344
+	 * need to calculate it on every request
345
+	 *
346
+	 * @deprecated since version 4.9.1
347
+	 * @return void
348
+	 */
349
+	public static function save_ee_routes()
350
+	{
351
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
352
+			$instance = self::instance();
353
+			$routes = apply_filters(
354
+				'EED_Core_Rest_Api__save_ee_routes__routes',
355
+				array_replace_recursive(
356
+					$instance->_register_config_routes(),
357
+					$instance->_register_meta_routes(),
358
+					$instance->_register_model_routes(),
359
+					$instance->_register_rpc_routes()
360
+				)
361
+			);
362
+			update_option(self::saved_routes_option_names, $routes, true);
363
+		}
364
+	}
365
+
366
+
367
+	/**
368
+	 * Gets all the route information relating to EE models
369
+	 *
370
+	 * @return array @see get_ee_route_data
371
+	 * @deprecated since version 4.9.1
372
+	 */
373
+	protected function _register_model_routes()
374
+	{
375
+		$model_routes = array();
376
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
377
+			$model_routes[ EED_Core_Rest_Api::ee_api_namespace
378
+						   . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
379
+		}
380
+		return $model_routes;
381
+	}
382
+
383
+
384
+	/**
385
+	 * Decides whether or not to add write endpoints for this model.
386
+	 *
387
+	 * Currently, this defaults to exclude all global tables and models
388
+	 * which would allow inserting WP core data (we don't want to duplicate
389
+	 * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
390
+	 *
391
+	 * @param EEM_Base $model
392
+	 * @return bool
393
+	 */
394
+	public static function should_have_write_endpoints(EEM_Base $model)
395
+	{
396
+		if ($model->is_wp_core_model()) {
397
+			return false;
398
+		}
399
+		foreach ($model->get_tables() as $table) {
400
+			if ($table->is_global()) {
401
+				return false;
402
+			}
403
+		}
404
+		return true;
405
+	}
406
+
407
+
408
+	/**
409
+	 * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
410
+	 * in this versioned namespace of EE4
411
+	 *
412
+	 * @param $version
413
+	 * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
414
+	 */
415
+	public static function model_names_with_plural_routes($version)
416
+	{
417
+		$model_version_info = new ModelVersionInfo($version);
418
+		$models_to_register = $model_version_info->modelsForRequestedVersion();
419
+		// let's not bother having endpoints for extra metas
420
+		unset(
421
+			$models_to_register['Extra_Meta'],
422
+			$models_to_register['Extra_Join'],
423
+			$models_to_register['Post_Meta']
424
+		);
425
+		return apply_filters(
426
+			'FHEE__EED_Core_REST_API___register_model_routes',
427
+			$models_to_register
428
+		);
429
+	}
430
+
431
+
432
+	/**
433
+	 * Gets the route data for EE models in the specified version
434
+	 *
435
+	 * @param string  $version
436
+	 * @param boolean $hidden_endpoint
437
+	 * @return array
438
+	 * @throws EE_Error
439
+	 */
440
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
441
+	{
442
+		$model_routes = array();
443
+		$model_version_info = new ModelVersionInfo($version);
444
+		foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
445
+			$model = \EE_Registry::instance()->load_model($model_name);
446
+			// if this isn't a valid model then let's skip iterate to the next item in the loop.
447
+			if (! $model instanceof EEM_Base) {
448
+				continue;
449
+			}
450
+			// yes we could just register one route for ALL models, but then they wouldn't show up in the index
451
+			$plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
452
+			$singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
453
+			$model_routes[ $plural_model_route ] = array(
454
+				array(
455
+					'callback'        => array(
456
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
457
+						'handleRequestGetAll',
458
+					),
459
+					'callback_args'   => array($version, $model_name),
460
+					'methods'         => WP_REST_Server::READABLE,
461
+					'hidden_endpoint' => $hidden_endpoint,
462
+					'args'            => $this->_get_read_query_params($model, $version),
463
+					'_links'          => array(
464
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
465
+					),
466
+				),
467
+				'schema' => array(
468
+					'schema_callback' => array(
469
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
470
+						'handleSchemaRequest',
471
+					),
472
+					'callback_args'   => array($version, $model_name),
473
+				),
474
+			);
475
+			$model_routes[ $singular_model_route ] = array(
476
+				array(
477
+					'callback'        => array(
478
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
479
+						'handleRequestGetOne',
480
+					),
481
+					'callback_args'   => array($version, $model_name),
482
+					'methods'         => WP_REST_Server::READABLE,
483
+					'hidden_endpoint' => $hidden_endpoint,
484
+					'args'            => $this->_get_response_selection_query_params($model, $version, true),
485
+				),
486
+			);
487
+			if (apply_filters(
488
+				'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
489
+				EED_Core_Rest_Api::should_have_write_endpoints($model),
490
+				$model
491
+			)) {
492
+				$model_routes[ $plural_model_route ][] = array(
493
+					'callback'        => array(
494
+						'EventEspresso\core\libraries\rest_api\controllers\model\Write',
495
+						'handleRequestInsert',
496
+					),
497
+					'callback_args'   => array($version, $model_name),
498
+					'methods'         => WP_REST_Server::CREATABLE,
499
+					'hidden_endpoint' => $hidden_endpoint,
500
+					'args'            => $this->_get_write_params($model_name, $model_version_info, true),
501
+				);
502
+				$model_routes[ $singular_model_route ] = array_merge(
503
+					$model_routes[ $singular_model_route ],
504
+					array(
505
+						array(
506
+							'callback'        => array(
507
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
508
+								'handleRequestUpdate',
509
+							),
510
+							'callback_args'   => array($version, $model_name),
511
+							'methods'         => WP_REST_Server::EDITABLE,
512
+							'hidden_endpoint' => $hidden_endpoint,
513
+							'args'            => $this->_get_write_params($model_name, $model_version_info),
514
+						),
515
+						array(
516
+							'callback'        => array(
517
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
518
+								'handleRequestDelete',
519
+							),
520
+							'callback_args'   => array($version, $model_name),
521
+							'methods'         => WP_REST_Server::DELETABLE,
522
+							'hidden_endpoint' => $hidden_endpoint,
523
+							'args'            => $this->_get_delete_query_params($model, $version),
524
+						),
525
+					)
526
+				);
527
+			}
528
+			foreach ($model->relation_settings() as $relation_name => $relation_obj) {
529
+				$related_route = EED_Core_Rest_Api::get_relation_route_via(
530
+					$model,
531
+					'(?P<id>[^\/]+)',
532
+					$relation_obj
533
+				);
534
+				$model_routes[ $related_route ] = array(
535
+					array(
536
+						'callback'        => array(
537
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
538
+							'handleRequestGetRelated',
539
+						),
540
+						'callback_args'   => array($version, $model_name, $relation_name),
541
+						'methods'         => WP_REST_Server::READABLE,
542
+						'hidden_endpoint' => $hidden_endpoint,
543
+						'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
544
+					),
545
+				);
546
+
547
+				$related_write_route = $related_route . '/' . '(?P<related_id>[^\/]+)';
548
+				$model_routes[ $related_write_route ] = array(
549
+					array(
550
+						'callback'        => array(
551
+							'EventEspresso\core\libraries\rest_api\controllers\model\Write',
552
+							'handleRequestAddRelation',
553
+						),
554
+						'callback_args'   => array($version, $model_name, $relation_name),
555
+						'methods'         => WP_REST_Server::EDITABLE,
556
+						'hidden_endpoint' => $hidden_endpoint,
557
+						'args'            => $this->_get_add_relation_query_params($model, $relation_obj->get_other_model(), $version)
558
+					),
559
+					array(
560
+						'callback'        => array(
561
+							'EventEspresso\core\libraries\rest_api\controllers\model\Write',
562
+							'handleRequestRemoveRelation',
563
+						),
564
+						'callback_args'   => array($version, $model_name, $relation_name),
565
+						'methods'         => WP_REST_Server::DELETABLE,
566
+						'hidden_endpoint' => $hidden_endpoint,
567
+						'args'            => array()
568
+					),
569
+				);
570
+			}
571
+		}
572
+		return $model_routes;
573
+	}
574
+
575
+
576
+	/**
577
+	 * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
578
+	 * excluding the preceding slash.
579
+	 * Eg you pass get_plural_route_to('Event') = 'events'
580
+	 *
581
+	 * @param EEM_Base $model
582
+	 * @return string
583
+	 */
584
+	public static function get_collection_route(EEM_Base $model)
585
+	{
586
+		return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
587
+	}
588
+
589
+
590
+	/**
591
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
592
+	 * excluding the preceding slash.
593
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
594
+	 *
595
+	 * @param EEM_Base $model eg Event or Venue
596
+	 * @param string   $id
597
+	 * @return string
598
+	 */
599
+	public static function get_entity_route($model, $id)
600
+	{
601
+		return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
602
+	}
603
+
604
+
605
+	/**
606
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
607
+	 * excluding the preceding slash.
608
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
609
+	 *
610
+	 * @param EEM_Base               $model eg Event or Venue
611
+	 * @param string                 $id
612
+	 * @param EE_Model_Relation_Base $relation_obj
613
+	 * @return string
614
+	 */
615
+	public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
616
+	{
617
+		$related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
618
+			$relation_obj->get_other_model()->get_this_model_name(),
619
+			$relation_obj
620
+		);
621
+		return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
622
+	}
623
+
624
+
625
+	/**
626
+	 * Adds onto the $relative_route the EE4 REST API versioned namespace.
627
+	 * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
628
+	 *
629
+	 * @param string $relative_route
630
+	 * @param string $version
631
+	 * @return string
632
+	 */
633
+	public static function get_versioned_route_to($relative_route, $version = '4.8.36')
634
+	{
635
+		return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
636
+	}
637
+
638
+
639
+	/**
640
+	 * Adds all the RPC-style routes (remote procedure call-like routes, ie
641
+	 * routes that don't conform to the traditional REST CRUD-style).
642
+	 *
643
+	 * @deprecated since 4.9.1
644
+	 */
645
+	protected function _register_rpc_routes()
646
+	{
647
+		$routes = array();
648
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
649
+			$routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
650
+				$version,
651
+				$hidden_endpoint
652
+			);
653
+		}
654
+		return $routes;
655
+	}
656
+
657
+
658
+	/**
659
+	 * @param string  $version
660
+	 * @param boolean $hidden_endpoint
661
+	 * @return array
662
+	 */
663
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
664
+	{
665
+		$this_versions_routes = array();
666
+		// checkin endpoint
667
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
668
+			array(
669
+				'callback'        => array(
670
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
671
+					'handleRequestToggleCheckin',
672
+				),
673
+				'methods'         => WP_REST_Server::CREATABLE,
674
+				'hidden_endpoint' => $hidden_endpoint,
675
+				'args'            => array(
676
+					'force' => array(
677
+						'required'    => false,
678
+						'default'     => false,
679
+						'description' => __(
680
+						// @codingStandardsIgnoreStart
681
+							'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
682
+							// @codingStandardsIgnoreEnd
683
+							'event_espresso'
684
+						),
685
+					),
686
+				),
687
+				'callback_args'   => array($version),
688
+			),
689
+		);
690
+		return apply_filters(
691
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
692
+			$this_versions_routes,
693
+			$version,
694
+			$hidden_endpoint
695
+		);
696
+	}
697
+
698
+
699
+	/**
700
+	 * Gets the query params that can be used when request one or many
701
+	 *
702
+	 * @param EEM_Base $model
703
+	 * @param string   $version
704
+	 * @return array
705
+	 */
706
+	protected function _get_response_selection_query_params(\EEM_Base $model, $version, $single_only = false)
707
+	{
708
+		$query_params = array(
709
+			'include'   => array(
710
+				'required' => false,
711
+				'default'  => '*',
712
+				'type'     => 'string',
713
+			),
714
+			'calculate' => array(
715
+				'required'          => false,
716
+				'default'           => '',
717
+				'enum'              => self::$_field_calculator->retrieveCalculatedFieldsForModel($model),
718
+				'type'              => 'string',
719
+				// because we accept a CSV'd list of the enumerated strings, WP core validation and sanitization
720
+				// freaks out. We'll just validate this argument while handling the request
721
+				'validate_callback' => null,
722
+				'sanitize_callback' => null,
723
+			),
724
+			'password' => array(
725
+				'required' => false,
726
+				'default' => '',
727
+				'type' => 'string'
728
+			)
729
+		);
730
+		return apply_filters(
731
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
732
+			$query_params,
733
+			$model,
734
+			$version
735
+		);
736
+	}
737
+
738
+
739
+	/**
740
+	 * Gets the parameters acceptable for delete requests
741
+	 *
742
+	 * @param \EEM_Base $model
743
+	 * @param string    $version
744
+	 * @return array
745
+	 */
746
+	protected function _get_delete_query_params(\EEM_Base $model, $version)
747
+	{
748
+		$params_for_delete = array(
749
+			'allow_blocking' => array(
750
+				'required' => false,
751
+				'default'  => true,
752
+				'type'     => 'boolean',
753
+			),
754
+		);
755
+		$params_for_delete['force'] = array(
756
+			'required' => false,
757
+			'default'  => false,
758
+			'type'     => 'boolean',
759
+		);
760
+		return apply_filters(
761
+			'FHEE__EED_Core_Rest_Api___get_delete_query_params',
762
+			$params_for_delete,
763
+			$model,
764
+			$version
765
+		);
766
+	}
767
+
768
+	protected function _get_add_relation_query_params(\EEM_Base $source_model, \EEM_Base $related_model, $version)
769
+	{
770
+		// if they're related through a HABTM relation, check for any non-FKs
771
+		$all_relation_settings = $source_model->relation_settings();
772
+		$relation_settings = $all_relation_settings[ $related_model->get_this_model_name() ];
773
+		$params = array();
774
+		if ($relation_settings instanceof EE_HABTM_Relation && $relation_settings->hasNonKeyFields()) {
775
+			foreach ($relation_settings->getNonKeyFields() as $field) {
776
+				/* @var $field EE_Model_Field_Base */
777
+				$params[ $field->get_name() ] = array(
778
+					'required' => ! $field->is_nullable(),
779
+					'default' => ModelDataTranslator::prepareFieldValueForJson($field, $field->get_default_value(), $version),
780
+					'type' => $field->getSchemaType(),
781
+					'validate_callbaack' => null,
782
+					'sanitize_callback' => null
783
+				);
784
+			}
785
+		}
786
+		return $params;
787
+	}
788
+
789
+
790
+	/**
791
+	 * Gets info about reading query params that are acceptable
792
+	 *
793
+	 * @param \EEM_Base $model eg 'Event' or 'Venue'
794
+	 * @param  string   $version
795
+	 * @return array    describing the args acceptable when querying this model
796
+	 * @throws EE_Error
797
+	 */
798
+	protected function _get_read_query_params(\EEM_Base $model, $version)
799
+	{
800
+		$default_orderby = array();
801
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
802
+			$default_orderby[ $key_field->get_name() ] = 'ASC';
803
+		}
804
+		return array_merge(
805
+			$this->_get_response_selection_query_params($model, $version),
806
+			array(
807
+				'where'    => array(
808
+					'required'          => false,
809
+					'default'           => array(),
810
+					'type'              => 'object',
811
+					// because we accept an almost infinite list of possible where conditions, WP
812
+					// core validation and sanitization freaks out. We'll just validate this argument
813
+					// while handling the request
814
+					'validate_callback' => null,
815
+					'sanitize_callback' => null,
816
+				),
817
+				'limit'    => array(
818
+					'required'          => false,
819
+					'default'           => EED_Core_Rest_Api::get_default_query_limit(),
820
+					'type'              => array(
821
+						'array',
822
+						'string',
823
+						'integer',
824
+					),
825
+					// because we accept a variety of types, WP core validation and sanitization
826
+					// freaks out. We'll just validate this argument while handling the request
827
+					'validate_callback' => null,
828
+					'sanitize_callback' => null,
829
+				),
830
+				'order_by' => array(
831
+					'required'          => false,
832
+					'default'           => $default_orderby,
833
+					'type'              => array(
834
+						'object',
835
+						'string',
836
+					),// because we accept a variety of types, WP core validation and sanitization
837
+					// freaks out. We'll just validate this argument while handling the request
838
+					'validate_callback' => null,
839
+					'sanitize_callback' => null,
840
+				),
841
+				'group_by' => array(
842
+					'required'          => false,
843
+					'default'           => null,
844
+					'type'              => array(
845
+						'object',
846
+						'string',
847
+					),
848
+					// because we accept  an almost infinite list of possible groupings,
849
+					// WP core validation and sanitization
850
+					// freaks out. We'll just validate this argument while handling the request
851
+					'validate_callback' => null,
852
+					'sanitize_callback' => null,
853
+				),
854
+				'having'   => array(
855
+					'required'          => false,
856
+					'default'           => null,
857
+					'type'              => 'object',
858
+					// because we accept an almost infinite list of possible where conditions, WP
859
+					// core validation and sanitization freaks out. We'll just validate this argument
860
+					// while handling the request
861
+					'validate_callback' => null,
862
+					'sanitize_callback' => null,
863
+				),
864
+				'caps'     => array(
865
+					'required' => false,
866
+					'default'  => EEM_Base::caps_read,
867
+					'type'     => 'string',
868
+					'enum'     => array(
869
+						EEM_Base::caps_read,
870
+						EEM_Base::caps_read_admin,
871
+						EEM_Base::caps_edit,
872
+						EEM_Base::caps_delete,
873
+					),
874
+				),
875
+			)
876
+		);
877
+	}
878
+
879
+
880
+	/**
881
+	 * Gets parameter information for a model regarding writing data
882
+	 *
883
+	 * @param string           $model_name
884
+	 * @param ModelVersionInfo $model_version_info
885
+	 * @param boolean          $create                                       whether this is for request to create (in
886
+	 *                                                                       which case we need all required params) or
887
+	 *                                                                       just to update (in which case we don't
888
+	 *                                                                       need those on every request)
889
+	 * @return array
890
+	 */
891
+	protected function _get_write_params(
892
+		$model_name,
893
+		ModelVersionInfo $model_version_info,
894
+		$create = false
895
+	) {
896
+		$model = EE_Registry::instance()->load_model($model_name);
897
+		$fields = $model_version_info->fieldsOnModelInThisVersion($model);
898
+		$args_info = array();
899
+		foreach ($fields as $field_name => $field_obj) {
900
+			if ($field_obj->is_auto_increment()) {
901
+				// totally ignore auto increment IDs
902
+				continue;
903
+			}
904
+			$arg_info = $field_obj->getSchema();
905
+			$required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
906
+			$arg_info['required'] = $required;
907
+			// remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
908
+			unset($arg_info['readonly']);
909
+			$schema_properties = $field_obj->getSchemaProperties();
910
+			if (isset($schema_properties['raw'])
911
+				&& $field_obj->getSchemaType() === 'object'
912
+			) {
913
+				// if there's a "raw" form of this argument, use those properties instead
914
+				$arg_info = array_replace(
915
+					$arg_info,
916
+					$schema_properties['raw']
917
+				);
918
+			}
919
+			$arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
920
+				$field_obj,
921
+				$field_obj->get_default_value(),
922
+				$model_version_info->requestedVersion()
923
+			);
924
+			// we do our own validation and sanitization within the controller
925
+			if (function_exists('rest_validate_value_from_schema')) {
926
+				$sanitize_callback = array(
927
+					'EED_Core_Rest_Api',
928
+					'default_sanitize_callback',
929
+				);
930
+			} else {
931
+				$sanitize_callback = null;
932
+			}
933
+			$arg_info['sanitize_callback'] = $sanitize_callback;
934
+			$args_info[ $field_name ] = $arg_info;
935
+			if ($field_obj instanceof EE_Datetime_Field) {
936
+				$gmt_arg_info = $arg_info;
937
+				$gmt_arg_info['description'] = sprintf(
938
+					esc_html__(
939
+						'%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
940
+						'event_espresso'
941
+					),
942
+					$field_obj->get_nicename(),
943
+					$field_name
944
+				);
945
+				$args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
946
+			}
947
+		}
948
+		return $args_info;
949
+	}
950
+
951
+
952
+	/**
953
+	 * Replacement for WP API's 'rest_parse_request_arg'.
954
+	 * If the value is blank but not required, don't bother validating it.
955
+	 * Also, it uses our email validation instead of WP API's default.
956
+	 *
957
+	 * @param                 $value
958
+	 * @param WP_REST_Request $request
959
+	 * @param                 $param
960
+	 * @return bool|true|WP_Error
961
+	 * @throws InvalidArgumentException
962
+	 * @throws InvalidInterfaceException
963
+	 * @throws InvalidDataTypeException
964
+	 */
965
+	public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
966
+	{
967
+		$attributes = $request->get_attributes();
968
+		if (! isset($attributes['args'][ $param ])
969
+			|| ! is_array($attributes['args'][ $param ])) {
970
+			$validation_result = true;
971
+		} else {
972
+			$args = $attributes['args'][ $param ];
973
+			if ((
974
+					$value === ''
975
+					|| $value === null
976
+				)
977
+				&& (! isset($args['required'])
978
+					|| $args['required'] === false
979
+				)
980
+			) {
981
+				// not required and not provided? that's cool
982
+				$validation_result = true;
983
+			} elseif (isset($args['format'])
984
+					  && $args['format'] === 'email'
985
+			) {
986
+				$validation_result = true;
987
+				if (! self::_validate_email($value)) {
988
+					$validation_result = new WP_Error(
989
+						'rest_invalid_param',
990
+						esc_html__(
991
+							'The email address is not valid or does not exist.',
992
+							'event_espresso'
993
+						)
994
+					);
995
+				}
996
+			} else {
997
+				$validation_result = rest_validate_value_from_schema($value, $args, $param);
998
+			}
999
+		}
1000
+		if (is_wp_error($validation_result)) {
1001
+			return $validation_result;
1002
+		}
1003
+		return rest_sanitize_request_arg($value, $request, $param);
1004
+	}
1005
+
1006
+
1007
+	/**
1008
+	 * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
1009
+	 *
1010
+	 * @param $email
1011
+	 * @return bool
1012
+	 * @throws InvalidArgumentException
1013
+	 * @throws InvalidInterfaceException
1014
+	 * @throws InvalidDataTypeException
1015
+	 */
1016
+	protected static function _validate_email($email)
1017
+	{
1018
+		try {
1019
+			EmailAddressFactory::create($email);
1020
+			return true;
1021
+		} catch (EmailValidationException $e) {
1022
+			return false;
1023
+		}
1024
+	}
1025
+
1026
+
1027
+	/**
1028
+	 * Gets routes for the config
1029
+	 *
1030
+	 * @return array @see _register_model_routes
1031
+	 * @deprecated since version 4.9.1
1032
+	 */
1033
+	protected function _register_config_routes()
1034
+	{
1035
+		$config_routes = array();
1036
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
1037
+			$config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
1038
+				$version,
1039
+				$hidden_endpoint
1040
+			);
1041
+		}
1042
+		return $config_routes;
1043
+	}
1044
+
1045
+
1046
+	/**
1047
+	 * Gets routes for the config for the specified version
1048
+	 *
1049
+	 * @param string  $version
1050
+	 * @param boolean $hidden_endpoint
1051
+	 * @return array
1052
+	 */
1053
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint)
1054
+	{
1055
+		return array(
1056
+			'config'    => array(
1057
+				array(
1058
+					'callback'        => array(
1059
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1060
+						'handleRequest',
1061
+					),
1062
+					'methods'         => WP_REST_Server::READABLE,
1063
+					'hidden_endpoint' => $hidden_endpoint,
1064
+					'callback_args'   => array($version),
1065
+				),
1066
+			),
1067
+			'site_info' => array(
1068
+				array(
1069
+					'callback'        => array(
1070
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1071
+						'handleRequestSiteInfo',
1072
+					),
1073
+					'methods'         => WP_REST_Server::READABLE,
1074
+					'hidden_endpoint' => $hidden_endpoint,
1075
+					'callback_args'   => array($version),
1076
+				),
1077
+			),
1078
+		);
1079
+	}
1080
+
1081
+
1082
+	/**
1083
+	 * Gets the meta info routes
1084
+	 *
1085
+	 * @return array @see _register_model_routes
1086
+	 * @deprecated since version 4.9.1
1087
+	 */
1088
+	protected function _register_meta_routes()
1089
+	{
1090
+		$meta_routes = array();
1091
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
1092
+			$meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
1093
+				$version,
1094
+				$hidden_endpoint
1095
+			);
1096
+		}
1097
+		return $meta_routes;
1098
+	}
1099
+
1100
+
1101
+	/**
1102
+	 * @param string  $version
1103
+	 * @param boolean $hidden_endpoint
1104
+	 * @return array
1105
+	 */
1106
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
1107
+	{
1108
+		return array(
1109
+			'resources' => array(
1110
+				array(
1111
+					'callback'        => array(
1112
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
1113
+						'handleRequestModelsMeta',
1114
+					),
1115
+					'methods'         => WP_REST_Server::READABLE,
1116
+					'hidden_endpoint' => $hidden_endpoint,
1117
+					'callback_args'   => array($version),
1118
+				),
1119
+			),
1120
+		);
1121
+	}
1122
+
1123
+
1124
+	/**
1125
+	 * Tries to hide old 4.6 endpoints from the
1126
+	 *
1127
+	 * @param array $route_data
1128
+	 * @return array
1129
+	 * @throws \EE_Error
1130
+	 */
1131
+	public static function hide_old_endpoints($route_data)
1132
+	{
1133
+		// allow API clients to override which endpoints get hidden, in case
1134
+		// they want to discover particular endpoints
1135
+		// also, we don't have access to the request so we have to just grab it from the superglobal
1136
+		$force_show_ee_namespace = ltrim(
1137
+			EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
1138
+			'/'
1139
+		);
1140
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
1141
+			foreach ($relative_urls as $resource_name => $endpoints) {
1142
+				foreach ($endpoints as $key => $endpoint) {
1143
+					// skip schema and other route options
1144
+					if (! is_numeric($key)) {
1145
+						continue;
1146
+					}
1147
+					// by default, hide "hidden_endpoint"s, unless the request indicates
1148
+					// to $force_show_ee_namespace, in which case only show that one
1149
+					// namespace's endpoints (and hide all others)
1150
+					if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
1151
+						|| ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
1152
+					) {
1153
+						$full_route = '/' . ltrim($namespace, '/');
1154
+						$full_route .= '/' . ltrim($resource_name, '/');
1155
+						unset($route_data[ $full_route ]);
1156
+					}
1157
+				}
1158
+			}
1159
+		}
1160
+		return $route_data;
1161
+	}
1162
+
1163
+
1164
+	/**
1165
+	 * Returns an array describing which versions of core support serving requests for.
1166
+	 * Keys are core versions' major and minor version, and values are the
1167
+	 * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
1168
+	 * data by just removing a few models and fields from the responses. However, 4.15 might remove
1169
+	 * the answers table entirely, in which case it would be very difficult for
1170
+	 * it to serve 4.6-style responses.
1171
+	 * Versions of core that are missing from this array are unknowns.
1172
+	 * previous ver
1173
+	 *
1174
+	 * @return array
1175
+	 */
1176
+	public static function version_compatibilities()
1177
+	{
1178
+		return apply_filters(
1179
+			'FHEE__EED_Core_REST_API__version_compatibilities',
1180
+			array(
1181
+				'4.8.29' => '4.8.29',
1182
+				'4.8.33' => '4.8.29',
1183
+				'4.8.34' => '4.8.29',
1184
+				'4.8.36' => '4.8.29',
1185
+			)
1186
+		);
1187
+	}
1188
+
1189
+
1190
+	/**
1191
+	 * Gets the latest API version served. Eg if there
1192
+	 * are two versions served of the API, 4.8.29 and 4.8.32, and
1193
+	 * we are on core version 4.8.34, it will return the string "4.8.32"
1194
+	 *
1195
+	 * @return string
1196
+	 */
1197
+	public static function latest_rest_api_version()
1198
+	{
1199
+		$versions_served = \EED_Core_Rest_Api::versions_served();
1200
+		$versions_served_keys = array_keys($versions_served);
1201
+		return end($versions_served_keys);
1202
+	}
1203
+
1204
+
1205
+	/**
1206
+	 * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
1207
+	 * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
1208
+	 * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
1209
+	 * We also indicate whether or not this version should be put in the index or not
1210
+	 *
1211
+	 * @return array keys are API version numbers (just major and minor numbers), and values
1212
+	 * are whether or not they should be hidden
1213
+	 */
1214
+	public static function versions_served()
1215
+	{
1216
+		$versions_served = array();
1217
+		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
1218
+		$lowest_compatible_version = end($possibly_served_versions);
1219
+		reset($possibly_served_versions);
1220
+		$versions_served_historically = array_keys($possibly_served_versions);
1221
+		$latest_version = end($versions_served_historically);
1222
+		reset($versions_served_historically);
1223
+		// for each version of core we have ever served:
1224
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
1225
+			// if it's not above the current core version, and it's compatible with the current version of core
1226
+			if ($key_versioned_endpoint === $latest_version) {
1227
+				// don't hide the latest version in the index
1228
+				$versions_served[ $key_versioned_endpoint ] = false;
1229
+			} elseif ($key_versioned_endpoint >= $lowest_compatible_version
1230
+				&& $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
1231
+			) {
1232
+				// include, but hide, previous versions which are still supported
1233
+				$versions_served[ $key_versioned_endpoint ] = true;
1234
+			} elseif (apply_filters(
1235
+				'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
1236
+				false,
1237
+				$possibly_served_versions
1238
+			)) {
1239
+				// if a version is no longer supported, don't include it in index or list of versions served
1240
+				$versions_served[ $key_versioned_endpoint ] = true;
1241
+			}
1242
+		}
1243
+		return $versions_served;
1244
+	}
1245
+
1246
+
1247
+	/**
1248
+	 * Gets the major and minor version of EE core's version string
1249
+	 *
1250
+	 * @return string
1251
+	 */
1252
+	public static function core_version()
1253
+	{
1254
+		return apply_filters(
1255
+			'FHEE__EED_Core_REST_API__core_version',
1256
+			implode(
1257
+				'.',
1258
+				array_slice(
1259
+					explode(
1260
+						'.',
1261
+						espresso_version()
1262
+					),
1263
+					0,
1264
+					3
1265
+				)
1266
+			)
1267
+		);
1268
+	}
1269
+
1270
+
1271
+	/**
1272
+	 * Gets the default limit that should be used when querying for resources
1273
+	 *
1274
+	 * @return int
1275
+	 */
1276
+	public static function get_default_query_limit()
1277
+	{
1278
+		// we actually don't use a const because we want folks to always use
1279
+		// this method, not the const directly
1280
+		return apply_filters(
1281
+			'FHEE__EED_Core_Rest_Api__get_default_query_limit',
1282
+			50
1283
+		);
1284
+	}
1285
+
1286
+
1287
+	/**
1288
+	 *
1289
+	 * @param string $version api version string (i.e. '4.8.36')
1290
+	 * @return array
1291
+	 */
1292
+	public static function getCollectionRoutesIndexedByModelName($version = '')
1293
+	{
1294
+		$version = empty($version) ? self::latest_rest_api_version() : $version;
1295
+		$model_names = self::model_names_with_plural_routes($version);
1296
+		$collection_routes = array();
1297
+		foreach ($model_names as $model_name => $model_class_name) {
1298
+			$collection_routes[ strtolower($model_name) ] = '/' . self::ee_api_namespace . $version . '/'
1299
+															. EEH_Inflector::pluralize_and_lower($model_name);
1300
+		}
1301
+		return $collection_routes;
1302
+	}
1303
+
1304
+
1305
+	/**
1306
+	 * Returns an array of primary key names indexed by model names.
1307
+	 * @param string $version
1308
+	 * @return array
1309
+	 */
1310
+	public static function getPrimaryKeyNamesIndexedByModelName($version = '')
1311
+	{
1312
+		$version = empty($version) ? self::latest_rest_api_version() : $version;
1313
+		$model_names = self::model_names_with_plural_routes($version);
1314
+		$primary_key_items = array();
1315
+		foreach ($model_names as $model_name => $model_class_name) {
1316
+			$primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
1317
+			foreach ($primary_keys as $primary_key_name => $primary_key_field) {
1318
+				if (count($primary_keys) > 1) {
1319
+					$primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
1320
+				} else {
1321
+					$primary_key_items[ strtolower($model_name) ] = $primary_key_name;
1322
+				}
1323
+			}
1324
+		}
1325
+		return $primary_key_items;
1326
+	}
1327
+
1328
+	/**
1329
+	 * Determines the EE REST API debug mode is activated, or not.
1330
+	 * @since 4.9.76.p
1331
+	 * @return bool
1332
+	 */
1333
+	public static function debugMode()
1334
+	{
1335
+		static $debug_mode = null; // could be class prop
1336
+		if ($debug_mode === null) {
1337
+			$debug_mode = defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE;
1338
+		}
1339
+		return $debug_mode;
1340
+	}
1341
+
1342
+
1343
+
1344
+	/**
1345
+	 *    run - initial module setup
1346
+	 *
1347
+	 * @access    public
1348
+	 * @param  WP $WP
1349
+	 * @return    void
1350
+	 */
1351
+	public function run($WP)
1352
+	{
1353
+	}
1354 1354
 }
Please login to merge, or discard this patch.
espresso.php 1 patch
Indentation   +80 added lines, -80 removed lines patch added patch discarded remove patch
@@ -38,103 +38,103 @@
 block discarded – undo
38 38
  * @since           4.0
39 39
  */
40 40
 if (function_exists('espresso_version')) {
41
-    if (! function_exists('espresso_duplicate_plugin_error')) {
42
-        /**
43
-         *    espresso_duplicate_plugin_error
44
-         *    displays if more than one version of EE is activated at the same time
45
-         */
46
-        function espresso_duplicate_plugin_error()
47
-        {
48
-            ?>
41
+	if (! function_exists('espresso_duplicate_plugin_error')) {
42
+		/**
43
+		 *    espresso_duplicate_plugin_error
44
+		 *    displays if more than one version of EE is activated at the same time
45
+		 */
46
+		function espresso_duplicate_plugin_error()
47
+		{
48
+			?>
49 49
             <div class="error">
50 50
                 <p>
51 51
                     <?php
52
-                    echo esc_html__(
53
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
-                        'event_espresso'
55
-                    ); ?>
52
+					echo esc_html__(
53
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
+						'event_espresso'
55
+					); ?>
56 56
                 </p>
57 57
             </div>
58 58
             <?php
59
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
60
-        }
61
-    }
62
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
59
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
60
+		}
61
+	}
62
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
63 63
 } else {
64
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
65
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
-        /**
67
-         * espresso_minimum_php_version_error
68
-         *
69
-         * @return void
70
-         */
71
-        function espresso_minimum_php_version_error()
72
-        {
73
-            ?>
64
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
65
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
+		/**
67
+		 * espresso_minimum_php_version_error
68
+		 *
69
+		 * @return void
70
+		 */
71
+		function espresso_minimum_php_version_error()
72
+		{
73
+			?>
74 74
             <div class="error">
75 75
                 <p>
76 76
                     <?php
77
-                    printf(
78
-                        esc_html__(
79
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
-                            'event_espresso'
81
-                        ),
82
-                        EE_MIN_PHP_VER_REQUIRED,
83
-                        PHP_VERSION,
84
-                        '<br/>',
85
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
-                    );
87
-                    ?>
77
+					printf(
78
+						esc_html__(
79
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
+							'event_espresso'
81
+						),
82
+						EE_MIN_PHP_VER_REQUIRED,
83
+						PHP_VERSION,
84
+						'<br/>',
85
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
+					);
87
+					?>
88 88
                 </p>
89 89
             </div>
90 90
             <?php
91
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
92
-        }
91
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
92
+		}
93 93
 
94
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
-    } else {
96
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
97
-        /**
98
-         * espresso_version
99
-         * Returns the plugin version
100
-         *
101
-         * @return string
102
-         */
103
-        function espresso_version()
104
-        {
105
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.77.rc.000');
106
-        }
94
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
+	} else {
96
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
97
+		/**
98
+		 * espresso_version
99
+		 * Returns the plugin version
100
+		 *
101
+		 * @return string
102
+		 */
103
+		function espresso_version()
104
+		{
105
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.77.rc.000');
106
+		}
107 107
 
108
-        /**
109
-         * espresso_plugin_activation
110
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
111
-         */
112
-        function espresso_plugin_activation()
113
-        {
114
-            update_option('ee_espresso_activation', true);
115
-        }
108
+		/**
109
+		 * espresso_plugin_activation
110
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
111
+		 */
112
+		function espresso_plugin_activation()
113
+		{
114
+			update_option('ee_espresso_activation', true);
115
+		}
116 116
 
117
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
117
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
118 118
 
119
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
120
-        bootstrap_espresso();
121
-    }
119
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
120
+		bootstrap_espresso();
121
+	}
122 122
 }
123 123
 if (! function_exists('espresso_deactivate_plugin')) {
124
-    /**
125
-     *    deactivate_plugin
126
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
127
-     *
128
-     * @access public
129
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
130
-     * @return    void
131
-     */
132
-    function espresso_deactivate_plugin($plugin_basename = '')
133
-    {
134
-        if (! function_exists('deactivate_plugins')) {
135
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
136
-        }
137
-        unset($_GET['activate'], $_REQUEST['activate']);
138
-        deactivate_plugins($plugin_basename);
139
-    }
124
+	/**
125
+	 *    deactivate_plugin
126
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
127
+	 *
128
+	 * @access public
129
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
130
+	 * @return    void
131
+	 */
132
+	function espresso_deactivate_plugin($plugin_basename = '')
133
+	{
134
+		if (! function_exists('deactivate_plugins')) {
135
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
136
+		}
137
+		unset($_GET['activate'], $_REQUEST['activate']);
138
+		deactivate_plugins($plugin_basename);
139
+	}
140 140
 }
Please login to merge, or discard this patch.