@@ -16,131 +16,131 @@ |
||
16 | 16 | */ |
17 | 17 | class Config |
18 | 18 | { |
19 | - /** |
|
20 | - * @var EE_Network_Config |
|
21 | - */ |
|
22 | - private $network_config; |
|
23 | - |
|
24 | - |
|
25 | - /** |
|
26 | - * @var EE_Config |
|
27 | - */ |
|
28 | - private $ee_config; |
|
29 | - |
|
30 | - |
|
31 | - public function __construct(EE_Network_Config $network_config, EE_Config $ee_config) |
|
32 | - { |
|
33 | - $this->network_config = $network_config; |
|
34 | - $this->ee_config = $ee_config; |
|
35 | - } |
|
36 | - |
|
37 | - |
|
38 | - /** |
|
39 | - * Get the site license key for the site. |
|
40 | - */ |
|
41 | - public function siteLicenseKey() |
|
42 | - { |
|
43 | - return $this->network_config->core->site_license_key; |
|
44 | - } |
|
45 | - |
|
46 | - |
|
47 | - public function i18nDomain() |
|
48 | - { |
|
49 | - return 'event_espresso'; |
|
50 | - } |
|
51 | - |
|
52 | - |
|
53 | - public function checkPeriod() |
|
54 | - { |
|
55 | - return 24; |
|
56 | - } |
|
57 | - |
|
58 | - |
|
59 | - public function optionKey() |
|
60 | - { |
|
61 | - return 'ee_site_license_key'; |
|
62 | - } |
|
63 | - |
|
64 | - |
|
65 | - public function optionsPageSlug() |
|
66 | - { |
|
67 | - return 'espresso_general_settings'; |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - public function hostServerUrl() |
|
72 | - { |
|
73 | - return defined('PUE_UPDATES_ENDPOINT') |
|
74 | - ? PUE_UPDATES_ENDPOINT |
|
75 | - : 'https://eventespresso.com'; |
|
76 | - } |
|
77 | - |
|
78 | - |
|
79 | - public function pluginSlug() |
|
80 | - { |
|
81 | - // Note: PUE uses a simple preg_match to determine what type is currently installed based on version number. |
|
82 | - // So it's important that you use a key for the version type that is unique and not found in another key. |
|
83 | - // For example: |
|
84 | - // $plugin_slug['premium']['p'] = 'some-premium-slug'; |
|
85 | - // $plugin_slug['prerelease']['pr'] = 'some-pre-release-slug'; |
|
86 | - // The above would not work because "p" is found in both keys for the version type. ( i.e 1.0.p vs 1.0.pr ) |
|
87 | - // so doing something like: |
|
88 | - // $plugin_slug['premium']['p'] = 'some-premium-slug'; |
|
89 | - // $plugin_slug['prerelease']['b'] = 'some-pre-release-slug'; |
|
90 | - // ..WOULD work! |
|
91 | - return array( |
|
92 | - 'free' => array('decaf' => 'event-espresso-core-decaf'), |
|
93 | - 'premium' => array('p' => 'event-espresso-core-reg'), |
|
94 | - 'prerelease' => array('beta' => 'event-espresso-core-pr'), |
|
95 | - ); |
|
96 | - } |
|
97 | - |
|
98 | - |
|
99 | - /** |
|
100 | - * Return whether the site is opted in for UXIP or not. |
|
101 | - * |
|
102 | - * @return bool |
|
103 | - */ |
|
104 | - public function isOptedInForUxip() |
|
105 | - { |
|
106 | - return filter_var($this->ee_config->core->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN); |
|
107 | - } |
|
108 | - |
|
109 | - |
|
110 | - /** |
|
111 | - * Return whether the site has been notified about UXIP or not. |
|
112 | - * |
|
113 | - * @return bool |
|
114 | - */ |
|
115 | - public function hasNotifiedForUxip() |
|
116 | - { |
|
117 | - return filter_var($this->ee_config->core->ee_ueip_has_notified, FILTER_VALIDATE_BOOLEAN); |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * Set the site opted in for UXIP. |
|
123 | - */ |
|
124 | - public function setHasOptedInForUxip() |
|
125 | - { |
|
126 | - $this->ee_config->core->ee_ueip_optin = true; |
|
127 | - $this->ee_config->update_espresso_config(false, false); |
|
128 | - } |
|
129 | - |
|
130 | - |
|
131 | - /** |
|
132 | - * Set the site opted out for UXIP |
|
133 | - */ |
|
134 | - public function setHasOptedOutForUxip() |
|
135 | - { |
|
136 | - $this->ee_config->core->ee_ueip_optin = false; |
|
137 | - $this->ee_config->update_espresso_config(false, false); |
|
138 | - } |
|
139 | - |
|
140 | - |
|
141 | - public function setHasNotifiedAboutUxip() |
|
142 | - { |
|
143 | - $this->ee_config->core->ee_ueip_has_notified = true; |
|
144 | - $this->ee_config->update_espresso_config(false, false); |
|
145 | - } |
|
19 | + /** |
|
20 | + * @var EE_Network_Config |
|
21 | + */ |
|
22 | + private $network_config; |
|
23 | + |
|
24 | + |
|
25 | + /** |
|
26 | + * @var EE_Config |
|
27 | + */ |
|
28 | + private $ee_config; |
|
29 | + |
|
30 | + |
|
31 | + public function __construct(EE_Network_Config $network_config, EE_Config $ee_config) |
|
32 | + { |
|
33 | + $this->network_config = $network_config; |
|
34 | + $this->ee_config = $ee_config; |
|
35 | + } |
|
36 | + |
|
37 | + |
|
38 | + /** |
|
39 | + * Get the site license key for the site. |
|
40 | + */ |
|
41 | + public function siteLicenseKey() |
|
42 | + { |
|
43 | + return $this->network_config->core->site_license_key; |
|
44 | + } |
|
45 | + |
|
46 | + |
|
47 | + public function i18nDomain() |
|
48 | + { |
|
49 | + return 'event_espresso'; |
|
50 | + } |
|
51 | + |
|
52 | + |
|
53 | + public function checkPeriod() |
|
54 | + { |
|
55 | + return 24; |
|
56 | + } |
|
57 | + |
|
58 | + |
|
59 | + public function optionKey() |
|
60 | + { |
|
61 | + return 'ee_site_license_key'; |
|
62 | + } |
|
63 | + |
|
64 | + |
|
65 | + public function optionsPageSlug() |
|
66 | + { |
|
67 | + return 'espresso_general_settings'; |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + public function hostServerUrl() |
|
72 | + { |
|
73 | + return defined('PUE_UPDATES_ENDPOINT') |
|
74 | + ? PUE_UPDATES_ENDPOINT |
|
75 | + : 'https://eventespresso.com'; |
|
76 | + } |
|
77 | + |
|
78 | + |
|
79 | + public function pluginSlug() |
|
80 | + { |
|
81 | + // Note: PUE uses a simple preg_match to determine what type is currently installed based on version number. |
|
82 | + // So it's important that you use a key for the version type that is unique and not found in another key. |
|
83 | + // For example: |
|
84 | + // $plugin_slug['premium']['p'] = 'some-premium-slug'; |
|
85 | + // $plugin_slug['prerelease']['pr'] = 'some-pre-release-slug'; |
|
86 | + // The above would not work because "p" is found in both keys for the version type. ( i.e 1.0.p vs 1.0.pr ) |
|
87 | + // so doing something like: |
|
88 | + // $plugin_slug['premium']['p'] = 'some-premium-slug'; |
|
89 | + // $plugin_slug['prerelease']['b'] = 'some-pre-release-slug'; |
|
90 | + // ..WOULD work! |
|
91 | + return array( |
|
92 | + 'free' => array('decaf' => 'event-espresso-core-decaf'), |
|
93 | + 'premium' => array('p' => 'event-espresso-core-reg'), |
|
94 | + 'prerelease' => array('beta' => 'event-espresso-core-pr'), |
|
95 | + ); |
|
96 | + } |
|
97 | + |
|
98 | + |
|
99 | + /** |
|
100 | + * Return whether the site is opted in for UXIP or not. |
|
101 | + * |
|
102 | + * @return bool |
|
103 | + */ |
|
104 | + public function isOptedInForUxip() |
|
105 | + { |
|
106 | + return filter_var($this->ee_config->core->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN); |
|
107 | + } |
|
108 | + |
|
109 | + |
|
110 | + /** |
|
111 | + * Return whether the site has been notified about UXIP or not. |
|
112 | + * |
|
113 | + * @return bool |
|
114 | + */ |
|
115 | + public function hasNotifiedForUxip() |
|
116 | + { |
|
117 | + return filter_var($this->ee_config->core->ee_ueip_has_notified, FILTER_VALIDATE_BOOLEAN); |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * Set the site opted in for UXIP. |
|
123 | + */ |
|
124 | + public function setHasOptedInForUxip() |
|
125 | + { |
|
126 | + $this->ee_config->core->ee_ueip_optin = true; |
|
127 | + $this->ee_config->update_espresso_config(false, false); |
|
128 | + } |
|
129 | + |
|
130 | + |
|
131 | + /** |
|
132 | + * Set the site opted out for UXIP |
|
133 | + */ |
|
134 | + public function setHasOptedOutForUxip() |
|
135 | + { |
|
136 | + $this->ee_config->core->ee_ueip_optin = false; |
|
137 | + $this->ee_config->update_espresso_config(false, false); |
|
138 | + } |
|
139 | + |
|
140 | + |
|
141 | + public function setHasNotifiedAboutUxip() |
|
142 | + { |
|
143 | + $this->ee_config->core->ee_ueip_has_notified = true; |
|
144 | + $this->ee_config->update_espresso_config(false, false); |
|
145 | + } |
|
146 | 146 | } |
@@ -97,7 +97,7 @@ discard block |
||
97 | 97 | */ |
98 | 98 | public function addAlias(ClassAlias $alias) |
99 | 99 | { |
100 | - $this->aliases[ $alias->alias() ] = $alias; |
|
100 | + $this->aliases[$alias->alias()] = $alias; |
|
101 | 101 | } |
102 | 102 | |
103 | 103 | /** |
@@ -106,8 +106,8 @@ discard block |
||
106 | 106 | */ |
107 | 107 | public function resolveAlias($param_fqcn) |
108 | 108 | { |
109 | - return isset($this->aliases[ $param_fqcn ]) |
|
110 | - ? $this->aliases[ $param_fqcn ]->fqcn() |
|
109 | + return isset($this->aliases[$param_fqcn]) |
|
110 | + ? $this->aliases[$param_fqcn]->fqcn() |
|
111 | 111 | : $this->classCache()->getFqnForAlias($param_fqcn); |
112 | 112 | } |
113 | 113 | |
@@ -170,7 +170,7 @@ discard block |
||
170 | 170 | $this->resolveDependenciesForClass($param_class); |
171 | 171 | } |
172 | 172 | $param_class = $this->resolveAlias($param_class); |
173 | - $dependencies[ $param_class ] = EE_Dependency_Map::load_from_cache; |
|
173 | + $dependencies[$param_class] = EE_Dependency_Map::load_from_cache; |
|
174 | 174 | } |
175 | 175 | $this->dependencyMap()->registerDependencies($fqcn, $dependencies); |
176 | 176 | } |
@@ -22,155 +22,155 @@ |
||
22 | 22 | */ |
23 | 23 | abstract class DependencyResolver implements DependencyResolverInterface |
24 | 24 | { |
25 | - /** |
|
26 | - * @var Mirror $mirror |
|
27 | - */ |
|
28 | - private $mirror; |
|
29 | - |
|
30 | - /** |
|
31 | - * @var ClassInterfaceCache $class_cache |
|
32 | - */ |
|
33 | - private $class_cache; |
|
34 | - |
|
35 | - /** |
|
36 | - * @var EE_Dependency_Map $dependency_map |
|
37 | - */ |
|
38 | - private $dependency_map; |
|
39 | - |
|
40 | - /** |
|
41 | - * @var ClassAlias[] $aliases |
|
42 | - */ |
|
43 | - protected $aliases = array(); |
|
44 | - |
|
45 | - /** |
|
46 | - * @var array $namespace_roots |
|
47 | - */ |
|
48 | - protected $namespace_roots = array(); |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * RouteMatchSpecificationDependencyResolver constructor. |
|
53 | - * |
|
54 | - * @param Mirror $mirror |
|
55 | - * @param ClassInterfaceCache $class_cache |
|
56 | - * @param EE_Dependency_Map $dependency_map |
|
57 | - */ |
|
58 | - public function __construct( |
|
59 | - Mirror $mirror, |
|
60 | - ClassInterfaceCache $class_cache, |
|
61 | - EE_Dependency_Map $dependency_map |
|
62 | - ) { |
|
63 | - $this->mirror = $mirror; |
|
64 | - $this->class_cache = $class_cache; |
|
65 | - $this->dependency_map = $dependency_map; |
|
66 | - $this->initialize(); |
|
67 | - } |
|
68 | - |
|
69 | - /** |
|
70 | - * @return Mirror |
|
71 | - */ |
|
72 | - public function mirror() |
|
73 | - { |
|
74 | - return $this->mirror; |
|
75 | - } |
|
76 | - |
|
77 | - /** |
|
78 | - * @return ClassInterfaceCache |
|
79 | - */ |
|
80 | - public function classCache() |
|
81 | - { |
|
82 | - return $this->class_cache; |
|
83 | - } |
|
84 | - |
|
85 | - /** |
|
86 | - * @return EE_Dependency_Map |
|
87 | - */ |
|
88 | - public function dependencyMap() |
|
89 | - { |
|
90 | - return $this->dependency_map; |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * @param ClassAlias $alias |
|
95 | - * @throws InvalidAliasException |
|
96 | - */ |
|
97 | - public function addAlias(ClassAlias $alias) |
|
98 | - { |
|
99 | - $this->aliases[ $alias->alias() ] = $alias; |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * @param string $param_fqcn Fully Qualified Class Name for dependency parameter |
|
104 | - * @return string |
|
105 | - */ |
|
106 | - public function resolveAlias($param_fqcn) |
|
107 | - { |
|
108 | - return isset($this->aliases[ $param_fqcn ]) |
|
109 | - ? $this->aliases[ $param_fqcn ]->fqcn() |
|
110 | - : $this->classCache()->getFqnForAlias($param_fqcn); |
|
111 | - } |
|
112 | - |
|
113 | - /** |
|
114 | - * Primarily used to indicate the namespace root for composite objects |
|
115 | - * so that dependencies requiring the same DependencyResolver can be acquired |
|
116 | - * for example: |
|
117 | - * Vendor\path\to\class\A, Vendor\path\to\class\B, and Vendor\path\to\class\C |
|
118 | - * may all implement Vendor\path\to\Interface, |
|
119 | - * but Vendor\path\to\class\C could be a composite object |
|
120 | - * that requires Vendor\path\to\class\A and Vendor\path\to\class\B, |
|
121 | - * and needs both of those dependencies resolved, which would therefore require |
|
122 | - * the use of the same DependencyResolver. |
|
123 | - * |
|
124 | - * By specifying a namespace root of "Vendor\path\to\", |
|
125 | - * then all classes that are descendants of that namespace |
|
126 | - * will use DependencyResolver to acquire the classes they need |
|
127 | - * |
|
128 | - * @param string $namespace_root Partial namespace used for detecting other classes |
|
129 | - * that should employ this same DependencyResolver |
|
130 | - */ |
|
131 | - public function addNamespaceRoot($namespace_root) |
|
132 | - { |
|
133 | - $this->namespace_roots[] = $namespace_root; |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * Returns true if the parameter FQCN belongs to one of |
|
138 | - * the namespaces that utilizes this DependencyResolver |
|
139 | - * |
|
140 | - * @param string $param_fqcn Fully Qualified Class Name for dependency parameter |
|
141 | - * @return boolean |
|
142 | - * @since 4.9.71.p |
|
143 | - */ |
|
144 | - public function dependencyRecursionExists($param_fqcn) |
|
145 | - { |
|
146 | - foreach ($this->namespace_roots as $namespace_root) { |
|
147 | - if (strpos($param_fqcn, $namespace_root) !== false) { |
|
148 | - return true; |
|
149 | - } |
|
150 | - } |
|
151 | - return false; |
|
152 | - } |
|
153 | - |
|
154 | - |
|
155 | - /** |
|
156 | - * @param string $fqcn Fully Qualified Class Name |
|
157 | - * @throws InvalidDataTypeException |
|
158 | - * @throws ReflectionException |
|
159 | - * @since 4.9.71.p |
|
160 | - */ |
|
161 | - public function resolveDependenciesForClass($fqcn) |
|
162 | - { |
|
163 | - $dependencies = array(); |
|
164 | - $params = $this->mirror()->getParameters($fqcn); |
|
165 | - foreach ($params as $index => $param) { |
|
166 | - // is this a dependency for a specific class ? |
|
167 | - $param_class = $this->mirror()->getParameterClassName($param, $fqcn, $index); |
|
168 | - if ($this->dependencyRecursionExists($param_class)) { |
|
169 | - $this->resolveDependenciesForClass($param_class); |
|
170 | - } |
|
171 | - $param_class = $this->resolveAlias($param_class); |
|
172 | - $dependencies[ $param_class ] = EE_Dependency_Map::load_from_cache; |
|
173 | - } |
|
174 | - $this->dependencyMap()->registerDependencies($fqcn, $dependencies); |
|
175 | - } |
|
25 | + /** |
|
26 | + * @var Mirror $mirror |
|
27 | + */ |
|
28 | + private $mirror; |
|
29 | + |
|
30 | + /** |
|
31 | + * @var ClassInterfaceCache $class_cache |
|
32 | + */ |
|
33 | + private $class_cache; |
|
34 | + |
|
35 | + /** |
|
36 | + * @var EE_Dependency_Map $dependency_map |
|
37 | + */ |
|
38 | + private $dependency_map; |
|
39 | + |
|
40 | + /** |
|
41 | + * @var ClassAlias[] $aliases |
|
42 | + */ |
|
43 | + protected $aliases = array(); |
|
44 | + |
|
45 | + /** |
|
46 | + * @var array $namespace_roots |
|
47 | + */ |
|
48 | + protected $namespace_roots = array(); |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * RouteMatchSpecificationDependencyResolver constructor. |
|
53 | + * |
|
54 | + * @param Mirror $mirror |
|
55 | + * @param ClassInterfaceCache $class_cache |
|
56 | + * @param EE_Dependency_Map $dependency_map |
|
57 | + */ |
|
58 | + public function __construct( |
|
59 | + Mirror $mirror, |
|
60 | + ClassInterfaceCache $class_cache, |
|
61 | + EE_Dependency_Map $dependency_map |
|
62 | + ) { |
|
63 | + $this->mirror = $mirror; |
|
64 | + $this->class_cache = $class_cache; |
|
65 | + $this->dependency_map = $dependency_map; |
|
66 | + $this->initialize(); |
|
67 | + } |
|
68 | + |
|
69 | + /** |
|
70 | + * @return Mirror |
|
71 | + */ |
|
72 | + public function mirror() |
|
73 | + { |
|
74 | + return $this->mirror; |
|
75 | + } |
|
76 | + |
|
77 | + /** |
|
78 | + * @return ClassInterfaceCache |
|
79 | + */ |
|
80 | + public function classCache() |
|
81 | + { |
|
82 | + return $this->class_cache; |
|
83 | + } |
|
84 | + |
|
85 | + /** |
|
86 | + * @return EE_Dependency_Map |
|
87 | + */ |
|
88 | + public function dependencyMap() |
|
89 | + { |
|
90 | + return $this->dependency_map; |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * @param ClassAlias $alias |
|
95 | + * @throws InvalidAliasException |
|
96 | + */ |
|
97 | + public function addAlias(ClassAlias $alias) |
|
98 | + { |
|
99 | + $this->aliases[ $alias->alias() ] = $alias; |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * @param string $param_fqcn Fully Qualified Class Name for dependency parameter |
|
104 | + * @return string |
|
105 | + */ |
|
106 | + public function resolveAlias($param_fqcn) |
|
107 | + { |
|
108 | + return isset($this->aliases[ $param_fqcn ]) |
|
109 | + ? $this->aliases[ $param_fqcn ]->fqcn() |
|
110 | + : $this->classCache()->getFqnForAlias($param_fqcn); |
|
111 | + } |
|
112 | + |
|
113 | + /** |
|
114 | + * Primarily used to indicate the namespace root for composite objects |
|
115 | + * so that dependencies requiring the same DependencyResolver can be acquired |
|
116 | + * for example: |
|
117 | + * Vendor\path\to\class\A, Vendor\path\to\class\B, and Vendor\path\to\class\C |
|
118 | + * may all implement Vendor\path\to\Interface, |
|
119 | + * but Vendor\path\to\class\C could be a composite object |
|
120 | + * that requires Vendor\path\to\class\A and Vendor\path\to\class\B, |
|
121 | + * and needs both of those dependencies resolved, which would therefore require |
|
122 | + * the use of the same DependencyResolver. |
|
123 | + * |
|
124 | + * By specifying a namespace root of "Vendor\path\to\", |
|
125 | + * then all classes that are descendants of that namespace |
|
126 | + * will use DependencyResolver to acquire the classes they need |
|
127 | + * |
|
128 | + * @param string $namespace_root Partial namespace used for detecting other classes |
|
129 | + * that should employ this same DependencyResolver |
|
130 | + */ |
|
131 | + public function addNamespaceRoot($namespace_root) |
|
132 | + { |
|
133 | + $this->namespace_roots[] = $namespace_root; |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * Returns true if the parameter FQCN belongs to one of |
|
138 | + * the namespaces that utilizes this DependencyResolver |
|
139 | + * |
|
140 | + * @param string $param_fqcn Fully Qualified Class Name for dependency parameter |
|
141 | + * @return boolean |
|
142 | + * @since 4.9.71.p |
|
143 | + */ |
|
144 | + public function dependencyRecursionExists($param_fqcn) |
|
145 | + { |
|
146 | + foreach ($this->namespace_roots as $namespace_root) { |
|
147 | + if (strpos($param_fqcn, $namespace_root) !== false) { |
|
148 | + return true; |
|
149 | + } |
|
150 | + } |
|
151 | + return false; |
|
152 | + } |
|
153 | + |
|
154 | + |
|
155 | + /** |
|
156 | + * @param string $fqcn Fully Qualified Class Name |
|
157 | + * @throws InvalidDataTypeException |
|
158 | + * @throws ReflectionException |
|
159 | + * @since 4.9.71.p |
|
160 | + */ |
|
161 | + public function resolveDependenciesForClass($fqcn) |
|
162 | + { |
|
163 | + $dependencies = array(); |
|
164 | + $params = $this->mirror()->getParameters($fqcn); |
|
165 | + foreach ($params as $index => $param) { |
|
166 | + // is this a dependency for a specific class ? |
|
167 | + $param_class = $this->mirror()->getParameterClassName($param, $fqcn, $index); |
|
168 | + if ($this->dependencyRecursionExists($param_class)) { |
|
169 | + $this->resolveDependenciesForClass($param_class); |
|
170 | + } |
|
171 | + $param_class = $this->resolveAlias($param_class); |
|
172 | + $dependencies[ $param_class ] = EE_Dependency_Map::load_from_cache; |
|
173 | + } |
|
174 | + $this->dependencyMap()->registerDependencies($fqcn, $dependencies); |
|
175 | + } |
|
176 | 176 | } |
@@ -31,7 +31,7 @@ |
||
31 | 31 | public function __construct(array $specifications, RequestInterface $request) |
32 | 32 | { |
33 | 33 | foreach ($specifications as $specification) { |
34 | - if (! $specification instanceof RouteMatchSpecificationInterface) { |
|
34 | + if ( ! $specification instanceof RouteMatchSpecificationInterface) { |
|
35 | 35 | throw new InvalidEntityException( |
36 | 36 | $specification, |
37 | 37 | 'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface' |
@@ -15,29 +15,29 @@ |
||
15 | 15 | */ |
16 | 16 | abstract class MultiRouteSpecification extends RouteMatchSpecification |
17 | 17 | { |
18 | - /** |
|
19 | - * @var RouteMatchSpecificationInterface[] $specifications |
|
20 | - */ |
|
21 | - protected $specifications; |
|
18 | + /** |
|
19 | + * @var RouteMatchSpecificationInterface[] $specifications |
|
20 | + */ |
|
21 | + protected $specifications; |
|
22 | 22 | |
23 | - /** |
|
24 | - * MultiRouteSpecification constructor. |
|
25 | - * |
|
26 | - * @param RouteMatchSpecificationInterface[] $specifications |
|
27 | - * @param RequestInterface $request |
|
28 | - * @throws InvalidEntityException |
|
29 | - */ |
|
30 | - public function __construct(array $specifications, RequestInterface $request) |
|
31 | - { |
|
32 | - foreach ($specifications as $specification) { |
|
33 | - if (! $specification instanceof RouteMatchSpecificationInterface) { |
|
34 | - throw new InvalidEntityException( |
|
35 | - $specification, |
|
36 | - 'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface' |
|
37 | - ); |
|
38 | - } |
|
39 | - } |
|
40 | - $this->specifications = $specifications; |
|
41 | - parent::__construct($request); |
|
42 | - } |
|
23 | + /** |
|
24 | + * MultiRouteSpecification constructor. |
|
25 | + * |
|
26 | + * @param RouteMatchSpecificationInterface[] $specifications |
|
27 | + * @param RequestInterface $request |
|
28 | + * @throws InvalidEntityException |
|
29 | + */ |
|
30 | + public function __construct(array $specifications, RequestInterface $request) |
|
31 | + { |
|
32 | + foreach ($specifications as $specification) { |
|
33 | + if (! $specification instanceof RouteMatchSpecificationInterface) { |
|
34 | + throw new InvalidEntityException( |
|
35 | + $specification, |
|
36 | + 'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface' |
|
37 | + ); |
|
38 | + } |
|
39 | + } |
|
40 | + $this->specifications = $specifications; |
|
41 | + parent::__construct($request); |
|
42 | + } |
|
43 | 43 | } |
@@ -18,22 +18,22 @@ |
||
18 | 18 | */ |
19 | 19 | class WordPressPostsEditor extends MatchAnyRouteSpecification |
20 | 20 | { |
21 | - /** |
|
22 | - * WordPressPostsEditor constructor. |
|
23 | - * |
|
24 | - * @param WordPressPostsEditorEdit $edit_post_route_match |
|
25 | - * @param WordPressPostsEditorAddNew $create_post_route_match |
|
26 | - * @param RequestInterface $request |
|
27 | - * @throws \EventEspresso\core\exceptions\InvalidEntityException |
|
28 | - */ |
|
29 | - public function __construct( |
|
30 | - WordPressPostsEditorEdit $edit_post_route_match, |
|
31 | - WordPressPostsEditorAddNew $create_post_route_match, |
|
32 | - RequestInterface $request |
|
33 | - ) { |
|
34 | - parent::__construct( |
|
35 | - array($edit_post_route_match, $create_post_route_match), |
|
36 | - $request |
|
37 | - ); |
|
38 | - } |
|
21 | + /** |
|
22 | + * WordPressPostsEditor constructor. |
|
23 | + * |
|
24 | + * @param WordPressPostsEditorEdit $edit_post_route_match |
|
25 | + * @param WordPressPostsEditorAddNew $create_post_route_match |
|
26 | + * @param RequestInterface $request |
|
27 | + * @throws \EventEspresso\core\exceptions\InvalidEntityException |
|
28 | + */ |
|
29 | + public function __construct( |
|
30 | + WordPressPostsEditorEdit $edit_post_route_match, |
|
31 | + WordPressPostsEditorAddNew $create_post_route_match, |
|
32 | + RequestInterface $request |
|
33 | + ) { |
|
34 | + parent::__construct( |
|
35 | + array($edit_post_route_match, $create_post_route_match), |
|
36 | + $request |
|
37 | + ); |
|
38 | + } |
|
39 | 39 | } |
@@ -19,22 +19,22 @@ |
||
19 | 19 | */ |
20 | 20 | class EspressoEventEditor extends MatchAnyRouteSpecification |
21 | 21 | { |
22 | - /** |
|
23 | - * EspressoEventEditor constructor. |
|
24 | - * |
|
25 | - * @param EspressoEventEditorEdit $edit_event_route_match |
|
26 | - * @param EspressoEventEditorAddNew $create_event_route_match |
|
27 | - * @param RequestInterface $request |
|
28 | - * @throws InvalidEntityException |
|
29 | - */ |
|
30 | - public function __construct( |
|
31 | - EspressoEventEditorEdit $edit_event_route_match, |
|
32 | - EspressoEventEditorAddNew $create_event_route_match, |
|
33 | - RequestInterface $request |
|
34 | - ) { |
|
35 | - parent::__construct( |
|
36 | - array($edit_event_route_match, $create_event_route_match), |
|
37 | - $request |
|
38 | - ); |
|
39 | - } |
|
22 | + /** |
|
23 | + * EspressoEventEditor constructor. |
|
24 | + * |
|
25 | + * @param EspressoEventEditorEdit $edit_event_route_match |
|
26 | + * @param EspressoEventEditorAddNew $create_event_route_match |
|
27 | + * @param RequestInterface $request |
|
28 | + * @throws InvalidEntityException |
|
29 | + */ |
|
30 | + public function __construct( |
|
31 | + EspressoEventEditorEdit $edit_event_route_match, |
|
32 | + EspressoEventEditorAddNew $create_event_route_match, |
|
33 | + RequestInterface $request |
|
34 | + ) { |
|
35 | + parent::__construct( |
|
36 | + array($edit_event_route_match, $create_event_route_match), |
|
37 | + $request |
|
38 | + ); |
|
39 | + } |
|
40 | 40 | } |
@@ -19,22 +19,22 @@ |
||
19 | 19 | */ |
20 | 20 | class EspressoVenueEditor extends MatchAnyRouteSpecification |
21 | 21 | { |
22 | - /** |
|
23 | - * EspressoVenueEditor constructor. |
|
24 | - * |
|
25 | - * @param EspressoVenueEditorEdit $edit_venue_route_match |
|
26 | - * @param EspressoVenueEditorAddNew $create_venue_route_match |
|
27 | - * @param RequestInterface $request |
|
28 | - * @throws InvalidEntityException |
|
29 | - */ |
|
30 | - public function __construct( |
|
31 | - EspressoVenueEditorEdit $edit_venue_route_match, |
|
32 | - EspressoVenueEditorAddNew $create_venue_route_match, |
|
33 | - RequestInterface $request |
|
34 | - ) { |
|
35 | - parent::__construct( |
|
36 | - array($edit_venue_route_match, $create_venue_route_match), |
|
37 | - $request |
|
38 | - ); |
|
39 | - } |
|
22 | + /** |
|
23 | + * EspressoVenueEditor constructor. |
|
24 | + * |
|
25 | + * @param EspressoVenueEditorEdit $edit_venue_route_match |
|
26 | + * @param EspressoVenueEditorAddNew $create_venue_route_match |
|
27 | + * @param RequestInterface $request |
|
28 | + * @throws InvalidEntityException |
|
29 | + */ |
|
30 | + public function __construct( |
|
31 | + EspressoVenueEditorEdit $edit_venue_route_match, |
|
32 | + EspressoVenueEditorAddNew $create_venue_route_match, |
|
33 | + RequestInterface $request |
|
34 | + ) { |
|
35 | + parent::__construct( |
|
36 | + array($edit_venue_route_match, $create_venue_route_match), |
|
37 | + $request |
|
38 | + ); |
|
39 | + } |
|
40 | 40 | } |
@@ -18,22 +18,22 @@ |
||
18 | 18 | */ |
19 | 19 | class EspressoPostTypeEditor extends MatchAnyRouteSpecification |
20 | 20 | { |
21 | - /** |
|
22 | - * EspressoEventEditor constructor. |
|
23 | - * |
|
24 | - * @param EspressoStandardPostTypeEditor $standard_route_match |
|
25 | - * @param EspressoAttendeePostTypeEditor $attendee_route_match |
|
26 | - * @param RequestInterface $request |
|
27 | - * @throws InvalidEntityException |
|
28 | - */ |
|
29 | - public function __construct( |
|
30 | - EspressoStandardPostTypeEditor $standard_route_match, |
|
31 | - EspressoAttendeePostTypeEditor $attendee_route_match, |
|
32 | - RequestInterface $request |
|
33 | - ) { |
|
34 | - parent::__construct( |
|
35 | - array($standard_route_match, $attendee_route_match), |
|
36 | - $request |
|
37 | - ); |
|
38 | - } |
|
21 | + /** |
|
22 | + * EspressoEventEditor constructor. |
|
23 | + * |
|
24 | + * @param EspressoStandardPostTypeEditor $standard_route_match |
|
25 | + * @param EspressoAttendeePostTypeEditor $attendee_route_match |
|
26 | + * @param RequestInterface $request |
|
27 | + * @throws InvalidEntityException |
|
28 | + */ |
|
29 | + public function __construct( |
|
30 | + EspressoStandardPostTypeEditor $standard_route_match, |
|
31 | + EspressoAttendeePostTypeEditor $attendee_route_match, |
|
32 | + RequestInterface $request |
|
33 | + ) { |
|
34 | + parent::__construct( |
|
35 | + array($standard_route_match, $attendee_route_match), |
|
36 | + $request |
|
37 | + ); |
|
38 | + } |
|
39 | 39 | } |
@@ -18,22 +18,22 @@ |
||
18 | 18 | */ |
19 | 19 | class WordPressPageEditor extends MatchAnyRouteSpecification |
20 | 20 | { |
21 | - /** |
|
22 | - * WordPressPostsEditor constructor. |
|
23 | - * |
|
24 | - * @param WordPressPostsEditorEdit $edit_page_route_match |
|
25 | - * @param WordPressPostsEditorAddNew $create_page_route_match |
|
26 | - * @param RequestInterface $request |
|
27 | - * @throws \EventEspresso\core\exceptions\InvalidEntityException |
|
28 | - */ |
|
29 | - public function __construct( |
|
30 | - WordPressPageEditorEdit $edit_page_route_match, |
|
31 | - WordPressPageEditorAddNew $create_page_route_match, |
|
32 | - RequestInterface $request |
|
33 | - ) { |
|
34 | - parent::__construct( |
|
35 | - array($edit_page_route_match, $create_page_route_match), |
|
36 | - $request |
|
37 | - ); |
|
38 | - } |
|
21 | + /** |
|
22 | + * WordPressPostsEditor constructor. |
|
23 | + * |
|
24 | + * @param WordPressPostsEditorEdit $edit_page_route_match |
|
25 | + * @param WordPressPostsEditorAddNew $create_page_route_match |
|
26 | + * @param RequestInterface $request |
|
27 | + * @throws \EventEspresso\core\exceptions\InvalidEntityException |
|
28 | + */ |
|
29 | + public function __construct( |
|
30 | + WordPressPageEditorEdit $edit_page_route_match, |
|
31 | + WordPressPageEditorAddNew $create_page_route_match, |
|
32 | + RequestInterface $request |
|
33 | + ) { |
|
34 | + parent::__construct( |
|
35 | + array($edit_page_route_match, $create_page_route_match), |
|
36 | + $request |
|
37 | + ); |
|
38 | + } |
|
39 | 39 | } |
@@ -76,22 +76,22 @@ discard block |
||
76 | 76 | public function getModelSchemaForFields(array $model_fields, array $schema) |
77 | 77 | { |
78 | 78 | foreach ($model_fields as $field => $model_field) { |
79 | - if (! $model_field instanceof EE_Model_Field_Base) { |
|
79 | + if ( ! $model_field instanceof EE_Model_Field_Base) { |
|
80 | 80 | continue; |
81 | 81 | } |
82 | - $schema['properties'][ $field ] = $model_field->getSchema(); |
|
82 | + $schema['properties'][$field] = $model_field->getSchema(); |
|
83 | 83 | |
84 | 84 | // if this is a primary key field add the primary key item |
85 | 85 | if ($model_field instanceof EE_Primary_Key_Field_Base) { |
86 | - $schema['properties'][ $field ]['primary_key'] = true; |
|
86 | + $schema['properties'][$field]['primary_key'] = true; |
|
87 | 87 | if ($model_field instanceof EE_Primary_Key_Int_Field) { |
88 | - $schema['properties'][ $field ]['readonly'] = true; |
|
88 | + $schema['properties'][$field]['readonly'] = true; |
|
89 | 89 | } |
90 | 90 | } |
91 | 91 | |
92 | 92 | // if this is a foreign key field add the foreign key item |
93 | 93 | if ($model_field instanceof EE_Foreign_Key_Field_Base) { |
94 | - $schema['properties'][ $field ]['foreign_key'] = array( |
|
94 | + $schema['properties'][$field]['foreign_key'] = array( |
|
95 | 95 | 'description' => esc_html__( |
96 | 96 | 'This is a foreign key the points to the given models.', |
97 | 97 | 'event_espresso' |
@@ -115,18 +115,18 @@ discard block |
||
115 | 115 | public function getModelSchemaForRelations(array $relations_on_model, array $schema) |
116 | 116 | { |
117 | 117 | foreach ($relations_on_model as $model_name => $relation) { |
118 | - if (! $relation instanceof EE_Model_Relation_Base) { |
|
118 | + if ( ! $relation instanceof EE_Model_Relation_Base) { |
|
119 | 119 | continue; |
120 | 120 | } |
121 | 121 | $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation |
122 | 122 | ? strtolower($model_name) |
123 | 123 | : EEH_Inflector::pluralize_and_lower($model_name); |
124 | - $schema['properties'][ $model_name_for_schema ] = $relation->getSchema(); |
|
125 | - $schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name; |
|
124 | + $schema['properties'][$model_name_for_schema] = $relation->getSchema(); |
|
125 | + $schema['properties'][$model_name_for_schema]['relation_model'] = $model_name; |
|
126 | 126 | |
127 | 127 | // links schema |
128 | - $links_key = 'https://api.eventespresso.com/' . strtolower($model_name); |
|
129 | - $schema['properties']['_links']['properties'][ $links_key ] = array( |
|
128 | + $links_key = 'https://api.eventespresso.com/'.strtolower($model_name); |
|
129 | + $schema['properties']['_links']['properties'][$links_key] = array( |
|
130 | 130 | 'description' => esc_html__( |
131 | 131 | 'Array of objects describing the link(s) for this relation resource.', |
132 | 132 | 'event_espresso' |
@@ -24,255 +24,255 @@ |
||
24 | 24 | */ |
25 | 25 | class JsonModelSchema |
26 | 26 | { |
27 | - /** |
|
28 | - * @var EEM_Base |
|
29 | - */ |
|
30 | - protected $model; |
|
27 | + /** |
|
28 | + * @var EEM_Base |
|
29 | + */ |
|
30 | + protected $model; |
|
31 | 31 | |
32 | - /** |
|
33 | - * @var CalculatedModelFields |
|
34 | - */ |
|
35 | - protected $fields_calculator; |
|
32 | + /** |
|
33 | + * @var CalculatedModelFields |
|
34 | + */ |
|
35 | + protected $fields_calculator; |
|
36 | 36 | |
37 | 37 | |
38 | - /** |
|
39 | - * JsonModelSchema constructor. |
|
40 | - * |
|
41 | - * @param EEM_Base $model |
|
42 | - * @param CalculatedModelFields $fields_calculator |
|
43 | - */ |
|
44 | - public function __construct(EEM_Base $model, CalculatedModelFields $fields_calculator) |
|
45 | - { |
|
46 | - $this->model = $model; |
|
47 | - $this->fields_calculator = $fields_calculator; |
|
48 | - } |
|
38 | + /** |
|
39 | + * JsonModelSchema constructor. |
|
40 | + * |
|
41 | + * @param EEM_Base $model |
|
42 | + * @param CalculatedModelFields $fields_calculator |
|
43 | + */ |
|
44 | + public function __construct(EEM_Base $model, CalculatedModelFields $fields_calculator) |
|
45 | + { |
|
46 | + $this->model = $model; |
|
47 | + $this->fields_calculator = $fields_calculator; |
|
48 | + } |
|
49 | 49 | |
50 | 50 | |
51 | - /** |
|
52 | - * Return the schema for a given model from a given model. |
|
53 | - * |
|
54 | - * @return array |
|
55 | - */ |
|
56 | - public function getModelSchema() |
|
57 | - { |
|
58 | - return $this->getModelSchemaForRelations( |
|
59 | - $this->model->relation_settings(), |
|
60 | - $this->getModelSchemaForFields( |
|
61 | - $this->model->field_settings(), |
|
62 | - $this->getInitialSchemaStructure() |
|
63 | - ) |
|
64 | - ); |
|
65 | - } |
|
51 | + /** |
|
52 | + * Return the schema for a given model from a given model. |
|
53 | + * |
|
54 | + * @return array |
|
55 | + */ |
|
56 | + public function getModelSchema() |
|
57 | + { |
|
58 | + return $this->getModelSchemaForRelations( |
|
59 | + $this->model->relation_settings(), |
|
60 | + $this->getModelSchemaForFields( |
|
61 | + $this->model->field_settings(), |
|
62 | + $this->getInitialSchemaStructure() |
|
63 | + ) |
|
64 | + ); |
|
65 | + } |
|
66 | 66 | |
67 | 67 | |
68 | - /** |
|
69 | - * Get the schema for a given set of model fields. |
|
70 | - * |
|
71 | - * @param EE_Model_Field_Base[] $model_fields |
|
72 | - * @param array $schema |
|
73 | - * @return array |
|
74 | - */ |
|
75 | - public function getModelSchemaForFields(array $model_fields, array $schema) |
|
76 | - { |
|
77 | - foreach ($model_fields as $field => $model_field) { |
|
78 | - if (! $model_field instanceof EE_Model_Field_Base) { |
|
79 | - continue; |
|
80 | - } |
|
81 | - $schema['properties'][ $field ] = $model_field->getSchema(); |
|
68 | + /** |
|
69 | + * Get the schema for a given set of model fields. |
|
70 | + * |
|
71 | + * @param EE_Model_Field_Base[] $model_fields |
|
72 | + * @param array $schema |
|
73 | + * @return array |
|
74 | + */ |
|
75 | + public function getModelSchemaForFields(array $model_fields, array $schema) |
|
76 | + { |
|
77 | + foreach ($model_fields as $field => $model_field) { |
|
78 | + if (! $model_field instanceof EE_Model_Field_Base) { |
|
79 | + continue; |
|
80 | + } |
|
81 | + $schema['properties'][ $field ] = $model_field->getSchema(); |
|
82 | 82 | |
83 | - // if this is a primary key field add the primary key item |
|
84 | - if ($model_field instanceof EE_Primary_Key_Field_Base) { |
|
85 | - $schema['properties'][ $field ]['primary_key'] = true; |
|
86 | - if ($model_field instanceof EE_Primary_Key_Int_Field) { |
|
87 | - $schema['properties'][ $field ]['readonly'] = true; |
|
88 | - } |
|
89 | - } |
|
83 | + // if this is a primary key field add the primary key item |
|
84 | + if ($model_field instanceof EE_Primary_Key_Field_Base) { |
|
85 | + $schema['properties'][ $field ]['primary_key'] = true; |
|
86 | + if ($model_field instanceof EE_Primary_Key_Int_Field) { |
|
87 | + $schema['properties'][ $field ]['readonly'] = true; |
|
88 | + } |
|
89 | + } |
|
90 | 90 | |
91 | - // if this is a foreign key field add the foreign key item |
|
92 | - if ($model_field instanceof EE_Foreign_Key_Field_Base) { |
|
93 | - $schema['properties'][ $field ]['foreign_key'] = array( |
|
94 | - 'description' => esc_html__( |
|
95 | - 'This is a foreign key the points to the given models.', |
|
96 | - 'event_espresso' |
|
97 | - ), |
|
98 | - 'type' => 'array', |
|
99 | - 'enum' => $model_field->get_model_class_names_pointed_to(), |
|
100 | - ); |
|
101 | - } |
|
102 | - } |
|
103 | - return $schema; |
|
104 | - } |
|
91 | + // if this is a foreign key field add the foreign key item |
|
92 | + if ($model_field instanceof EE_Foreign_Key_Field_Base) { |
|
93 | + $schema['properties'][ $field ]['foreign_key'] = array( |
|
94 | + 'description' => esc_html__( |
|
95 | + 'This is a foreign key the points to the given models.', |
|
96 | + 'event_espresso' |
|
97 | + ), |
|
98 | + 'type' => 'array', |
|
99 | + 'enum' => $model_field->get_model_class_names_pointed_to(), |
|
100 | + ); |
|
101 | + } |
|
102 | + } |
|
103 | + return $schema; |
|
104 | + } |
|
105 | 105 | |
106 | 106 | |
107 | - /** |
|
108 | - * Get the schema for a given set of model relations |
|
109 | - * |
|
110 | - * @param EE_Model_Relation_Base[] $relations_on_model |
|
111 | - * @param array $schema |
|
112 | - * @return array |
|
113 | - */ |
|
114 | - public function getModelSchemaForRelations(array $relations_on_model, array $schema) |
|
115 | - { |
|
116 | - foreach ($relations_on_model as $model_name => $relation) { |
|
117 | - if (! $relation instanceof EE_Model_Relation_Base) { |
|
118 | - continue; |
|
119 | - } |
|
120 | - $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation |
|
121 | - ? strtolower($model_name) |
|
122 | - : EEH_Inflector::pluralize_and_lower($model_name); |
|
123 | - $schema['properties'][ $model_name_for_schema ] = $relation->getSchema(); |
|
124 | - $schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name; |
|
107 | + /** |
|
108 | + * Get the schema for a given set of model relations |
|
109 | + * |
|
110 | + * @param EE_Model_Relation_Base[] $relations_on_model |
|
111 | + * @param array $schema |
|
112 | + * @return array |
|
113 | + */ |
|
114 | + public function getModelSchemaForRelations(array $relations_on_model, array $schema) |
|
115 | + { |
|
116 | + foreach ($relations_on_model as $model_name => $relation) { |
|
117 | + if (! $relation instanceof EE_Model_Relation_Base) { |
|
118 | + continue; |
|
119 | + } |
|
120 | + $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation |
|
121 | + ? strtolower($model_name) |
|
122 | + : EEH_Inflector::pluralize_and_lower($model_name); |
|
123 | + $schema['properties'][ $model_name_for_schema ] = $relation->getSchema(); |
|
124 | + $schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name; |
|
125 | 125 | |
126 | - // links schema |
|
127 | - $links_key = 'https://api.eventespresso.com/' . strtolower($model_name); |
|
128 | - $schema['properties']['_links']['properties'][ $links_key ] = array( |
|
129 | - 'description' => esc_html__( |
|
130 | - 'Array of objects describing the link(s) for this relation resource.', |
|
131 | - 'event_espresso' |
|
132 | - ), |
|
133 | - 'type' => 'array', |
|
134 | - 'readonly' => true, |
|
135 | - 'items' => array( |
|
136 | - 'type' => 'object', |
|
137 | - 'properties' => array( |
|
138 | - 'href' => array( |
|
139 | - 'type' => 'string', |
|
140 | - 'description' => sprintf( |
|
141 | - // translators: placeholder is the model name for the relation. |
|
142 | - esc_html__( |
|
143 | - 'The link to the resource for the %s relation(s) to this entity', |
|
144 | - 'event_espresso' |
|
145 | - ), |
|
146 | - $model_name |
|
147 | - ), |
|
148 | - ), |
|
149 | - 'single' => array( |
|
150 | - 'type' => 'boolean', |
|
151 | - 'description' => sprintf( |
|
152 | - // translators: placeholder is the model name for the relation. |
|
153 | - esc_html__( |
|
154 | - 'Whether or not there is only a single %s relation to this entity', |
|
155 | - 'event_espresso' |
|
156 | - ), |
|
157 | - $model_name |
|
158 | - ), |
|
159 | - ), |
|
160 | - ), |
|
161 | - 'additionalProperties' => false |
|
162 | - ), |
|
163 | - ); |
|
164 | - } |
|
165 | - return $schema; |
|
166 | - } |
|
126 | + // links schema |
|
127 | + $links_key = 'https://api.eventespresso.com/' . strtolower($model_name); |
|
128 | + $schema['properties']['_links']['properties'][ $links_key ] = array( |
|
129 | + 'description' => esc_html__( |
|
130 | + 'Array of objects describing the link(s) for this relation resource.', |
|
131 | + 'event_espresso' |
|
132 | + ), |
|
133 | + 'type' => 'array', |
|
134 | + 'readonly' => true, |
|
135 | + 'items' => array( |
|
136 | + 'type' => 'object', |
|
137 | + 'properties' => array( |
|
138 | + 'href' => array( |
|
139 | + 'type' => 'string', |
|
140 | + 'description' => sprintf( |
|
141 | + // translators: placeholder is the model name for the relation. |
|
142 | + esc_html__( |
|
143 | + 'The link to the resource for the %s relation(s) to this entity', |
|
144 | + 'event_espresso' |
|
145 | + ), |
|
146 | + $model_name |
|
147 | + ), |
|
148 | + ), |
|
149 | + 'single' => array( |
|
150 | + 'type' => 'boolean', |
|
151 | + 'description' => sprintf( |
|
152 | + // translators: placeholder is the model name for the relation. |
|
153 | + esc_html__( |
|
154 | + 'Whether or not there is only a single %s relation to this entity', |
|
155 | + 'event_espresso' |
|
156 | + ), |
|
157 | + $model_name |
|
158 | + ), |
|
159 | + ), |
|
160 | + ), |
|
161 | + 'additionalProperties' => false |
|
162 | + ), |
|
163 | + ); |
|
164 | + } |
|
165 | + return $schema; |
|
166 | + } |
|
167 | 167 | |
168 | 168 | |
169 | - /** |
|
170 | - * Outputs the schema header for a model. |
|
171 | - * |
|
172 | - * @return array |
|
173 | - */ |
|
174 | - public function getInitialSchemaStructure() |
|
175 | - { |
|
176 | - return array( |
|
177 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
178 | - 'title' => $this->model->get_this_model_name(), |
|
179 | - 'type' => 'object', |
|
180 | - 'properties' => array( |
|
181 | - 'link' => array( |
|
182 | - 'description' => esc_html__( |
|
183 | - 'Link to event on WordPress site hosting events.', |
|
184 | - 'event_espresso' |
|
185 | - ), |
|
186 | - 'type' => 'string', |
|
187 | - 'readonly' => true, |
|
188 | - ), |
|
189 | - '_links' => array( |
|
190 | - 'description' => esc_html__( |
|
191 | - 'Various links for resources related to the entity.', |
|
192 | - 'event_espresso' |
|
193 | - ), |
|
194 | - 'type' => 'object', |
|
195 | - 'readonly' => true, |
|
196 | - 'properties' => array( |
|
197 | - 'self' => array( |
|
198 | - 'description' => esc_html__( |
|
199 | - 'Link to this entities resource.', |
|
200 | - 'event_espresso' |
|
201 | - ), |
|
202 | - 'type' => 'array', |
|
203 | - 'items' => array( |
|
204 | - 'type' => 'object', |
|
205 | - 'properties' => array( |
|
206 | - 'href' => array( |
|
207 | - 'type' => 'string', |
|
208 | - ), |
|
209 | - ), |
|
210 | - 'additionalProperties' => false |
|
211 | - ), |
|
212 | - 'readonly' => true |
|
213 | - ), |
|
214 | - 'collection' => array( |
|
215 | - 'description' => esc_html__( |
|
216 | - 'Link to this entities collection resource.', |
|
217 | - 'event_espresso' |
|
218 | - ), |
|
219 | - 'type' => 'array', |
|
220 | - 'items' => array( |
|
221 | - 'type' => 'object', |
|
222 | - 'properties' => array( |
|
223 | - 'href' => array( |
|
224 | - 'type' => 'string' |
|
225 | - ), |
|
226 | - ), |
|
227 | - 'additionalProperties' => false |
|
228 | - ), |
|
229 | - 'readonly' => true |
|
230 | - ), |
|
231 | - ), |
|
232 | - 'additionalProperties' => false, |
|
233 | - ), |
|
234 | - '_calculated_fields' => array_merge( |
|
235 | - $this->fields_calculator->getJsonSchemaForModel($this->model), |
|
236 | - array( |
|
237 | - '_protected' => $this->getProtectedFieldsSchema() |
|
238 | - ) |
|
239 | - ), |
|
240 | - '_protected' => $this->getProtectedFieldsSchema() |
|
241 | - ), |
|
242 | - 'additionalProperties' => false, |
|
243 | - ); |
|
244 | - } |
|
169 | + /** |
|
170 | + * Outputs the schema header for a model. |
|
171 | + * |
|
172 | + * @return array |
|
173 | + */ |
|
174 | + public function getInitialSchemaStructure() |
|
175 | + { |
|
176 | + return array( |
|
177 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
178 | + 'title' => $this->model->get_this_model_name(), |
|
179 | + 'type' => 'object', |
|
180 | + 'properties' => array( |
|
181 | + 'link' => array( |
|
182 | + 'description' => esc_html__( |
|
183 | + 'Link to event on WordPress site hosting events.', |
|
184 | + 'event_espresso' |
|
185 | + ), |
|
186 | + 'type' => 'string', |
|
187 | + 'readonly' => true, |
|
188 | + ), |
|
189 | + '_links' => array( |
|
190 | + 'description' => esc_html__( |
|
191 | + 'Various links for resources related to the entity.', |
|
192 | + 'event_espresso' |
|
193 | + ), |
|
194 | + 'type' => 'object', |
|
195 | + 'readonly' => true, |
|
196 | + 'properties' => array( |
|
197 | + 'self' => array( |
|
198 | + 'description' => esc_html__( |
|
199 | + 'Link to this entities resource.', |
|
200 | + 'event_espresso' |
|
201 | + ), |
|
202 | + 'type' => 'array', |
|
203 | + 'items' => array( |
|
204 | + 'type' => 'object', |
|
205 | + 'properties' => array( |
|
206 | + 'href' => array( |
|
207 | + 'type' => 'string', |
|
208 | + ), |
|
209 | + ), |
|
210 | + 'additionalProperties' => false |
|
211 | + ), |
|
212 | + 'readonly' => true |
|
213 | + ), |
|
214 | + 'collection' => array( |
|
215 | + 'description' => esc_html__( |
|
216 | + 'Link to this entities collection resource.', |
|
217 | + 'event_espresso' |
|
218 | + ), |
|
219 | + 'type' => 'array', |
|
220 | + 'items' => array( |
|
221 | + 'type' => 'object', |
|
222 | + 'properties' => array( |
|
223 | + 'href' => array( |
|
224 | + 'type' => 'string' |
|
225 | + ), |
|
226 | + ), |
|
227 | + 'additionalProperties' => false |
|
228 | + ), |
|
229 | + 'readonly' => true |
|
230 | + ), |
|
231 | + ), |
|
232 | + 'additionalProperties' => false, |
|
233 | + ), |
|
234 | + '_calculated_fields' => array_merge( |
|
235 | + $this->fields_calculator->getJsonSchemaForModel($this->model), |
|
236 | + array( |
|
237 | + '_protected' => $this->getProtectedFieldsSchema() |
|
238 | + ) |
|
239 | + ), |
|
240 | + '_protected' => $this->getProtectedFieldsSchema() |
|
241 | + ), |
|
242 | + 'additionalProperties' => false, |
|
243 | + ); |
|
244 | + } |
|
245 | 245 | |
246 | - /** |
|
247 | - * Returns an array of JSON schema to describe the _protected property on responses |
|
248 | - * @since 4.9.74.p |
|
249 | - * @return array |
|
250 | - */ |
|
251 | - protected function getProtectedFieldsSchema() |
|
252 | - { |
|
253 | - return array( |
|
254 | - 'description' => esc_html__('Array of property names whose values were replaced with their default (because they are related to a password-protected entity.)', 'event_espresso'), |
|
255 | - 'type' => 'array', |
|
256 | - 'items' => array( |
|
257 | - 'description' => esc_html__('Each name corresponds to a property that is protected by password for this entity and has its default value returned in the response.', 'event_espresso'), |
|
258 | - 'type' => 'string', |
|
259 | - 'readonly' => true, |
|
260 | - ), |
|
261 | - 'readonly' => true |
|
262 | - ); |
|
263 | - } |
|
246 | + /** |
|
247 | + * Returns an array of JSON schema to describe the _protected property on responses |
|
248 | + * @since 4.9.74.p |
|
249 | + * @return array |
|
250 | + */ |
|
251 | + protected function getProtectedFieldsSchema() |
|
252 | + { |
|
253 | + return array( |
|
254 | + 'description' => esc_html__('Array of property names whose values were replaced with their default (because they are related to a password-protected entity.)', 'event_espresso'), |
|
255 | + 'type' => 'array', |
|
256 | + 'items' => array( |
|
257 | + 'description' => esc_html__('Each name corresponds to a property that is protected by password for this entity and has its default value returned in the response.', 'event_espresso'), |
|
258 | + 'type' => 'string', |
|
259 | + 'readonly' => true, |
|
260 | + ), |
|
261 | + 'readonly' => true |
|
262 | + ); |
|
263 | + } |
|
264 | 264 | |
265 | 265 | |
266 | - /** |
|
267 | - * Allows one to just use the object as a string to get the json. |
|
268 | - * eg. |
|
269 | - * $json_schema = new JsonModelSchema(EEM_Event::instance(), new CalculatedModelFields); |
|
270 | - * // if echoed, would convert schema to a json formatted string. |
|
271 | - * |
|
272 | - * @return bool|false|mixed|string |
|
273 | - */ |
|
274 | - public function __toString() |
|
275 | - { |
|
276 | - return wp_json_encode($this->getModelSchema()); |
|
277 | - } |
|
266 | + /** |
|
267 | + * Allows one to just use the object as a string to get the json. |
|
268 | + * eg. |
|
269 | + * $json_schema = new JsonModelSchema(EEM_Event::instance(), new CalculatedModelFields); |
|
270 | + * // if echoed, would convert schema to a json formatted string. |
|
271 | + * |
|
272 | + * @return bool|false|mixed|string |
|
273 | + */ |
|
274 | + public function __toString() |
|
275 | + { |
|
276 | + return wp_json_encode($this->getModelSchema()); |
|
277 | + } |
|
278 | 278 | } |