Completed
Branch Gutenberg/event-attendees-bloc... (888b56)
by
unknown
40:24 queued 26:18
created
core/services/request/LegacyRequestInterface.php 1 patch
Indentation   +87 added lines, -87 removed lines patch added patch discarded remove patch
@@ -15,125 +15,125 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
core/services/request/Response.php 2 patches
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -58,7 +58,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 
Please login to merge, or discard this patch.
Indentation   +115 added lines, -115 removed lines patch added patch discarded remove patch
@@ -16,119 +16,119 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
core/services/request/middleware/PreProductionVersionWarning.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -78,7 +78,7 @@
 block discarded – undo
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
     }
Please login to merge, or discard this patch.
Indentation   +79 added lines, -79 removed lines patch added patch discarded remove patch
@@ -18,91 +18,91 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
core/services/bootstrap/BootstrapRequestResponseObjects.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -83,7 +83,7 @@
 block discarded – undo
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);
Please login to merge, or discard this patch.
Indentation   +65 added lines, -65 removed lines patch added patch discarded remove patch
@@ -25,80 +25,80 @@
 block discarded – undo
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);
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);
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
 }
Please login to merge, or discard this patch.
core/request_stack/EE_Request.core.php 2 patches
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -181,7 +181,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
Please login to merge, or discard this patch.
Indentation   +355 added lines, -355 removed lines patch added patch discarded remove patch
@@ -18,359 +18,359 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
core/services/request/RequestStack.php 2 patches
Indentation   +45 added lines, -45 removed lines patch added patch discarded remove patch
@@ -19,59 +19,59 @@
 block discarded – undo
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
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -47,7 +47,7 @@
 block discarded – undo
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
 
Please login to merge, or discard this patch.
core/services/request/middleware/SetRequestTypeContextChecker.php 1 patch
Indentation   +32 added lines, -32 removed lines patch added patch discarded remove patch
@@ -22,36 +22,36 @@
 block discarded – undo
22 22
 class SetRequestTypeContextChecker extends Middleware
23 23
 {
24 24
 
25
-    /**
26
-     * converts a Request to a Response
27
-     *
28
-     * @param RequestInterface  $request
29
-     * @param ResponseInterface $response
30
-     * @return ResponseInterface
31
-     * @throws InvalidArgumentException
32
-     */
33
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
34
-    {
35
-        $this->request  = $request;
36
-        $this->response = $response;
37
-        /** @var RequestTypeContextDetector $request_type_context_detector */
38
-        $request_type_context_detector = $this->loader->getShared(
39
-            'EventEspresso\core\domain\services\contexts\RequestTypeContextDetector',
40
-            array(
41
-                $this->request,
42
-                $this->loader->getShared(
43
-                    'EventEspresso\core\domain\services\contexts\RequestTypeContextFactory',
44
-                    array($this->loader)
45
-                ),
46
-            )
47
-        );
48
-        $request_type_context          = $request_type_context_detector->detectRequestTypeContext();
49
-        $request_type_context_checker  = $this->loader->getShared(
50
-            'EventEspresso\core\domain\services\contexts\RequestTypeContextChecker',
51
-            array($request_type_context)
52
-        );
53
-        $this->request->setRequestTypeContextChecker($request_type_context_checker);
54
-        $this->response = $this->processRequestStack($this->request, $this->response);
55
-        return $this->response;
56
-    }
25
+	/**
26
+	 * converts a Request to a Response
27
+	 *
28
+	 * @param RequestInterface  $request
29
+	 * @param ResponseInterface $response
30
+	 * @return ResponseInterface
31
+	 * @throws InvalidArgumentException
32
+	 */
33
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
34
+	{
35
+		$this->request  = $request;
36
+		$this->response = $response;
37
+		/** @var RequestTypeContextDetector $request_type_context_detector */
38
+		$request_type_context_detector = $this->loader->getShared(
39
+			'EventEspresso\core\domain\services\contexts\RequestTypeContextDetector',
40
+			array(
41
+				$this->request,
42
+				$this->loader->getShared(
43
+					'EventEspresso\core\domain\services\contexts\RequestTypeContextFactory',
44
+					array($this->loader)
45
+				),
46
+			)
47
+		);
48
+		$request_type_context          = $request_type_context_detector->detectRequestTypeContext();
49
+		$request_type_context_checker  = $this->loader->getShared(
50
+			'EventEspresso\core\domain\services\contexts\RequestTypeContextChecker',
51
+			array($request_type_context)
52
+		);
53
+		$this->request->setRequestTypeContextChecker($request_type_context_checker);
54
+		$this->response = $this->processRequestStack($this->request, $this->response);
55
+		return $this->response;
56
+	}
57 57
 }
Please login to merge, or discard this patch.
modules/core_rest_api/EED_Core_Rest_Api.module.php 3 patches
Unused Use Statements   -1 removed lines patch added patch discarded remove patch
@@ -1,7 +1,6 @@
 block discarded – undo
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;
Please login to merge, or discard this patch.
Indentation   +1264 added lines, -1264 removed lines patch added patch discarded remove patch
@@ -22,1268 +22,1268 @@
 block discarded – undo
22 22
 class EED_Core_Rest_Api extends \EED_Module
