@@ -9,24 +9,24 @@ |
||
9 | 9 | interface EEI_Request_Decorator |
10 | 10 | { |
11 | 11 | |
12 | - /** |
|
13 | - * converts a Request to a Response |
|
14 | - * can perform their logic either before or after the core application has run like so: |
|
15 | - * public function handle_request( EE_Request $request, EE_Response $response ) { |
|
16 | - * $this->request = $request; |
|
17 | - * $this->response = $response; |
|
18 | - * // logic performed BEFORE core app has run |
|
19 | - * $this->process_request_stack( $this->request, $this->response ); |
|
20 | - * // logic performed AFTER core app has run |
|
21 | - * return $response; |
|
22 | - * } |
|
23 | - * |
|
24 | - * @deprecated 4.9.53 |
|
25 | - * @param EE_Request $request |
|
26 | - * @param EE_Response $response |
|
27 | - * @return EE_Response |
|
28 | - */ |
|
29 | - public function handle_request(EE_Request $request, EE_Response $response); |
|
12 | + /** |
|
13 | + * converts a Request to a Response |
|
14 | + * can perform their logic either before or after the core application has run like so: |
|
15 | + * public function handle_request( EE_Request $request, EE_Response $response ) { |
|
16 | + * $this->request = $request; |
|
17 | + * $this->response = $response; |
|
18 | + * // logic performed BEFORE core app has run |
|
19 | + * $this->process_request_stack( $this->request, $this->response ); |
|
20 | + * // logic performed AFTER core app has run |
|
21 | + * return $response; |
|
22 | + * } |
|
23 | + * |
|
24 | + * @deprecated 4.9.53 |
|
25 | + * @param EE_Request $request |
|
26 | + * @param EE_Response $response |
|
27 | + * @return EE_Response |
|
28 | + */ |
|
29 | + public function handle_request(EE_Request $request, EE_Response $response); |
|
30 | 30 | |
31 | 31 | |
32 | 32 | } |
@@ -15,125 +15,125 @@ |
||
15 | 15 | interface LegacyRequestInterface |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * @return array |
|
20 | - */ |
|
21 | - public function get_params(); |
|
18 | + /** |
|
19 | + * @return array |
|
20 | + */ |
|
21 | + public function get_params(); |
|
22 | 22 | |
23 | 23 | |
24 | - /** |
|
25 | - * @return array |
|
26 | - */ |
|
27 | - public function post_params(); |
|
24 | + /** |
|
25 | + * @return array |
|
26 | + */ |
|
27 | + public function post_params(); |
|
28 | 28 | |
29 | 29 | |
30 | - /** |
|
31 | - * @return array |
|
32 | - */ |
|
33 | - public function cookie_params(); |
|
30 | + /** |
|
31 | + * @return array |
|
32 | + */ |
|
33 | + public function cookie_params(); |
|
34 | 34 | |
35 | 35 | |
36 | - /** |
|
37 | - * @return array |
|
38 | - */ |
|
39 | - public function server_params(); |
|
36 | + /** |
|
37 | + * @return array |
|
38 | + */ |
|
39 | + public function server_params(); |
|
40 | 40 | |
41 | 41 | |
42 | - /** |
|
43 | - * returns contents of $_REQUEST |
|
44 | - * |
|
45 | - * @return array |
|
46 | - */ |
|
47 | - public function params(); |
|
42 | + /** |
|
43 | + * returns contents of $_REQUEST |
|
44 | + * |
|
45 | + * @return array |
|
46 | + */ |
|
47 | + public function params(); |
|
48 | 48 | |
49 | 49 | |
50 | - /** |
|
51 | - * @param $key |
|
52 | - * @param $value |
|
53 | - * @param bool $override_ee |
|
54 | - * @return void |
|
55 | - */ |
|
56 | - public function set($key, $value, $override_ee = false); |
|
50 | + /** |
|
51 | + * @param $key |
|
52 | + * @param $value |
|
53 | + * @param bool $override_ee |
|
54 | + * @return void |
|
55 | + */ |
|
56 | + public function set($key, $value, $override_ee = false); |
|
57 | 57 | |
58 | 58 | |
59 | - /** |
|
60 | - * returns the value for a request param if the given key exists |
|
61 | - * |
|
62 | - * @param $key |
|
63 | - * @param null $default |
|
64 | - * @return mixed |
|
65 | - */ |
|
66 | - public function get($key, $default = null); |
|
59 | + /** |
|
60 | + * returns the value for a request param if the given key exists |
|
61 | + * |
|
62 | + * @param $key |
|
63 | + * @param null $default |
|
64 | + * @return mixed |
|
65 | + */ |
|
66 | + public function get($key, $default = null); |
|
67 | 67 | |
68 | 68 | |
69 | - /** |
|
70 | - * check if param exists |
|
71 | - * |
|
72 | - * @param $key |
|
73 | - * @return bool |
|
74 | - */ |
|
75 | - public function is_set($key); |
|
69 | + /** |
|
70 | + * check if param exists |
|
71 | + * |
|
72 | + * @param $key |
|
73 | + * @return bool |
|
74 | + */ |
|
75 | + public function is_set($key); |
|
76 | 76 | |
77 | 77 | |
78 | - /** |
|
79 | - * remove param |
|
80 | - * |
|
81 | - * @param $key |
|
82 | - * @param bool $unset_from_global_too |
|
83 | - */ |
|
84 | - public function un_set($key, $unset_from_global_too = false); |
|
78 | + /** |
|
79 | + * remove param |
|
80 | + * |
|
81 | + * @param $key |
|
82 | + * @param bool $unset_from_global_too |
|
83 | + */ |
|
84 | + public function un_set($key, $unset_from_global_too = false); |
|
85 | 85 | |
86 | 86 | |
87 | - /** |
|
88 | - * @return string |
|
89 | - */ |
|
90 | - public function ip_address(); |
|
87 | + /** |
|
88 | + * @return string |
|
89 | + */ |
|
90 | + public function ip_address(); |
|
91 | 91 | |
92 | 92 | |
93 | - /** |
|
94 | - * @return bool |
|
95 | - */ |
|
96 | - public function isAdmin(); |
|
93 | + /** |
|
94 | + * @return bool |
|
95 | + */ |
|
96 | + public function isAdmin(); |
|
97 | 97 | |
98 | 98 | |
99 | - /** |
|
100 | - * @return mixed |
|
101 | - */ |
|
102 | - public function isAjax(); |
|
99 | + /** |
|
100 | + * @return mixed |
|
101 | + */ |
|
102 | + public function isAjax(); |
|
103 | 103 | |
104 | 104 | |
105 | - /** |
|
106 | - * @return mixed |
|
107 | - */ |
|
108 | - public function isFrontAjax(); |
|
105 | + /** |
|
106 | + * @return mixed |
|
107 | + */ |
|
108 | + public function isFrontAjax(); |
|
109 | 109 | |
110 | 110 | |
111 | - /** |
|
112 | - * @return mixed|string |
|
113 | - */ |
|
114 | - public function requestUri(); |
|
111 | + /** |
|
112 | + * @return mixed|string |
|
113 | + */ |
|
114 | + public function requestUri(); |
|
115 | 115 | |
116 | 116 | |
117 | - /** |
|
118 | - * @return string |
|
119 | - */ |
|
120 | - public function userAgent(); |
|
117 | + /** |
|
118 | + * @return string |
|
119 | + */ |
|
120 | + public function userAgent(); |
|
121 | 121 | |
122 | 122 | |
123 | - /** |
|
124 | - * @param string $user_agent |
|
125 | - */ |
|
126 | - public function setUserAgent($user_agent = ''); |
|
123 | + /** |
|
124 | + * @param string $user_agent |
|
125 | + */ |
|
126 | + public function setUserAgent($user_agent = ''); |
|
127 | 127 | |
128 | 128 | |
129 | - /** |
|
130 | - * @return bool |
|
131 | - */ |
|
132 | - public function isBot(); |
|
129 | + /** |
|
130 | + * @return bool |
|
131 | + */ |
|
132 | + public function isBot(); |
|
133 | 133 | |
134 | 134 | |
135 | - /** |
|
136 | - * @param bool $is_bot |
|
137 | - */ |
|
138 | - public function setIsBot($is_bot); |
|
135 | + /** |
|
136 | + * @param bool $is_bot |
|
137 | + */ |
|
138 | + public function setIsBot($is_bot); |
|
139 | 139 | } |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | */ |
59 | 59 | public function setNotice($key, $value) |
60 | 60 | { |
61 | - $this->notice[ $key ] = $value; |
|
61 | + $this->notice[$key] = $value; |
|
62 | 62 | } |
63 | 63 | |
64 | 64 | |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | */ |
70 | 70 | public function getNotice($key) |
71 | 71 | { |
72 | - return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null; |
|
72 | + return isset($this->notice[$key]) ? $this->notice[$key] : null; |
|
73 | 73 | } |
74 | 74 | |
75 | 75 | |
@@ -90,7 +90,7 @@ discard block |
||
90 | 90 | */ |
91 | 91 | public function addOutput($string, $append = true) |
92 | 92 | { |
93 | - $this->output = $append ? $this->output . $string : $string . $this->output; |
|
93 | + $this->output = $append ? $this->output.$string : $string.$this->output; |
|
94 | 94 | } |
95 | 95 | |
96 | 96 |
@@ -16,119 +16,119 @@ |
||
16 | 16 | class Response implements ResponseInterface, ReservedInstanceInterface |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @var array $notice |
|
21 | - */ |
|
22 | - protected $notice = array(); |
|
23 | - |
|
24 | - /** |
|
25 | - * rendered output to be returned to WP |
|
26 | - * |
|
27 | - * @var string $output |
|
28 | - */ |
|
29 | - protected $output = ''; |
|
30 | - |
|
31 | - /** |
|
32 | - * @var bool |
|
33 | - */ |
|
34 | - protected $request_terminated = false; |
|
35 | - |
|
36 | - /** |
|
37 | - * @var bool $deactivate_plugin |
|
38 | - */ |
|
39 | - protected $deactivate_plugin = false; |
|
40 | - |
|
41 | - |
|
42 | - /** |
|
43 | - * EE_Response constructor. |
|
44 | - */ |
|
45 | - public function __construct() |
|
46 | - { |
|
47 | - $this->terminateRequest(false); |
|
48 | - } |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * @param $key |
|
53 | - * @param $value |
|
54 | - * @return void |
|
55 | - */ |
|
56 | - public function setNotice($key, $value) |
|
57 | - { |
|
58 | - $this->notice[ $key ] = $value; |
|
59 | - } |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * @param $key |
|
64 | - * @return mixed |
|
65 | - */ |
|
66 | - public function getNotice($key) |
|
67 | - { |
|
68 | - return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null; |
|
69 | - } |
|
70 | - |
|
71 | - |
|
72 | - /** |
|
73 | - * @return array |
|
74 | - */ |
|
75 | - public function getNotices() |
|
76 | - { |
|
77 | - return $this->notice; |
|
78 | - } |
|
79 | - |
|
80 | - |
|
81 | - /** |
|
82 | - * @param string $string |
|
83 | - * @param bool $append |
|
84 | - */ |
|
85 | - public function addOutput($string, $append = true) |
|
86 | - { |
|
87 | - $this->output = $append ? $this->output . $string : $string . $this->output; |
|
88 | - } |
|
89 | - |
|
90 | - |
|
91 | - /** |
|
92 | - * @return string |
|
93 | - */ |
|
94 | - public function getOutput() |
|
95 | - { |
|
96 | - return $this->output; |
|
97 | - } |
|
98 | - |
|
99 | - |
|
100 | - /** |
|
101 | - * @return boolean |
|
102 | - */ |
|
103 | - public function requestTerminated() |
|
104 | - { |
|
105 | - return $this->request_terminated; |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * @param boolean $request_terminated |
|
111 | - */ |
|
112 | - public function terminateRequest($request_terminated = true) |
|
113 | - { |
|
114 | - $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN); |
|
115 | - } |
|
116 | - |
|
117 | - |
|
118 | - /** |
|
119 | - * @return boolean |
|
120 | - */ |
|
121 | - public function pluginDeactivated() |
|
122 | - { |
|
123 | - return $this->deactivate_plugin; |
|
124 | - } |
|
125 | - |
|
126 | - |
|
127 | - /** |
|
128 | - * sets $deactivate_plugin to true |
|
129 | - */ |
|
130 | - public function deactivatePlugin() |
|
131 | - { |
|
132 | - $this->deactivate_plugin = true; |
|
133 | - } |
|
19 | + /** |
|
20 | + * @var array $notice |
|
21 | + */ |
|
22 | + protected $notice = array(); |
|
23 | + |
|
24 | + /** |
|
25 | + * rendered output to be returned to WP |
|
26 | + * |
|
27 | + * @var string $output |
|
28 | + */ |
|
29 | + protected $output = ''; |
|
30 | + |
|
31 | + /** |
|
32 | + * @var bool |
|
33 | + */ |
|
34 | + protected $request_terminated = false; |
|
35 | + |
|
36 | + /** |
|
37 | + * @var bool $deactivate_plugin |
|
38 | + */ |
|
39 | + protected $deactivate_plugin = false; |
|
40 | + |
|
41 | + |
|
42 | + /** |
|
43 | + * EE_Response constructor. |
|
44 | + */ |
|
45 | + public function __construct() |
|
46 | + { |
|
47 | + $this->terminateRequest(false); |
|
48 | + } |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * @param $key |
|
53 | + * @param $value |
|
54 | + * @return void |
|
55 | + */ |
|
56 | + public function setNotice($key, $value) |
|
57 | + { |
|
58 | + $this->notice[ $key ] = $value; |
|
59 | + } |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * @param $key |
|
64 | + * @return mixed |
|
65 | + */ |
|
66 | + public function getNotice($key) |
|
67 | + { |
|
68 | + return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null; |
|
69 | + } |
|
70 | + |
|
71 | + |
|
72 | + /** |
|
73 | + * @return array |
|
74 | + */ |
|
75 | + public function getNotices() |
|
76 | + { |
|
77 | + return $this->notice; |
|
78 | + } |
|
79 | + |
|
80 | + |
|
81 | + /** |
|
82 | + * @param string $string |
|
83 | + * @param bool $append |
|
84 | + */ |
|
85 | + public function addOutput($string, $append = true) |
|
86 | + { |
|
87 | + $this->output = $append ? $this->output . $string : $string . $this->output; |
|
88 | + } |
|
89 | + |
|
90 | + |
|
91 | + /** |
|
92 | + * @return string |
|
93 | + */ |
|
94 | + public function getOutput() |
|
95 | + { |
|
96 | + return $this->output; |
|
97 | + } |
|
98 | + |
|
99 | + |
|
100 | + /** |
|
101 | + * @return boolean |
|
102 | + */ |
|
103 | + public function requestTerminated() |
|
104 | + { |
|
105 | + return $this->request_terminated; |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * @param boolean $request_terminated |
|
111 | + */ |
|
112 | + public function terminateRequest($request_terminated = true) |
|
113 | + { |
|
114 | + $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN); |
|
115 | + } |
|
116 | + |
|
117 | + |
|
118 | + /** |
|
119 | + * @return boolean |
|
120 | + */ |
|
121 | + public function pluginDeactivated() |
|
122 | + { |
|
123 | + return $this->deactivate_plugin; |
|
124 | + } |
|
125 | + |
|
126 | + |
|
127 | + /** |
|
128 | + * sets $deactivate_plugin to true |
|
129 | + */ |
|
130 | + public function deactivatePlugin() |
|
131 | + { |
|
132 | + $this->deactivate_plugin = true; |
|
133 | + } |
|
134 | 134 | } |
@@ -78,7 +78,7 @@ |
||
78 | 78 | public function preProductionVersionAdminNotice() |
79 | 79 | { |
80 | 80 | new PersistentAdminNotice( |
81 | - 'preProductionVersionAdminNotice_' . EVENT_ESPRESSO_VERSION, |
|
81 | + 'preProductionVersionAdminNotice_'.EVENT_ESPRESSO_VERSION, |
|
82 | 82 | $this->warningNotice() |
83 | 83 | ); |
84 | 84 | } |
@@ -18,91 +18,91 @@ |
||
18 | 18 | class PreProductionVersionWarning extends Middleware |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * converts a Request to a Response |
|
23 | - * |
|
24 | - * @param RequestInterface $request |
|
25 | - * @param ResponseInterface $response |
|
26 | - * @return ResponseInterface |
|
27 | - */ |
|
28 | - public function handleRequest(RequestInterface $request, ResponseInterface $response) |
|
29 | - { |
|
30 | - $this->request = $request; |
|
31 | - $this->response = $response; |
|
32 | - $this->displayPreProductionVersionWarning(); |
|
33 | - $this->response = $this->processRequestStack($this->request, $this->response); |
|
34 | - return $this->response; |
|
35 | - } |
|
21 | + /** |
|
22 | + * converts a Request to a Response |
|
23 | + * |
|
24 | + * @param RequestInterface $request |
|
25 | + * @param ResponseInterface $response |
|
26 | + * @return ResponseInterface |
|
27 | + */ |
|
28 | + public function handleRequest(RequestInterface $request, ResponseInterface $response) |
|
29 | + { |
|
30 | + $this->request = $request; |
|
31 | + $this->response = $response; |
|
32 | + $this->displayPreProductionVersionWarning(); |
|
33 | + $this->response = $this->processRequestStack($this->request, $this->response); |
|
34 | + return $this->response; |
|
35 | + } |
|
36 | 36 | |
37 | 37 | |
38 | - /** |
|
39 | - * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode |
|
40 | - * |
|
41 | - * @return void |
|
42 | - */ |
|
43 | - public function displayPreProductionVersionWarning() |
|
44 | - { |
|
45 | - // skip AJAX requests |
|
46 | - if ($this->request->isAjax()) { |
|
47 | - return; |
|
48 | - } |
|
49 | - // skip stable releases |
|
50 | - if (substr(EVENT_ESPRESSO_VERSION, -5) !== '.beta') { |
|
51 | - return; |
|
52 | - } |
|
53 | - // site admin has authorized use of non-stable release candidate for production |
|
54 | - if (defined('ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE') && ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE) { |
|
55 | - return; |
|
56 | - } |
|
57 | - // post release candidate warning |
|
58 | - if ($this->request->isAdmin()) { |
|
59 | - add_action('admin_notices', array($this, 'preProductionVersionAdminNotice'), -999); |
|
60 | - } else { |
|
61 | - add_action('shutdown', array($this, 'preProductionVersionWarningNotice'), 10); |
|
62 | - } |
|
63 | - } |
|
38 | + /** |
|
39 | + * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode |
|
40 | + * |
|
41 | + * @return void |
|
42 | + */ |
|
43 | + public function displayPreProductionVersionWarning() |
|
44 | + { |
|
45 | + // skip AJAX requests |
|
46 | + if ($this->request->isAjax()) { |
|
47 | + return; |
|
48 | + } |
|
49 | + // skip stable releases |
|
50 | + if (substr(EVENT_ESPRESSO_VERSION, -5) !== '.beta') { |
|
51 | + return; |
|
52 | + } |
|
53 | + // site admin has authorized use of non-stable release candidate for production |
|
54 | + if (defined('ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE') && ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE) { |
|
55 | + return; |
|
56 | + } |
|
57 | + // post release candidate warning |
|
58 | + if ($this->request->isAdmin()) { |
|
59 | + add_action('admin_notices', array($this, 'preProductionVersionAdminNotice'), -999); |
|
60 | + } else { |
|
61 | + add_action('shutdown', array($this, 'preProductionVersionWarningNotice'), 10); |
|
62 | + } |
|
63 | + } |
|
64 | 64 | |
65 | 65 | |
66 | - /** |
|
67 | - * displays admin notice that current version of EE is not a stable release |
|
68 | - * |
|
69 | - * @return void |
|
70 | - * @throws InvalidDataTypeException |
|
71 | - */ |
|
72 | - public function preProductionVersionAdminNotice() |
|
73 | - { |
|
74 | - new PersistentAdminNotice( |
|
75 | - 'preProductionVersionAdminNotice_' . EVENT_ESPRESSO_VERSION, |
|
76 | - $this->warningNotice() |
|
77 | - ); |
|
78 | - } |
|
66 | + /** |
|
67 | + * displays admin notice that current version of EE is not a stable release |
|
68 | + * |
|
69 | + * @return void |
|
70 | + * @throws InvalidDataTypeException |
|
71 | + */ |
|
72 | + public function preProductionVersionAdminNotice() |
|
73 | + { |
|
74 | + new PersistentAdminNotice( |
|
75 | + 'preProductionVersionAdminNotice_' . EVENT_ESPRESSO_VERSION, |
|
76 | + $this->warningNotice() |
|
77 | + ); |
|
78 | + } |
|
79 | 79 | |
80 | 80 | |
81 | - /** |
|
82 | - * displays message on frontend of site notifying admin that current version of EE is not a stable release |
|
83 | - * |
|
84 | - * @return void |
|
85 | - */ |
|
86 | - public function preProductionVersionWarningNotice() |
|
87 | - { |
|
88 | - echo '<div id="ee-release-candidate-notice-dv" class="ee-really-important-notice-dv"><p>'; |
|
89 | - echo $this->warningNotice(); |
|
90 | - echo '</p></div>'; |
|
91 | - } |
|
81 | + /** |
|
82 | + * displays message on frontend of site notifying admin that current version of EE is not a stable release |
|
83 | + * |
|
84 | + * @return void |
|
85 | + */ |
|
86 | + public function preProductionVersionWarningNotice() |
|
87 | + { |
|
88 | + echo '<div id="ee-release-candidate-notice-dv" class="ee-really-important-notice-dv"><p>'; |
|
89 | + echo $this->warningNotice(); |
|
90 | + echo '</p></div>'; |
|
91 | + } |
|
92 | 92 | |
93 | 93 | |
94 | - /** |
|
95 | - * @return string |
|
96 | - */ |
|
97 | - private function warningNotice() |
|
98 | - { |
|
99 | - return sprintf( |
|
100 | - esc_html__( |
|
101 | - 'This version of Event Espresso is for testing and/or evaluation purposes only. It is %1$snot%2$s considered a stable release and should therefore %1$snot%2$s be activated on a live or production website.', |
|
102 | - 'event_espresso' |
|
103 | - ), |
|
104 | - '<strong>', |
|
105 | - '</strong>' |
|
106 | - ); |
|
107 | - } |
|
94 | + /** |
|
95 | + * @return string |
|
96 | + */ |
|
97 | + private function warningNotice() |
|
98 | + { |
|
99 | + return sprintf( |
|
100 | + esc_html__( |
|
101 | + 'This version of Event Espresso is for testing and/or evaluation purposes only. It is %1$snot%2$s considered a stable release and should therefore %1$snot%2$s be activated on a live or production website.', |
|
102 | + 'event_espresso' |
|
103 | + ), |
|
104 | + '<strong>', |
|
105 | + '</strong>' |
|
106 | + ); |
|
107 | + } |
|
108 | 108 | } |
@@ -83,7 +83,7 @@ |
||
83 | 83 | { |
84 | 84 | espresso_load_required( |
85 | 85 | 'EE_Request', |
86 | - EE_CORE . 'request_stack' . DS . 'EE_Request.core.php' |
|
86 | + EE_CORE.'request_stack'.DS.'EE_Request.core.php' |
|
87 | 87 | ); |
88 | 88 | $this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER); |
89 | 89 | $this->legacy_request->setRequest($this->request); |
@@ -25,80 +25,80 @@ |
||
25 | 25 | class BootstrapRequestResponseObjects |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @type LegacyRequestInterface $legacy_request |
|
30 | - */ |
|
31 | - protected $legacy_request; |
|
28 | + /** |
|
29 | + * @type LegacyRequestInterface $legacy_request |
|
30 | + */ |
|
31 | + protected $legacy_request; |
|
32 | 32 | |
33 | - /** |
|
34 | - * @type LoaderInterface $loader |
|
35 | - */ |
|
36 | - protected $loader; |
|
33 | + /** |
|
34 | + * @type LoaderInterface $loader |
|
35 | + */ |
|
36 | + protected $loader; |
|
37 | 37 | |
38 | - /** |
|
39 | - * @var RequestInterface $request |
|
40 | - */ |
|
41 | - protected $request; |
|
38 | + /** |
|
39 | + * @var RequestInterface $request |
|
40 | + */ |
|
41 | + protected $request; |
|
42 | 42 | |
43 | - /** |
|
44 | - * @var ResponseInterface $response |
|
45 | - */ |
|
46 | - protected $response; |
|
43 | + /** |
|
44 | + * @var ResponseInterface $response |
|
45 | + */ |
|
46 | + protected $response; |
|
47 | 47 | |
48 | 48 | |
49 | - /** |
|
50 | - * BootstrapRequestResponseObjects constructor. |
|
51 | - * |
|
52 | - * @param LoaderInterface $loader |
|
53 | - */ |
|
54 | - public function __construct(LoaderInterface $loader) |
|
55 | - { |
|
56 | - $this->loader = $loader; |
|
57 | - } |
|
49 | + /** |
|
50 | + * BootstrapRequestResponseObjects constructor. |
|
51 | + * |
|
52 | + * @param LoaderInterface $loader |
|
53 | + */ |
|
54 | + public function __construct(LoaderInterface $loader) |
|
55 | + { |
|
56 | + $this->loader = $loader; |
|
57 | + } |
|
58 | 58 | |
59 | 59 | |
60 | - /** |
|
61 | - * @return void |
|
62 | - */ |
|
63 | - public function buildRequestResponse() |
|
64 | - { |
|
65 | - // load our Request and Response objects |
|
66 | - $this->request = new Request($_GET, $_POST, $_COOKIE, $_SERVER, $_FILES); |
|
67 | - $this->response = new Response(); |
|
68 | - } |
|
60 | + /** |
|
61 | + * @return void |
|
62 | + */ |
|
63 | + public function buildRequestResponse() |
|
64 | + { |
|
65 | + // load our Request and Response objects |
|
66 | + $this->request = new Request($_GET, $_POST, $_COOKIE, $_SERVER, $_FILES); |
|
67 | + $this->response = new Response(); |
|
68 | + } |
|
69 | 69 | |
70 | 70 | |
71 | - /** |
|
72 | - * @return void |
|
73 | - * @throws InvalidArgumentException |
|
74 | - */ |
|
75 | - public function shareRequestResponse() |
|
76 | - { |
|
77 | - $this->loader->share('EventEspresso\core\services\request\Request', $this->request); |
|
78 | - $this->loader->share('EventEspresso\core\services\request\Response', $this->response); |
|
79 | - EE_Dependency_Map::instance()->setRequest($this->request); |
|
80 | - EE_Dependency_Map::instance()->setResponse($this->response); |
|
81 | - } |
|
71 | + /** |
|
72 | + * @return void |
|
73 | + * @throws InvalidArgumentException |
|
74 | + */ |
|
75 | + public function shareRequestResponse() |
|
76 | + { |
|
77 | + $this->loader->share('EventEspresso\core\services\request\Request', $this->request); |
|
78 | + $this->loader->share('EventEspresso\core\services\request\Response', $this->response); |
|
79 | + EE_Dependency_Map::instance()->setRequest($this->request); |
|
80 | + EE_Dependency_Map::instance()->setResponse($this->response); |
|
81 | + } |
|
82 | 82 | |
83 | 83 | |
84 | - /** |
|
85 | - * @return void |
|
86 | - * @throws InvalidArgumentException |
|
87 | - * @throws EE_Error |
|
88 | - */ |
|
89 | - public function setupLegacyRequest() |
|
90 | - { |
|
91 | - espresso_load_required( |
|
92 | - 'EE_Request', |
|
93 | - EE_CORE . 'request_stack' . DS . 'EE_Request.core.php' |
|
94 | - ); |
|
95 | - $this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER); |
|
96 | - $this->legacy_request->setRequest($this->request); |
|
97 | - $this->legacy_request->admin = $this->request->isAdmin(); |
|
98 | - $this->legacy_request->ajax = $this->request->isAjax(); |
|
99 | - $this->legacy_request->front_ajax = $this->request->isFrontAjax(); |
|
100 | - EE_Dependency_Map::instance()->setLegacyRequest($this->legacy_request); |
|
101 | - $this->loader->share('EE_Request', $this->legacy_request); |
|
102 | - $this->loader->share('EventEspresso\core\services\request\LegacyRequestInterface', $this->legacy_request); |
|
103 | - } |
|
84 | + /** |
|
85 | + * @return void |
|
86 | + * @throws InvalidArgumentException |
|
87 | + * @throws EE_Error |
|
88 | + */ |
|
89 | + public function setupLegacyRequest() |
|
90 | + { |
|
91 | + espresso_load_required( |
|
92 | + 'EE_Request', |
|
93 | + EE_CORE . 'request_stack' . DS . 'EE_Request.core.php' |
|
94 | + ); |
|
95 | + $this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER); |
|
96 | + $this->legacy_request->setRequest($this->request); |
|
97 | + $this->legacy_request->admin = $this->request->isAdmin(); |
|
98 | + $this->legacy_request->ajax = $this->request->isAjax(); |
|
99 | + $this->legacy_request->front_ajax = $this->request->isFrontAjax(); |
|
100 | + EE_Dependency_Map::instance()->setLegacyRequest($this->legacy_request); |
|
101 | + $this->loader->share('EE_Request', $this->legacy_request); |
|
102 | + $this->loader->share('EventEspresso\core\services\request\LegacyRequestInterface', $this->legacy_request); |
|
103 | + } |
|
104 | 104 | } |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | * |
182 | 182 | * @deprecated 4.9.53 |
183 | 183 | * @param $key |
184 | - * @param null $default |
|
184 | + * @param null|string $default |
|
185 | 185 | * @return mixed |
186 | 186 | * @throws InvalidArgumentException |
187 | 187 | * @throws InvalidDataTypeException |
@@ -256,7 +256,7 @@ discard block |
||
256 | 256 | |
257 | 257 | /** |
258 | 258 | * @deprecated 4.9.53 |
259 | - * @return mixed |
|
259 | + * @return boolean |
|
260 | 260 | * @throws InvalidArgumentException |
261 | 261 | * @throws InvalidDataTypeException |
262 | 262 | * @throws InvalidInterfaceException |
@@ -269,7 +269,7 @@ discard block |
||
269 | 269 | |
270 | 270 | /** |
271 | 271 | * @deprecated 4.9.53 |
272 | - * @return mixed |
|
272 | + * @return boolean |
|
273 | 273 | * @throws InvalidArgumentException |
274 | 274 | * @throws InvalidDataTypeException |
275 | 275 | * @throws InvalidInterfaceException |
@@ -282,7 +282,7 @@ discard block |
||
282 | 282 | |
283 | 283 | /** |
284 | 284 | * @deprecated 4.9.53 |
285 | - * @return mixed|string |
|
285 | + * @return string |
|
286 | 286 | * @throws InvalidArgumentException |
287 | 287 | * @throws InvalidDataTypeException |
288 | 288 | * @throws InvalidInterfaceException |
@@ -18,359 +18,359 @@ |
||
18 | 18 | class EE_Request implements LegacyRequestInterface, InterminableInterface |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * @var RequestInterface $request |
|
23 | - */ |
|
24 | - private $request; |
|
25 | - |
|
26 | - /** |
|
27 | - * whether current request is for the admin but NOT via AJAX |
|
28 | - * |
|
29 | - * @var boolean $admin |
|
30 | - */ |
|
31 | - public $admin = false; |
|
32 | - |
|
33 | - /** |
|
34 | - * whether current request is via AJAX |
|
35 | - * |
|
36 | - * @var boolean $ajax |
|
37 | - */ |
|
38 | - public $ajax = false; |
|
39 | - |
|
40 | - /** |
|
41 | - * whether current request is via AJAX from the frontend of the site |
|
42 | - * |
|
43 | - * @var boolean $front_ajax |
|
44 | - */ |
|
45 | - public $front_ajax = false; |
|
46 | - |
|
47 | - |
|
48 | - /** |
|
49 | - * @deprecated 4.9.53 |
|
50 | - * @param array $get |
|
51 | - * @param array $post |
|
52 | - * @param array $cookie |
|
53 | - * @param array $server |
|
54 | - */ |
|
55 | - public function __construct( |
|
56 | - array $get = array(), |
|
57 | - array $post = array(), |
|
58 | - array $cookie = array(), |
|
59 | - array $server = array() |
|
60 | - ) { |
|
61 | - } |
|
62 | - |
|
63 | - |
|
64 | - /** |
|
65 | - * @return RequestInterface |
|
66 | - * @throws InvalidArgumentException |
|
67 | - * @throws InvalidInterfaceException |
|
68 | - * @throws InvalidDataTypeException |
|
69 | - */ |
|
70 | - private function request() |
|
71 | - { |
|
72 | - if ($this->request instanceof RequestInterface) { |
|
73 | - return $this->request; |
|
74 | - } |
|
75 | - $loader = LoaderFactory::getLoader(); |
|
76 | - $this->request = $loader->getShared('EventEspresso\core\services\request\RequestInterface'); |
|
77 | - return $this->request; |
|
78 | - } |
|
79 | - |
|
80 | - |
|
81 | - /** |
|
82 | - * @param RequestInterface $request |
|
83 | - */ |
|
84 | - public function setRequest(RequestInterface $request) |
|
85 | - { |
|
86 | - $this->request = $request; |
|
87 | - } |
|
88 | - |
|
89 | - |
|
90 | - /** |
|
91 | - * @deprecated 4.9.53 |
|
92 | - * @return array |
|
93 | - * @throws InvalidArgumentException |
|
94 | - * @throws InvalidDataTypeException |
|
95 | - * @throws InvalidInterfaceException |
|
96 | - */ |
|
97 | - public function get_params() |
|
98 | - { |
|
99 | - return $this->request()->getParams(); |
|
100 | - } |
|
101 | - |
|
102 | - |
|
103 | - /** |
|
104 | - * @deprecated 4.9.53 |
|
105 | - * @return array |
|
106 | - * @throws InvalidArgumentException |
|
107 | - * @throws InvalidDataTypeException |
|
108 | - * @throws InvalidInterfaceException |
|
109 | - */ |
|
110 | - public function post_params() |
|
111 | - { |
|
112 | - return $this->request()->postParams(); |
|
113 | - } |
|
114 | - |
|
115 | - |
|
116 | - /** |
|
117 | - * @deprecated 4.9.53 |
|
118 | - * @return array |
|
119 | - * @throws InvalidArgumentException |
|
120 | - * @throws InvalidDataTypeException |
|
121 | - * @throws InvalidInterfaceException |
|
122 | - */ |
|
123 | - public function cookie_params() |
|
124 | - { |
|
125 | - return $this->request()->cookieParams(); |
|
126 | - } |
|
127 | - |
|
128 | - |
|
129 | - /** |
|
130 | - * @deprecated 4.9.53 |
|
131 | - * @return array |
|
132 | - * @throws InvalidArgumentException |
|
133 | - * @throws InvalidDataTypeException |
|
134 | - * @throws InvalidInterfaceException |
|
135 | - */ |
|
136 | - public function server_params() |
|
137 | - { |
|
138 | - return $this->request()->serverParams(); |
|
139 | - } |
|
140 | - |
|
141 | - |
|
142 | - /** |
|
143 | - * returns contents of $_REQUEST |
|
144 | - * |
|
145 | - * @deprecated 4.9.53 |
|
146 | - * @return array |
|
147 | - * @throws InvalidArgumentException |
|
148 | - * @throws InvalidDataTypeException |
|
149 | - * @throws InvalidInterfaceException |
|
150 | - */ |
|
151 | - public function params() |
|
152 | - { |
|
153 | - return $this->request()->requestParams(); |
|
154 | - } |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * @deprecated 4.9.53 |
|
159 | - * @param $key |
|
160 | - * @param $value |
|
161 | - * @param bool $override_ee |
|
162 | - * @return void |
|
163 | - * @throws InvalidArgumentException |
|
164 | - * @throws InvalidDataTypeException |
|
165 | - * @throws InvalidInterfaceException |
|
166 | - */ |
|
167 | - public function set($key, $value, $override_ee = false) |
|
168 | - { |
|
169 | - $this->request()->setRequestParam($key, $value, $override_ee); |
|
170 | - } |
|
171 | - |
|
172 | - |
|
173 | - /** |
|
174 | - * returns the value for a request param if the given key exists |
|
175 | - * |
|
176 | - * @deprecated 4.9.53 |
|
177 | - * @param $key |
|
178 | - * @param null $default |
|
179 | - * @return mixed |
|
180 | - * @throws InvalidArgumentException |
|
181 | - * @throws InvalidDataTypeException |
|
182 | - * @throws InvalidInterfaceException |
|
183 | - */ |
|
184 | - public function get($key, $default = null) |
|
185 | - { |
|
186 | - return $this->request()->getRequestParam($key, $default); |
|
187 | - } |
|
188 | - |
|
189 | - |
|
190 | - /** |
|
191 | - * check if param exists |
|
192 | - * |
|
193 | - * @deprecated 4.9.53 |
|
194 | - * @param $key |
|
195 | - * @return bool |
|
196 | - * @throws InvalidArgumentException |
|
197 | - * @throws InvalidDataTypeException |
|
198 | - * @throws InvalidInterfaceException |
|
199 | - */ |
|
200 | - public function is_set($key) |
|
201 | - { |
|
202 | - return $this->request()->requestParamIsSet($key); |
|
203 | - } |
|
204 | - |
|
205 | - |
|
206 | - /** |
|
207 | - * remove param |
|
208 | - * |
|
209 | - * @deprecated 4.9.53 |
|
210 | - * @param $key |
|
211 | - * @param bool $unset_from_global_too |
|
212 | - * @throws InvalidArgumentException |
|
213 | - * @throws InvalidDataTypeException |
|
214 | - * @throws InvalidInterfaceException |
|
215 | - */ |
|
216 | - public function un_set($key, $unset_from_global_too = false) |
|
217 | - { |
|
218 | - $this->request()->unSetRequestParam($key, $unset_from_global_too); |
|
219 | - } |
|
220 | - |
|
221 | - |
|
222 | - /** |
|
223 | - * @deprecated 4.9.53 |
|
224 | - * @return string |
|
225 | - * @throws InvalidArgumentException |
|
226 | - * @throws InvalidDataTypeException |
|
227 | - * @throws InvalidInterfaceException |
|
228 | - */ |
|
229 | - public function ip_address() |
|
230 | - { |
|
231 | - return $this->request()->ipAddress(); |
|
232 | - } |
|
233 | - |
|
234 | - |
|
235 | - /** |
|
236 | - * @deprecated 4.9.53 |
|
237 | - * @return bool |
|
238 | - * @throws InvalidArgumentException |
|
239 | - * @throws InvalidDataTypeException |
|
240 | - * @throws InvalidInterfaceException |
|
241 | - */ |
|
242 | - public function isAdmin() |
|
243 | - { |
|
244 | - return $this->request()->isAdmin(); |
|
245 | - } |
|
246 | - |
|
247 | - |
|
248 | - /** |
|
249 | - * @deprecated 4.9.53 |
|
250 | - * @return mixed |
|
251 | - * @throws InvalidArgumentException |
|
252 | - * @throws InvalidDataTypeException |
|
253 | - * @throws InvalidInterfaceException |
|
254 | - */ |
|
255 | - public function isAjax() |
|
256 | - { |
|
257 | - return $this->request()->isAjax(); |
|
258 | - } |
|
259 | - |
|
260 | - |
|
261 | - /** |
|
262 | - * @deprecated 4.9.53 |
|
263 | - * @return mixed |
|
264 | - * @throws InvalidArgumentException |
|
265 | - * @throws InvalidDataTypeException |
|
266 | - * @throws InvalidInterfaceException |
|
267 | - */ |
|
268 | - public function isFrontAjax() |
|
269 | - { |
|
270 | - return $this->request()->isFrontAjax(); |
|
271 | - } |
|
272 | - |
|
273 | - |
|
274 | - /** |
|
275 | - * @deprecated 4.9.53 |
|
276 | - * @return mixed|string |
|
277 | - * @throws InvalidArgumentException |
|
278 | - * @throws InvalidDataTypeException |
|
279 | - * @throws InvalidInterfaceException |
|
280 | - */ |
|
281 | - public function requestUri() |
|
282 | - { |
|
283 | - return $this->request()->requestUri(); |
|
284 | - } |
|
285 | - |
|
286 | - |
|
287 | - /** |
|
288 | - * @deprecated 4.9.53 |
|
289 | - * @return string |
|
290 | - * @throws InvalidArgumentException |
|
291 | - * @throws InvalidDataTypeException |
|
292 | - * @throws InvalidInterfaceException |
|
293 | - */ |
|
294 | - public function userAgent() |
|
295 | - { |
|
296 | - return $this->request()->userAgent(); |
|
297 | - } |
|
298 | - |
|
299 | - |
|
300 | - /** |
|
301 | - * @deprecated 4.9.53 |
|
302 | - * @param string $user_agent |
|
303 | - * @throws InvalidArgumentException |
|
304 | - * @throws InvalidDataTypeException |
|
305 | - * @throws InvalidInterfaceException |
|
306 | - */ |
|
307 | - public function setUserAgent($user_agent = '') |
|
308 | - { |
|
309 | - $this->request()->setUserAgent($user_agent); |
|
310 | - } |
|
311 | - |
|
312 | - |
|
313 | - /** |
|
314 | - * @deprecated 4.9.53 |
|
315 | - * @return bool |
|
316 | - * @throws InvalidArgumentException |
|
317 | - * @throws InvalidDataTypeException |
|
318 | - * @throws InvalidInterfaceException |
|
319 | - */ |
|
320 | - public function isBot() |
|
321 | - { |
|
322 | - return $this->request()->isBot(); |
|
323 | - } |
|
324 | - |
|
325 | - |
|
326 | - /** |
|
327 | - * @deprecated 4.9.53 |
|
328 | - * @param bool $is_bot |
|
329 | - * @throws InvalidArgumentException |
|
330 | - * @throws InvalidDataTypeException |
|
331 | - * @throws InvalidInterfaceException |
|
332 | - */ |
|
333 | - public function setIsBot($is_bot) |
|
334 | - { |
|
335 | - $this->request()->setIsBot($is_bot); |
|
336 | - } |
|
337 | - |
|
338 | - |
|
339 | - /** |
|
340 | - * check if a request parameter exists whose key that matches the supplied wildcard pattern |
|
341 | - * and return the value for the first match found |
|
342 | - * wildcards can be either of the following: |
|
343 | - * ? to represent a single character of any type |
|
344 | - * * to represent one or more characters of any type |
|
345 | - * |
|
346 | - * @param string $pattern |
|
347 | - * @param null|mixed $default |
|
348 | - * @return false|int |
|
349 | - * @throws InvalidArgumentException |
|
350 | - * @throws InvalidInterfaceException |
|
351 | - * @throws InvalidDataTypeException |
|
352 | - */ |
|
353 | - public function getMatch($pattern, $default = null) |
|
354 | - { |
|
355 | - return $this->request()->getMatch($pattern, $default); |
|
356 | - } |
|
357 | - |
|
358 | - |
|
359 | - /** |
|
360 | - * check if a request parameter exists whose key matches the supplied wildcard pattern |
|
361 | - * wildcards can be either of the following: |
|
362 | - * ? to represent a single character of any type |
|
363 | - * * to represent one or more characters of any type |
|
364 | - * returns true if a match is found or false if not |
|
365 | - * |
|
366 | - * @param string $pattern |
|
367 | - * @return false|int |
|
368 | - * @throws InvalidArgumentException |
|
369 | - * @throws InvalidInterfaceException |
|
370 | - * @throws InvalidDataTypeException |
|
371 | - */ |
|
372 | - public function matches($pattern) |
|
373 | - { |
|
374 | - return $this->request()->matches($pattern); |
|
375 | - } |
|
21 | + /** |
|
22 | + * @var RequestInterface $request |
|
23 | + */ |
|
24 | + private $request; |
|
25 | + |
|
26 | + /** |
|
27 | + * whether current request is for the admin but NOT via AJAX |
|
28 | + * |
|
29 | + * @var boolean $admin |
|
30 | + */ |
|
31 | + public $admin = false; |
|
32 | + |
|
33 | + /** |
|
34 | + * whether current request is via AJAX |
|
35 | + * |
|
36 | + * @var boolean $ajax |
|
37 | + */ |
|
38 | + public $ajax = false; |
|
39 | + |
|
40 | + /** |
|
41 | + * whether current request is via AJAX from the frontend of the site |
|
42 | + * |
|
43 | + * @var boolean $front_ajax |
|
44 | + */ |
|
45 | + public $front_ajax = false; |
|
46 | + |
|
47 | + |
|
48 | + /** |
|
49 | + * @deprecated 4.9.53 |
|
50 | + * @param array $get |
|
51 | + * @param array $post |
|
52 | + * @param array $cookie |
|
53 | + * @param array $server |
|
54 | + */ |
|
55 | + public function __construct( |
|
56 | + array $get = array(), |
|
57 | + array $post = array(), |
|
58 | + array $cookie = array(), |
|
59 | + array $server = array() |
|
60 | + ) { |
|
61 | + } |
|
62 | + |
|
63 | + |
|
64 | + /** |
|
65 | + * @return RequestInterface |
|
66 | + * @throws InvalidArgumentException |
|
67 | + * @throws InvalidInterfaceException |
|
68 | + * @throws InvalidDataTypeException |
|
69 | + */ |
|
70 | + private function request() |
|
71 | + { |
|
72 | + if ($this->request instanceof RequestInterface) { |
|
73 | + return $this->request; |
|
74 | + } |
|
75 | + $loader = LoaderFactory::getLoader(); |
|
76 | + $this->request = $loader->getShared('EventEspresso\core\services\request\RequestInterface'); |
|
77 | + return $this->request; |
|
78 | + } |
|
79 | + |
|
80 | + |
|
81 | + /** |
|
82 | + * @param RequestInterface $request |
|
83 | + */ |
|
84 | + public function setRequest(RequestInterface $request) |
|
85 | + { |
|
86 | + $this->request = $request; |
|
87 | + } |
|
88 | + |
|
89 | + |
|
90 | + /** |
|
91 | + * @deprecated 4.9.53 |
|
92 | + * @return array |
|
93 | + * @throws InvalidArgumentException |
|
94 | + * @throws InvalidDataTypeException |
|
95 | + * @throws InvalidInterfaceException |
|
96 | + */ |
|
97 | + public function get_params() |
|
98 | + { |
|
99 | + return $this->request()->getParams(); |
|
100 | + } |
|
101 | + |
|
102 | + |
|
103 | + /** |
|
104 | + * @deprecated 4.9.53 |
|
105 | + * @return array |
|
106 | + * @throws InvalidArgumentException |
|
107 | + * @throws InvalidDataTypeException |
|
108 | + * @throws InvalidInterfaceException |
|
109 | + */ |
|
110 | + public function post_params() |
|
111 | + { |
|
112 | + return $this->request()->postParams(); |
|
113 | + } |
|
114 | + |
|
115 | + |
|
116 | + /** |
|
117 | + * @deprecated 4.9.53 |
|
118 | + * @return array |
|
119 | + * @throws InvalidArgumentException |
|
120 | + * @throws InvalidDataTypeException |
|
121 | + * @throws InvalidInterfaceException |
|
122 | + */ |
|
123 | + public function cookie_params() |
|
124 | + { |
|
125 | + return $this->request()->cookieParams(); |
|
126 | + } |
|
127 | + |
|
128 | + |
|
129 | + /** |
|
130 | + * @deprecated 4.9.53 |
|
131 | + * @return array |
|
132 | + * @throws InvalidArgumentException |
|
133 | + * @throws InvalidDataTypeException |
|
134 | + * @throws InvalidInterfaceException |
|
135 | + */ |
|
136 | + public function server_params() |
|
137 | + { |
|
138 | + return $this->request()->serverParams(); |
|
139 | + } |
|
140 | + |
|
141 | + |
|
142 | + /** |
|
143 | + * returns contents of $_REQUEST |
|
144 | + * |
|
145 | + * @deprecated 4.9.53 |
|
146 | + * @return array |
|
147 | + * @throws InvalidArgumentException |
|
148 | + * @throws InvalidDataTypeException |
|
149 | + * @throws InvalidInterfaceException |
|
150 | + */ |
|
151 | + public function params() |
|
152 | + { |
|
153 | + return $this->request()->requestParams(); |
|
154 | + } |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * @deprecated 4.9.53 |
|
159 | + * @param $key |
|
160 | + * @param $value |
|
161 | + * @param bool $override_ee |
|
162 | + * @return void |
|
163 | + * @throws InvalidArgumentException |
|
164 | + * @throws InvalidDataTypeException |
|
165 | + * @throws InvalidInterfaceException |
|
166 | + */ |
|
167 | + public function set($key, $value, $override_ee = false) |
|
168 | + { |
|
169 | + $this->request()->setRequestParam($key, $value, $override_ee); |
|
170 | + } |
|
171 | + |
|
172 | + |
|
173 | + /** |
|
174 | + * returns the value for a request param if the given key exists |
|
175 | + * |
|
176 | + * @deprecated 4.9.53 |
|
177 | + * @param $key |
|
178 | + * @param null $default |
|
179 | + * @return mixed |
|
180 | + * @throws InvalidArgumentException |
|
181 | + * @throws InvalidDataTypeException |
|
182 | + * @throws InvalidInterfaceException |
|
183 | + */ |
|
184 | + public function get($key, $default = null) |
|
185 | + { |
|
186 | + return $this->request()->getRequestParam($key, $default); |
|
187 | + } |
|
188 | + |
|
189 | + |
|
190 | + /** |
|
191 | + * check if param exists |
|
192 | + * |
|
193 | + * @deprecated 4.9.53 |
|
194 | + * @param $key |
|
195 | + * @return bool |
|
196 | + * @throws InvalidArgumentException |
|
197 | + * @throws InvalidDataTypeException |
|
198 | + * @throws InvalidInterfaceException |
|
199 | + */ |
|
200 | + public function is_set($key) |
|
201 | + { |
|
202 | + return $this->request()->requestParamIsSet($key); |
|
203 | + } |
|
204 | + |
|
205 | + |
|
206 | + /** |
|
207 | + * remove param |
|
208 | + * |
|
209 | + * @deprecated 4.9.53 |
|
210 | + * @param $key |
|
211 | + * @param bool $unset_from_global_too |
|
212 | + * @throws InvalidArgumentException |
|
213 | + * @throws InvalidDataTypeException |
|
214 | + * @throws InvalidInterfaceException |
|
215 | + */ |
|
216 | + public function un_set($key, $unset_from_global_too = false) |
|
217 | + { |
|
218 | + $this->request()->unSetRequestParam($key, $unset_from_global_too); |
|
219 | + } |
|
220 | + |
|
221 | + |
|
222 | + /** |
|
223 | + * @deprecated 4.9.53 |
|
224 | + * @return string |
|
225 | + * @throws InvalidArgumentException |
|
226 | + * @throws InvalidDataTypeException |
|
227 | + * @throws InvalidInterfaceException |
|
228 | + */ |
|
229 | + public function ip_address() |
|
230 | + { |
|
231 | + return $this->request()->ipAddress(); |
|
232 | + } |
|
233 | + |
|
234 | + |
|
235 | + /** |
|
236 | + * @deprecated 4.9.53 |
|
237 | + * @return bool |
|
238 | + * @throws InvalidArgumentException |
|
239 | + * @throws InvalidDataTypeException |
|
240 | + * @throws InvalidInterfaceException |
|
241 | + */ |
|
242 | + public function isAdmin() |
|
243 | + { |
|
244 | + return $this->request()->isAdmin(); |
|
245 | + } |
|
246 | + |
|
247 | + |
|
248 | + /** |
|
249 | + * @deprecated 4.9.53 |
|
250 | + * @return mixed |
|
251 | + * @throws InvalidArgumentException |
|
252 | + * @throws InvalidDataTypeException |
|
253 | + * @throws InvalidInterfaceException |
|
254 | + */ |
|
255 | + public function isAjax() |
|
256 | + { |
|
257 | + return $this->request()->isAjax(); |
|
258 | + } |
|
259 | + |
|
260 | + |
|
261 | + /** |
|
262 | + * @deprecated 4.9.53 |
|
263 | + * @return mixed |
|
264 | + * @throws InvalidArgumentException |
|
265 | + * @throws InvalidDataTypeException |
|
266 | + * @throws InvalidInterfaceException |
|
267 | + */ |
|
268 | + public function isFrontAjax() |
|
269 | + { |
|
270 | + return $this->request()->isFrontAjax(); |
|
271 | + } |
|
272 | + |
|
273 | + |
|
274 | + /** |
|
275 | + * @deprecated 4.9.53 |
|
276 | + * @return mixed|string |
|
277 | + * @throws InvalidArgumentException |
|
278 | + * @throws InvalidDataTypeException |
|
279 | + * @throws InvalidInterfaceException |
|
280 | + */ |
|
281 | + public function requestUri() |
|
282 | + { |
|
283 | + return $this->request()->requestUri(); |
|
284 | + } |
|
285 | + |
|
286 | + |
|
287 | + /** |
|
288 | + * @deprecated 4.9.53 |
|
289 | + * @return string |
|
290 | + * @throws InvalidArgumentException |
|
291 | + * @throws InvalidDataTypeException |
|
292 | + * @throws InvalidInterfaceException |
|
293 | + */ |
|
294 | + public function userAgent() |
|
295 | + { |
|
296 | + return $this->request()->userAgent(); |
|
297 | + } |
|
298 | + |
|
299 | + |
|
300 | + /** |
|
301 | + * @deprecated 4.9.53 |
|
302 | + * @param string $user_agent |
|
303 | + * @throws InvalidArgumentException |
|
304 | + * @throws InvalidDataTypeException |
|
305 | + * @throws InvalidInterfaceException |
|
306 | + */ |
|
307 | + public function setUserAgent($user_agent = '') |
|
308 | + { |
|
309 | + $this->request()->setUserAgent($user_agent); |
|
310 | + } |
|
311 | + |
|
312 | + |
|
313 | + /** |
|
314 | + * @deprecated 4.9.53 |
|
315 | + * @return bool |
|
316 | + * @throws InvalidArgumentException |
|
317 | + * @throws InvalidDataTypeException |
|
318 | + * @throws InvalidInterfaceException |
|
319 | + */ |
|
320 | + public function isBot() |
|
321 | + { |
|
322 | + return $this->request()->isBot(); |
|
323 | + } |
|
324 | + |
|
325 | + |
|
326 | + /** |
|
327 | + * @deprecated 4.9.53 |
|
328 | + * @param bool $is_bot |
|
329 | + * @throws InvalidArgumentException |
|
330 | + * @throws InvalidDataTypeException |
|
331 | + * @throws InvalidInterfaceException |
|
332 | + */ |
|
333 | + public function setIsBot($is_bot) |
|
334 | + { |
|
335 | + $this->request()->setIsBot($is_bot); |
|
336 | + } |
|
337 | + |
|
338 | + |
|
339 | + /** |
|
340 | + * check if a request parameter exists whose key that matches the supplied wildcard pattern |
|
341 | + * and return the value for the first match found |
|
342 | + * wildcards can be either of the following: |
|
343 | + * ? to represent a single character of any type |
|
344 | + * * to represent one or more characters of any type |
|
345 | + * |
|
346 | + * @param string $pattern |
|
347 | + * @param null|mixed $default |
|
348 | + * @return false|int |
|
349 | + * @throws InvalidArgumentException |
|
350 | + * @throws InvalidInterfaceException |
|
351 | + * @throws InvalidDataTypeException |
|
352 | + */ |
|
353 | + public function getMatch($pattern, $default = null) |
|
354 | + { |
|
355 | + return $this->request()->getMatch($pattern, $default); |
|
356 | + } |
|
357 | + |
|
358 | + |
|
359 | + /** |
|
360 | + * check if a request parameter exists whose key matches the supplied wildcard pattern |
|
361 | + * wildcards can be either of the following: |
|
362 | + * ? to represent a single character of any type |
|
363 | + * * to represent one or more characters of any type |
|
364 | + * returns true if a match is found or false if not |
|
365 | + * |
|
366 | + * @param string $pattern |
|
367 | + * @return false|int |
|
368 | + * @throws InvalidArgumentException |
|
369 | + * @throws InvalidInterfaceException |
|
370 | + * @throws InvalidDataTypeException |
|
371 | + */ |
|
372 | + public function matches($pattern) |
|
373 | + { |
|
374 | + return $this->request()->matches($pattern); |
|
375 | + } |
|
376 | 376 | } |
@@ -19,59 +19,59 @@ |
||
19 | 19 | class RequestStack |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * @var RequestDecoratorInterface $request_stack_app |
|
24 | - */ |
|
25 | - protected $request_stack_app; |
|
22 | + /** |
|
23 | + * @var RequestDecoratorInterface $request_stack_app |
|
24 | + */ |
|
25 | + protected $request_stack_app; |
|
26 | 26 | |
27 | - /** |
|
28 | - * @var RequestStackCoreAppInterface $core_app |
|
29 | - */ |
|
30 | - protected $core_app; |
|
27 | + /** |
|
28 | + * @var RequestStackCoreAppInterface $core_app |
|
29 | + */ |
|
30 | + protected $core_app; |
|
31 | 31 | |
32 | - /** |
|
33 | - * @var RequestInterface $request |
|
34 | - */ |
|
35 | - protected $request; |
|
32 | + /** |
|
33 | + * @var RequestInterface $request |
|
34 | + */ |
|
35 | + protected $request; |
|
36 | 36 | |
37 | - /** |
|
38 | - * @var ResponseInterface $response |
|
39 | - */ |
|
40 | - protected $response; |
|
37 | + /** |
|
38 | + * @var ResponseInterface $response |
|
39 | + */ |
|
40 | + protected $response; |
|
41 | 41 | |
42 | 42 | |
43 | - /** |
|
44 | - * @param RequestDecoratorInterface $request_stack_app |
|
45 | - * @param RequestStackCoreAppInterface $core_app |
|
46 | - */ |
|
47 | - public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app) |
|
48 | - { |
|
49 | - $this->request_stack_app = $request_stack_app; |
|
50 | - $this->core_app = $core_app; |
|
51 | - } |
|
43 | + /** |
|
44 | + * @param RequestDecoratorInterface $request_stack_app |
|
45 | + * @param RequestStackCoreAppInterface $core_app |
|
46 | + */ |
|
47 | + public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app) |
|
48 | + { |
|
49 | + $this->request_stack_app = $request_stack_app; |
|
50 | + $this->core_app = $core_app; |
|
51 | + } |
|
52 | 52 | |
53 | 53 | |
54 | - /** |
|
55 | - * @param RequestInterface $request |
|
56 | - * @param ResponseInterface $response |
|
57 | - * @return ResponseInterface |
|
58 | - */ |
|
59 | - public function handleRequest(RequestInterface $request, ResponseInterface $response) |
|
60 | - { |
|
61 | - $this->request = $request; |
|
62 | - $this->response = $response; |
|
63 | - return $this->request_stack_app->handleRequest($request, $response); |
|
64 | - } |
|
54 | + /** |
|
55 | + * @param RequestInterface $request |
|
56 | + * @param ResponseInterface $response |
|
57 | + * @return ResponseInterface |
|
58 | + */ |
|
59 | + public function handleRequest(RequestInterface $request, ResponseInterface $response) |
|
60 | + { |
|
61 | + $this->request = $request; |
|
62 | + $this->response = $response; |
|
63 | + return $this->request_stack_app->handleRequest($request, $response); |
|
64 | + } |
|
65 | 65 | |
66 | 66 | |
67 | - /** |
|
68 | - * handle_response |
|
69 | - * executes the handle_response() method on the RequestStackCoreAppInterface object |
|
70 | - * after the request stack has been fully processed |
|
71 | - */ |
|
72 | - public function handleResponse() |
|
73 | - { |
|
74 | - $this->core_app->handleResponse($this->request, $this->response); |
|
75 | - } |
|
67 | + /** |
|
68 | + * handle_response |
|
69 | + * executes the handle_response() method on the RequestStackCoreAppInterface object |
|
70 | + * after the request stack has been fully processed |
|
71 | + */ |
|
72 | + public function handleResponse() |
|
73 | + { |
|
74 | + $this->core_app->handleResponse($this->request, $this->response); |
|
75 | + } |
|
76 | 76 | } |
77 | 77 | // Location: RequestStack.php |
@@ -47,7 +47,7 @@ |
||
47 | 47 | public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app) |
48 | 48 | { |
49 | 49 | $this->request_stack_app = $request_stack_app; |
50 | - $this->core_app = $core_app; |
|
50 | + $this->core_app = $core_app; |
|
51 | 51 | } |
52 | 52 | |
53 | 53 |
@@ -1,7 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | 3 | use EventEspresso\core\domain\Domain; |
4 | -use EventEspresso\core\domain\entities\notifications\PersistentAdminNotice; |
|
5 | 4 | use EventEspresso\core\domain\services\factories\EmailAddressFactory; |
6 | 5 | use EventEspresso\core\domain\services\validation\email\EmailValidationException; |
7 | 6 | use EventEspresso\core\exceptions\InvalidDataTypeException; |
@@ -765,6 +765,9 @@ |
||
765 | 765 | ); |
766 | 766 | } |
767 | 767 | |
768 | + /** |
|
769 | + * @param string $version |
|
770 | + */ |
|
768 | 771 | protected function _get_add_relation_query_params(\EEM_Base $source_model, \EEM_Base $related_model, $version) |
769 | 772 | { |
770 | 773 | // if they're related through a HABTM relation, check for any non-FKs |
@@ -123,7 +123,7 @@ discard block |
||
123 | 123 | */ |
124 | 124 | protected static function _set_hooks_for_changes() |
125 | 125 | { |
126 | - $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false); |
|
126 | + $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES.'rest_api'.DS.'changes'), false); |
|
127 | 127 | foreach ($folder_contents as $classname_in_namespace => $filepath) { |
128 | 128 | // ignore the base parent class |
129 | 129 | // and legacy named classes |
@@ -132,7 +132,7 @@ discard block |
||
132 | 132 | ) { |
133 | 133 | continue; |
134 | 134 | } |
135 | - $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace; |
|
135 | + $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\'.$classname_in_namespace; |
|
136 | 136 | if (class_exists($full_classname)) { |
137 | 137 | $instance_of_class = new $full_classname; |
138 | 138 | if ($instance_of_class instanceof ChangesInBase) { |
@@ -177,10 +177,10 @@ discard block |
||
177 | 177 | * } |
178 | 178 | */ |
179 | 179 | // skip route options |
180 | - if (! is_numeric($endpoint_key)) { |
|
180 | + if ( ! is_numeric($endpoint_key)) { |
|
181 | 181 | continue; |
182 | 182 | } |
183 | - if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) { |
|
183 | + if ( ! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) { |
|
184 | 184 | throw new EE_Error( |
185 | 185 | esc_html__( |
186 | 186 | // @codingStandardsIgnoreStart |
@@ -201,7 +201,7 @@ discard block |
||
201 | 201 | } |
202 | 202 | if (isset($data_for_single_endpoint['callback_args'])) { |
203 | 203 | $callback_args = $data_for_single_endpoint['callback_args']; |
204 | - $single_endpoint_args['callback'] = function (\WP_REST_Request $request) use ( |
|
204 | + $single_endpoint_args['callback'] = function(\WP_REST_Request $request) use ( |
|
205 | 205 | $callback, |
206 | 206 | $callback_args |
207 | 207 | ) { |
@@ -220,7 +220,7 @@ discard block |
||
220 | 220 | $schema_route_data = $data_for_multiple_endpoints['schema']; |
221 | 221 | $schema_callback = $schema_route_data['schema_callback']; |
222 | 222 | $callback_args = $schema_route_data['callback_args']; |
223 | - $multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) { |
|
223 | + $multiple_endpoint_args['schema'] = function() use ($schema_callback, $callback_args) { |
|
224 | 224 | return call_user_func_array( |
225 | 225 | $schema_callback, |
226 | 226 | $callback_args |
@@ -262,7 +262,7 @@ discard block |
||
262 | 262 | { |
263 | 263 | // delete the saved EE REST API routes |
264 | 264 | foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) { |
265 | - delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version); |
|
265 | + delete_option(EED_Core_Rest_Api::saved_routes_option_names.$version); |
|
266 | 266 | } |
267 | 267 | } |
268 | 268 | |
@@ -281,7 +281,7 @@ discard block |
||
281 | 281 | { |
282 | 282 | $ee_routes = array(); |
283 | 283 | foreach (self::versions_served() as $version => $hidden_endpoints) { |
284 | - $ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version( |
|
284 | + $ee_routes[self::ee_api_namespace.$version] = self::_get_ee_route_data_for_version( |
|
285 | 285 | $version, |
286 | 286 | $hidden_endpoints |
287 | 287 | ); |
@@ -301,8 +301,8 @@ discard block |
||
301 | 301 | */ |
302 | 302 | protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false) |
303 | 303 | { |
304 | - $ee_routes = get_option(self::saved_routes_option_names . $version, null); |
|
305 | - if (! $ee_routes || EED_Core_Rest_Api::debugMode()) { |
|
304 | + $ee_routes = get_option(self::saved_routes_option_names.$version, null); |
|
305 | + if ( ! $ee_routes || EED_Core_Rest_Api::debugMode()) { |
|
306 | 306 | $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints); |
307 | 307 | } |
308 | 308 | return $ee_routes; |
@@ -329,7 +329,7 @@ discard block |
||
329 | 329 | $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints) |
330 | 330 | ) |
331 | 331 | ); |
332 | - $option_name = self::saved_routes_option_names . $version; |
|
332 | + $option_name = self::saved_routes_option_names.$version; |
|
333 | 333 | if (get_option($option_name)) { |
334 | 334 | update_option($option_name, $routes, true); |
335 | 335 | } else { |
@@ -374,8 +374,8 @@ discard block |
||
374 | 374 | { |
375 | 375 | $model_routes = array(); |
376 | 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); |
|
377 | + $model_routes[EED_Core_Rest_Api::ee_api_namespace |
|
378 | + . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint); |
|
379 | 379 | } |
380 | 380 | return $model_routes; |
381 | 381 | } |
@@ -444,13 +444,13 @@ discard block |
||
444 | 444 | foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) { |
445 | 445 | $model = \EE_Registry::instance()->load_model($model_name); |
446 | 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) { |
|
447 | + if ( ! $model instanceof EEM_Base) { |
|
448 | 448 | continue; |
449 | 449 | } |
450 | 450 | // yes we could just register one route for ALL models, but then they wouldn't show up in the index |
451 | 451 | $plural_model_route = EED_Core_Rest_Api::get_collection_route($model); |
452 | 452 | $singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)'); |
453 | - $model_routes[ $plural_model_route ] = array( |
|
453 | + $model_routes[$plural_model_route] = array( |
|
454 | 454 | array( |
455 | 455 | 'callback' => array( |
456 | 456 | 'EventEspresso\core\libraries\rest_api\controllers\model\Read', |
@@ -461,7 +461,7 @@ discard block |
||
461 | 461 | 'hidden_endpoint' => $hidden_endpoint, |
462 | 462 | 'args' => $this->_get_read_query_params($model, $version), |
463 | 463 | '_links' => array( |
464 | - 'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route), |
|
464 | + 'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace.$version.$singular_model_route), |
|
465 | 465 | ), |
466 | 466 | ), |
467 | 467 | 'schema' => array( |
@@ -472,7 +472,7 @@ discard block |
||
472 | 472 | 'callback_args' => array($version, $model_name), |
473 | 473 | ), |
474 | 474 | ); |
475 | - $model_routes[ $singular_model_route ] = array( |
|
475 | + $model_routes[$singular_model_route] = array( |
|
476 | 476 | array( |
477 | 477 | 'callback' => array( |
478 | 478 | 'EventEspresso\core\libraries\rest_api\controllers\model\Read', |
@@ -489,7 +489,7 @@ discard block |
||
489 | 489 | EED_Core_Rest_Api::should_have_write_endpoints($model), |
490 | 490 | $model |
491 | 491 | )) { |
492 | - $model_routes[ $plural_model_route ][] = array( |
|
492 | + $model_routes[$plural_model_route][] = array( |
|
493 | 493 | 'callback' => array( |
494 | 494 | 'EventEspresso\core\libraries\rest_api\controllers\model\Write', |
495 | 495 | 'handleRequestInsert', |
@@ -499,8 +499,8 @@ discard block |
||
499 | 499 | 'hidden_endpoint' => $hidden_endpoint, |
500 | 500 | 'args' => $this->_get_write_params($model_name, $model_version_info, true), |
501 | 501 | ); |
502 | - $model_routes[ $singular_model_route ] = array_merge( |
|
503 | - $model_routes[ $singular_model_route ], |
|
502 | + $model_routes[$singular_model_route] = array_merge( |
|
503 | + $model_routes[$singular_model_route], |
|
504 | 504 | array( |
505 | 505 | array( |
506 | 506 | 'callback' => array( |
@@ -531,7 +531,7 @@ discard block |
||
531 | 531 | '(?P<id>[^\/]+)', |
532 | 532 | $relation_obj |
533 | 533 | ); |
534 | - $model_routes[ $related_route ] = array( |
|
534 | + $model_routes[$related_route] = array( |
|
535 | 535 | array( |
536 | 536 | 'callback' => array( |
537 | 537 | 'EventEspresso\core\libraries\rest_api\controllers\model\Read', |
@@ -544,8 +544,8 @@ discard block |
||
544 | 544 | ), |
545 | 545 | ); |
546 | 546 | |
547 | - $related_write_route = $related_route . '/' . '(?P<related_id>[^\/]+)'; |
|
548 | - $model_routes[ $related_write_route ] = array( |
|
547 | + $related_write_route = $related_route.'/'.'(?P<related_id>[^\/]+)'; |
|
548 | + $model_routes[$related_write_route] = array( |
|
549 | 549 | array( |
550 | 550 | 'callback' => array( |
551 | 551 | 'EventEspresso\core\libraries\rest_api\controllers\model\Write', |
@@ -598,7 +598,7 @@ discard block |
||
598 | 598 | */ |
599 | 599 | public static function get_entity_route($model, $id) |
600 | 600 | { |
601 | - return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id; |
|
601 | + return EED_Core_Rest_Api::get_collection_route($model).'/'.$id; |
|
602 | 602 | } |
603 | 603 | |
604 | 604 | |
@@ -618,7 +618,7 @@ discard block |
||
618 | 618 | $relation_obj->get_other_model()->get_this_model_name(), |
619 | 619 | $relation_obj |
620 | 620 | ); |
621 | - return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part; |
|
621 | + return EED_Core_Rest_Api::get_entity_route($model, $id).'/'.$related_model_name_endpoint_part; |
|
622 | 622 | } |
623 | 623 | |
624 | 624 | |
@@ -632,7 +632,7 @@ discard block |
||
632 | 632 | */ |
633 | 633 | public static function get_versioned_route_to($relative_route, $version = '4.8.36') |
634 | 634 | { |
635 | - return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route; |
|
635 | + return '/'.EED_Core_Rest_Api::ee_api_namespace.$version.'/'.$relative_route; |
|
636 | 636 | } |
637 | 637 | |
638 | 638 | |
@@ -646,7 +646,7 @@ discard block |
||
646 | 646 | { |
647 | 647 | $routes = array(); |
648 | 648 | foreach (self::versions_served() as $version => $hidden_endpoint) { |
649 | - $routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version( |
|
649 | + $routes[self::ee_api_namespace.$version] = $this->_get_rpc_route_data_for_version( |
|
650 | 650 | $version, |
651 | 651 | $hidden_endpoint |
652 | 652 | ); |
@@ -769,12 +769,12 @@ discard block |
||
769 | 769 | { |
770 | 770 | // if they're related through a HABTM relation, check for any non-FKs |
771 | 771 | $all_relation_settings = $source_model->relation_settings(); |
772 | - $relation_settings = $all_relation_settings[ $related_model->get_this_model_name() ]; |
|
772 | + $relation_settings = $all_relation_settings[$related_model->get_this_model_name()]; |
|
773 | 773 | $params = array(); |
774 | 774 | if ($relation_settings instanceof EE_HABTM_Relation && $relation_settings->hasNonKeyFields()) { |
775 | 775 | foreach ($relation_settings->getNonKeyFields() as $field) { |
776 | 776 | /* @var $field EE_Model_Field_Base */ |
777 | - $params[ $field->get_name() ] = array( |
|
777 | + $params[$field->get_name()] = array( |
|
778 | 778 | 'required' => ! $field->is_nullable(), |
779 | 779 | 'default' => ModelDataTranslator::prepareFieldValueForJson($field, $field->get_default_value(), $version), |
780 | 780 | 'type' => $field->getSchemaType(), |
@@ -799,7 +799,7 @@ discard block |
||
799 | 799 | { |
800 | 800 | $default_orderby = array(); |
801 | 801 | foreach ($model->get_combined_primary_key_fields() as $key_field) { |
802 | - $default_orderby[ $key_field->get_name() ] = 'ASC'; |
|
802 | + $default_orderby[$key_field->get_name()] = 'ASC'; |
|
803 | 803 | } |
804 | 804 | return array_merge( |
805 | 805 | $this->_get_response_selection_query_params($model, $version), |
@@ -833,7 +833,7 @@ discard block |
||
833 | 833 | 'type' => array( |
834 | 834 | 'object', |
835 | 835 | 'string', |
836 | - ),// because we accept a variety of types, WP core validation and sanitization |
|
836 | + ), // because we accept a variety of types, WP core validation and sanitization |
|
837 | 837 | // freaks out. We'll just validate this argument while handling the request |
838 | 838 | 'validate_callback' => null, |
839 | 839 | 'sanitize_callback' => null, |
@@ -931,7 +931,7 @@ discard block |
||
931 | 931 | $sanitize_callback = null; |
932 | 932 | } |
933 | 933 | $arg_info['sanitize_callback'] = $sanitize_callback; |
934 | - $args_info[ $field_name ] = $arg_info; |
|
934 | + $args_info[$field_name] = $arg_info; |
|
935 | 935 | if ($field_obj instanceof EE_Datetime_Field) { |
936 | 936 | $gmt_arg_info = $arg_info; |
937 | 937 | $gmt_arg_info['description'] = sprintf( |
@@ -942,7 +942,7 @@ discard block |
||
942 | 942 | $field_obj->get_nicename(), |
943 | 943 | $field_name |
944 | 944 | ); |
945 | - $args_info[ $field_name . '_gmt' ] = $gmt_arg_info; |
|
945 | + $args_info[$field_name.'_gmt'] = $gmt_arg_info; |
|
946 | 946 | } |
947 | 947 | } |
948 | 948 | return $args_info; |
@@ -965,16 +965,16 @@ discard block |
||
965 | 965 | public static function default_sanitize_callback($value, WP_REST_Request $request, $param) |
966 | 966 | { |
967 | 967 | $attributes = $request->get_attributes(); |
968 | - if (! isset($attributes['args'][ $param ]) |
|
969 | - || ! is_array($attributes['args'][ $param ])) { |
|
968 | + if ( ! isset($attributes['args'][$param]) |
|
969 | + || ! is_array($attributes['args'][$param])) { |
|
970 | 970 | $validation_result = true; |
971 | 971 | } else { |
972 | - $args = $attributes['args'][ $param ]; |
|
972 | + $args = $attributes['args'][$param]; |
|
973 | 973 | if (( |
974 | 974 | $value === '' |
975 | 975 | || $value === null |
976 | 976 | ) |
977 | - && (! isset($args['required']) |
|
977 | + && ( ! isset($args['required']) |
|
978 | 978 | || $args['required'] === false |
979 | 979 | ) |
980 | 980 | ) { |
@@ -984,7 +984,7 @@ discard block |
||
984 | 984 | && $args['format'] === 'email' |
985 | 985 | ) { |
986 | 986 | $validation_result = true; |
987 | - if (! self::_validate_email($value)) { |
|
987 | + if ( ! self::_validate_email($value)) { |
|
988 | 988 | $validation_result = new WP_Error( |
989 | 989 | 'rest_invalid_param', |
990 | 990 | esc_html__( |
@@ -1034,7 +1034,7 @@ discard block |
||
1034 | 1034 | { |
1035 | 1035 | $config_routes = array(); |
1036 | 1036 | foreach (self::versions_served() as $version => $hidden_endpoint) { |
1037 | - $config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version( |
|
1037 | + $config_routes[self::ee_api_namespace.$version] = $this->_get_config_route_data_for_version( |
|
1038 | 1038 | $version, |
1039 | 1039 | $hidden_endpoint |
1040 | 1040 | ); |
@@ -1089,7 +1089,7 @@ discard block |
||
1089 | 1089 | { |
1090 | 1090 | $meta_routes = array(); |
1091 | 1091 | foreach (self::versions_served() as $version => $hidden_endpoint) { |
1092 | - $meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version( |
|
1092 | + $meta_routes[self::ee_api_namespace.$version] = $this->_get_meta_route_data_for_version( |
|
1093 | 1093 | $version, |
1094 | 1094 | $hidden_endpoint |
1095 | 1095 | ); |
@@ -1141,7 +1141,7 @@ discard block |
||
1141 | 1141 | foreach ($relative_urls as $resource_name => $endpoints) { |
1142 | 1142 | foreach ($endpoints as $key => $endpoint) { |
1143 | 1143 | // skip schema and other route options |
1144 | - if (! is_numeric($key)) { |
|
1144 | + if ( ! is_numeric($key)) { |
|
1145 | 1145 | continue; |
1146 | 1146 | } |
1147 | 1147 | // by default, hide "hidden_endpoint"s, unless the request indicates |
@@ -1150,9 +1150,9 @@ discard block |
||
1150 | 1150 | if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace) |
1151 | 1151 | || ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '') |
1152 | 1152 | ) { |
1153 | - $full_route = '/' . ltrim($namespace, '/'); |
|
1154 | - $full_route .= '/' . ltrim($resource_name, '/'); |
|
1155 | - unset($route_data[ $full_route ]); |
|
1153 | + $full_route = '/'.ltrim($namespace, '/'); |
|
1154 | + $full_route .= '/'.ltrim($resource_name, '/'); |
|
1155 | + unset($route_data[$full_route]); |
|
1156 | 1156 | } |
1157 | 1157 | } |
1158 | 1158 | } |
@@ -1225,19 +1225,19 @@ discard block |
||
1225 | 1225 | // if it's not above the current core version, and it's compatible with the current version of core |
1226 | 1226 | if ($key_versioned_endpoint === $latest_version) { |
1227 | 1227 | // don't hide the latest version in the index |
1228 | - $versions_served[ $key_versioned_endpoint ] = false; |
|
1228 | + $versions_served[$key_versioned_endpoint] = false; |
|
1229 | 1229 | } elseif ($key_versioned_endpoint >= $lowest_compatible_version |
1230 | 1230 | && $key_versioned_endpoint < EED_Core_Rest_Api::core_version() |
1231 | 1231 | ) { |
1232 | 1232 | // include, but hide, previous versions which are still supported |
1233 | - $versions_served[ $key_versioned_endpoint ] = true; |
|
1233 | + $versions_served[$key_versioned_endpoint] = true; |
|
1234 | 1234 | } elseif (apply_filters( |
1235 | 1235 | 'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions', |
1236 | 1236 | false, |
1237 | 1237 | $possibly_served_versions |
1238 | 1238 | )) { |
1239 | 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; |
|
1240 | + $versions_served[$key_versioned_endpoint] = true; |
|
1241 | 1241 | } |
1242 | 1242 | } |
1243 | 1243 | return $versions_served; |
@@ -1295,7 +1295,7 @@ discard block |
||
1295 | 1295 | $model_names = self::model_names_with_plural_routes($version); |
1296 | 1296 | $collection_routes = array(); |
1297 | 1297 | foreach ($model_names as $model_name => $model_class_name) { |
1298 | - $collection_routes[ strtolower($model_name) ] = '/' . self::ee_api_namespace . $version . '/' |
|
1298 | + $collection_routes[strtolower($model_name)] = '/'.self::ee_api_namespace.$version.'/' |
|
1299 | 1299 | . EEH_Inflector::pluralize_and_lower($model_name); |
1300 | 1300 | } |
1301 | 1301 | return $collection_routes; |
@@ -1316,9 +1316,9 @@ discard block |
||
1316 | 1316 | $primary_keys = $model_class_name::instance()->get_combined_primary_key_fields(); |
1317 | 1317 | foreach ($primary_keys as $primary_key_name => $primary_key_field) { |
1318 | 1318 | if (count($primary_keys) > 1) { |
1319 | - $primary_key_items[ strtolower($model_name) ][] = $primary_key_name; |
|
1319 | + $primary_key_items[strtolower($model_name)][] = $primary_key_name; |
|
1320 | 1320 | } else { |
1321 | - $primary_key_items[ strtolower($model_name) ] = $primary_key_name; |
|
1321 | + $primary_key_items[strtolower($model_name)] = $primary_key_name; |
|
1322 | 1322 | } |
1323 | 1323 | } |
1324 | 1324 | } |
@@ -23,1332 +23,1332 @@ |
||
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 | } |
@@ -9,51 +9,51 @@ |
||
9 | 9 | class CollectionFilterCallbackIterator extends FilterIterator |
10 | 10 | { |
11 | 11 | |
12 | - /** |
|
13 | - * Used for determining whether the iterated object in the Collection is "valid" or not. |
|
14 | - * @var Closure |
|
15 | - */ |
|
16 | - private $acceptance_callback; |
|
17 | - |
|
18 | - |
|
19 | - /** |
|
20 | - * CollectionFilterCallbackIterator constructor. |
|
21 | - * |
|
22 | - * @param Collection $collection |
|
23 | - * @param Closure $acceptance_callback The closure will receive an instance of whatever object is stored on the |
|
24 | - * collection when iterating over the collection and should return boolean. |
|
25 | - */ |
|
26 | - public function __construct(Collection $collection, Closure $acceptance_callback) |
|
27 | - { |
|
28 | - $this->acceptance_callback = $acceptance_callback; |
|
29 | - parent::__construct($collection); |
|
30 | - } |
|
31 | - |
|
32 | - /** |
|
33 | - * Check whether the current element of the iterator is acceptable |
|
34 | - * |
|
35 | - * @link http://php.net/manual/en/filteriterator.accept.php |
|
36 | - * @return bool true if the current element is acceptable, otherwise false. |
|
37 | - */ |
|
38 | - public function accept() |
|
39 | - { |
|
40 | - $acceptance_callback = $this->acceptance_callback; |
|
41 | - return $acceptance_callback($this->getInnerIterator()->current()); |
|
42 | - } |
|
43 | - |
|
44 | - |
|
45 | - |
|
46 | - /** |
|
47 | - * Returns a filtered array of objects from the collection using the provided acceptance callback |
|
48 | - * @return array |
|
49 | - */ |
|
50 | - public function getFiltered() |
|
51 | - { |
|
52 | - $filtered_array = array(); |
|
53 | - $this->rewind(); |
|
54 | - foreach ($this as $filtered_object) { |
|
55 | - $filtered_array[] = $filtered_object; |
|
56 | - } |
|
57 | - return $filtered_array; |
|
58 | - } |
|
12 | + /** |
|
13 | + * Used for determining whether the iterated object in the Collection is "valid" or not. |
|
14 | + * @var Closure |
|
15 | + */ |
|
16 | + private $acceptance_callback; |
|
17 | + |
|
18 | + |
|
19 | + /** |
|
20 | + * CollectionFilterCallbackIterator constructor. |
|
21 | + * |
|
22 | + * @param Collection $collection |
|
23 | + * @param Closure $acceptance_callback The closure will receive an instance of whatever object is stored on the |
|
24 | + * collection when iterating over the collection and should return boolean. |
|
25 | + */ |
|
26 | + public function __construct(Collection $collection, Closure $acceptance_callback) |
|
27 | + { |
|
28 | + $this->acceptance_callback = $acceptance_callback; |
|
29 | + parent::__construct($collection); |
|
30 | + } |
|
31 | + |
|
32 | + /** |
|
33 | + * Check whether the current element of the iterator is acceptable |
|
34 | + * |
|
35 | + * @link http://php.net/manual/en/filteriterator.accept.php |
|
36 | + * @return bool true if the current element is acceptable, otherwise false. |
|
37 | + */ |
|
38 | + public function accept() |
|
39 | + { |
|
40 | + $acceptance_callback = $this->acceptance_callback; |
|
41 | + return $acceptance_callback($this->getInnerIterator()->current()); |
|
42 | + } |
|
43 | + |
|
44 | + |
|
45 | + |
|
46 | + /** |
|
47 | + * Returns a filtered array of objects from the collection using the provided acceptance callback |
|
48 | + * @return array |
|
49 | + */ |
|
50 | + public function getFiltered() |
|
51 | + { |
|
52 | + $filtered_array = array(); |
|
53 | + $this->rewind(); |
|
54 | + foreach ($this as $filtered_object) { |
|
55 | + $filtered_array[] = $filtered_object; |
|
56 | + } |
|
57 | + return $filtered_array; |
|
58 | + } |
|
59 | 59 | } |