23 23
 {
24 24
 
25
-    const ee_api_namespace = Domain::API_NAMESPACE;
26
-
27
-    const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
28
-
29
-    const saved_routes_option_names = 'ee_core_routes';
30
-
31
-    /**
32
-     * string used in _links response bodies to make them globally unique.
33
-     *
34
-     * @see http://v2.wp-api.org/extending/linking/
35
-     */
36
-    const ee_api_link_namespace = 'https://api.eventespresso.com/';
37
-
38
-    /**
39
-     * @var CalculatedModelFields
40
-     */
41
-    protected static $_field_calculator;
42
-
43
-
44
-    /**
45
-     * @return EED_Core_Rest_Api|EED_Module
46
-     */
47
-    public static function instance()
48
-    {
49
-        self::$_field_calculator = new CalculatedModelFields();
50
-        return parent::get_instance(__CLASS__);
51
-    }
52
-
53
-
54
-    /**
55
-     *    set_hooks - for hooking into EE Core, other modules, etc
56
-     *
57
-     * @access    public
58
-     * @return    void
59
-     */
60
-    public static function set_hooks()
61
-    {
62
-        self::set_hooks_both();
63
-    }
64
-
65
-
66
-    /**
67
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
68
-     *
69
-     * @access    public
70
-     * @return    void
71
-     */
72
-    public static function set_hooks_admin()
73
-    {
74
-        self::set_hooks_both();
75
-    }
76
-
77
-
78
-    public static function set_hooks_both()
79
-    {
80
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
81
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
82
-        add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
83
-        add_filter(
84
-            'rest_index',
85
-            array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex')
86
-        );
87
-        EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
88
-    }
89
-
90
-
91
-    /**
92
-     * sets up hooks which only need to be included as part of REST API requests;
93
-     * other requests like to the frontend or admin etc don't need them
94
-     *
95
-     * @throws \EE_Error
96
-     */
97
-    public static function set_hooks_rest_api()
98
-    {
99
-        // set hooks which account for changes made to the API
100
-        EED_Core_Rest_Api::_set_hooks_for_changes();
101
-    }
102
-
103
-
104
-    /**
105
-     * public wrapper of _set_hooks_for_changes.
106
-     * Loads all the hooks which make requests to old versions of the API
107
-     * appear the same as they always did
108
-     *
109
-     * @throws EE_Error
110
-     */
111
-    public static function set_hooks_for_changes()
112
-    {
113
-        self::_set_hooks_for_changes();
114
-    }
115
-
116
-
117
-    /**
118
-     * Loads all the hooks which make requests to old versions of the API
119
-     * appear the same as they always did
120
-     *
121
-     * @throws EE_Error
122
-     */
123
-    protected static function _set_hooks_for_changes()
124
-    {
125
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
126
-        foreach ($folder_contents as $classname_in_namespace => $filepath) {
127
-            // ignore the base parent class
128
-            // and legacy named classes
129
-            if ($classname_in_namespace === 'ChangesInBase'
130
-                || strpos($classname_in_namespace, 'Changes_In_') === 0
131
-            ) {
132
-                continue;
133
-            }
134
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
135
-            if (class_exists($full_classname)) {
136
-                $instance_of_class = new $full_classname;
137
-                if ($instance_of_class instanceof ChangesInBase) {
138
-                    $instance_of_class->setHooks();
139
-                }
140
-            }
141
-        }
142
-    }
143
-
144
-
145
-    /**
146
-     * Filters the WP routes to add our EE-related ones. This takes a bit of time
147
-     * so we actually prefer to only do it when an EE plugin is activated or upgraded
148
-     *
149
-     * @throws \EE_Error
150
-     */
151
-    public static function register_routes()
152
-    {
153
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
154
-            foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
155
-                /**
156
-                 * @var array     $data_for_multiple_endpoints numerically indexed array
157
-                 *                                         but can also contain route options like {
158
-                 * @type array    $schema                      {
159
-                 * @type callable $schema_callback
160
-                 * @type array    $callback_args               arguments that will be passed to the callback, after the
161
-                 * WP_REST_Request of course
162
-                 * }
163
-                 * }
164
-                 */
165
-                // when registering routes, register all the endpoints' data at the same time
166
-                $multiple_endpoint_args = array();
167
-                foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
168
-                    /**
169
-                     * @var array     $data_for_single_endpoint {
170
-                     * @type callable $callback
171
-                     * @type string methods
172
-                     * @type array args
173
-                     * @type array _links
174
-                     * @type array    $callback_args            arguments that will be passed to the callback, after the
175
-                     * WP_REST_Request of course
176
-                     * }
177
-                     */
178
-                    // skip route options
179
-                    if (! is_numeric($endpoint_key)) {
180
-                        continue;
181
-                    }
182
-                    if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
183
-                        throw new EE_Error(
184
-                            esc_html__(
185
-                            // @codingStandardsIgnoreStart
186
-                                'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
187
-                                // @codingStandardsIgnoreEnd
188
-                                'event_espresso'
189
-                            )
190
-                        );
191
-                    }
192
-                    $callback = $data_for_single_endpoint['callback'];
193
-                    $single_endpoint_args = array(
194
-                        'methods' => $data_for_single_endpoint['methods'],
195
-                        'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
196
-                            : array(),
197
-                    );
198
-                    if (isset($data_for_single_endpoint['_links'])) {
199
-                        $single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
200
-                    }
201
-                    if (isset($data_for_single_endpoint['callback_args'])) {
202
-                        $callback_args = $data_for_single_endpoint['callback_args'];
203
-                        $single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
204
-                            $callback,
205
-                            $callback_args
206
-                        ) {
207
-                            array_unshift($callback_args, $request);
208
-                            return call_user_func_array(
209
-                                $callback,
210
-                                $callback_args
211
-                            );
212
-                        };
213
-                    } else {
214
-                        $single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
215
-                    }
216
-                    $multiple_endpoint_args[] = $single_endpoint_args;
217
-                }
218
-                if (isset($data_for_multiple_endpoints['schema'])) {
219
-                    $schema_route_data = $data_for_multiple_endpoints['schema'];
220
-                    $schema_callback = $schema_route_data['schema_callback'];
221
-                    $callback_args = $schema_route_data['callback_args'];
222
-                    $multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
223
-                        return call_user_func_array(
224
-                            $schema_callback,
225
-                            $callback_args
226
-                        );
227
-                    };
228
-                }
229
-                register_rest_route(
230
-                    $namespace,
231
-                    $relative_route,
232
-                    $multiple_endpoint_args
233
-                );
234
-            }
235
-        }
236
-    }
237
-
238
-
239
-    /**
240
-     * Checks if there was a version change or something that merits invalidating the cached
241
-     * route data. If so, invalidates the cached route data so that it gets refreshed
242
-     * next time the WP API is used
243
-     */
244
-    public static function invalidate_cached_route_data_on_version_change()
245
-    {
246
-        if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
247
-            EED_Core_Rest_Api::invalidate_cached_route_data();
248
-        }
249
-        foreach (EE_Registry::instance()->addons as $addon) {
250
-            if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
251
-                EED_Core_Rest_Api::invalidate_cached_route_data();
252
-            }
253
-        }
254
-    }
255
-
256
-
257
-    /**
258
-     * Removes the cached route data so it will get refreshed next time the WP API is used
259
-     */
260
-    public static function invalidate_cached_route_data()
261
-    {
262
-        // delete the saved EE REST API routes
263
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
264
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
265
-        }
266
-    }
267
-
268
-
269
-    /**
270
-     * Gets the EE route data
271
-     *
272
-     * @return array top-level key is the namespace, next-level key is the route and its value is array{
273
-     * @throws \EE_Error
274
-     * @type string|array $callback
275
-     * @type string       $methods
276
-     * @type boolean      $hidden_endpoint
277
-     * }
278
-     */
279
-    public static function get_ee_route_data()
280
-    {
281
-        $ee_routes = array();
282
-        foreach (self::versions_served() as $version => $hidden_endpoints) {
283
-            $ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version(
284
-                $version,
285
-                $hidden_endpoints
286
-            );
287
-        }
288
-        return $ee_routes;
289
-    }
290
-
291
-
292
-    /**
293
-     * Gets the EE route data from the wp options if it exists already,
294
-     * otherwise re-generates it and saves it to the option
295
-     *
296
-     * @param string  $version
297
-     * @param boolean $hidden_endpoints
298
-     * @return array
299
-     * @throws \EE_Error
300
-     */
301
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
302
-    {
303
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
304
-        if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
305
-            $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
306
-        }
307
-        return $ee_routes;
308
-    }
309
-
310
-
311
-    /**
312
-     * Saves the EE REST API route data to a wp option and returns it
313
-     *
314
-     * @param string  $version
315
-     * @param boolean $hidden_endpoints
316
-     * @return mixed|null
317
-     * @throws \EE_Error
318
-     */
319
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
320
-    {
321
-        $instance = self::instance();
322
-        $routes = apply_filters(
323
-            'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
324
-            array_replace_recursive(
325
-                $instance->_get_config_route_data_for_version($version, $hidden_endpoints),
326
-                $instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
327
-                $instance->_get_model_route_data_for_version($version, $hidden_endpoints),
328
-                $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
329
-            )
330
-        );
331
-        $option_name = self::saved_routes_option_names . $version;
332
-        if (get_option($option_name)) {
333
-            update_option($option_name, $routes, true);
334
-        } else {
335
-            add_option($option_name, $routes, null, 'no');
336
-        }
337
-        return $routes;
338
-    }
339
-
340
-
341
-    /**
342
-     * Calculates all the EE routes and saves it to a WordPress option so we don't
343
-     * need to calculate it on every request
344
-     *
345
-     * @deprecated since version 4.9.1
346
-     * @return void
347
-     */
348
-    public static function save_ee_routes()
349
-    {
350
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
351
-            $instance = self::instance();
352
-            $routes = apply_filters(
353
-                'EED_Core_Rest_Api__save_ee_routes__routes',
354
-                array_replace_recursive(
355
-                    $instance->_register_config_routes(),
356
-                    $instance->_register_meta_routes(),
357
-                    $instance->_register_model_routes(),
358
-                    $instance->_register_rpc_routes()
359
-                )
360
-            );
361
-            update_option(self::saved_routes_option_names, $routes, true);
362
-        }
363
-    }
364
-
365
-
366
-    /**
367
-     * Gets all the route information relating to EE models
368
-     *
369
-     * @return array @see get_ee_route_data
370
-     * @deprecated since version 4.9.1
371
-     */
372
-    protected function _register_model_routes()
373
-    {
374
-        $model_routes = array();
375
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
376
-            $model_routes[ EED_Core_Rest_Api::ee_api_namespace
377
-                           . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
378
-        }
379
-        return $model_routes;
380
-    }
381
-
382
-
383
-    /**
384
-     * Decides whether or not to add write endpoints for this model.
385
-     *
386
-     * Currently, this defaults to exclude all global tables and models
387
-     * which would allow inserting WP core data (we don't want to duplicate
388
-     * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
389
-     *
390
-     * @param EEM_Base $model
391
-     * @return bool
392
-     */
393
-    public static function should_have_write_endpoints(EEM_Base $model)
394
-    {
395
-        if ($model->is_wp_core_model()) {
396
-            return false;
397
-        }
398
-        foreach ($model->get_tables() as $table) {
399
-            if ($table->is_global()) {
400
-                return false;
401
-            }
402
-        }
403
-        return true;
404
-    }
405
-
406
-
407
-    /**
408
-     * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
409
-     * in this versioned namespace of EE4
410
-     *
411
-     * @param $version
412
-     * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
413
-     */
414
-    public static function model_names_with_plural_routes($version)
415
-    {
416
-        $model_version_info = new ModelVersionInfo($version);
417
-        $models_to_register = $model_version_info->modelsForRequestedVersion();
418
-        // let's not bother having endpoints for extra metas
419
-        unset(
420
-            $models_to_register['Extra_Meta'],
421
-            $models_to_register['Extra_Join'],
422
-            $models_to_register['Post_Meta']
423
-        );
424
-        return apply_filters(
425
-            'FHEE__EED_Core_REST_API___register_model_routes',
426
-            $models_to_register
427
-        );
428
-    }
429
-
430
-
431
-    /**
432
-     * Gets the route data for EE models in the specified version
433
-     *
434
-     * @param string  $version
435
-     * @param boolean $hidden_endpoint
436
-     * @return array
437
-     * @throws EE_Error
438
-     */
439
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
440
-    {
441
-        $model_routes = array();
442
-        $model_version_info = new ModelVersionInfo($version);
443
-        foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
444
-            $model = \EE_Registry::instance()->load_model($model_name);
445
-            // if this isn't a valid model then let's skip iterate to the next item in the loop.
446
-            if (! $model instanceof EEM_Base) {
447
-                continue;
448
-            }
449
-            // yes we could just register one route for ALL models, but then they wouldn't show up in the index
450
-            $plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
451
-            $singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
452
-            $model_routes[ $plural_model_route ] = array(
453
-                array(
454
-                    'callback'        => array(
455
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
456
-                        'handleRequestGetAll',
457
-                    ),
458
-                    'callback_args'   => array($version, $model_name),
459
-                    'methods'         => WP_REST_Server::READABLE,
460
-                    'hidden_endpoint' => $hidden_endpoint,
461
-                    'args'            => $this->_get_read_query_params($model, $version),
462
-                    '_links'          => array(
463
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
464
-                    ),
465
-                ),
466
-                'schema' => array(
467
-                    'schema_callback' => array(
468
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
469
-                        'handleSchemaRequest',
470
-                    ),
471
-                    'callback_args'   => array($version, $model_name),
472
-                ),
473
-            );
474
-            $model_routes[ $singular_model_route ] = array(
475
-                array(
476
-                    'callback'        => array(
477
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
478
-                        'handleRequestGetOne',
479
-                    ),
480
-                    'callback_args'   => array($version, $model_name),
481
-                    'methods'         => WP_REST_Server::READABLE,
482
-                    'hidden_endpoint' => $hidden_endpoint,
483
-                    'args'            => $this->_get_response_selection_query_params($model, $version),
484
-                ),
485
-            );
486
-            if (apply_filters(
487
-                'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
488
-                EED_Core_Rest_Api::should_have_write_endpoints($model),
489
-                $model
490
-            )) {
491
-                $model_routes[ $plural_model_route ][] = array(
492
-                    'callback'        => array(
493
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Write',
494
-                        'handleRequestInsert',
495
-                    ),
496
-                    'callback_args'   => array($version, $model_name),
497
-                    'methods'         => WP_REST_Server::CREATABLE,
498
-                    'hidden_endpoint' => $hidden_endpoint,
499
-                    'args'            => $this->_get_write_params($model_name, $model_version_info, true),
500
-                );
501
-                $model_routes[ $singular_model_route ] = array_merge(
502
-                    $model_routes[ $singular_model_route ],
503
-                    array(
504
-                        array(
505
-                            'callback'        => array(
506
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
507
-                                'handleRequestUpdate',
508
-                            ),
509
-                            'callback_args'   => array($version, $model_name),
510
-                            'methods'         => WP_REST_Server::EDITABLE,
511
-                            'hidden_endpoint' => $hidden_endpoint,
512
-                            'args'            => $this->_get_write_params($model_name, $model_version_info),
513
-                        ),
514
-                        array(
515
-                            'callback'        => array(
516
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
517
-                                'handleRequestDelete',
518
-                            ),
519
-                            'callback_args'   => array($version, $model_name),
520
-                            'methods'         => WP_REST_Server::DELETABLE,
521
-                            'hidden_endpoint' => $hidden_endpoint,
522
-                            'args'            => $this->_get_delete_query_params($model, $version),
523
-                        ),
524
-                    )
525
-                );
526
-            }
527
-            foreach ($model->relation_settings() as $relation_name => $relation_obj) {
528
-                $related_route = EED_Core_Rest_Api::get_relation_route_via(
529
-                    $model,
530
-                    '(?P<id>[^\/]+)',
531
-                    $relation_obj
532
-                );
533
-                $endpoints = array(
534
-                    array(
535
-                        'callback'        => array(
536
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
537
-                            'handleRequestGetRelated',
538
-                        ),
539
-                        'callback_args'   => array($version, $model_name, $relation_name),
540
-                        'methods'         => WP_REST_Server::READABLE,
541
-                        'hidden_endpoint' => $hidden_endpoint,
542
-                        'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
543
-                    ),
544
-                );
545
-                $model_routes[ $related_route ] = $endpoints;
546
-            }
547
-        }
548
-        return $model_routes;
549
-    }
550
-
551
-
552
-    /**
553
-     * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
554
-     * excluding the preceding slash.
555
-     * Eg you pass get_plural_route_to('Event') = 'events'
556
-     *
557
-     * @param EEM_Base $model
558
-     * @return string
559
-     */
560
-    public static function get_collection_route(EEM_Base $model)
561
-    {
562
-        return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
563
-    }
564
-
565
-
566
-    /**
567
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
568
-     * excluding the preceding slash.
569
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
570
-     *
571
-     * @param EEM_Base $model eg Event or Venue
572
-     * @param string   $id
573
-     * @return string
574
-     */
575
-    public static function get_entity_route($model, $id)
576
-    {
577
-        return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
578
-    }
579
-
580
-
581
-    /**
582
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
583
-     * excluding the preceding slash.
584
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
585
-     *
586
-     * @param EEM_Base               $model eg Event or Venue
587
-     * @param string                 $id
588
-     * @param EE_Model_Relation_Base $relation_obj
589
-     * @return string
590
-     */
591
-    public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
592
-    {
593
-        $related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
594
-            $relation_obj->get_other_model()->get_this_model_name(),
595
-            $relation_obj
596
-        );
597
-        return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
598
-    }
599
-
600
-
601
-    /**
602
-     * Adds onto the $relative_route the EE4 REST API versioned namespace.
603
-     * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
604
-     *
605
-     * @param string $relative_route
606
-     * @param string $version
607
-     * @return string
608
-     */
609
-    public static function get_versioned_route_to($relative_route, $version = '4.8.36')
610
-    {
611
-        return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
612
-    }
613
-
614
-
615
-    /**
616
-     * Adds all the RPC-style routes (remote procedure call-like routes, ie
617
-     * routes that don't conform to the traditional REST CRUD-style).
618
-     *
619
-     * @deprecated since 4.9.1
620
-     */
621
-    protected function _register_rpc_routes()
622
-    {
623
-        $routes = array();
624
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
625
-            $routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
626
-                $version,
627
-                $hidden_endpoint
628
-            );
629
-        }
630
-        return $routes;
631
-    }
632
-
633
-
634
-    /**
635
-     * @param string  $version
636
-     * @param boolean $hidden_endpoint
637
-     * @return array
638
-     */
639
-    protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
640
-    {
641
-        $this_versions_routes = array();
642
-        // checkin endpoint
643
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
644
-            array(
645
-                'callback'        => array(
646
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
647
-                    'handleRequestToggleCheckin',
648
-                ),
649
-                'methods'         => WP_REST_Server::CREATABLE,
650
-                'hidden_endpoint' => $hidden_endpoint,
651
-                'args'            => array(
652
-                    'force' => array(
653
-                        'required'    => false,
654
-                        'default'     => false,
655
-                        'description' => __(
656
-                        // @codingStandardsIgnoreStart
657
-                            'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
658
-                            // @codingStandardsIgnoreEnd
659
-                            'event_espresso'
660
-                        ),
661
-                    ),
662
-                ),
663
-                'callback_args'   => array($version),
664
-            ),
665
-        );
666
-        return apply_filters(
667
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
668
-            $this_versions_routes,
669
-            $version,
670
-            $hidden_endpoint
671
-        );
672
-    }
673
-
674
-
675
-    /**
676
-     * Gets the query params that can be used when request one or many
677
-     *
678
-     * @param EEM_Base $model
679
-     * @param string   $version
680
-     * @return array
681
-     */
682
-    protected function _get_response_selection_query_params(\EEM_Base $model, $version)
683
-    {
684
-        return apply_filters(
685
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
686
-            array(
687
-                'include'   => array(
688
-                    'required' => false,
689
-                    'default'  => '*',
690
-                    'type'     => 'string',
691
-                ),
692
-                'calculate' => array(
693
-                    'required'          => false,
694
-                    'default'           => '',
695
-                    'enum'              => self::$_field_calculator->retrieveCalculatedFieldsForModel($model),
696
-                    'type'              => 'string',
697
-                    // because we accept a CSV'd list of the enumerated strings, WP core validation and sanitization
698
-                    // freaks out. We'll just validate this argument while handling the request
699
-                    'validate_callback' => null,
700
-                    'sanitize_callback' => null,
701
-                ),
702
-            ),
703
-            $model,
704
-            $version
705
-        );
706
-    }
707
-
708
-
709
-    /**
710
-     * Gets the parameters acceptable for delete requests
711
-     *
712
-     * @param \EEM_Base $model
713
-     * @param string    $version
714
-     * @return array
715
-     */
716
-    protected function _get_delete_query_params(\EEM_Base $model, $version)
717
-    {
718
-        $params_for_delete = array(
719
-            'allow_blocking' => array(
720
-                'required' => false,
721
-                'default'  => true,
722
-                'type'     => 'boolean',
723
-            ),
724
-        );
725
-        $params_for_delete['force'] = array(
726
-            'required' => false,
727
-            'default'  => false,
728
-            'type'     => 'boolean',
729
-        );
730
-        return apply_filters(
731
-            'FHEE__EED_Core_Rest_Api___get_delete_query_params',
732
-            $params_for_delete,
733
-            $model,
734
-            $version
735
-        );
736
-    }
737
-
738
-
739
-    /**
740
-     * Gets info about reading query params that are acceptable
741
-     *
742
-     * @param \EEM_Base $model eg 'Event' or 'Venue'
743
-     * @param  string   $version
744
-     * @return array    describing the args acceptable when querying this model
745
-     * @throws EE_Error
746
-     */
747
-    protected function _get_read_query_params(\EEM_Base $model, $version)
748
-    {
749
-        $default_orderby = array();
750
-        foreach ($model->get_combined_primary_key_fields() as $key_field) {
751
-            $default_orderby[ $key_field->get_name() ] = 'ASC';
752
-        }
753
-        return array_merge(
754
-            $this->_get_response_selection_query_params($model, $version),
755
-            array(
756
-                'where'    => array(
757
-                    'required'          => false,
758
-                    'default'           => array(),
759
-                    'type'              => 'object',
760
-                    // because we accept an almost infinite list of possible where conditions, WP
761
-                    // core validation and sanitization freaks out. We'll just validate this argument
762
-                    // while handling the request
763
-                    'validate_callback' => null,
764
-                    'sanitize_callback' => null,
765
-                ),
766
-                'limit'    => array(
767
-                    'required'          => false,
768
-                    'default'           => EED_Core_Rest_Api::get_default_query_limit(),
769
-                    'type'              => array(
770
-                        'array',
771
-                        'string',
772
-                        'integer',
773
-                    ),
774
-                    // because we accept a variety of types, WP core validation and sanitization
775
-                    // freaks out. We'll just validate this argument while handling the request
776
-                    'validate_callback' => null,
777
-                    'sanitize_callback' => null,
778
-                ),
779
-                'order_by' => array(
780
-                    'required'          => false,
781
-                    'default'           => $default_orderby,
782
-                    'type'              => array(
783
-                        'object',
784
-                        'string',
785
-                    ),// because we accept a variety of types, WP core validation and sanitization
786
-                    // freaks out. We'll just validate this argument while handling the request
787
-                    'validate_callback' => null,
788
-                    'sanitize_callback' => null,
789
-                ),
790
-                'group_by' => array(
791
-                    'required'          => false,
792
-                    'default'           => null,
793
-                    'type'              => array(
794
-                        'object',
795
-                        'string',
796
-                    ),
797
-                    // because we accept  an almost infinite list of possible groupings,
798
-                    // WP core validation and sanitization
799
-                    // freaks out. We'll just validate this argument while handling the request
800
-                    'validate_callback' => null,
801
-                    'sanitize_callback' => null,
802
-                ),
803
-                'having'   => array(
804
-                    'required'          => false,
805
-                    'default'           => null,
806
-                    'type'              => 'object',
807
-                    // because we accept an almost infinite list of possible where conditions, WP
808
-                    // core validation and sanitization freaks out. We'll just validate this argument
809
-                    // while handling the request
810
-                    'validate_callback' => null,
811
-                    'sanitize_callback' => null,
812
-                ),
813
-                'caps'     => array(
814
-                    'required' => false,
815
-                    'default'  => EEM_Base::caps_read,
816
-                    'type'     => 'string',
817
-                    'enum'     => array(
818
-                        EEM_Base::caps_read,
819
-                        EEM_Base::caps_read_admin,
820
-                        EEM_Base::caps_edit,
821
-                        EEM_Base::caps_delete,
822
-                    ),
823
-                ),
824
-            )
825
-        );
826
-    }
827
-
828
-
829
-    /**
830
-     * Gets parameter information for a model regarding writing data
831
-     *
832
-     * @param string           $model_name
833
-     * @param ModelVersionInfo $model_version_info
834
-     * @param boolean          $create                                       whether this is for request to create (in
835
-     *                                                                       which case we need all required params) or
836
-     *                                                                       just to update (in which case we don't
837
-     *                                                                       need those on every request)
838
-     * @return array
839
-     */
840
-    protected function _get_write_params(
841
-        $model_name,
842
-        ModelVersionInfo $model_version_info,
843
-        $create = false
844
-    ) {
845
-        $model = EE_Registry::instance()->load_model($model_name);
846
-        $fields = $model_version_info->fieldsOnModelInThisVersion($model);
847
-        $args_info = array();
848
-        foreach ($fields as $field_name => $field_obj) {
849
-            if ($field_obj->is_auto_increment()) {
850
-                // totally ignore auto increment IDs
851
-                continue;
852
-            }
853
-            $arg_info = $field_obj->getSchema();
854
-            $required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
855
-            $arg_info['required'] = $required;
856
-            // remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
857
-            unset($arg_info['readonly']);
858
-            $schema_properties = $field_obj->getSchemaProperties();
859
-            if (isset($schema_properties['raw'])
860
-                && $field_obj->getSchemaType() === 'object'
861
-            ) {
862
-                // if there's a "raw" form of this argument, use those properties instead
863
-                $arg_info = array_replace(
864
-                    $arg_info,
865
-                    $schema_properties['raw']
866
-                );
867
-            }
868
-            $arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
869
-                $field_obj,
870
-                $field_obj->get_default_value(),
871
-                $model_version_info->requestedVersion()
872
-            );
873
-            // we do our own validation and sanitization within the controller
874
-            if (function_exists('rest_validate_value_from_schema')) {
875
-                $sanitize_callback = array(
876
-                    'EED_Core_Rest_Api',
877
-                    'default_sanitize_callback',
878
-                );
879
-            } else {
880
-                $sanitize_callback = null;
881
-            }
882
-            $arg_info['sanitize_callback'] = $sanitize_callback;
883
-            $args_info[ $field_name ] = $arg_info;
884
-            if ($field_obj instanceof EE_Datetime_Field) {
885
-                $gmt_arg_info = $arg_info;
886
-                $gmt_arg_info['description'] = sprintf(
887
-                    esc_html__(
888
-                        '%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
889
-                        'event_espresso'
890
-                    ),
891
-                    $field_obj->get_nicename(),
892
-                    $field_name
893
-                );
894
-                $args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
895
-            }
896
-        }
897
-        return $args_info;
898
-    }
899
-
900
-
901
-    /**
902
-     * Replacement for WP API's 'rest_parse_request_arg'.
903
-     * If the value is blank but not required, don't bother validating it.
904
-     * Also, it uses our email validation instead of WP API's default.
905
-     *
906
-     * @param                 $value
907
-     * @param WP_REST_Request $request
908
-     * @param                 $param
909
-     * @return bool|true|WP_Error
910
-     * @throws InvalidArgumentException
911
-     * @throws InvalidInterfaceException
912
-     * @throws InvalidDataTypeException
913
-     */
914
-    public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
915
-    {
916
-        $attributes = $request->get_attributes();
917
-        if (! isset($attributes['args'][ $param ])
918
-            || ! is_array($attributes['args'][ $param ])) {
919
-            $validation_result = true;
920
-        } else {
921
-            $args = $attributes['args'][ $param ];
922
-            if ((
923
-                    $value === ''
924
-                    || $value === null
925
-                )
926
-                && (! isset($args['required'])
927
-                    || $args['required'] === false
928
-                )
929
-            ) {
930
-                // not required and not provided? that's cool
931
-                $validation_result = true;
932
-            } elseif (isset($args['format'])
933
-                      && $args['format'] === 'email'
934
-            ) {
935
-                $validation_result = true;
936
-                if (! self::_validate_email($value)) {
937
-                    $validation_result = new WP_Error(
938
-                        'rest_invalid_param',
939
-                        esc_html__(
940
-                            'The email address is not valid or does not exist.',
941
-                            'event_espresso'
942
-                        )
943
-                    );
944
-                }
945
-            } else {
946
-                $validation_result = rest_validate_value_from_schema($value, $args, $param);
947
-            }
948
-        }
949
-        if (is_wp_error($validation_result)) {
950
-            return $validation_result;
951
-        }
952
-        return rest_sanitize_request_arg($value, $request, $param);
953
-    }
954
-
955
-
956
-    /**
957
-     * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
958
-     *
959
-     * @param $email
960
-     * @return bool
961
-     * @throws InvalidArgumentException
962
-     * @throws InvalidInterfaceException
963
-     * @throws InvalidDataTypeException
964
-     */
965
-    protected static function _validate_email($email)
966
-    {
967
-        try {
968
-            EmailAddressFactory::create($email);
969
-            return true;
970
-        } catch (EmailValidationException $e) {
971
-            return false;
972
-        }
973
-    }
974
-
975
-
976
-    /**
977
-     * Gets routes for the config
978
-     *
979
-     * @return array @see _register_model_routes
980
-     * @deprecated since version 4.9.1
981
-     */
982
-    protected function _register_config_routes()
983
-    {
984
-        $config_routes = array();
985
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
986
-            $config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
987
-                $version,
988
-                $hidden_endpoint
989
-            );
990
-        }
991
-        return $config_routes;
992
-    }
993
-
994
-
995
-    /**
996
-     * Gets routes for the config for the specified version
997
-     *
998
-     * @param string  $version
999
-     * @param boolean $hidden_endpoint
1000
-     * @return array
1001
-     */
1002
-    protected function _get_config_route_data_for_version($version, $hidden_endpoint)
1003
-    {
1004
-        return array(
1005
-            'config'    => array(
1006
-                array(
1007
-                    'callback'        => array(
1008
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1009
-                        'handleRequest',
1010
-                    ),
1011
-                    'methods'         => WP_REST_Server::READABLE,
1012
-                    'hidden_endpoint' => $hidden_endpoint,
1013
-                    'callback_args'   => array($version),
1014
-                ),
1015
-            ),
1016
-            'site_info' => array(
1017
-                array(
1018
-                    'callback'        => array(
1019
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1020
-                        'handleRequestSiteInfo',
1021
-                    ),
1022
-                    'methods'         => WP_REST_Server::READABLE,
1023
-                    'hidden_endpoint' => $hidden_endpoint,
1024
-                    'callback_args'   => array($version),
1025
-                ),
1026
-            ),
1027
-        );
1028
-    }
1029
-
1030
-
1031
-    /**
1032
-     * Gets the meta info routes
1033
-     *
1034
-     * @return array @see _register_model_routes
1035
-     * @deprecated since version 4.9.1
1036
-     */
1037
-    protected function _register_meta_routes()
1038
-    {
1039
-        $meta_routes = array();
1040
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
1041
-            $meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
1042
-                $version,
1043
-                $hidden_endpoint
1044
-            );
1045
-        }
1046
-        return $meta_routes;
1047
-    }
1048
-
1049
-
1050
-    /**
1051
-     * @param string  $version
1052
-     * @param boolean $hidden_endpoint
1053
-     * @return array
1054
-     */
1055
-    protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
1056
-    {
1057
-        return array(
1058
-            'resources' => array(
1059
-                array(
1060
-                    'callback'        => array(
1061
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
1062
-                        'handleRequestModelsMeta',
1063
-                    ),
1064
-                    'methods'         => WP_REST_Server::READABLE,
1065
-                    'hidden_endpoint' => $hidden_endpoint,
1066
-                    'callback_args'   => array($version),
1067
-                ),
1068
-            ),
1069
-        );
1070
-    }
1071
-
1072
-
1073
-    /**
1074
-     * Tries to hide old 4.6 endpoints from the
1075
-     *
1076
-     * @param array $route_data
1077
-     * @return array
1078
-     * @throws \EE_Error
1079
-     */
1080
-    public static function hide_old_endpoints($route_data)
1081
-    {
1082
-        // allow API clients to override which endpoints get hidden, in case
1083
-        // they want to discover particular endpoints
1084
-        // also, we don't have access to the request so we have to just grab it from the superglobal
1085
-        $force_show_ee_namespace = ltrim(
1086
-            EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
1087
-            '/'
1088
-        );
1089
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
1090
-            foreach ($relative_urls as $resource_name => $endpoints) {
1091
-                foreach ($endpoints as $key => $endpoint) {
1092
-                    // skip schema and other route options
1093
-                    if (! is_numeric($key)) {
1094
-                        continue;
1095
-                    }
1096
-                    // by default, hide "hidden_endpoint"s, unless the request indicates
1097
-                    // to $force_show_ee_namespace, in which case only show that one
1098
-                    // namespace's endpoints (and hide all others)
1099
-                    if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
1100
-                        || ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
1101
-                    ) {
1102
-                        $full_route = '/' . ltrim($namespace, '/');
1103
-                        $full_route .= '/' . ltrim($resource_name, '/');
1104
-                        unset($route_data[ $full_route ]);
1105
-                    }
1106
-                }
1107
-            }
1108
-        }
1109
-        return $route_data;
1110
-    }
1111
-
1112
-
1113
-    /**
1114
-     * Returns an array describing which versions of core support serving requests for.
1115
-     * Keys are core versions' major and minor version, and values are the
1116
-     * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
1117
-     * data by just removing a few models and fields from the responses. However, 4.15 might remove
1118
-     * the answers table entirely, in which case it would be very difficult for
1119
-     * it to serve 4.6-style responses.
1120
-     * Versions of core that are missing from this array are unknowns.
1121
-     * previous ver
1122
-     *
1123
-     * @return array
1124
-     */
1125
-    public static function version_compatibilities()
1126
-    {
1127
-        return apply_filters(
1128
-            'FHEE__EED_Core_REST_API__version_compatibilities',
1129
-            array(
1130
-                '4.8.29' => '4.8.29',
1131
-                '4.8.33' => '4.8.29',
1132
-                '4.8.34' => '4.8.29',
1133
-                '4.8.36' => '4.8.29',
1134
-            )
1135
-        );
1136
-    }
1137
-
1138
-
1139
-    /**
1140
-     * Gets the latest API version served. Eg if there
1141
-     * are two versions served of the API, 4.8.29 and 4.8.32, and
1142
-     * we are on core version 4.8.34, it will return the string "4.8.32"
1143
-     *
1144
-     * @return string
1145
-     */
1146
-    public static function latest_rest_api_version()
1147
-    {
1148
-        $versions_served = \EED_Core_Rest_Api::versions_served();
1149
-        $versions_served_keys = array_keys($versions_served);
1150
-        return end($versions_served_keys);
1151
-    }
1152
-
1153
-
1154
-    /**
1155
-     * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
1156
-     * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
1157
-     * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
1158
-     * We also indicate whether or not this version should be put in the index or not
1159
-     *
1160
-     * @return array keys are API version numbers (just major and minor numbers), and values
1161
-     * are whether or not they should be hidden
1162
-     */
1163
-    public static function versions_served()
1164
-    {
1165
-        $versions_served = array();
1166
-        $possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
1167
-        $lowest_compatible_version = end($possibly_served_versions);
1168
-        reset($possibly_served_versions);
1169
-        $versions_served_historically = array_keys($possibly_served_versions);
1170
-        $latest_version = end($versions_served_historically);
1171
-        reset($versions_served_historically);
1172
-        // for each version of core we have ever served:
1173
-        foreach ($versions_served_historically as $key_versioned_endpoint) {
1174
-            // if it's not above the current core version, and it's compatible with the current version of core
1175
-            if ($key_versioned_endpoint === $latest_version) {
1176
-                // don't hide the latest version in the index
1177
-                $versions_served[ $key_versioned_endpoint ] = false;
1178
-            } elseif ($key_versioned_endpoint >= $lowest_compatible_version
1179
-                && $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
1180
-            ) {
1181
-                // include, but hide, previous versions which are still supported
1182
-                $versions_served[ $key_versioned_endpoint ] = true;
1183
-            } elseif (apply_filters(
1184
-                'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
1185
-                false,
1186
-                $possibly_served_versions
1187
-            )) {
1188
-                // if a version is no longer supported, don't include it in index or list of versions served
1189
-                $versions_served[ $key_versioned_endpoint ] = true;
1190
-            }
1191
-        }
1192
-        return $versions_served;
1193
-    }
1194
-
1195
-
1196
-    /**
1197
-     * Gets the major and minor version of EE core's version string
1198
-     *
1199
-     * @return string
1200
-     */
1201
-    public static function core_version()
1202
-    {
1203
-        return apply_filters(
1204
-            'FHEE__EED_Core_REST_API__core_version',
1205
-            implode(
1206
-                '.',
1207
-                array_slice(
1208
-                    explode(
1209
-                        '.',
1210
-                        espresso_version()
1211
-                    ),
1212
-                    0,
1213
-                    3
1214
-                )
1215
-            )
1216
-        );
1217
-    }
1218
-
1219
-
1220
-    /**
1221
-     * Gets the default limit that should be used when querying for resources
1222
-     *
1223
-     * @return int
1224
-     */
1225
-    public static function get_default_query_limit()
1226
-    {
1227
-        // we actually don't use a const because we want folks to always use
1228
-        // this method, not the const directly
1229
-        return apply_filters(
1230
-            'FHEE__EED_Core_Rest_Api__get_default_query_limit',
1231
-            50
1232
-        );
1233
-    }
1234
-
1235
-
1236
-    /**
1237
-     *
1238
-     * @param string $version api version string (i.e. '4.8.36')
1239
-     * @return array
1240
-     */
1241
-    public static function getCollectionRoutesIndexedByModelName($version = '')
1242
-    {
1243
-        $version = empty($version) ? self::latest_rest_api_version() : $version;
1244
-        $model_names = self::model_names_with_plural_routes($version);
1245
-        $collection_routes = array();
1246
-        foreach ($model_names as $model_name => $model_class_name) {
1247
-            $collection_routes[ strtolower($model_name) ] = '/' . self::ee_api_namespace . $version . '/'
1248
-                                                            . EEH_Inflector::pluralize_and_lower($model_name);
1249
-        }
1250
-        return $collection_routes;
1251
-    }
1252
-
1253
-
1254
-    /**
1255
-     * Returns an array of primary key names indexed by model names.
1256
-     * @param string $version
1257
-     * @return array
1258
-     */
1259
-    public static function getPrimaryKeyNamesIndexedByModelName($version = '')
1260
-    {
1261
-        $version = empty($version) ? self::latest_rest_api_version() : $version;
1262
-        $model_names = self::model_names_with_plural_routes($version);
1263
-        $primary_key_items = array();
1264
-        foreach ($model_names as $model_name => $model_class_name) {
1265
-            $primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
1266
-            foreach ($primary_keys as $primary_key_name => $primary_key_field) {
1267
-                if (count($primary_keys) > 1) {
1268
-                    $primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
1269
-                } else {
1270
-                    $primary_key_items[ strtolower($model_name) ] = $primary_key_name;
1271
-                }
1272
-            }
1273
-        }
1274
-        return $primary_key_items;
1275
-    }
1276
-
1277
-
1278
-
1279
-    /**
1280
-     *    run - initial module setup
1281
-     *
1282
-     * @access    public
1283
-     * @param  WP $WP
1284
-     * @return    void
1285
-     */
1286
-    public function run($WP)
1287
-    {
1288
-    }
25
+	const ee_api_namespace = Domain::API_NAMESPACE;
26
+
27
+	const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
28
+
29
+	const saved_routes_option_names = 'ee_core_routes';
30
+
31
+	/**
32
+	 * string used in _links response bodies to make them globally unique.
33
+	 *
34
+	 * @see http://v2.wp-api.org/extending/linking/
35
+	 */
36
+	const ee_api_link_namespace = 'https://api.eventespresso.com/';
37
+
38
+	/**
39
+	 * @var CalculatedModelFields
40
+	 */
41
+	protected static $_field_calculator;
42
+
43
+
44
+	/**
45
+	 * @return EED_Core_Rest_Api|EED_Module
46
+	 */
47
+	public static function instance()
48
+	{
49
+		self::$_field_calculator = new CalculatedModelFields();
50
+		return parent::get_instance(__CLASS__);
51
+	}
52
+
53
+
54
+	/**
55
+	 *    set_hooks - for hooking into EE Core, other modules, etc
56
+	 *
57
+	 * @access    public
58
+	 * @return    void
59
+	 */
60
+	public static function set_hooks()
61
+	{
62
+		self::set_hooks_both();
63
+	}
64
+
65
+
66
+	/**
67
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
68
+	 *
69
+	 * @access    public
70
+	 * @return    void
71
+	 */
72
+	public static function set_hooks_admin()
73
+	{
74
+		self::set_hooks_both();
75
+	}
76
+
77
+
78
+	public static function set_hooks_both()
79
+	{
80
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
81
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
82
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
83
+		add_filter(
84
+			'rest_index',
85
+			array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex')
86
+		);
87
+		EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
88
+	}
89
+
90
+
91
+	/**
92
+	 * sets up hooks which only need to be included as part of REST API requests;
93
+	 * other requests like to the frontend or admin etc don't need them
94
+	 *
95
+	 * @throws \EE_Error
96
+	 */
97
+	public static function set_hooks_rest_api()
98
+	{
99
+		// set hooks which account for changes made to the API
100
+		EED_Core_Rest_Api::_set_hooks_for_changes();
101
+	}
102
+
103
+
104
+	/**
105
+	 * public wrapper of _set_hooks_for_changes.
106
+	 * Loads all the hooks which make requests to old versions of the API
107
+	 * appear the same as they always did
108
+	 *
109
+	 * @throws EE_Error
110
+	 */
111
+	public static function set_hooks_for_changes()
112
+	{
113
+		self::_set_hooks_for_changes();
114
+	}
115
+
116
+
117
+	/**
118
+	 * Loads all the hooks which make requests to old versions of the API
119
+	 * appear the same as they always did
120
+	 *
121
+	 * @throws EE_Error
122
+	 */
123
+	protected static function _set_hooks_for_changes()
124
+	{
125
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
126
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
127
+			// ignore the base parent class
128
+			// and legacy named classes
129
+			if ($classname_in_namespace === 'ChangesInBase'
130
+				|| strpos($classname_in_namespace, 'Changes_In_') === 0
131
+			) {
132
+				continue;
133
+			}
134
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
135
+			if (class_exists($full_classname)) {
136
+				$instance_of_class = new $full_classname;
137
+				if ($instance_of_class instanceof ChangesInBase) {
138
+					$instance_of_class->setHooks();
139
+				}
140
+			}
141
+		}
142
+	}
143
+
144
+
145
+	/**
146
+	 * Filters the WP routes to add our EE-related ones. This takes a bit of time
147
+	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
148
+	 *
149
+	 * @throws \EE_Error
150
+	 */
151
+	public static function register_routes()
152
+	{
153
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
154
+			foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
155
+				/**
156
+				 * @var array     $data_for_multiple_endpoints numerically indexed array
157
+				 *                                         but can also contain route options like {
158
+				 * @type array    $schema                      {
159
+				 * @type callable $schema_callback
160
+				 * @type array    $callback_args               arguments that will be passed to the callback, after the
161
+				 * WP_REST_Request of course
162
+				 * }
163
+				 * }
164
+				 */
165
+				// when registering routes, register all the endpoints' data at the same time
166
+				$multiple_endpoint_args = array();
167
+				foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
168
+					/**
169
+					 * @var array     $data_for_single_endpoint {
170
+					 * @type callable $callback
171
+					 * @type string methods
172
+					 * @type array args
173
+					 * @type array _links
174
+					 * @type array    $callback_args            arguments that will be passed to the callback, after the
175
+					 * WP_REST_Request of course
176
+					 * }
177
+					 */
178
+					// skip route options
179
+					if (! is_numeric($endpoint_key)) {
180
+						continue;
181
+					}
182
+					if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
183
+						throw new EE_Error(
184
+							esc_html__(
185
+							// @codingStandardsIgnoreStart
186
+								'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
187
+								// @codingStandardsIgnoreEnd
188
+								'event_espresso'
189
+							)
190
+						);
191
+					}
192
+					$callback = $data_for_single_endpoint['callback'];
193
+					$single_endpoint_args = array(
194
+						'methods' => $data_for_single_endpoint['methods'],
195
+						'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
196
+							: array(),
197
+					);
198
+					if (isset($data_for_single_endpoint['_links'])) {
199
+						$single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
200
+					}
201
+					if (isset($data_for_single_endpoint['callback_args'])) {
202
+						$callback_args = $data_for_single_endpoint['callback_args'];
203
+						$single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
204
+							$callback,
205
+							$callback_args
206
+						) {
207
+							array_unshift($callback_args, $request);
208
+							return call_user_func_array(
209
+								$callback,
210
+								$callback_args
211
+							);
212
+						};
213
+					} else {
214
+						$single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
215
+					}
216
+					$multiple_endpoint_args[] = $single_endpoint_args;
217
+				}
218
+				if (isset($data_for_multiple_endpoints['schema'])) {
219
+					$schema_route_data = $data_for_multiple_endpoints['schema'];
220
+					$schema_callback = $schema_route_data['schema_callback'];
221
+					$callback_args = $schema_route_data['callback_args'];
222
+					$multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
223
+						return call_user_func_array(
224
+							$schema_callback,
225
+							$callback_args
226
+						);
227
+					};
228
+				}
229
+				register_rest_route(
230
+					$namespace,
231
+					$relative_route,
232
+					$multiple_endpoint_args
233
+				);
234
+			}
235
+		}
236
+	}
237
+
238
+
239
+	/**
240
+	 * Checks if there was a version change or something that merits invalidating the cached
241
+	 * route data. If so, invalidates the cached route data so that it gets refreshed
242
+	 * next time the WP API is used
243
+	 */
244
+	public static function invalidate_cached_route_data_on_version_change()
245
+	{
246
+		if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
247
+			EED_Core_Rest_Api::invalidate_cached_route_data();
248
+		}
249
+		foreach (EE_Registry::instance()->addons as $addon) {
250
+			if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
251
+				EED_Core_Rest_Api::invalidate_cached_route_data();
252
+			}
253
+		}
254
+	}
255
+
256
+
257
+	/**
258
+	 * Removes the cached route data so it will get refreshed next time the WP API is used
259
+	 */
260
+	public static function invalidate_cached_route_data()
261
+	{
262
+		// delete the saved EE REST API routes
263
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
264
+			delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
265
+		}
266
+	}
267
+
268
+
269
+	/**
270
+	 * Gets the EE route data
271
+	 *
272
+	 * @return array top-level key is the namespace, next-level key is the route and its value is array{
273
+	 * @throws \EE_Error
274
+	 * @type string|array $callback
275
+	 * @type string       $methods
276
+	 * @type boolean      $hidden_endpoint
277
+	 * }
278
+	 */
279
+	public static function get_ee_route_data()
280
+	{
281
+		$ee_routes = array();
282
+		foreach (self::versions_served() as $version => $hidden_endpoints) {
283
+			$ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version(
284
+				$version,
285
+				$hidden_endpoints
286
+			);
287
+		}
288
+		return $ee_routes;
289
+	}
290
+
291
+
292
+	/**
293
+	 * Gets the EE route data from the wp options if it exists already,
294
+	 * otherwise re-generates it and saves it to the option
295
+	 *
296
+	 * @param string  $version
297
+	 * @param boolean $hidden_endpoints
298
+	 * @return array
299
+	 * @throws \EE_Error
300
+	 */
301
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
302
+	{
303
+		$ee_routes = get_option(self::saved_routes_option_names . $version, null);
304
+		if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
305
+			$ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
306
+		}
307
+		return $ee_routes;
308
+	}
309
+
310
+
311
+	/**
312
+	 * Saves the EE REST API route data to a wp option and returns it
313
+	 *
314
+	 * @param string  $version
315
+	 * @param boolean $hidden_endpoints
316
+	 * @return mixed|null
317
+	 * @throws \EE_Error
318
+	 */
319
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
320
+	{
321
+		$instance = self::instance();
322
+		$routes = apply_filters(
323
+			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
324
+			array_replace_recursive(
325
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
326
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
327
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
328
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
329
+			)
330
+		);
331
+		$option_name = self::saved_routes_option_names . $version;
332
+		if (get_option($option_name)) {
333
+			update_option($option_name, $routes, true);
334
+		} else {
335
+			add_option($option_name, $routes, null, 'no');
336
+		}
337
+		return $routes;
338
+	}
339
+
340
+
341
+	/**
342
+	 * Calculates all the EE routes and saves it to a WordPress option so we don't
343
+	 * need to calculate it on every request
344
+	 *
345
+	 * @deprecated since version 4.9.1
346
+	 * @return void
347
+	 */
348
+	public static function save_ee_routes()
349
+	{
350
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
351
+			$instance = self::instance();
352
+			$routes = apply_filters(
353
+				'EED_Core_Rest_Api__save_ee_routes__routes',
354
+				array_replace_recursive(
355
+					$instance->_register_config_routes(),
356
+					$instance->_register_meta_routes(),
357
+					$instance->_register_model_routes(),
358
+					$instance->_register_rpc_routes()
359
+				)
360
+			);
361
+			update_option(self::saved_routes_option_names, $routes, true);
362
+		}
363
+	}
364
+
365
+
366
+	/**
367
+	 * Gets all the route information relating to EE models
368
+	 *
369
+	 * @return array @see get_ee_route_data
370
+	 * @deprecated since version 4.9.1
371
+	 */
372
+	protected function _register_model_routes()
373
+	{
374
+		$model_routes = array();
375
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
376
+			$model_routes[ EED_Core_Rest_Api::ee_api_namespace
377
+						   . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
378
+		}
379
+		return $model_routes;
380
+	}
381
+
382
+
383
+	/**
384
+	 * Decides whether or not to add write endpoints for this model.
385
+	 *
386
+	 * Currently, this defaults to exclude all global tables and models
387
+	 * which would allow inserting WP core data (we don't want to duplicate
388
+	 * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
389
+	 *
390
+	 * @param EEM_Base $model
391
+	 * @return bool
392
+	 */
393
+	public static function should_have_write_endpoints(EEM_Base $model)
394
+	{
395
+		if ($model->is_wp_core_model()) {
396
+			return false;
397
+		}
398
+		foreach ($model->get_tables() as $table) {
399
+			if ($table->is_global()) {
400
+				return false;
401
+			}
402
+		}
403
+		return true;
404
+	}
405
+
406
+
407
+	/**
408
+	 * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
409
+	 * in this versioned namespace of EE4
410
+	 *
411
+	 * @param $version
412
+	 * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
413
+	 */
414
+	public static function model_names_with_plural_routes($version)
415
+	{
416
+		$model_version_info = new ModelVersionInfo($version);
417
+		$models_to_register = $model_version_info->modelsForRequestedVersion();
418
+		// let's not bother having endpoints for extra metas
419
+		unset(
420
+			$models_to_register['Extra_Meta'],
421
+			$models_to_register['Extra_Join'],
422
+			$models_to_register['Post_Meta']
423
+		);
424
+		return apply_filters(
425
+			'FHEE__EED_Core_REST_API___register_model_routes',
426
+			$models_to_register
427
+		);
428
+	}
429
+
430
+
431
+	/**
432
+	 * Gets the route data for EE models in the specified version
433
+	 *
434
+	 * @param string  $version
435
+	 * @param boolean $hidden_endpoint
436
+	 * @return array
437
+	 * @throws EE_Error
438
+	 */
439
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
440
+	{
441
+		$model_routes = array();
442
+		$model_version_info = new ModelVersionInfo($version);
443
+		foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
444
+			$model = \EE_Registry::instance()->load_model($model_name);
445
+			// if this isn't a valid model then let's skip iterate to the next item in the loop.
446
+			if (! $model instanceof EEM_Base) {
447
+				continue;
448
+			}
449
+			// yes we could just register one route for ALL models, but then they wouldn't show up in the index
450
+			$plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
451
+			$singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
452
+			$model_routes[ $plural_model_route ] = array(
453
+				array(
454
+					'callback'        => array(
455
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
456
+						'handleRequestGetAll',
457
+					),
458
+					'callback_args'   => array($version, $model_name),
459
+					'methods'         => WP_REST_Server::READABLE,
460
+					'hidden_endpoint' => $hidden_endpoint,
461
+					'args'            => $this->_get_read_query_params($model, $version),
462
+					'_links'          => array(
463
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
464
+					),
465
+				),
466
+				'schema' => array(
467
+					'schema_callback' => array(
468
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
469
+						'handleSchemaRequest',
470
+					),
471
+					'callback_args'   => array($version, $model_name),
472
+				),
473
+			);
474
+			$model_routes[ $singular_model_route ] = array(
475
+				array(
476
+					'callback'        => array(
477
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
478
+						'handleRequestGetOne',
479
+					),
480
+					'callback_args'   => array($version, $model_name),
481
+					'methods'         => WP_REST_Server::READABLE,
482
+					'hidden_endpoint' => $hidden_endpoint,
483
+					'args'            => $this->_get_response_selection_query_params($model, $version),
484
+				),
485
+			);
486
+			if (apply_filters(
487
+				'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
488
+				EED_Core_Rest_Api::should_have_write_endpoints($model),
489
+				$model
490
+			)) {
491
+				$model_routes[ $plural_model_route ][] = array(
492
+					'callback'        => array(
493
+						'EventEspresso\core\libraries\rest_api\controllers\model\Write',
494
+						'handleRequestInsert',
495
+					),
496
+					'callback_args'   => array($version, $model_name),
497
+					'methods'         => WP_REST_Server::CREATABLE,
498
+					'hidden_endpoint' => $hidden_endpoint,
499
+					'args'            => $this->_get_write_params($model_name, $model_version_info, true),
500
+				);
501
+				$model_routes[ $singular_model_route ] = array_merge(
502
+					$model_routes[ $singular_model_route ],
503
+					array(
504
+						array(
505
+							'callback'        => array(
506
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
507
+								'handleRequestUpdate',
508
+							),
509
+							'callback_args'   => array($version, $model_name),
510
+							'methods'         => WP_REST_Server::EDITABLE,
511
+							'hidden_endpoint' => $hidden_endpoint,
512
+							'args'            => $this->_get_write_params($model_name, $model_version_info),
513
+						),
514
+						array(
515
+							'callback'        => array(
516
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
517
+								'handleRequestDelete',
518
+							),
519
+							'callback_args'   => array($version, $model_name),
520
+							'methods'         => WP_REST_Server::DELETABLE,
521
+							'hidden_endpoint' => $hidden_endpoint,
522
+							'args'            => $this->_get_delete_query_params($model, $version),
523
+						),
524
+					)
525
+				);
526
+			}
527
+			foreach ($model->relation_settings() as $relation_name => $relation_obj) {
528
+				$related_route = EED_Core_Rest_Api::get_relation_route_via(
529
+					$model,
530
+					'(?P<id>[^\/]+)',
531
+					$relation_obj
532
+				);
533
+				$endpoints = array(
534
+					array(
535
+						'callback'        => array(
536
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
537
+							'handleRequestGetRelated',
538
+						),
539
+						'callback_args'   => array($version, $model_name, $relation_name),
540
+						'methods'         => WP_REST_Server::READABLE,
541
+						'hidden_endpoint' => $hidden_endpoint,
542
+						'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
543
+					),
544
+				);
545
+				$model_routes[ $related_route ] = $endpoints;
546
+			}
547
+		}
548
+		return $model_routes;
549
+	}
550
+
551
+
552
+	/**
553
+	 * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
554
+	 * excluding the preceding slash.
555
+	 * Eg you pass get_plural_route_to('Event') = 'events'
556
+	 *
557
+	 * @param EEM_Base $model
558
+	 * @return string
559
+	 */
560
+	public static function get_collection_route(EEM_Base $model)
561
+	{
562
+		return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
563
+	}
564
+
565
+
566
+	/**
567
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
568
+	 * excluding the preceding slash.
569
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
570
+	 *
571
+	 * @param EEM_Base $model eg Event or Venue
572
+	 * @param string   $id
573
+	 * @return string
574
+	 */
575
+	public static function get_entity_route($model, $id)
576
+	{
577
+		return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
578
+	}
579
+
580
+
581
+	/**
582
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
583
+	 * excluding the preceding slash.
584
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
585
+	 *
586
+	 * @param EEM_Base               $model eg Event or Venue
587
+	 * @param string                 $id
588
+	 * @param EE_Model_Relation_Base $relation_obj
589
+	 * @return string
590
+	 */
591
+	public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
592
+	{
593
+		$related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
594
+			$relation_obj->get_other_model()->get_this_model_name(),
595
+			$relation_obj
596
+		);
597
+		return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
598
+	}
599
+
600
+
601
+	/**
602
+	 * Adds onto the $relative_route the EE4 REST API versioned namespace.
603
+	 * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
604
+	 *
605
+	 * @param string $relative_route
606
+	 * @param string $version
607
+	 * @return string
608
+	 */
609
+	public static function get_versioned_route_to($relative_route, $version = '4.8.36')
610
+	{
611
+		return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
612
+	}
613
+
614
+
615
+	/**
616
+	 * Adds all the RPC-style routes (remote procedure call-like routes, ie
617
+	 * routes that don't conform to the traditional REST CRUD-style).
618
+	 *
619
+	 * @deprecated since 4.9.1
620
+	 */
621
+	protected function _register_rpc_routes()
622
+	{
623
+		$routes = array();
624
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
625
+			$routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
626
+				$version,
627
+				$hidden_endpoint
628
+			);
629
+		}
630
+		return $routes;
631
+	}
632
+
633
+
634
+	/**
635
+	 * @param string  $version
636
+	 * @param boolean $hidden_endpoint
637
+	 * @return array
638
+	 */
639
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
640
+	{
641
+		$this_versions_routes = array();
642
+		// checkin endpoint
643
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
644
+			array(
645
+				'callback'        => array(
646
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
647
+					'handleRequestToggleCheckin',
648
+				),
649
+				'methods'         => WP_REST_Server::CREATABLE,
650
+				'hidden_endpoint' => $hidden_endpoint,
651
+				'args'            => array(
652
+					'force' => array(
653
+						'required'    => false,
654
+						'default'     => false,
655
+						'description' => __(
656
+						// @codingStandardsIgnoreStart
657
+							'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
658
+							// @codingStandardsIgnoreEnd
659
+							'event_espresso'
660
+						),
661
+					),
662
+				),
663
+				'callback_args'   => array($version),
664
+			),
665
+		);
666
+		return apply_filters(
667
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
668
+			$this_versions_routes,
669
+			$version,
670
+			$hidden_endpoint
671
+		);
672
+	}
673
+
674
+
675
+	/**
676
+	 * Gets the query params that can be used when request one or many
677
+	 *
678
+	 * @param EEM_Base $model
679
+	 * @param string   $version
680
+	 * @return array
681
+	 */
682
+	protected function _get_response_selection_query_params(\EEM_Base $model, $version)
683
+	{
684
+		return apply_filters(
685
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
686
+			array(
687
+				'include'   => array(
688
+					'required' => false,
689
+					'default'  => '*',
690
+					'type'     => 'string',
691
+				),
692
+				'calculate' => array(
693
+					'required'          => false,
694
+					'default'           => '',
695
+					'enum'              => self::$_field_calculator->retrieveCalculatedFieldsForModel($model),
696
+					'type'              => 'string',
697
+					// because we accept a CSV'd list of the enumerated strings, WP core validation and sanitization
698
+					// freaks out. We'll just validate this argument while handling the request
699
+					'validate_callback' => null,
700
+					'sanitize_callback' => null,
701
+				),
702
+			),
703
+			$model,
704
+			$version
705
+		);
706
+	}
707
+
708
+
709
+	/**
710
+	 * Gets the parameters acceptable for delete requests
711
+	 *
712
+	 * @param \EEM_Base $model
713
+	 * @param string    $version
714
+	 * @return array
715
+	 */
716
+	protected function _get_delete_query_params(\EEM_Base $model, $version)
717
+	{
718
+		$params_for_delete = array(
719
+			'allow_blocking' => array(
720
+				'required' => false,
721
+				'default'  => true,
722
+				'type'     => 'boolean',
723
+			),
724
+		);
725
+		$params_for_delete['force'] = array(
726
+			'required' => false,
727
+			'default'  => false,
728
+			'type'     => 'boolean',
729
+		);
730
+		return apply_filters(
731
+			'FHEE__EED_Core_Rest_Api___get_delete_query_params',
732
+			$params_for_delete,
733
+			$model,
734
+			$version
735
+		);
736
+	}
737
+
738
+
739
+	/**
740
+	 * Gets info about reading query params that are acceptable
741
+	 *
742
+	 * @param \EEM_Base $model eg 'Event' or 'Venue'
743
+	 * @param  string   $version
744
+	 * @return array    describing the args acceptable when querying this model
745
+	 * @throws EE_Error
746
+	 */
747
+	protected function _get_read_query_params(\EEM_Base $model, $version)
748
+	{
749
+		$default_orderby = array();
750
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
751
+			$default_orderby[ $key_field->get_name() ] = 'ASC';
752
+		}
753
+		return array_merge(
754
+			$this->_get_response_selection_query_params($model, $version),
755
+			array(
756
+				'where'    => array(
757
+					'required'          => false,
758
+					'default'           => array(),
759
+					'type'              => 'object',
760
+					// because we accept an almost infinite list of possible where conditions, WP
761
+					// core validation and sanitization freaks out. We'll just validate this argument
762
+					// while handling the request
763
+					'validate_callback' => null,
764
+					'sanitize_callback' => null,
765
+				),
766
+				'limit'    => array(
767
+					'required'          => false,
768
+					'default'           => EED_Core_Rest_Api::get_default_query_limit(),
769
+					'type'              => array(
770
+						'array',
771
+						'string',
772
+						'integer',
773
+					),
774
+					// because we accept a variety of types, WP core validation and sanitization
775
+					// freaks out. We'll just validate this argument while handling the request
776
+					'validate_callback' => null,
777
+					'sanitize_callback' => null,
778
+				),
779
+				'order_by' => array(
780
+					'required'          => false,
781
+					'default'           => $default_orderby,
782
+					'type'              => array(
783
+						'object',
784
+						'string',
785
+					),// because we accept a variety of types, WP core validation and sanitization
786
+					// freaks out. We'll just validate this argument while handling the request
787
+					'validate_callback' => null,
788
+					'sanitize_callback' => null,
789
+				),
790
+				'group_by' => array(
791
+					'required'          => false,
792
+					'default'           => null,
793
+					'type'              => array(
794
+						'object',
795
+						'string',
796
+					),
797
+					// because we accept  an almost infinite list of possible groupings,
798
+					// WP core validation and sanitization
799
+					// freaks out. We'll just validate this argument while handling the request
800
+					'validate_callback' => null,
801
+					'sanitize_callback' => null,
802
+				),
803
+				'having'   => array(
804
+					'required'          => false,
805
+					'default'           => null,
806
+					'type'              => 'object',
807
+					// because we accept an almost infinite list of possible where conditions, WP
808
+					// core validation and sanitization freaks out. We'll just validate this argument
809
+					// while handling the request
810
+					'validate_callback' => null,
811
+					'sanitize_callback' => null,
812
+				),
813
+				'caps'     => array(
814
+					'required' => false,
815
+					'default'  => EEM_Base::caps_read,
816
+					'type'     => 'string',
817
+					'enum'     => array(
818
+						EEM_Base::caps_read,
819
+						EEM_Base::caps_read_admin,
820
+						EEM_Base::caps_edit,
821
+						EEM_Base::caps_delete,
822
+					),
823
+				),
824
+			)
825
+		);
826
+	}
827
+
828
+
829
+	/**
830
+	 * Gets parameter information for a model regarding writing data
831
+	 *
832
+	 * @param string           $model_name
833
+	 * @param ModelVersionInfo $model_version_info
834
+	 * @param boolean          $create                                       whether this is for request to create (in
835
+	 *                                                                       which case we need all required params) or
836
+	 *                                                                       just to update (in which case we don't
837
+	 *                                                                       need those on every request)
838
+	 * @return array
839
+	 */
840
+	protected function _get_write_params(
841
+		$model_name,
842
+		ModelVersionInfo $model_version_info,
843
+		$create = false
844
+	) {
845
+		$model = EE_Registry::instance()->load_model($model_name);
846
+		$fields = $model_version_info->fieldsOnModelInThisVersion($model);
847
+		$args_info = array();
848
+		foreach ($fields as $field_name => $field_obj) {
849
+			if ($field_obj->is_auto_increment()) {
850
+				// totally ignore auto increment IDs
851
+				continue;
852
+			}
853
+			$arg_info = $field_obj->getSchema();
854
+			$required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
855
+			$arg_info['required'] = $required;
856
+			// remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
857
+			unset($arg_info['readonly']);
858
+			$schema_properties = $field_obj->getSchemaProperties();
859
+			if (isset($schema_properties['raw'])
860
+				&& $field_obj->getSchemaType() === 'object'
861
+			) {
862
+				// if there's a "raw" form of this argument, use those properties instead
863
+				$arg_info = array_replace(
864
+					$arg_info,
865
+					$schema_properties['raw']
866
+				);
867
+			}
868
+			$arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
869
+				$field_obj,
870
+				$field_obj->get_default_value(),
871
+				$model_version_info->requestedVersion()
872
+			);
873
+			// we do our own validation and sanitization within the controller
874
+			if (function_exists('rest_validate_value_from_schema')) {
875
+				$sanitize_callback = array(
876
+					'EED_Core_Rest_Api',
877
+					'default_sanitize_callback',
878
+				);
879
+			} else {
880
+				$sanitize_callback = null;
881
+			}
882
+			$arg_info['sanitize_callback'] = $sanitize_callback;
883
+			$args_info[ $field_name ] = $arg_info;
884
+			if ($field_obj instanceof EE_Datetime_Field) {
885
+				$gmt_arg_info = $arg_info;
886
+				$gmt_arg_info['description'] = sprintf(
887
+					esc_html__(
888
+						'%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
889
+						'event_espresso'
890
+					),
891
+					$field_obj->get_nicename(),
892
+					$field_name
893
+				);
894
+				$args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
895
+			}
896
+		}
897
+		return $args_info;
898
+	}
899
+
900
+
901
+	/**
902
+	 * Replacement for WP API's 'rest_parse_request_arg'.
903
+	 * If the value is blank but not required, don't bother validating it.
904
+	 * Also, it uses our email validation instead of WP API's default.
905
+	 *
906
+	 * @param                 $value
907
+	 * @param WP_REST_Request $request
908
+	 * @param                 $param
909
+	 * @return bool|true|WP_Error
910
+	 * @throws InvalidArgumentException
911
+	 * @throws InvalidInterfaceException
912
+	 * @throws InvalidDataTypeException
913
+	 */
914
+	public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
915
+	{
916
+		$attributes = $request->get_attributes();
917
+		if (! isset($attributes['args'][ $param ])
918
+			|| ! is_array($attributes['args'][ $param ])) {
919
+			$validation_result = true;
920
+		} else {
921
+			$args = $attributes['args'][ $param ];
922
+			if ((
923
+					$value === ''
924
+					|| $value === null
925
+				)
926
+				&& (! isset($args['required'])
927
+					|| $args['required'] === false
928
+				)
929
+			) {
930
+				// not required and not provided? that's cool
931
+				$validation_result = true;
932
+			} elseif (isset($args['format'])
933
+					  && $args['format'] === 'email'
934
+			) {
935
+				$validation_result = true;
936
+				if (! self::_validate_email($value)) {
937
+					$validation_result = new WP_Error(
938
+						'rest_invalid_param',
939
+						esc_html__(
940
+							'The email address is not valid or does not exist.',
941
+							'event_espresso'
942
+						)
943
+					);
944
+				}
945
+			} else {
946
+				$validation_result = rest_validate_value_from_schema($value, $args, $param);
947
+			}
948
+		}
949
+		if (is_wp_error($validation_result)) {
950
+			return $validation_result;
951
+		}
952
+		return rest_sanitize_request_arg($value, $request, $param);
953
+	}
954
+
955
+
956
+	/**
957
+	 * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
958
+	 *
959
+	 * @param $email
960
+	 * @return bool
961
+	 * @throws InvalidArgumentException
962
+	 * @throws InvalidInterfaceException
963
+	 * @throws InvalidDataTypeException
964
+	 */
965
+	protected static function _validate_email($email)
966
+	{
967
+		try {
968
+			EmailAddressFactory::create($email);
969
+			return true;
970
+		} catch (EmailValidationException $e) {
971
+			return false;
972
+		}
973
+	}
974
+
975
+
976
+	/**
977
+	 * Gets routes for the config
978
+	 *
979
+	 * @return array @see _register_model_routes
980
+	 * @deprecated since version 4.9.1
981
+	 */
982
+	protected function _register_config_routes()
983
+	{
984
+		$config_routes = array();
985
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
986
+			$config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
987
+				$version,
988
+				$hidden_endpoint
989
+			);
990
+		}
991
+		return $config_routes;
992
+	}
993
+
994
+
995
+	/**
996
+	 * Gets routes for the config for the specified version
997
+	 *
998
+	 * @param string  $version
999
+	 * @param boolean $hidden_endpoint
1000
+	 * @return array
1001
+	 */
1002
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint)
1003
+	{
1004
+		return array(
1005
+			'config'    => array(
1006
+				array(
1007
+					'callback'        => array(
1008
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1009
+						'handleRequest',
1010
+					),
1011
+					'methods'         => WP_REST_Server::READABLE,
1012
+					'hidden_endpoint' => $hidden_endpoint,
1013
+					'callback_args'   => array($version),
1014
+				),
1015
+			),
1016
+			'site_info' => array(
1017
+				array(
1018
+					'callback'        => array(
1019
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
1020
+						'handleRequestSiteInfo',
1021
+					),
1022
+					'methods'         => WP_REST_Server::READABLE,
1023
+					'hidden_endpoint' => $hidden_endpoint,
1024
+					'callback_args'   => array($version),
1025
+				),
1026
+			),
1027
+		);
1028
+	}
1029
+
1030
+
1031
+	/**
1032
+	 * Gets the meta info routes
1033
+	 *
1034
+	 * @return array @see _register_model_routes
1035
+	 * @deprecated since version 4.9.1
1036
+	 */
1037
+	protected function _register_meta_routes()
1038
+	{
1039
+		$meta_routes = array();
1040
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
1041
+			$meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
1042
+				$version,
1043
+				$hidden_endpoint
1044
+			);
1045
+		}
1046
+		return $meta_routes;
1047
+	}
1048
+
1049
+
1050
+	/**
1051
+	 * @param string  $version
1052
+	 * @param boolean $hidden_endpoint
1053
+	 * @return array
1054
+	 */
1055
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
1056
+	{
1057
+		return array(
1058
+			'resources' => array(
1059
+				array(
1060
+					'callback'        => array(
1061
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
1062
+						'handleRequestModelsMeta',
1063
+					),
1064
+					'methods'         => WP_REST_Server::READABLE,
1065
+					'hidden_endpoint' => $hidden_endpoint,
1066
+					'callback_args'   => array($version),
1067
+				),
1068
+			),
1069
+		);
1070
+	}
1071
+
1072
+
1073
+	/**
1074
+	 * Tries to hide old 4.6 endpoints from the
1075
+	 *
1076
+	 * @param array $route_data
1077
+	 * @return array
1078
+	 * @throws \EE_Error
1079
+	 */
1080
+	public static function hide_old_endpoints($route_data)
1081
+	{
1082
+		// allow API clients to override which endpoints get hidden, in case
1083
+		// they want to discover particular endpoints
1084
+		// also, we don't have access to the request so we have to just grab it from the superglobal
1085
+		$force_show_ee_namespace = ltrim(
1086
+			EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
1087
+			'/'
1088
+		);
1089
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
1090
+			foreach ($relative_urls as $resource_name => $endpoints) {
1091
+				foreach ($endpoints as $key => $endpoint) {
1092
+					// skip schema and other route options
1093
+					if (! is_numeric($key)) {
1094
+						continue;
1095
+					}
1096
+					// by default, hide "hidden_endpoint"s, unless the request indicates
1097
+					// to $force_show_ee_namespace, in which case only show that one
1098
+					// namespace's endpoints (and hide all others)
1099
+					if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
1100
+						|| ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
1101
+					) {
1102
+						$full_route = '/' . ltrim($namespace, '/');
1103
+						$full_route .= '/' . ltrim($resource_name, '/');
1104
+						unset($route_data[ $full_route ]);
1105
+					}
1106
+				}
1107
+			}
1108
+		}
1109
+		return $route_data;
1110
+	}
1111
+
1112
+
1113
+	/**
1114
+	 * Returns an array describing which versions of core support serving requests for.
1115
+	 * Keys are core versions' major and minor version, and values are the
1116
+	 * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
1117
+	 * data by just removing a few models and fields from the responses. However, 4.15 might remove
1118
+	 * the answers table entirely, in which case it would be very difficult for
1119
+	 * it to serve 4.6-style responses.
1120
+	 * Versions of core that are missing from this array are unknowns.
1121
+	 * previous ver
1122
+	 *
1123
+	 * @return array
1124
+	 */
1125
+	public static function version_compatibilities()
1126
+	{
1127
+		return apply_filters(
1128
+			'FHEE__EED_Core_REST_API__version_compatibilities',
1129
+			array(
1130
+				'4.8.29' => '4.8.29',
1131
+				'4.8.33' => '4.8.29',
1132
+				'4.8.34' => '4.8.29',
1133
+				'4.8.36' => '4.8.29',
1134
+			)
1135
+		);
1136
+	}
1137
+
1138
+
1139
+	/**
1140
+	 * Gets the latest API version served. Eg if there
1141
+	 * are two versions served of the API, 4.8.29 and 4.8.32, and
1142
+	 * we are on core version 4.8.34, it will return the string "4.8.32"
1143
+	 *
1144
+	 * @return string
1145
+	 */
1146
+	public static function latest_rest_api_version()
1147
+	{
1148
+		$versions_served = \EED_Core_Rest_Api::versions_served();
1149
+		$versions_served_keys = array_keys($versions_served);
1150
+		return end($versions_served_keys);
1151
+	}
1152
+
1153
+
1154
+	/**
1155
+	 * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
1156
+	 * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
1157
+	 * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
1158
+	 * We also indicate whether or not this version should be put in the index or not
1159
+	 *
1160
+	 * @return array keys are API version numbers (just major and minor numbers), and values
1161
+	 * are whether or not they should be hidden
1162
+	 */
1163
+	public static function versions_served()
1164
+	{
1165
+		$versions_served = array();
1166
+		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
1167
+		$lowest_compatible_version = end($possibly_served_versions);
1168
+		reset($possibly_served_versions);
1169
+		$versions_served_historically = array_keys($possibly_served_versions);
1170
+		$latest_version = end($versions_served_historically);
1171
+		reset($versions_served_historically);
1172
+		// for each version of core we have ever served:
1173
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
1174
+			// if it's not above the current core version, and it's compatible with the current version of core
1175
+			if ($key_versioned_endpoint === $latest_version) {
1176
+				// don't hide the latest version in the index
1177
+				$versions_served[ $key_versioned_endpoint ] = false;
1178
+			} elseif ($key_versioned_endpoint >= $lowest_compatible_version
1179
+				&& $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
1180
+			) {
1181
+				// include, but hide, previous versions which are still supported
1182
+				$versions_served[ $key_versioned_endpoint ] = true;
1183
+			} elseif (apply_filters(
1184
+				'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
1185
+				false,
1186
+				$possibly_served_versions
1187
+			)) {
1188
+				// if a version is no longer supported, don't include it in index or list of versions served
1189
+				$versions_served[ $key_versioned_endpoint ] = true;
1190
+			}
1191
+		}
1192
+		return $versions_served;
1193
+	}
1194
+
1195
+
1196
+	/**
1197
+	 * Gets the major and minor version of EE core's version string
1198
+	 *
1199
+	 * @return string
1200
+	 */
1201
+	public static function core_version()
1202
+	{
1203
+		return apply_filters(
1204
+			'FHEE__EED_Core_REST_API__core_version',
1205
+			implode(
1206
+				'.',
1207
+				array_slice(
1208
+					explode(
1209
+						'.',
1210
+						espresso_version()
1211
+					),
1212
+					0,
1213
+					3
1214
+				)
1215
+			)
1216
+		);
1217
+	}
1218
+
1219
+
1220
+	/**
1221
+	 * Gets the default limit that should be used when querying for resources
1222
+	 *
1223
+	 * @return int
1224
+	 */
1225
+	public static function get_default_query_limit()
1226
+	{
1227
+		// we actually don't use a const because we want folks to always use
1228
+		// this method, not the const directly
1229
+		return apply_filters(
1230
+			'FHEE__EED_Core_Rest_Api__get_default_query_limit',
1231
+			50
1232
+		);
1233
+	}
1234
+
1235
+
1236
+	/**
1237
+	 *
1238
+	 * @param string $version api version string (i.e. '4.8.36')
1239
+	 * @return array
1240
+	 */
1241
+	public static function getCollectionRoutesIndexedByModelName($version = '')
1242
+	{
1243
+		$version = empty($version) ? self::latest_rest_api_version() : $version;
1244
+		$model_names = self::model_names_with_plural_routes($version);
1245
+		$collection_routes = array();
1246
+		foreach ($model_names as $model_name => $model_class_name) {
1247
+			$collection_routes[ strtolower($model_name) ] = '/' . self::ee_api_namespace . $version . '/'
1248
+															. EEH_Inflector::pluralize_and_lower($model_name);
1249
+		}
1250
+		return $collection_routes;
1251
+	}
1252
+
1253
+
1254
+	/**
1255
+	 * Returns an array of primary key names indexed by model names.
1256
+	 * @param string $version
1257
+	 * @return array
1258
+	 */
1259
+	public static function getPrimaryKeyNamesIndexedByModelName($version = '')
1260
+	{
1261
+		$version = empty($version) ? self::latest_rest_api_version() : $version;
1262
+		$model_names = self::model_names_with_plural_routes($version);
1263
+		$primary_key_items = array();
1264
+		foreach ($model_names as $model_name => $model_class_name) {
1265
+			$primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
1266
+			foreach ($primary_keys as $primary_key_name => $primary_key_field) {
1267
+				if (count($primary_keys) > 1) {
1268
+					$primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
1269
+				} else {
1270
+					$primary_key_items[ strtolower($model_name) ] = $primary_key_name;
1271
+				}
1272
+			}
1273
+		}
1274
+		return $primary_key_items;
1275
+	}
1276
+
1277
+
1278
+
1279
+	/**
1280
+	 *    run - initial module setup
1281
+	 *
1282
+	 * @access    public
1283
+	 * @param  WP $WP
1284
+	 * @return    void
1285
+	 */
1286
+	public function run($WP)
1287
+	{
1288
+	}
1289 1289
 }
Please login to merge, or discard this patch.
Spacing   +46 added lines, -46 removed lines patch added patch discarded remove patch
@@ -122,7 +122,7 @@  discard block
 block discarded – undo
122 122
      */
123 123
     protected static function _set_hooks_for_changes()
124 124
     {
125
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
125
+        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES.'rest_api'.DS.'changes'), false);
126 126
         foreach ($folder_contents as $classname_in_namespace => $filepath) {
127 127
             // ignore the base parent class
128 128
             // and legacy named classes
@@ -131,7 +131,7 @@  discard block
 block discarded – undo
131 131
             ) {
132 132
                 continue;
133 133
             }
134
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
134
+            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\'.$classname_in_namespace;
135 135
             if (class_exists($full_classname)) {
136 136
                 $instance_of_class = new $full_classname;
137 137
                 if ($instance_of_class instanceof ChangesInBase) {
@@ -176,10 +176,10 @@  discard block
 block discarded – undo
176 176
                      * }
177 177
                      */
178 178
                     // skip route options
179
-                    if (! is_numeric($endpoint_key)) {
179
+                    if ( ! is_numeric($endpoint_key)) {
180 180
                         continue;
181 181
                     }
182
-                    if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
182
+                    if ( ! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
183 183
                         throw new EE_Error(
184 184
                             esc_html__(
185 185
                             // @codingStandardsIgnoreStart
@@ -200,7 +200,7 @@  discard block
 block discarded – undo
200 200
                     }
201 201
                     if (isset($data_for_single_endpoint['callback_args'])) {
202 202
                         $callback_args = $data_for_single_endpoint['callback_args'];
203
-                        $single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
203
+                        $single_endpoint_args['callback'] = function(\WP_REST_Request $request) use (
204 204
                             $callback,
205 205
                             $callback_args
206 206
                         ) {
@@ -219,7 +219,7 @@  discard block
 block discarded – undo
219 219
                     $schema_route_data = $data_for_multiple_endpoints['schema'];
220 220
                     $schema_callback = $schema_route_data['schema_callback'];
221 221
                     $callback_args = $schema_route_data['callback_args'];
222
-                    $multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
222
+                    $multiple_endpoint_args['schema'] = function() use ($schema_callback, $callback_args) {
223 223
                         return call_user_func_array(
224 224
                             $schema_callback,
225 225
                             $callback_args
@@ -261,7 +261,7 @@  discard block
 block discarded – undo
261 261
     {
262 262
         // delete the saved EE REST API routes
263 263
         foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
264
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
264
+            delete_option(EED_Core_Rest_Api::saved_routes_option_names.$version);
265 265
         }
266 266
     }
267 267
 
@@ -280,7 +280,7 @@  discard block
 block discarded – undo
280 280
     {
281 281
         $ee_routes = array();
282 282
         foreach (self::versions_served() as $version => $hidden_endpoints) {
283
-            $ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version(
283
+            $ee_routes[self::ee_api_namespace.$version] = self::_get_ee_route_data_for_version(
284 284
                 $version,
285 285
                 $hidden_endpoints
286 286
             );
@@ -300,8 +300,8 @@  discard block
 block discarded – undo
300 300
      */
301 301
     protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
302 302
     {
303
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
304
-        if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
303
+        $ee_routes = get_option(self::saved_routes_option_names.$version, null);
304
+        if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
305 305
             $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
306 306
         }
307 307
         return $ee_routes;
@@ -328,7 +328,7 @@  discard block
 block discarded – undo
328 328
                 $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
329 329
             )
330 330
         );
331
-        $option_name = self::saved_routes_option_names . $version;
331
+        $option_name = self::saved_routes_option_names.$version;
332 332
         if (get_option($option_name)) {
333 333
             update_option($option_name, $routes, true);
334 334
         } else {
@@ -373,8 +373,8 @@  discard block
 block discarded – undo
373 373
     {
374 374
         $model_routes = array();
375 375
         foreach (self::versions_served() as $version => $hidden_endpoint) {
376
-            $model_routes[ EED_Core_Rest_Api::ee_api_namespace
377
-                           . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
376
+            $model_routes[EED_Core_Rest_Api::ee_api_namespace
377
+                           . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
378 378
         }
379 379
         return $model_routes;
380 380
     }
@@ -443,13 +443,13 @@  discard block
 block discarded – undo
443 443
         foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
444 444
             $model = \EE_Registry::instance()->load_model($model_name);
445 445
             // if this isn't a valid model then let's skip iterate to the next item in the loop.
446
-            if (! $model instanceof EEM_Base) {
446
+            if ( ! $model instanceof EEM_Base) {
447 447
                 continue;
448 448
             }
449 449
             // yes we could just register one route for ALL models, but then they wouldn't show up in the index
450 450
             $plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
451 451
             $singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
452
-            $model_routes[ $plural_model_route ] = array(
452
+            $model_routes[$plural_model_route] = array(
453 453
                 array(
454 454
                     'callback'        => array(
455 455
                         'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -460,7 +460,7 @@  discard block
 block discarded – undo
460 460
                     'hidden_endpoint' => $hidden_endpoint,
461 461
                     'args'            => $this->_get_read_query_params($model, $version),
462 462
                     '_links'          => array(
463
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
463
+                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace.$version.$singular_model_route),
464 464
                     ),
465 465
                 ),
466 466
                 'schema' => array(
@@ -471,7 +471,7 @@  discard block
 block discarded – undo
471 471
                     'callback_args'   => array($version, $model_name),
472 472
                 ),
473 473
             );
474
-            $model_routes[ $singular_model_route ] = array(
474
+            $model_routes[$singular_model_route] = array(
475 475
                 array(
476 476
                     'callback'        => array(
477 477
                         'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -488,7 +488,7 @@  discard block
 block discarded – undo
488 488
                 EED_Core_Rest_Api::should_have_write_endpoints($model),
489 489
                 $model
490 490
             )) {
491
-                $model_routes[ $plural_model_route ][] = array(
491
+                $model_routes[$plural_model_route][] = array(
492 492
                     'callback'        => array(
493 493
                         'EventEspresso\core\libraries\rest_api\controllers\model\Write',
494 494
                         'handleRequestInsert',
@@ -498,8 +498,8 @@  discard block
 block discarded – undo
498 498
                     'hidden_endpoint' => $hidden_endpoint,
499 499
                     'args'            => $this->_get_write_params($model_name, $model_version_info, true),
500 500
                 );
501
-                $model_routes[ $singular_model_route ] = array_merge(
502
-                    $model_routes[ $singular_model_route ],
501
+                $model_routes[$singular_model_route] = array_merge(
502
+                    $model_routes[$singular_model_route],
503 503
                     array(
504 504
                         array(
505 505
                             'callback'        => array(
@@ -542,7 +542,7 @@  discard block
 block discarded – undo
542 542
                         'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
543 543
                     ),
544 544
                 );
545
-                $model_routes[ $related_route ] = $endpoints;
545
+                $model_routes[$related_route] = $endpoints;
546 546
             }
547 547
         }
548 548
         return $model_routes;
@@ -574,7 +574,7 @@  discard block
 block discarded – undo
574 574
      */
575 575
     public static function get_entity_route($model, $id)
576 576
     {
577
-        return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
577
+        return EED_Core_Rest_Api::get_collection_route($model).'/'.$id;
578 578
     }
579 579
 
580 580
 
@@ -594,7 +594,7 @@  discard block
 block discarded – undo
594 594
             $relation_obj->get_other_model()->get_this_model_name(),
595 595
             $relation_obj
596 596
         );
597
-        return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
597
+        return EED_Core_Rest_Api::get_entity_route($model, $id).'/'.$related_model_name_endpoint_part;
598 598
     }
599 599
 
600 600
 
@@ -608,7 +608,7 @@  discard block
 block discarded – undo
608 608
      */
609 609
     public static function get_versioned_route_to($relative_route, $version = '4.8.36')
610 610
     {
611
-        return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
611
+        return '/'.EED_Core_Rest_Api::ee_api_namespace.$version.'/'.$relative_route;
612 612
     }
613 613
 
614 614
 
@@ -622,7 +622,7 @@  discard block
 block discarded – undo
622 622
     {
623 623
         $routes = array();
624 624
         foreach (self::versions_served() as $version => $hidden_endpoint) {
625
-            $routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
625
+            $routes[self::ee_api_namespace.$version] = $this->_get_rpc_route_data_for_version(
626 626
                 $version,
627 627
                 $hidden_endpoint
628 628
             );
@@ -748,7 +748,7 @@  discard block
 block discarded – undo
748 748
     {
749 749
         $default_orderby = array();
750 750
         foreach ($model->get_combined_primary_key_fields() as $key_field) {
751
-            $default_orderby[ $key_field->get_name() ] = 'ASC';
751
+            $default_orderby[$key_field->get_name()] = 'ASC';
752 752
         }
753 753
         return array_merge(
754 754
             $this->_get_response_selection_query_params($model, $version),
@@ -782,7 +782,7 @@  discard block
 block discarded – undo
782 782
                     'type'              => array(
783 783
                         'object',
784 784
                         'string',
785
-                    ),// because we accept a variety of types, WP core validation and sanitization
785
+                    ), // because we accept a variety of types, WP core validation and sanitization
786 786
                     // freaks out. We'll just validate this argument while handling the request
787 787
                     'validate_callback' => null,
788 788
                     'sanitize_callback' => null,
@@ -880,7 +880,7 @@  discard block
 block discarded – undo
880 880
                 $sanitize_callback = null;
881 881
             }
882 882
             $arg_info['sanitize_callback'] = $sanitize_callback;
883
-            $args_info[ $field_name ] = $arg_info;
883
+            $args_info[$field_name] = $arg_info;
884 884
             if ($field_obj instanceof EE_Datetime_Field) {
885 885
                 $gmt_arg_info = $arg_info;
886 886
                 $gmt_arg_info['description'] = sprintf(
@@ -891,7 +891,7 @@  discard block
 block discarded – undo
891 891
                     $field_obj->get_nicename(),
892 892
                     $field_name
893 893
                 );
894
-                $args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
894
+                $args_info[$field_name.'_gmt'] = $gmt_arg_info;
895 895
             }
896 896
         }
897 897
         return $args_info;
@@ -914,16 +914,16 @@  discard block
 block discarded – undo
914 914
     public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
915 915
     {
916 916
         $attributes = $request->get_attributes();
917
-        if (! isset($attributes['args'][ $param ])
918
-            || ! is_array($attributes['args'][ $param ])) {
917
+        if ( ! isset($attributes['args'][$param])
918
+            || ! is_array($attributes['args'][$param])) {
919 919
             $validation_result = true;
920 920
         } else {
921
-            $args = $attributes['args'][ $param ];
921
+            $args = $attributes['args'][$param];
922 922
             if ((
923 923
                     $value === ''
924 924
                     || $value === null
925 925
                 )
926
-                && (! isset($args['required'])
926
+                && ( ! isset($args['required'])
927 927
                     || $args['required'] === false
928 928
                 )
929 929
             ) {
@@ -933,7 +933,7 @@  discard block
 block discarded – undo
933 933
                       && $args['format'] === 'email'
934 934
             ) {
935 935
                 $validation_result = true;
936
-                if (! self::_validate_email($value)) {
936
+                if ( ! self::_validate_email($value)) {
937 937
                     $validation_result = new WP_Error(
938 938
                         'rest_invalid_param',
939 939
                         esc_html__(
@@ -983,7 +983,7 @@  discard block
 block discarded – undo
983 983
     {
984 984
         $config_routes = array();
985 985
         foreach (self::versions_served() as $version => $hidden_endpoint) {
986
-            $config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
986
+            $config_routes[self::ee_api_namespace.$version] = $this->_get_config_route_data_for_version(
987 987
                 $version,
988 988
                 $hidden_endpoint
989 989
             );
@@ -1038,7 +1038,7 @@  discard block
 block discarded – undo
1038 1038
     {
1039 1039
         $meta_routes = array();
1040 1040
         foreach (self::versions_served() as $version => $hidden_endpoint) {
1041
-            $meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
1041
+            $meta_routes[self::ee_api_namespace.$version] = $this->_get_meta_route_data_for_version(
1042 1042
                 $version,
1043 1043
                 $hidden_endpoint
1044 1044
             );
@@ -1090,7 +1090,7 @@  discard block
 block discarded – undo
1090 1090
             foreach ($relative_urls as $resource_name => $endpoints) {
1091 1091
                 foreach ($endpoints as $key => $endpoint) {
1092 1092
                     // skip schema and other route options
1093
-                    if (! is_numeric($key)) {
1093
+                    if ( ! is_numeric($key)) {
1094 1094
                         continue;
1095 1095
                     }
1096 1096
                     // by default, hide "hidden_endpoint"s, unless the request indicates
@@ -1099,9 +1099,9 @@  discard block
 block discarded – undo
1099 1099
                     if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
1100 1100
                         || ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
1101 1101
                     ) {
1102
-                        $full_route = '/' . ltrim($namespace, '/');
1103
-                        $full_route .= '/' . ltrim($resource_name, '/');
1104
-                        unset($route_data[ $full_route ]);
1102
+                        $full_route = '/'.ltrim($namespace, '/');
1103
+                        $full_route .= '/'.ltrim($resource_name, '/');
1104
+                        unset($route_data[$full_route]);
1105 1105
                     }
1106 1106
                 }
1107 1107
             }
@@ -1174,19 +1174,19 @@  discard block
 block discarded – undo
1174 1174
             // if it's not above the current core version, and it's compatible with the current version of core
1175 1175
             if ($key_versioned_endpoint === $latest_version) {
1176 1176
                 // don't hide the latest version in the index
1177
-                $versions_served[ $key_versioned_endpoint ] = false;
1177
+                $versions_served[$key_versioned_endpoint] = false;
1178 1178
             } elseif ($key_versioned_endpoint >= $lowest_compatible_version
1179 1179
                 && $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
1180 1180
             ) {
1181 1181
                 // include, but hide, previous versions which are still supported
1182
-                $versions_served[ $key_versioned_endpoint ] = true;
1182
+                $versions_served[$key_versioned_endpoint] = true;
1183 1183
             } elseif (apply_filters(
1184 1184
                 'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
1185 1185
                 false,
1186 1186
                 $possibly_served_versions
1187 1187
             )) {
1188 1188
                 // if a version is no longer supported, don't include it in index or list of versions served
1189
-                $versions_served[ $key_versioned_endpoint ] = true;
1189
+                $versions_served[$key_versioned_endpoint] = true;
1190 1190
             }
1191 1191
         }
1192 1192
         return $versions_served;
@@ -1244,7 +1244,7 @@  discard block
 block discarded – undo
1244 1244
         $model_names = self::model_names_with_plural_routes($version);
1245 1245
         $collection_routes = array();
1246 1246
         foreach ($model_names as $model_name => $model_class_name) {
1247
-            $collection_routes[ strtolower($model_name) ] = '/' . self::ee_api_namespace . $version . '/'
1247
+            $collection_routes[strtolower($model_name)] = '/'.self::ee_api_namespace.$version.'/'
1248 1248
                                                             . EEH_Inflector::pluralize_and_lower($model_name);
1249 1249
         }
1250 1250
         return $collection_routes;
@@ -1265,9 +1265,9 @@  discard block
 block discarded – undo
1265 1265
             $primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
1266 1266
             foreach ($primary_keys as $primary_key_name => $primary_key_field) {
1267 1267
                 if (count($primary_keys) > 1) {
1268
-                    $primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
1268
+                    $primary_key_items[strtolower($model_name)][] = $primary_key_name;
1269 1269
                 } else {
1270
-                    $primary_key_items[ strtolower($model_name) ] = $primary_key_name;
1270
+                    $primary_key_items[strtolower($model_name)] = $primary_key_name;
1271 1271
                 }
1272 1272
             }
1273 1273
         }
Please login to merge, or discard this patch.
core/services/collections/iterators/CollectionFilterCallbackIterator.php 1 patch
Indentation   +47 added lines, -47 removed lines patch added patch discarded remove patch
@@ -9,51 +9,51 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.