@@ -18,104 +18,104 @@ |
||
18 | 18 | class CommandHandlerManager implements CommandHandlerManagerInterface |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * @var CommandHandlerInterface[] $command_handlers |
|
23 | - */ |
|
24 | - protected $command_handlers; |
|
21 | + /** |
|
22 | + * @var CommandHandlerInterface[] $command_handlers |
|
23 | + */ |
|
24 | + protected $command_handlers; |
|
25 | 25 | |
26 | - /** |
|
27 | - * @type LoaderInterface $loader |
|
28 | - */ |
|
29 | - private $loader; |
|
26 | + /** |
|
27 | + * @type LoaderInterface $loader |
|
28 | + */ |
|
29 | + private $loader; |
|
30 | 30 | |
31 | 31 | |
32 | - /** |
|
33 | - * CommandHandlerManager constructor |
|
34 | - * |
|
35 | - * @param LoaderInterface $loader |
|
36 | - */ |
|
37 | - public function __construct(LoaderInterface $loader) |
|
38 | - { |
|
39 | - $this->loader = $loader; |
|
40 | - } |
|
32 | + /** |
|
33 | + * CommandHandlerManager constructor |
|
34 | + * |
|
35 | + * @param LoaderInterface $loader |
|
36 | + */ |
|
37 | + public function __construct(LoaderInterface $loader) |
|
38 | + { |
|
39 | + $this->loader = $loader; |
|
40 | + } |
|
41 | 41 | |
42 | 42 | |
43 | - /** |
|
44 | - * By default, Commands and CommandHandlers would normally |
|
45 | - * reside in the same folder under the same namespace, |
|
46 | - * and the names of the two classes would only differ in that |
|
47 | - * one ends in "Command" and the other ends in "CommandHandler". |
|
48 | - * However, if you wanted to utilize a CommandHandler from somewhere else, |
|
49 | - * then this method allows you to add that CommandHandler and specify the FQCN |
|
50 | - * (Fully Qualified ClassName) for the Command class that it should be used for. |
|
51 | - * For example: |
|
52 | - * by default the "Vendor\some\namespace\DoSomethingCommand" |
|
53 | - * would resolve to using "Vendor\some\namespace\DoSomethingCommandHandler" |
|
54 | - * but if you wanted to instead process that commend using: |
|
55 | - * "Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler" |
|
56 | - * then the following code: |
|
57 | - * $CommandHandlerManager = $this->loader->getShared( 'CommandHandlerManagerInterface' ); |
|
58 | - * $CommandHandlerManager->addCommandHandler( |
|
59 | - * new Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler(), |
|
60 | - * 'Vendor\some\namespace\DoSomethingCommand' |
|
61 | - * ); |
|
62 | - * would result in the alternate CommandHandler being used to process that Command |
|
63 | - * |
|
64 | - * @param CommandHandlerInterface $command_handler |
|
65 | - * @param string $fqcn_for_command Fully Qualified ClassName for Command |
|
66 | - * @return void |
|
67 | - * @throws InvalidCommandHandlerException |
|
68 | - */ |
|
69 | - public function addCommandHandler(CommandHandlerInterface $command_handler, $fqcn_for_command = '') |
|
70 | - { |
|
71 | - $command = ! empty($fqcn_for_command) |
|
72 | - ? $fqcn_for_command |
|
73 | - : str_replace('CommandHandler', 'Command', get_class($command_handler)); |
|
74 | - if (empty($command)) { |
|
75 | - throw new InvalidCommandHandlerException($command); |
|
76 | - } |
|
77 | - $this->command_handlers[ $command ] = $command_handler; |
|
78 | - } |
|
43 | + /** |
|
44 | + * By default, Commands and CommandHandlers would normally |
|
45 | + * reside in the same folder under the same namespace, |
|
46 | + * and the names of the two classes would only differ in that |
|
47 | + * one ends in "Command" and the other ends in "CommandHandler". |
|
48 | + * However, if you wanted to utilize a CommandHandler from somewhere else, |
|
49 | + * then this method allows you to add that CommandHandler and specify the FQCN |
|
50 | + * (Fully Qualified ClassName) for the Command class that it should be used for. |
|
51 | + * For example: |
|
52 | + * by default the "Vendor\some\namespace\DoSomethingCommand" |
|
53 | + * would resolve to using "Vendor\some\namespace\DoSomethingCommandHandler" |
|
54 | + * but if you wanted to instead process that commend using: |
|
55 | + * "Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler" |
|
56 | + * then the following code: |
|
57 | + * $CommandHandlerManager = $this->loader->getShared( 'CommandHandlerManagerInterface' ); |
|
58 | + * $CommandHandlerManager->addCommandHandler( |
|
59 | + * new Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler(), |
|
60 | + * 'Vendor\some\namespace\DoSomethingCommand' |
|
61 | + * ); |
|
62 | + * would result in the alternate CommandHandler being used to process that Command |
|
63 | + * |
|
64 | + * @param CommandHandlerInterface $command_handler |
|
65 | + * @param string $fqcn_for_command Fully Qualified ClassName for Command |
|
66 | + * @return void |
|
67 | + * @throws InvalidCommandHandlerException |
|
68 | + */ |
|
69 | + public function addCommandHandler(CommandHandlerInterface $command_handler, $fqcn_for_command = '') |
|
70 | + { |
|
71 | + $command = ! empty($fqcn_for_command) |
|
72 | + ? $fqcn_for_command |
|
73 | + : str_replace('CommandHandler', 'Command', get_class($command_handler)); |
|
74 | + if (empty($command)) { |
|
75 | + throw new InvalidCommandHandlerException($command); |
|
76 | + } |
|
77 | + $this->command_handlers[ $command ] = $command_handler; |
|
78 | + } |
|
79 | 79 | |
80 | 80 | |
81 | - /** |
|
82 | - * @param CommandInterface $command |
|
83 | - * @param CommandBusInterface $command_bus |
|
84 | - * @return mixed |
|
85 | - * @throws DomainException |
|
86 | - * @throws CommandHandlerNotFoundException |
|
87 | - */ |
|
88 | - public function getCommandHandler(CommandInterface $command, CommandBusInterface $command_bus = null) |
|
89 | - { |
|
90 | - $command_name = get_class($command); |
|
91 | - $command_handler = apply_filters( |
|
92 | - 'FHEE__EventEspresso_core_services_commands_CommandHandlerManager__getCommandHandler__command_handler', |
|
93 | - str_replace('Command', 'CommandHandler', $command_name), |
|
94 | - $command |
|
95 | - ); |
|
96 | - $handler = null; |
|
97 | - // has a command handler already been set for this class ? |
|
98 | - // if not, can we find one via the FQCN ? |
|
99 | - if (isset($this->command_handlers[ $command_name ])) { |
|
100 | - $handler = $this->command_handlers[ $command_name ]; |
|
101 | - } elseif (class_exists($command_handler)) { |
|
102 | - $handler = $this->loader->getShared($command_handler); |
|
103 | - } |
|
104 | - // if Handler requires an instance of the CommandBus, but that has not yet been set |
|
105 | - if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) { |
|
106 | - if (! $command_bus instanceof CommandBusInterface) { |
|
107 | - throw new DomainException( |
|
108 | - esc_html__( |
|
109 | - 'CompositeCommandHandler classes require an instance of the CommandBus.', |
|
110 | - 'event_espresso' |
|
111 | - ) |
|
112 | - ); |
|
113 | - } |
|
114 | - $handler->setCommandBus($command_bus); |
|
115 | - } |
|
116 | - if ($handler instanceof CommandHandlerInterface) { |
|
117 | - return $handler; |
|
118 | - } |
|
119 | - throw new CommandHandlerNotFoundException($command_handler); |
|
120 | - } |
|
81 | + /** |
|
82 | + * @param CommandInterface $command |
|
83 | + * @param CommandBusInterface $command_bus |
|
84 | + * @return mixed |
|
85 | + * @throws DomainException |
|
86 | + * @throws CommandHandlerNotFoundException |
|
87 | + */ |
|
88 | + public function getCommandHandler(CommandInterface $command, CommandBusInterface $command_bus = null) |
|
89 | + { |
|
90 | + $command_name = get_class($command); |
|
91 | + $command_handler = apply_filters( |
|
92 | + 'FHEE__EventEspresso_core_services_commands_CommandHandlerManager__getCommandHandler__command_handler', |
|
93 | + str_replace('Command', 'CommandHandler', $command_name), |
|
94 | + $command |
|
95 | + ); |
|
96 | + $handler = null; |
|
97 | + // has a command handler already been set for this class ? |
|
98 | + // if not, can we find one via the FQCN ? |
|
99 | + if (isset($this->command_handlers[ $command_name ])) { |
|
100 | + $handler = $this->command_handlers[ $command_name ]; |
|
101 | + } elseif (class_exists($command_handler)) { |
|
102 | + $handler = $this->loader->getShared($command_handler); |
|
103 | + } |
|
104 | + // if Handler requires an instance of the CommandBus, but that has not yet been set |
|
105 | + if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) { |
|
106 | + if (! $command_bus instanceof CommandBusInterface) { |
|
107 | + throw new DomainException( |
|
108 | + esc_html__( |
|
109 | + 'CompositeCommandHandler classes require an instance of the CommandBus.', |
|
110 | + 'event_espresso' |
|
111 | + ) |
|
112 | + ); |
|
113 | + } |
|
114 | + $handler->setCommandBus($command_bus); |
|
115 | + } |
|
116 | + if ($handler instanceof CommandHandlerInterface) { |
|
117 | + return $handler; |
|
118 | + } |
|
119 | + throw new CommandHandlerNotFoundException($command_handler); |
|
120 | + } |
|
121 | 121 | } |
@@ -74,7 +74,7 @@ discard block |
||
74 | 74 | if (empty($command)) { |
75 | 75 | throw new InvalidCommandHandlerException($command); |
76 | 76 | } |
77 | - $this->command_handlers[ $command ] = $command_handler; |
|
77 | + $this->command_handlers[$command] = $command_handler; |
|
78 | 78 | } |
79 | 79 | |
80 | 80 | |
@@ -96,14 +96,14 @@ discard block |
||
96 | 96 | $handler = null; |
97 | 97 | // has a command handler already been set for this class ? |
98 | 98 | // if not, can we find one via the FQCN ? |
99 | - if (isset($this->command_handlers[ $command_name ])) { |
|
100 | - $handler = $this->command_handlers[ $command_name ]; |
|
99 | + if (isset($this->command_handlers[$command_name])) { |
|
100 | + $handler = $this->command_handlers[$command_name]; |
|
101 | 101 | } elseif (class_exists($command_handler)) { |
102 | 102 | $handler = $this->loader->getShared($command_handler); |
103 | 103 | } |
104 | 104 | // if Handler requires an instance of the CommandBus, but that has not yet been set |
105 | 105 | if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) { |
106 | - if (! $command_bus instanceof CommandBusInterface) { |
|
106 | + if ( ! $command_bus instanceof CommandBusInterface) { |
|
107 | 107 | throw new DomainException( |
108 | 108 | esc_html__( |
109 | 109 | 'CompositeCommandHandler classes require an instance of the CommandBus.', |
@@ -14,253 +14,253 @@ |
||
14 | 14 | class Notice implements NoticeInterface |
15 | 15 | { |
16 | 16 | |
17 | - const ERROR = 'error'; |
|
18 | - |
|
19 | - const SUCCESS = 'success'; |
|
20 | - |
|
21 | - const ATTENTION = 'attention'; // alias for warning |
|
22 | - |
|
23 | - const INFORMATION = 'information'; |
|
24 | - |
|
25 | - /** |
|
26 | - * @var string $type |
|
27 | - */ |
|
28 | - private $type; |
|
29 | - |
|
30 | - |
|
31 | - /** |
|
32 | - * @var string $message |
|
33 | - */ |
|
34 | - private $message; |
|
35 | - |
|
36 | - |
|
37 | - /** |
|
38 | - * @var string $file |
|
39 | - */ |
|
40 | - private $file; |
|
41 | - |
|
42 | - |
|
43 | - /** |
|
44 | - * @var string $func |
|
45 | - */ |
|
46 | - private $func; |
|
47 | - |
|
48 | - |
|
49 | - /** |
|
50 | - * @var string $line |
|
51 | - */ |
|
52 | - private $line; |
|
53 | - |
|
54 | - |
|
55 | - /** |
|
56 | - * @var boolean $dismissible |
|
57 | - */ |
|
58 | - private $dismissible; |
|
59 | - |
|
60 | - |
|
61 | - /** |
|
62 | - * Notice constructor. |
|
63 | - * |
|
64 | - * @param string $type |
|
65 | - * @param string $message |
|
66 | - * @param bool $dismissible |
|
67 | - * @param string $file |
|
68 | - * @param string $func |
|
69 | - * @param string $line |
|
70 | - * @throws InvalidDataTypeException |
|
71 | - */ |
|
72 | - public function __construct($type, $message, $dismissible = true, $file = '', $func = '', $line = '') |
|
73 | - { |
|
74 | - $this->setType($type); |
|
75 | - $this->setMessage($message); |
|
76 | - $this->setDismissible($dismissible); |
|
77 | - $this->setFile($file); |
|
78 | - $this->setFunc($func); |
|
79 | - $this->setLine($line); |
|
80 | - } |
|
81 | - |
|
82 | - |
|
83 | - /** |
|
84 | - * @return array |
|
85 | - */ |
|
86 | - private function types() |
|
87 | - { |
|
88 | - return (array) apply_filters( |
|
89 | - 'FHEE__EventEspresso_core_services_notices_Notice__types', |
|
90 | - array( |
|
91 | - Notice::ERROR, |
|
92 | - Notice::SUCCESS, |
|
93 | - Notice::ATTENTION, |
|
94 | - Notice::INFORMATION, |
|
95 | - ) |
|
96 | - ); |
|
97 | - } |
|
98 | - |
|
99 | - |
|
100 | - /** |
|
101 | - * @return string |
|
102 | - */ |
|
103 | - public function type() |
|
104 | - { |
|
105 | - return $this->type; |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * @return string |
|
111 | - */ |
|
112 | - public function message() |
|
113 | - { |
|
114 | - return $this->message; |
|
115 | - } |
|
116 | - |
|
117 | - |
|
118 | - /** |
|
119 | - * @return string |
|
120 | - */ |
|
121 | - public function file() |
|
122 | - { |
|
123 | - return $this->file; |
|
124 | - } |
|
125 | - |
|
126 | - |
|
127 | - /** |
|
128 | - * @return string |
|
129 | - */ |
|
130 | - public function func() |
|
131 | - { |
|
132 | - return $this->func; |
|
133 | - } |
|
134 | - |
|
135 | - |
|
136 | - /** |
|
137 | - * @return string |
|
138 | - */ |
|
139 | - public function line() |
|
140 | - { |
|
141 | - return $this->line; |
|
142 | - } |
|
143 | - |
|
144 | - |
|
145 | - /** |
|
146 | - * @return bool |
|
147 | - */ |
|
148 | - public function isDismissible() |
|
149 | - { |
|
150 | - return $this->dismissible; |
|
151 | - } |
|
152 | - |
|
153 | - |
|
154 | - /** |
|
155 | - * @param string $type |
|
156 | - * @throws InvalidDataTypeException |
|
157 | - */ |
|
158 | - private function setType($type) |
|
159 | - { |
|
160 | - if (! in_array($type, $this->types(), true)) { |
|
161 | - throw new InvalidDataTypeException( |
|
162 | - '$type', |
|
163 | - $type, |
|
164 | - $this->invalidTypeMessage() |
|
165 | - ); |
|
166 | - } |
|
167 | - $this->type = $type; |
|
168 | - } |
|
169 | - |
|
170 | - |
|
171 | - /** |
|
172 | - * gets the $invalid_type_message string |
|
173 | - */ |
|
174 | - private function invalidTypeMessage() |
|
175 | - { |
|
176 | - return apply_filters( |
|
177 | - 'FHEE__EventEspresso_core_services_notices_Notice__invalidTypeMessage', |
|
178 | - sprintf( |
|
179 | - esc_html__( |
|
180 | - ' one of the following notice types was expected: %1$s %2$s', |
|
181 | - 'event_espresso' |
|
182 | - ), |
|
183 | - '<br />', |
|
184 | - var_export($this->types(), true) |
|
185 | - ) |
|
186 | - ); |
|
187 | - } |
|
188 | - |
|
189 | - |
|
190 | - /** |
|
191 | - * @param string $message |
|
192 | - * @throws InvalidDataTypeException |
|
193 | - */ |
|
194 | - private function setMessage($message) |
|
195 | - { |
|
196 | - if (empty($message) || ! is_string($message)) { |
|
197 | - throw new InvalidDataTypeException( |
|
198 | - '$message', |
|
199 | - $message, |
|
200 | - esc_html__('non empty string', 'event_espresso') |
|
201 | - ); |
|
202 | - } |
|
203 | - $this->message = $message; |
|
204 | - } |
|
205 | - |
|
206 | - |
|
207 | - /** |
|
208 | - * @param string $file |
|
209 | - * @throws InvalidDataTypeException |
|
210 | - */ |
|
211 | - private function setFile($file) |
|
212 | - { |
|
213 | - if ($this->type === Notice::ERROR && (empty($file) || ! is_string($file))) { |
|
214 | - throw new InvalidDataTypeException( |
|
215 | - '$file', |
|
216 | - $file, |
|
217 | - esc_html__('non empty string', 'event_espresso') |
|
218 | - ); |
|
219 | - } |
|
220 | - $this->file = $file; |
|
221 | - } |
|
222 | - |
|
223 | - |
|
224 | - /** |
|
225 | - * @param string $func |
|
226 | - * @throws InvalidDataTypeException |
|
227 | - */ |
|
228 | - private function setFunc($func) |
|
229 | - { |
|
230 | - if ($this->type === Notice::ERROR && (empty($func) || ! is_string($func))) { |
|
231 | - throw new InvalidDataTypeException( |
|
232 | - '$func', |
|
233 | - $func, |
|
234 | - esc_html__('non empty string', 'event_espresso') |
|
235 | - ); |
|
236 | - } |
|
237 | - $this->func = $func; |
|
238 | - } |
|
239 | - |
|
240 | - |
|
241 | - /** |
|
242 | - * @param int $line |
|
243 | - * @throws InvalidDataTypeException |
|
244 | - */ |
|
245 | - private function setLine($line) |
|
246 | - { |
|
247 | - $line = absint($line); |
|
248 | - if ($this->type === Notice::ERROR && $line === 0) { |
|
249 | - throw new InvalidDataTypeException( |
|
250 | - '$line', |
|
251 | - $line, |
|
252 | - esc_html__('integer', 'event_espresso') |
|
253 | - ); |
|
254 | - } |
|
255 | - $this->line = $line; |
|
256 | - } |
|
257 | - |
|
258 | - |
|
259 | - /** |
|
260 | - * @param boolean $dismissible |
|
261 | - */ |
|
262 | - private function setDismissible($dismissible = true) |
|
263 | - { |
|
264 | - $this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN); |
|
265 | - } |
|
17 | + const ERROR = 'error'; |
|
18 | + |
|
19 | + const SUCCESS = 'success'; |
|
20 | + |
|
21 | + const ATTENTION = 'attention'; // alias for warning |
|
22 | + |
|
23 | + const INFORMATION = 'information'; |
|
24 | + |
|
25 | + /** |
|
26 | + * @var string $type |
|
27 | + */ |
|
28 | + private $type; |
|
29 | + |
|
30 | + |
|
31 | + /** |
|
32 | + * @var string $message |
|
33 | + */ |
|
34 | + private $message; |
|
35 | + |
|
36 | + |
|
37 | + /** |
|
38 | + * @var string $file |
|
39 | + */ |
|
40 | + private $file; |
|
41 | + |
|
42 | + |
|
43 | + /** |
|
44 | + * @var string $func |
|
45 | + */ |
|
46 | + private $func; |
|
47 | + |
|
48 | + |
|
49 | + /** |
|
50 | + * @var string $line |
|
51 | + */ |
|
52 | + private $line; |
|
53 | + |
|
54 | + |
|
55 | + /** |
|
56 | + * @var boolean $dismissible |
|
57 | + */ |
|
58 | + private $dismissible; |
|
59 | + |
|
60 | + |
|
61 | + /** |
|
62 | + * Notice constructor. |
|
63 | + * |
|
64 | + * @param string $type |
|
65 | + * @param string $message |
|
66 | + * @param bool $dismissible |
|
67 | + * @param string $file |
|
68 | + * @param string $func |
|
69 | + * @param string $line |
|
70 | + * @throws InvalidDataTypeException |
|
71 | + */ |
|
72 | + public function __construct($type, $message, $dismissible = true, $file = '', $func = '', $line = '') |
|
73 | + { |
|
74 | + $this->setType($type); |
|
75 | + $this->setMessage($message); |
|
76 | + $this->setDismissible($dismissible); |
|
77 | + $this->setFile($file); |
|
78 | + $this->setFunc($func); |
|
79 | + $this->setLine($line); |
|
80 | + } |
|
81 | + |
|
82 | + |
|
83 | + /** |
|
84 | + * @return array |
|
85 | + */ |
|
86 | + private function types() |
|
87 | + { |
|
88 | + return (array) apply_filters( |
|
89 | + 'FHEE__EventEspresso_core_services_notices_Notice__types', |
|
90 | + array( |
|
91 | + Notice::ERROR, |
|
92 | + Notice::SUCCESS, |
|
93 | + Notice::ATTENTION, |
|
94 | + Notice::INFORMATION, |
|
95 | + ) |
|
96 | + ); |
|
97 | + } |
|
98 | + |
|
99 | + |
|
100 | + /** |
|
101 | + * @return string |
|
102 | + */ |
|
103 | + public function type() |
|
104 | + { |
|
105 | + return $this->type; |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * @return string |
|
111 | + */ |
|
112 | + public function message() |
|
113 | + { |
|
114 | + return $this->message; |
|
115 | + } |
|
116 | + |
|
117 | + |
|
118 | + /** |
|
119 | + * @return string |
|
120 | + */ |
|
121 | + public function file() |
|
122 | + { |
|
123 | + return $this->file; |
|
124 | + } |
|
125 | + |
|
126 | + |
|
127 | + /** |
|
128 | + * @return string |
|
129 | + */ |
|
130 | + public function func() |
|
131 | + { |
|
132 | + return $this->func; |
|
133 | + } |
|
134 | + |
|
135 | + |
|
136 | + /** |
|
137 | + * @return string |
|
138 | + */ |
|
139 | + public function line() |
|
140 | + { |
|
141 | + return $this->line; |
|
142 | + } |
|
143 | + |
|
144 | + |
|
145 | + /** |
|
146 | + * @return bool |
|
147 | + */ |
|
148 | + public function isDismissible() |
|
149 | + { |
|
150 | + return $this->dismissible; |
|
151 | + } |
|
152 | + |
|
153 | + |
|
154 | + /** |
|
155 | + * @param string $type |
|
156 | + * @throws InvalidDataTypeException |
|
157 | + */ |
|
158 | + private function setType($type) |
|
159 | + { |
|
160 | + if (! in_array($type, $this->types(), true)) { |
|
161 | + throw new InvalidDataTypeException( |
|
162 | + '$type', |
|
163 | + $type, |
|
164 | + $this->invalidTypeMessage() |
|
165 | + ); |
|
166 | + } |
|
167 | + $this->type = $type; |
|
168 | + } |
|
169 | + |
|
170 | + |
|
171 | + /** |
|
172 | + * gets the $invalid_type_message string |
|
173 | + */ |
|
174 | + private function invalidTypeMessage() |
|
175 | + { |
|
176 | + return apply_filters( |
|
177 | + 'FHEE__EventEspresso_core_services_notices_Notice__invalidTypeMessage', |
|
178 | + sprintf( |
|
179 | + esc_html__( |
|
180 | + ' one of the following notice types was expected: %1$s %2$s', |
|
181 | + 'event_espresso' |
|
182 | + ), |
|
183 | + '<br />', |
|
184 | + var_export($this->types(), true) |
|
185 | + ) |
|
186 | + ); |
|
187 | + } |
|
188 | + |
|
189 | + |
|
190 | + /** |
|
191 | + * @param string $message |
|
192 | + * @throws InvalidDataTypeException |
|
193 | + */ |
|
194 | + private function setMessage($message) |
|
195 | + { |
|
196 | + if (empty($message) || ! is_string($message)) { |
|
197 | + throw new InvalidDataTypeException( |
|
198 | + '$message', |
|
199 | + $message, |
|
200 | + esc_html__('non empty string', 'event_espresso') |
|
201 | + ); |
|
202 | + } |
|
203 | + $this->message = $message; |
|
204 | + } |
|
205 | + |
|
206 | + |
|
207 | + /** |
|
208 | + * @param string $file |
|
209 | + * @throws InvalidDataTypeException |
|
210 | + */ |
|
211 | + private function setFile($file) |
|
212 | + { |
|
213 | + if ($this->type === Notice::ERROR && (empty($file) || ! is_string($file))) { |
|
214 | + throw new InvalidDataTypeException( |
|
215 | + '$file', |
|
216 | + $file, |
|
217 | + esc_html__('non empty string', 'event_espresso') |
|
218 | + ); |
|
219 | + } |
|
220 | + $this->file = $file; |
|
221 | + } |
|
222 | + |
|
223 | + |
|
224 | + /** |
|
225 | + * @param string $func |
|
226 | + * @throws InvalidDataTypeException |
|
227 | + */ |
|
228 | + private function setFunc($func) |
|
229 | + { |
|
230 | + if ($this->type === Notice::ERROR && (empty($func) || ! is_string($func))) { |
|
231 | + throw new InvalidDataTypeException( |
|
232 | + '$func', |
|
233 | + $func, |
|
234 | + esc_html__('non empty string', 'event_espresso') |
|
235 | + ); |
|
236 | + } |
|
237 | + $this->func = $func; |
|
238 | + } |
|
239 | + |
|
240 | + |
|
241 | + /** |
|
242 | + * @param int $line |
|
243 | + * @throws InvalidDataTypeException |
|
244 | + */ |
|
245 | + private function setLine($line) |
|
246 | + { |
|
247 | + $line = absint($line); |
|
248 | + if ($this->type === Notice::ERROR && $line === 0) { |
|
249 | + throw new InvalidDataTypeException( |
|
250 | + '$line', |
|
251 | + $line, |
|
252 | + esc_html__('integer', 'event_espresso') |
|
253 | + ); |
|
254 | + } |
|
255 | + $this->line = $line; |
|
256 | + } |
|
257 | + |
|
258 | + |
|
259 | + /** |
|
260 | + * @param boolean $dismissible |
|
261 | + */ |
|
262 | + private function setDismissible($dismissible = true) |
|
263 | + { |
|
264 | + $this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN); |
|
265 | + } |
|
266 | 266 | } |
@@ -157,7 +157,7 @@ |
||
157 | 157 | */ |
158 | 158 | private function setType($type) |
159 | 159 | { |
160 | - if (! in_array($type, $this->types(), true)) { |
|
160 | + if ( ! in_array($type, $this->types(), true)) { |
|
161 | 161 | throw new InvalidDataTypeException( |
162 | 162 | '$type', |
163 | 163 | $type, |
@@ -18,371 +18,371 @@ |
||
18 | 18 | class Iframe |
19 | 19 | { |
20 | 20 | |
21 | - /* |
|
21 | + /* |
|
22 | 22 | * HTML for notices and ajax gif |
23 | 23 | * @var string $title |
24 | 24 | */ |
25 | - protected $title = ''; |
|
25 | + protected $title = ''; |
|
26 | 26 | |
27 | - /* |
|
27 | + /* |
|
28 | 28 | * HTML for the content being displayed |
29 | 29 | * @var string $content |
30 | 30 | */ |
31 | - protected $content = ''; |
|
31 | + protected $content = ''; |
|
32 | 32 | |
33 | - /* |
|
33 | + /* |
|
34 | 34 | * whether or not to call wp_head() and wp_footer() |
35 | 35 | * @var boolean $enqueue_wp_assets |
36 | 36 | */ |
37 | - protected $enqueue_wp_assets = false; |
|
37 | + protected $enqueue_wp_assets = false; |
|
38 | 38 | |
39 | - /* |
|
39 | + /* |
|
40 | 40 | * an array of CSS URLs |
41 | 41 | * @var array $css |
42 | 42 | */ |
43 | - protected $css = array(); |
|
43 | + protected $css = array(); |
|
44 | 44 | |
45 | - /* |
|
45 | + /* |
|
46 | 46 | * an array of JS URLs to be set in the HTML header. |
47 | 47 | * @var array $header_js |
48 | 48 | */ |
49 | - protected $header_js = array(); |
|
49 | + protected $header_js = array(); |
|
50 | 50 | |
51 | - /* |
|
51 | + /* |
|
52 | 52 | * an array of additional attributes to be added to <script> tags for header JS |
53 | 53 | * @var array $footer_js |
54 | 54 | */ |
55 | - protected $header_js_attributes = array(); |
|
55 | + protected $header_js_attributes = array(); |
|
56 | 56 | |
57 | - /* |
|
57 | + /* |
|
58 | 58 | * an array of JS URLs to be displayed before the HTML </body> tag |
59 | 59 | * @var array $footer_js |
60 | 60 | */ |
61 | - protected $footer_js = array(); |
|
61 | + protected $footer_js = array(); |
|
62 | 62 | |
63 | - /* |
|
63 | + /* |
|
64 | 64 | * an array of additional attributes to be added to <script> tags for footer JS |
65 | 65 | * @var array $footer_js_attributes |
66 | 66 | */ |
67 | - protected $footer_js_attributes = array(); |
|
67 | + protected $footer_js_attributes = array(); |
|
68 | 68 | |
69 | - /* |
|
69 | + /* |
|
70 | 70 | * an array of JSON vars to be set in the HTML header. |
71 | 71 | * @var array $localized_vars |
72 | 72 | */ |
73 | - protected $localized_vars = array(); |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * Iframe constructor |
|
78 | - * |
|
79 | - * @param string $title |
|
80 | - * @param string $content |
|
81 | - * @throws DomainException |
|
82 | - */ |
|
83 | - public function __construct($title, $content) |
|
84 | - { |
|
85 | - global $wp_version; |
|
86 | - if (! defined('EE_IFRAME_DIR_URL')) { |
|
87 | - define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__)); |
|
88 | - } |
|
89 | - $this->setContent($content); |
|
90 | - $this->setTitle($title); |
|
91 | - $this->addStylesheets( |
|
92 | - apply_filters( |
|
93 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css', |
|
94 | - array( |
|
95 | - 'site_theme' => get_stylesheet_directory_uri() . DS |
|
96 | - . 'style.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
97 | - 'dashicons' => includes_url('css/dashicons.min.css?ver=' . $wp_version), |
|
98 | - 'espresso_default' => EE_GLOBAL_ASSETS_URL |
|
99 | - . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
100 | - ), |
|
101 | - $this |
|
102 | - ) |
|
103 | - ); |
|
104 | - $this->addScripts( |
|
105 | - apply_filters( |
|
106 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js', |
|
107 | - array( |
|
108 | - 'jquery' => includes_url('js/jquery/jquery.js?ver=' . $wp_version), |
|
109 | - 'espresso_core' => EE_GLOBAL_ASSETS_URL |
|
110 | - . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION, |
|
111 | - ), |
|
112 | - $this |
|
113 | - ) |
|
114 | - ); |
|
115 | - if (apply_filters( |
|
116 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__load_default_theme_stylesheet', |
|
117 | - false |
|
118 | - )) { |
|
119 | - $this->addStylesheets( |
|
120 | - apply_filters( |
|
121 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_theme_stylesheet', |
|
122 | - array('default_theme_stylesheet' => get_stylesheet_uri()), |
|
123 | - $this |
|
124 | - ) |
|
125 | - ); |
|
126 | - } |
|
127 | - } |
|
128 | - |
|
129 | - |
|
130 | - /** |
|
131 | - * @param string $title |
|
132 | - * @throws DomainException |
|
133 | - */ |
|
134 | - public function setTitle($title) |
|
135 | - { |
|
136 | - if (empty($title)) { |
|
137 | - throw new DomainException( |
|
138 | - esc_html__('You must provide a page title in order to create an iframe.', 'event_espresso') |
|
139 | - ); |
|
140 | - } |
|
141 | - $this->title = $title; |
|
142 | - } |
|
143 | - |
|
144 | - |
|
145 | - /** |
|
146 | - * @param string $content |
|
147 | - * @throws DomainException |
|
148 | - */ |
|
149 | - public function setContent($content) |
|
150 | - { |
|
151 | - if (empty($content)) { |
|
152 | - throw new DomainException( |
|
153 | - esc_html__('You must provide content in order to create an iframe.', 'event_espresso') |
|
154 | - ); |
|
155 | - } |
|
156 | - $this->content = $content; |
|
157 | - } |
|
158 | - |
|
159 | - |
|
160 | - /** |
|
161 | - * @param boolean $enqueue_wp_assets |
|
162 | - */ |
|
163 | - public function setEnqueueWpAssets($enqueue_wp_assets) |
|
164 | - { |
|
165 | - $this->enqueue_wp_assets = filter_var($enqueue_wp_assets, FILTER_VALIDATE_BOOLEAN); |
|
166 | - } |
|
167 | - |
|
168 | - |
|
169 | - /** |
|
170 | - * @param array $stylesheets |
|
171 | - * @throws DomainException |
|
172 | - */ |
|
173 | - public function addStylesheets(array $stylesheets) |
|
174 | - { |
|
175 | - if (empty($stylesheets)) { |
|
176 | - throw new DomainException( |
|
177 | - esc_html__( |
|
178 | - 'A non-empty array of URLs, is required to add a CSS stylesheet to an iframe.', |
|
179 | - 'event_espresso' |
|
180 | - ) |
|
181 | - ); |
|
182 | - } |
|
183 | - foreach ($stylesheets as $handle => $stylesheet) { |
|
184 | - $this->css[ $handle ] = $stylesheet; |
|
185 | - } |
|
186 | - } |
|
187 | - |
|
188 | - |
|
189 | - /** |
|
190 | - * @param array $scripts |
|
191 | - * @param bool $add_to_header |
|
192 | - * @throws DomainException |
|
193 | - */ |
|
194 | - public function addScripts(array $scripts, $add_to_header = false) |
|
195 | - { |
|
196 | - if (empty($scripts)) { |
|
197 | - throw new DomainException( |
|
198 | - esc_html__( |
|
199 | - 'A non-empty array of URLs, is required to add Javascript to an iframe.', |
|
200 | - 'event_espresso' |
|
201 | - ) |
|
202 | - ); |
|
203 | - } |
|
204 | - foreach ($scripts as $handle => $script) { |
|
205 | - if ($add_to_header) { |
|
206 | - $this->header_js[ $handle ] = $script; |
|
207 | - } else { |
|
208 | - $this->footer_js[ $handle ] = $script; |
|
209 | - } |
|
210 | - } |
|
211 | - } |
|
212 | - |
|
213 | - |
|
214 | - /** |
|
215 | - * @param array $script_attributes |
|
216 | - * @param bool $add_to_header |
|
217 | - * @throws DomainException |
|
218 | - */ |
|
219 | - public function addScriptAttributes(array $script_attributes, $add_to_header = false) |
|
220 | - { |
|
221 | - if (empty($script_attributes)) { |
|
222 | - throw new DomainException( |
|
223 | - esc_html__( |
|
224 | - 'A non-empty array of strings, is required to add attributes to iframe Javascript.', |
|
225 | - 'event_espresso' |
|
226 | - ) |
|
227 | - ); |
|
228 | - } |
|
229 | - foreach ($script_attributes as $handle => $script_attribute) { |
|
230 | - if ($add_to_header) { |
|
231 | - $this->header_js_attributes[ $handle ] = $script_attribute; |
|
232 | - } else { |
|
233 | - $this->footer_js_attributes[ $handle ] = $script_attribute; |
|
234 | - } |
|
235 | - } |
|
236 | - } |
|
237 | - |
|
238 | - |
|
239 | - /** |
|
240 | - * @param array $vars |
|
241 | - * @param string $var_name |
|
242 | - * @throws DomainException |
|
243 | - */ |
|
244 | - public function addLocalizedVars(array $vars, $var_name = 'eei18n') |
|
245 | - { |
|
246 | - if (empty($vars)) { |
|
247 | - throw new DomainException( |
|
248 | - esc_html__( |
|
249 | - 'A non-empty array of vars, is required to add localized Javascript vars to an iframe.', |
|
250 | - 'event_espresso' |
|
251 | - ) |
|
252 | - ); |
|
253 | - } |
|
254 | - foreach ($vars as $handle => $var) { |
|
255 | - if ($var_name === 'eei18n') { |
|
256 | - EE_Registry::$i18n_js_strings[ $handle ] = $var; |
|
257 | - } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') { |
|
258 | - $this->localized_vars[ $var_name ] = $var; |
|
259 | - } else { |
|
260 | - if (! isset($this->localized_vars[ $var_name ])) { |
|
261 | - $this->localized_vars[ $var_name ] = array(); |
|
262 | - } |
|
263 | - $this->localized_vars[ $var_name ][ $handle ] = $var; |
|
264 | - } |
|
265 | - } |
|
266 | - } |
|
267 | - |
|
268 | - |
|
269 | - /** |
|
270 | - * @param string $utm_content |
|
271 | - * @throws DomainException |
|
272 | - */ |
|
273 | - public function display($utm_content = '') |
|
274 | - { |
|
275 | - $this->content .= EEH_Template::powered_by_event_espresso( |
|
276 | - '', |
|
277 | - '', |
|
278 | - ! empty($utm_content) ? array('utm_content' => $utm_content) : array() |
|
279 | - ); |
|
280 | - EE_System::do_not_cache(); |
|
281 | - echo $this->getTemplate(); |
|
282 | - exit; |
|
283 | - } |
|
284 | - |
|
285 | - |
|
286 | - /** |
|
287 | - * @return string |
|
288 | - * @throws DomainException |
|
289 | - */ |
|
290 | - public function getTemplate() |
|
291 | - { |
|
292 | - return EEH_Template::display_template( |
|
293 | - __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php', |
|
294 | - array( |
|
295 | - 'title' => apply_filters( |
|
296 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title', |
|
297 | - $this->title, |
|
298 | - $this |
|
299 | - ), |
|
300 | - 'content' => apply_filters( |
|
301 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__content', |
|
302 | - $this->content, |
|
303 | - $this |
|
304 | - ), |
|
305 | - 'enqueue_wp_assets' => apply_filters( |
|
306 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__enqueue_wp_assets', |
|
307 | - $this->enqueue_wp_assets, |
|
308 | - $this |
|
309 | - ), |
|
310 | - 'css' => (array) apply_filters( |
|
311 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls', |
|
312 | - $this->css, |
|
313 | - $this |
|
314 | - ), |
|
315 | - 'header_js' => (array) apply_filters( |
|
316 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_urls', |
|
317 | - $this->header_js, |
|
318 | - $this |
|
319 | - ), |
|
320 | - 'header_js_attributes' => (array) apply_filters( |
|
321 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_attributes', |
|
322 | - $this->header_js_attributes, |
|
323 | - $this |
|
324 | - ), |
|
325 | - 'footer_js' => (array) apply_filters( |
|
326 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_urls', |
|
327 | - $this->footer_js, |
|
328 | - $this |
|
329 | - ), |
|
330 | - 'footer_js_attributes' => (array) apply_filters( |
|
331 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_attributes', |
|
332 | - $this->footer_js_attributes, |
|
333 | - $this |
|
334 | - ), |
|
335 | - 'eei18n' => apply_filters( |
|
336 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings', |
|
337 | - EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(), |
|
338 | - $this |
|
339 | - ), |
|
340 | - 'notices' => EEH_Template::display_template( |
|
341 | - EE_TEMPLATES . 'espresso-ajax-notices.template.php', |
|
342 | - array(), |
|
343 | - true |
|
344 | - ), |
|
345 | - ), |
|
346 | - true, |
|
347 | - true |
|
348 | - ); |
|
349 | - } |
|
350 | - |
|
351 | - |
|
352 | - /** |
|
353 | - * localizeJsonVars |
|
354 | - * |
|
355 | - * @return string |
|
356 | - */ |
|
357 | - public function localizeJsonVars() |
|
358 | - { |
|
359 | - $JSON = ''; |
|
360 | - foreach ((array) $this->localized_vars as $var_name => $vars) { |
|
361 | - $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars); |
|
362 | - $JSON .= "/* <![CDATA[ */ var {$var_name} = "; |
|
363 | - $JSON .= wp_json_encode($this->localized_vars[ $var_name ]); |
|
364 | - $JSON .= '; /* ]]> */'; |
|
365 | - } |
|
366 | - return $JSON; |
|
367 | - } |
|
368 | - |
|
369 | - |
|
370 | - /** |
|
371 | - * @param bool|int|float|string|array $var |
|
372 | - * @return array |
|
373 | - */ |
|
374 | - public function encodeJsonVars($var) |
|
375 | - { |
|
376 | - if (is_array($var)) { |
|
377 | - $localized_vars = array(); |
|
378 | - foreach ((array) $var as $key => $value) { |
|
379 | - $localized_vars[ $key ] = $this->encodeJsonVars($value); |
|
380 | - } |
|
381 | - return $localized_vars; |
|
382 | - } |
|
383 | - if (is_scalar($var)) { |
|
384 | - return html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8'); |
|
385 | - } |
|
386 | - return null; |
|
387 | - } |
|
73 | + protected $localized_vars = array(); |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * Iframe constructor |
|
78 | + * |
|
79 | + * @param string $title |
|
80 | + * @param string $content |
|
81 | + * @throws DomainException |
|
82 | + */ |
|
83 | + public function __construct($title, $content) |
|
84 | + { |
|
85 | + global $wp_version; |
|
86 | + if (! defined('EE_IFRAME_DIR_URL')) { |
|
87 | + define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__)); |
|
88 | + } |
|
89 | + $this->setContent($content); |
|
90 | + $this->setTitle($title); |
|
91 | + $this->addStylesheets( |
|
92 | + apply_filters( |
|
93 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css', |
|
94 | + array( |
|
95 | + 'site_theme' => get_stylesheet_directory_uri() . DS |
|
96 | + . 'style.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
97 | + 'dashicons' => includes_url('css/dashicons.min.css?ver=' . $wp_version), |
|
98 | + 'espresso_default' => EE_GLOBAL_ASSETS_URL |
|
99 | + . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
100 | + ), |
|
101 | + $this |
|
102 | + ) |
|
103 | + ); |
|
104 | + $this->addScripts( |
|
105 | + apply_filters( |
|
106 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js', |
|
107 | + array( |
|
108 | + 'jquery' => includes_url('js/jquery/jquery.js?ver=' . $wp_version), |
|
109 | + 'espresso_core' => EE_GLOBAL_ASSETS_URL |
|
110 | + . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION, |
|
111 | + ), |
|
112 | + $this |
|
113 | + ) |
|
114 | + ); |
|
115 | + if (apply_filters( |
|
116 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__load_default_theme_stylesheet', |
|
117 | + false |
|
118 | + )) { |
|
119 | + $this->addStylesheets( |
|
120 | + apply_filters( |
|
121 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_theme_stylesheet', |
|
122 | + array('default_theme_stylesheet' => get_stylesheet_uri()), |
|
123 | + $this |
|
124 | + ) |
|
125 | + ); |
|
126 | + } |
|
127 | + } |
|
128 | + |
|
129 | + |
|
130 | + /** |
|
131 | + * @param string $title |
|
132 | + * @throws DomainException |
|
133 | + */ |
|
134 | + public function setTitle($title) |
|
135 | + { |
|
136 | + if (empty($title)) { |
|
137 | + throw new DomainException( |
|
138 | + esc_html__('You must provide a page title in order to create an iframe.', 'event_espresso') |
|
139 | + ); |
|
140 | + } |
|
141 | + $this->title = $title; |
|
142 | + } |
|
143 | + |
|
144 | + |
|
145 | + /** |
|
146 | + * @param string $content |
|
147 | + * @throws DomainException |
|
148 | + */ |
|
149 | + public function setContent($content) |
|
150 | + { |
|
151 | + if (empty($content)) { |
|
152 | + throw new DomainException( |
|
153 | + esc_html__('You must provide content in order to create an iframe.', 'event_espresso') |
|
154 | + ); |
|
155 | + } |
|
156 | + $this->content = $content; |
|
157 | + } |
|
158 | + |
|
159 | + |
|
160 | + /** |
|
161 | + * @param boolean $enqueue_wp_assets |
|
162 | + */ |
|
163 | + public function setEnqueueWpAssets($enqueue_wp_assets) |
|
164 | + { |
|
165 | + $this->enqueue_wp_assets = filter_var($enqueue_wp_assets, FILTER_VALIDATE_BOOLEAN); |
|
166 | + } |
|
167 | + |
|
168 | + |
|
169 | + /** |
|
170 | + * @param array $stylesheets |
|
171 | + * @throws DomainException |
|
172 | + */ |
|
173 | + public function addStylesheets(array $stylesheets) |
|
174 | + { |
|
175 | + if (empty($stylesheets)) { |
|
176 | + throw new DomainException( |
|
177 | + esc_html__( |
|
178 | + 'A non-empty array of URLs, is required to add a CSS stylesheet to an iframe.', |
|
179 | + 'event_espresso' |
|
180 | + ) |
|
181 | + ); |
|
182 | + } |
|
183 | + foreach ($stylesheets as $handle => $stylesheet) { |
|
184 | + $this->css[ $handle ] = $stylesheet; |
|
185 | + } |
|
186 | + } |
|
187 | + |
|
188 | + |
|
189 | + /** |
|
190 | + * @param array $scripts |
|
191 | + * @param bool $add_to_header |
|
192 | + * @throws DomainException |
|
193 | + */ |
|
194 | + public function addScripts(array $scripts, $add_to_header = false) |
|
195 | + { |
|
196 | + if (empty($scripts)) { |
|
197 | + throw new DomainException( |
|
198 | + esc_html__( |
|
199 | + 'A non-empty array of URLs, is required to add Javascript to an iframe.', |
|
200 | + 'event_espresso' |
|
201 | + ) |
|
202 | + ); |
|
203 | + } |
|
204 | + foreach ($scripts as $handle => $script) { |
|
205 | + if ($add_to_header) { |
|
206 | + $this->header_js[ $handle ] = $script; |
|
207 | + } else { |
|
208 | + $this->footer_js[ $handle ] = $script; |
|
209 | + } |
|
210 | + } |
|
211 | + } |
|
212 | + |
|
213 | + |
|
214 | + /** |
|
215 | + * @param array $script_attributes |
|
216 | + * @param bool $add_to_header |
|
217 | + * @throws DomainException |
|
218 | + */ |
|
219 | + public function addScriptAttributes(array $script_attributes, $add_to_header = false) |
|
220 | + { |
|
221 | + if (empty($script_attributes)) { |
|
222 | + throw new DomainException( |
|
223 | + esc_html__( |
|
224 | + 'A non-empty array of strings, is required to add attributes to iframe Javascript.', |
|
225 | + 'event_espresso' |
|
226 | + ) |
|
227 | + ); |
|
228 | + } |
|
229 | + foreach ($script_attributes as $handle => $script_attribute) { |
|
230 | + if ($add_to_header) { |
|
231 | + $this->header_js_attributes[ $handle ] = $script_attribute; |
|
232 | + } else { |
|
233 | + $this->footer_js_attributes[ $handle ] = $script_attribute; |
|
234 | + } |
|
235 | + } |
|
236 | + } |
|
237 | + |
|
238 | + |
|
239 | + /** |
|
240 | + * @param array $vars |
|
241 | + * @param string $var_name |
|
242 | + * @throws DomainException |
|
243 | + */ |
|
244 | + public function addLocalizedVars(array $vars, $var_name = 'eei18n') |
|
245 | + { |
|
246 | + if (empty($vars)) { |
|
247 | + throw new DomainException( |
|
248 | + esc_html__( |
|
249 | + 'A non-empty array of vars, is required to add localized Javascript vars to an iframe.', |
|
250 | + 'event_espresso' |
|
251 | + ) |
|
252 | + ); |
|
253 | + } |
|
254 | + foreach ($vars as $handle => $var) { |
|
255 | + if ($var_name === 'eei18n') { |
|
256 | + EE_Registry::$i18n_js_strings[ $handle ] = $var; |
|
257 | + } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') { |
|
258 | + $this->localized_vars[ $var_name ] = $var; |
|
259 | + } else { |
|
260 | + if (! isset($this->localized_vars[ $var_name ])) { |
|
261 | + $this->localized_vars[ $var_name ] = array(); |
|
262 | + } |
|
263 | + $this->localized_vars[ $var_name ][ $handle ] = $var; |
|
264 | + } |
|
265 | + } |
|
266 | + } |
|
267 | + |
|
268 | + |
|
269 | + /** |
|
270 | + * @param string $utm_content |
|
271 | + * @throws DomainException |
|
272 | + */ |
|
273 | + public function display($utm_content = '') |
|
274 | + { |
|
275 | + $this->content .= EEH_Template::powered_by_event_espresso( |
|
276 | + '', |
|
277 | + '', |
|
278 | + ! empty($utm_content) ? array('utm_content' => $utm_content) : array() |
|
279 | + ); |
|
280 | + EE_System::do_not_cache(); |
|
281 | + echo $this->getTemplate(); |
|
282 | + exit; |
|
283 | + } |
|
284 | + |
|
285 | + |
|
286 | + /** |
|
287 | + * @return string |
|
288 | + * @throws DomainException |
|
289 | + */ |
|
290 | + public function getTemplate() |
|
291 | + { |
|
292 | + return EEH_Template::display_template( |
|
293 | + __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php', |
|
294 | + array( |
|
295 | + 'title' => apply_filters( |
|
296 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title', |
|
297 | + $this->title, |
|
298 | + $this |
|
299 | + ), |
|
300 | + 'content' => apply_filters( |
|
301 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__content', |
|
302 | + $this->content, |
|
303 | + $this |
|
304 | + ), |
|
305 | + 'enqueue_wp_assets' => apply_filters( |
|
306 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__enqueue_wp_assets', |
|
307 | + $this->enqueue_wp_assets, |
|
308 | + $this |
|
309 | + ), |
|
310 | + 'css' => (array) apply_filters( |
|
311 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls', |
|
312 | + $this->css, |
|
313 | + $this |
|
314 | + ), |
|
315 | + 'header_js' => (array) apply_filters( |
|
316 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_urls', |
|
317 | + $this->header_js, |
|
318 | + $this |
|
319 | + ), |
|
320 | + 'header_js_attributes' => (array) apply_filters( |
|
321 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_attributes', |
|
322 | + $this->header_js_attributes, |
|
323 | + $this |
|
324 | + ), |
|
325 | + 'footer_js' => (array) apply_filters( |
|
326 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_urls', |
|
327 | + $this->footer_js, |
|
328 | + $this |
|
329 | + ), |
|
330 | + 'footer_js_attributes' => (array) apply_filters( |
|
331 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_attributes', |
|
332 | + $this->footer_js_attributes, |
|
333 | + $this |
|
334 | + ), |
|
335 | + 'eei18n' => apply_filters( |
|
336 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings', |
|
337 | + EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(), |
|
338 | + $this |
|
339 | + ), |
|
340 | + 'notices' => EEH_Template::display_template( |
|
341 | + EE_TEMPLATES . 'espresso-ajax-notices.template.php', |
|
342 | + array(), |
|
343 | + true |
|
344 | + ), |
|
345 | + ), |
|
346 | + true, |
|
347 | + true |
|
348 | + ); |
|
349 | + } |
|
350 | + |
|
351 | + |
|
352 | + /** |
|
353 | + * localizeJsonVars |
|
354 | + * |
|
355 | + * @return string |
|
356 | + */ |
|
357 | + public function localizeJsonVars() |
|
358 | + { |
|
359 | + $JSON = ''; |
|
360 | + foreach ((array) $this->localized_vars as $var_name => $vars) { |
|
361 | + $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars); |
|
362 | + $JSON .= "/* <![CDATA[ */ var {$var_name} = "; |
|
363 | + $JSON .= wp_json_encode($this->localized_vars[ $var_name ]); |
|
364 | + $JSON .= '; /* ]]> */'; |
|
365 | + } |
|
366 | + return $JSON; |
|
367 | + } |
|
368 | + |
|
369 | + |
|
370 | + /** |
|
371 | + * @param bool|int|float|string|array $var |
|
372 | + * @return array |
|
373 | + */ |
|
374 | + public function encodeJsonVars($var) |
|
375 | + { |
|
376 | + if (is_array($var)) { |
|
377 | + $localized_vars = array(); |
|
378 | + foreach ((array) $var as $key => $value) { |
|
379 | + $localized_vars[ $key ] = $this->encodeJsonVars($value); |
|
380 | + } |
|
381 | + return $localized_vars; |
|
382 | + } |
|
383 | + if (is_scalar($var)) { |
|
384 | + return html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8'); |
|
385 | + } |
|
386 | + return null; |
|
387 | + } |
|
388 | 388 | } |
@@ -83,7 +83,7 @@ discard block |
||
83 | 83 | public function __construct($title, $content) |
84 | 84 | { |
85 | 85 | global $wp_version; |
86 | - if (! defined('EE_IFRAME_DIR_URL')) { |
|
86 | + if ( ! defined('EE_IFRAME_DIR_URL')) { |
|
87 | 87 | define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__)); |
88 | 88 | } |
89 | 89 | $this->setContent($content); |
@@ -92,11 +92,11 @@ discard block |
||
92 | 92 | apply_filters( |
93 | 93 | 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css', |
94 | 94 | array( |
95 | - 'site_theme' => get_stylesheet_directory_uri() . DS |
|
96 | - . 'style.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
97 | - 'dashicons' => includes_url('css/dashicons.min.css?ver=' . $wp_version), |
|
95 | + 'site_theme' => get_stylesheet_directory_uri().DS |
|
96 | + . 'style.css?ver='.EVENT_ESPRESSO_VERSION, |
|
97 | + 'dashicons' => includes_url('css/dashicons.min.css?ver='.$wp_version), |
|
98 | 98 | 'espresso_default' => EE_GLOBAL_ASSETS_URL |
99 | - . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
99 | + . 'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION, |
|
100 | 100 | ), |
101 | 101 | $this |
102 | 102 | ) |
@@ -105,9 +105,9 @@ discard block |
||
105 | 105 | apply_filters( |
106 | 106 | 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js', |
107 | 107 | array( |
108 | - 'jquery' => includes_url('js/jquery/jquery.js?ver=' . $wp_version), |
|
108 | + 'jquery' => includes_url('js/jquery/jquery.js?ver='.$wp_version), |
|
109 | 109 | 'espresso_core' => EE_GLOBAL_ASSETS_URL |
110 | - . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION, |
|
110 | + . 'scripts/espresso_core.js?ver='.EVENT_ESPRESSO_VERSION, |
|
111 | 111 | ), |
112 | 112 | $this |
113 | 113 | ) |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | ); |
182 | 182 | } |
183 | 183 | foreach ($stylesheets as $handle => $stylesheet) { |
184 | - $this->css[ $handle ] = $stylesheet; |
|
184 | + $this->css[$handle] = $stylesheet; |
|
185 | 185 | } |
186 | 186 | } |
187 | 187 | |
@@ -203,9 +203,9 @@ discard block |
||
203 | 203 | } |
204 | 204 | foreach ($scripts as $handle => $script) { |
205 | 205 | if ($add_to_header) { |
206 | - $this->header_js[ $handle ] = $script; |
|
206 | + $this->header_js[$handle] = $script; |
|
207 | 207 | } else { |
208 | - $this->footer_js[ $handle ] = $script; |
|
208 | + $this->footer_js[$handle] = $script; |
|
209 | 209 | } |
210 | 210 | } |
211 | 211 | } |
@@ -228,9 +228,9 @@ discard block |
||
228 | 228 | } |
229 | 229 | foreach ($script_attributes as $handle => $script_attribute) { |
230 | 230 | if ($add_to_header) { |
231 | - $this->header_js_attributes[ $handle ] = $script_attribute; |
|
231 | + $this->header_js_attributes[$handle] = $script_attribute; |
|
232 | 232 | } else { |
233 | - $this->footer_js_attributes[ $handle ] = $script_attribute; |
|
233 | + $this->footer_js_attributes[$handle] = $script_attribute; |
|
234 | 234 | } |
235 | 235 | } |
236 | 236 | } |
@@ -253,14 +253,14 @@ discard block |
||
253 | 253 | } |
254 | 254 | foreach ($vars as $handle => $var) { |
255 | 255 | if ($var_name === 'eei18n') { |
256 | - EE_Registry::$i18n_js_strings[ $handle ] = $var; |
|
256 | + EE_Registry::$i18n_js_strings[$handle] = $var; |
|
257 | 257 | } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') { |
258 | - $this->localized_vars[ $var_name ] = $var; |
|
258 | + $this->localized_vars[$var_name] = $var; |
|
259 | 259 | } else { |
260 | - if (! isset($this->localized_vars[ $var_name ])) { |
|
261 | - $this->localized_vars[ $var_name ] = array(); |
|
260 | + if ( ! isset($this->localized_vars[$var_name])) { |
|
261 | + $this->localized_vars[$var_name] = array(); |
|
262 | 262 | } |
263 | - $this->localized_vars[ $var_name ][ $handle ] = $var; |
|
263 | + $this->localized_vars[$var_name][$handle] = $var; |
|
264 | 264 | } |
265 | 265 | } |
266 | 266 | } |
@@ -290,7 +290,7 @@ discard block |
||
290 | 290 | public function getTemplate() |
291 | 291 | { |
292 | 292 | return EEH_Template::display_template( |
293 | - __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php', |
|
293 | + __DIR__.DIRECTORY_SEPARATOR.'iframe_wrapper.template.php', |
|
294 | 294 | array( |
295 | 295 | 'title' => apply_filters( |
296 | 296 | 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title', |
@@ -334,11 +334,11 @@ discard block |
||
334 | 334 | ), |
335 | 335 | 'eei18n' => apply_filters( |
336 | 336 | 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings', |
337 | - EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(), |
|
337 | + EE_Registry::localize_i18n_js_strings().$this->localizeJsonVars(), |
|
338 | 338 | $this |
339 | 339 | ), |
340 | 340 | 'notices' => EEH_Template::display_template( |
341 | - EE_TEMPLATES . 'espresso-ajax-notices.template.php', |
|
341 | + EE_TEMPLATES.'espresso-ajax-notices.template.php', |
|
342 | 342 | array(), |
343 | 343 | true |
344 | 344 | ), |
@@ -358,9 +358,9 @@ discard block |
||
358 | 358 | { |
359 | 359 | $JSON = ''; |
360 | 360 | foreach ((array) $this->localized_vars as $var_name => $vars) { |
361 | - $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars); |
|
361 | + $this->localized_vars[$var_name] = $this->encodeJsonVars($vars); |
|
362 | 362 | $JSON .= "/* <![CDATA[ */ var {$var_name} = "; |
363 | - $JSON .= wp_json_encode($this->localized_vars[ $var_name ]); |
|
363 | + $JSON .= wp_json_encode($this->localized_vars[$var_name]); |
|
364 | 364 | $JSON .= '; /* ]]> */'; |
365 | 365 | } |
366 | 366 | return $JSON; |
@@ -376,7 +376,7 @@ discard block |
||
376 | 376 | if (is_array($var)) { |
377 | 377 | $localized_vars = array(); |
378 | 378 | foreach ((array) $var as $key => $value) { |
379 | - $localized_vars[ $key ] = $this->encodeJsonVars($value); |
|
379 | + $localized_vars[$key] = $this->encodeJsonVars($value); |
|
380 | 380 | } |
381 | 381 | return $localized_vars; |
382 | 382 | } |
@@ -13,274 +13,274 @@ |
||
13 | 13 | { |
14 | 14 | |
15 | 15 | |
16 | - /** |
|
17 | - * @var string $iframe_name |
|
18 | - */ |
|
19 | - private $iframe_name; |
|
16 | + /** |
|
17 | + * @var string $iframe_name |
|
18 | + */ |
|
19 | + private $iframe_name; |
|
20 | 20 | |
21 | - /** |
|
22 | - * @var string $route_name |
|
23 | - */ |
|
24 | - private $route_name; |
|
21 | + /** |
|
22 | + * @var string $route_name |
|
23 | + */ |
|
24 | + private $route_name; |
|
25 | 25 | |
26 | - /** |
|
27 | - * @var string $slug |
|
28 | - */ |
|
29 | - private $slug; |
|
26 | + /** |
|
27 | + * @var string $slug |
|
28 | + */ |
|
29 | + private $slug; |
|
30 | 30 | |
31 | - /** |
|
32 | - * @var boolean $append_filterable_content |
|
33 | - */ |
|
34 | - private $append_filterable_content; |
|
31 | + /** |
|
32 | + * @var boolean $append_filterable_content |
|
33 | + */ |
|
34 | + private $append_filterable_content; |
|
35 | 35 | |
36 | 36 | |
37 | - /** |
|
38 | - * IframeEmbedButton constructor. |
|
39 | - * |
|
40 | - * @param string $iframe_name i18n name for the iframe. This will be used in HTML |
|
41 | - * @param string $route_name the name of the registered route |
|
42 | - * @param string $slug URL slug used for the thing the iframe button is being embedded in. |
|
43 | - * will most likely be "event" since that's the only usage atm |
|
44 | - */ |
|
45 | - public function __construct($iframe_name, $route_name, $slug = 'event') |
|
46 | - { |
|
47 | - $this->iframe_name = $iframe_name; |
|
48 | - $this->route_name = $route_name; |
|
49 | - $this->slug = $slug; |
|
50 | - } |
|
37 | + /** |
|
38 | + * IframeEmbedButton constructor. |
|
39 | + * |
|
40 | + * @param string $iframe_name i18n name for the iframe. This will be used in HTML |
|
41 | + * @param string $route_name the name of the registered route |
|
42 | + * @param string $slug URL slug used for the thing the iframe button is being embedded in. |
|
43 | + * will most likely be "event" since that's the only usage atm |
|
44 | + */ |
|
45 | + public function __construct($iframe_name, $route_name, $slug = 'event') |
|
46 | + { |
|
47 | + $this->iframe_name = $iframe_name; |
|
48 | + $this->route_name = $route_name; |
|
49 | + $this->slug = $slug; |
|
50 | + } |
|
51 | 51 | |
52 | 52 | |
53 | - /** |
|
54 | - * Adds an iframe embed code button to the Event editor. |
|
55 | - */ |
|
56 | - public function addEventEditorIframeEmbedButtonFilter() |
|
57 | - { |
|
58 | - // add button for iframe code to event editor. |
|
59 | - add_filter( |
|
60 | - 'get_sample_permalink_html', |
|
61 | - array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'), |
|
62 | - 10, |
|
63 | - 2 |
|
64 | - ); |
|
65 | - add_action( |
|
66 | - 'admin_enqueue_scripts', |
|
67 | - array($this, 'embedButtonAssets'), |
|
68 | - 10 |
|
69 | - ); |
|
70 | - } |
|
53 | + /** |
|
54 | + * Adds an iframe embed code button to the Event editor. |
|
55 | + */ |
|
56 | + public function addEventEditorIframeEmbedButtonFilter() |
|
57 | + { |
|
58 | + // add button for iframe code to event editor. |
|
59 | + add_filter( |
|
60 | + 'get_sample_permalink_html', |
|
61 | + array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'), |
|
62 | + 10, |
|
63 | + 2 |
|
64 | + ); |
|
65 | + add_action( |
|
66 | + 'admin_enqueue_scripts', |
|
67 | + array($this, 'embedButtonAssets'), |
|
68 | + 10 |
|
69 | + ); |
|
70 | + } |
|
71 | 71 | |
72 | 72 | |
73 | - /** |
|
74 | - * @param $permalink_string |
|
75 | - * @param $id |
|
76 | - * @return string |
|
77 | - */ |
|
78 | - public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id) |
|
79 | - { |
|
80 | - return $this->eventEditorIframeEmbedButton( |
|
81 | - $permalink_string, |
|
82 | - $id |
|
83 | - ); |
|
84 | - } |
|
73 | + /** |
|
74 | + * @param $permalink_string |
|
75 | + * @param $id |
|
76 | + * @return string |
|
77 | + */ |
|
78 | + public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id) |
|
79 | + { |
|
80 | + return $this->eventEditorIframeEmbedButton( |
|
81 | + $permalink_string, |
|
82 | + $id |
|
83 | + ); |
|
84 | + } |
|
85 | 85 | |
86 | 86 | |
87 | - /** |
|
88 | - * iframe embed code button to the Event editor. |
|
89 | - * |
|
90 | - * @param string $permalink_string |
|
91 | - * @param int $id |
|
92 | - * @return string |
|
93 | - */ |
|
94 | - public function eventEditorIframeEmbedButton( |
|
95 | - $permalink_string, |
|
96 | - $id |
|
97 | - ) { |
|
98 | - // make sure this is ONLY when editing and the event id has been set. |
|
99 | - if (! empty($id)) { |
|
100 | - $post = get_post($id); |
|
101 | - // if NOT event then let's get out. |
|
102 | - if ($post->post_type !== 'espresso_events') { |
|
103 | - return $permalink_string; |
|
104 | - } |
|
105 | - $permalink_string .= $this->embedButtonHtml( |
|
106 | - array($this->slug => $id), |
|
107 | - 'button-small' |
|
108 | - ); |
|
109 | - } |
|
110 | - return $permalink_string; |
|
111 | - } |
|
87 | + /** |
|
88 | + * iframe embed code button to the Event editor. |
|
89 | + * |
|
90 | + * @param string $permalink_string |
|
91 | + * @param int $id |
|
92 | + * @return string |
|
93 | + */ |
|
94 | + public function eventEditorIframeEmbedButton( |
|
95 | + $permalink_string, |
|
96 | + $id |
|
97 | + ) { |
|
98 | + // make sure this is ONLY when editing and the event id has been set. |
|
99 | + if (! empty($id)) { |
|
100 | + $post = get_post($id); |
|
101 | + // if NOT event then let's get out. |
|
102 | + if ($post->post_type !== 'espresso_events') { |
|
103 | + return $permalink_string; |
|
104 | + } |
|
105 | + $permalink_string .= $this->embedButtonHtml( |
|
106 | + array($this->slug => $id), |
|
107 | + 'button-small' |
|
108 | + ); |
|
109 | + } |
|
110 | + return $permalink_string; |
|
111 | + } |
|
112 | 112 | |
113 | 113 | |
114 | - /** |
|
115 | - * Adds an iframe embed code button via a WP do_action() as determined by the first parameter |
|
116 | - * |
|
117 | - * @param string $action name of the WP do_action() to hook into |
|
118 | - */ |
|
119 | - public function addActionIframeEmbedButton($action) |
|
120 | - { |
|
121 | - // add button for iframe code to event editor. |
|
122 | - add_action( |
|
123 | - $action, |
|
124 | - array($this, 'addActionIframeEmbedButtonCallback'), |
|
125 | - 10, |
|
126 | - 2 |
|
127 | - ); |
|
128 | - } |
|
114 | + /** |
|
115 | + * Adds an iframe embed code button via a WP do_action() as determined by the first parameter |
|
116 | + * |
|
117 | + * @param string $action name of the WP do_action() to hook into |
|
118 | + */ |
|
119 | + public function addActionIframeEmbedButton($action) |
|
120 | + { |
|
121 | + // add button for iframe code to event editor. |
|
122 | + add_action( |
|
123 | + $action, |
|
124 | + array($this, 'addActionIframeEmbedButtonCallback'), |
|
125 | + 10, |
|
126 | + 2 |
|
127 | + ); |
|
128 | + } |
|
129 | 129 | |
130 | 130 | |
131 | - /** |
|
132 | - * @return void |
|
133 | - */ |
|
134 | - public function addActionIframeEmbedButtonCallback() |
|
135 | - { |
|
136 | - echo $this->embedButtonHtml(); |
|
137 | - } |
|
131 | + /** |
|
132 | + * @return void |
|
133 | + */ |
|
134 | + public function addActionIframeEmbedButtonCallback() |
|
135 | + { |
|
136 | + echo $this->embedButtonHtml(); |
|
137 | + } |
|
138 | 138 | |
139 | 139 | |
140 | - /** |
|
141 | - * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter |
|
142 | - * |
|
143 | - * @param string $filter name of the WP apply_filters() to hook into |
|
144 | - * @param bool $append if true, will add iframe embed button to end of content, |
|
145 | - * else if false, will add to the beginning of the content |
|
146 | - */ |
|
147 | - public function addFilterIframeEmbedButton($filter, $append = true) |
|
148 | - { |
|
149 | - $this->append_filterable_content = $append; |
|
150 | - // add button for iframe code to event editor. |
|
151 | - add_filter( |
|
152 | - $filter, |
|
153 | - array($this, 'addFilterIframeEmbedButtonCallback'), |
|
154 | - 10 |
|
155 | - ); |
|
156 | - } |
|
140 | + /** |
|
141 | + * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter |
|
142 | + * |
|
143 | + * @param string $filter name of the WP apply_filters() to hook into |
|
144 | + * @param bool $append if true, will add iframe embed button to end of content, |
|
145 | + * else if false, will add to the beginning of the content |
|
146 | + */ |
|
147 | + public function addFilterIframeEmbedButton($filter, $append = true) |
|
148 | + { |
|
149 | + $this->append_filterable_content = $append; |
|
150 | + // add button for iframe code to event editor. |
|
151 | + add_filter( |
|
152 | + $filter, |
|
153 | + array($this, 'addFilterIframeEmbedButtonCallback'), |
|
154 | + 10 |
|
155 | + ); |
|
156 | + } |
|
157 | 157 | |
158 | 158 | |
159 | - /** |
|
160 | - * @param array|string $filterable_content |
|
161 | - * @return array|string |
|
162 | - */ |
|
163 | - public function addFilterIframeEmbedButtonCallback($filterable_content) |
|
164 | - { |
|
165 | - $embedButtonHtml = $this->embedButtonHtml(); |
|
166 | - if (is_array($filterable_content)) { |
|
167 | - $filterable_content = $this->append_filterable_content |
|
168 | - ? $filterable_content + array($this->route_name => $embedButtonHtml) |
|
169 | - : array($this->route_name => $embedButtonHtml) + $filterable_content; |
|
170 | - } else { |
|
171 | - $filterable_content = $this->append_filterable_content |
|
172 | - ? $filterable_content . $embedButtonHtml |
|
173 | - : $embedButtonHtml . $filterable_content; |
|
174 | - } |
|
175 | - return $filterable_content; |
|
176 | - } |
|
159 | + /** |
|
160 | + * @param array|string $filterable_content |
|
161 | + * @return array|string |
|
162 | + */ |
|
163 | + public function addFilterIframeEmbedButtonCallback($filterable_content) |
|
164 | + { |
|
165 | + $embedButtonHtml = $this->embedButtonHtml(); |
|
166 | + if (is_array($filterable_content)) { |
|
167 | + $filterable_content = $this->append_filterable_content |
|
168 | + ? $filterable_content + array($this->route_name => $embedButtonHtml) |
|
169 | + : array($this->route_name => $embedButtonHtml) + $filterable_content; |
|
170 | + } else { |
|
171 | + $filterable_content = $this->append_filterable_content |
|
172 | + ? $filterable_content . $embedButtonHtml |
|
173 | + : $embedButtonHtml . $filterable_content; |
|
174 | + } |
|
175 | + return $filterable_content; |
|
176 | + } |
|
177 | 177 | |
178 | 178 | |
179 | - /** |
|
180 | - * iframe_embed_html |
|
181 | - * |
|
182 | - * @param array $query_args |
|
183 | - * @param string $button_class |
|
184 | - * @return string |
|
185 | - */ |
|
186 | - public function embedButtonHtml($query_args = array(), $button_class = '') |
|
187 | - { |
|
188 | - // incoming args will replace the defaults listed here in the second array (union preserves first array) |
|
189 | - $query_args = (array) $query_args + array($this->route_name => 'iframe'); |
|
190 | - $query_args = (array) apply_filters( |
|
191 | - 'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args', |
|
192 | - $query_args |
|
193 | - ); |
|
194 | - // add this route to our localized vars |
|
195 | - $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes']) |
|
196 | - ? \EE_Registry::$i18n_js_strings['iframe_module_routes'] |
|
197 | - : array(); |
|
198 | - $iframe_module_routes[ $this->route_name ] = $this->route_name; |
|
199 | - \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes; |
|
200 | - $iframe_embed_html = \EEH_HTML::link( |
|
201 | - '#', |
|
202 | - sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name), |
|
203 | - sprintf( |
|
204 | - esc_html__( |
|
205 | - 'click here to generate code for embedding %1$s iframe into another site.', |
|
206 | - 'event_espresso' |
|
207 | - ), |
|
208 | - \EEH_Inflector::add_indefinite_article($this->iframe_name) |
|
209 | - ), |
|
210 | - "{$this->route_name}-iframe-embed-trigger-js", |
|
211 | - 'iframe-embed-trigger-js button ' . $button_class, |
|
212 | - '', |
|
213 | - ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"' |
|
214 | - ); |
|
215 | - $iframe_embed_html .= \EEH_HTML::div( |
|
216 | - '', |
|
217 | - "{$this->route_name}-iframe-js", |
|
218 | - 'iframe-embed-wrapper-js', |
|
219 | - 'display:none;' |
|
220 | - ); |
|
221 | - $iframe_embed_html .= esc_html( |
|
222 | - \EEH_HTML::div( |
|
223 | - '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>', |
|
224 | - '', |
|
225 | - '', |
|
226 | - 'width:100%; height: 500px;' |
|
227 | - ) |
|
228 | - ); |
|
229 | - $iframe_embed_html .= \EEH_HTML::divx(); |
|
230 | - return $iframe_embed_html; |
|
231 | - } |
|
179 | + /** |
|
180 | + * iframe_embed_html |
|
181 | + * |
|
182 | + * @param array $query_args |
|
183 | + * @param string $button_class |
|
184 | + * @return string |
|
185 | + */ |
|
186 | + public function embedButtonHtml($query_args = array(), $button_class = '') |
|
187 | + { |
|
188 | + // incoming args will replace the defaults listed here in the second array (union preserves first array) |
|
189 | + $query_args = (array) $query_args + array($this->route_name => 'iframe'); |
|
190 | + $query_args = (array) apply_filters( |
|
191 | + 'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args', |
|
192 | + $query_args |
|
193 | + ); |
|
194 | + // add this route to our localized vars |
|
195 | + $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes']) |
|
196 | + ? \EE_Registry::$i18n_js_strings['iframe_module_routes'] |
|
197 | + : array(); |
|
198 | + $iframe_module_routes[ $this->route_name ] = $this->route_name; |
|
199 | + \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes; |
|
200 | + $iframe_embed_html = \EEH_HTML::link( |
|
201 | + '#', |
|
202 | + sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name), |
|
203 | + sprintf( |
|
204 | + esc_html__( |
|
205 | + 'click here to generate code for embedding %1$s iframe into another site.', |
|
206 | + 'event_espresso' |
|
207 | + ), |
|
208 | + \EEH_Inflector::add_indefinite_article($this->iframe_name) |
|
209 | + ), |
|
210 | + "{$this->route_name}-iframe-embed-trigger-js", |
|
211 | + 'iframe-embed-trigger-js button ' . $button_class, |
|
212 | + '', |
|
213 | + ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"' |
|
214 | + ); |
|
215 | + $iframe_embed_html .= \EEH_HTML::div( |
|
216 | + '', |
|
217 | + "{$this->route_name}-iframe-js", |
|
218 | + 'iframe-embed-wrapper-js', |
|
219 | + 'display:none;' |
|
220 | + ); |
|
221 | + $iframe_embed_html .= esc_html( |
|
222 | + \EEH_HTML::div( |
|
223 | + '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>', |
|
224 | + '', |
|
225 | + '', |
|
226 | + 'width:100%; height: 500px;' |
|
227 | + ) |
|
228 | + ); |
|
229 | + $iframe_embed_html .= \EEH_HTML::divx(); |
|
230 | + return $iframe_embed_html; |
|
231 | + } |
|
232 | 232 | |
233 | 233 | |
234 | - /** |
|
235 | - * enqueue iframe button js |
|
236 | - */ |
|
237 | - public function embedButtonAssets() |
|
238 | - { |
|
239 | - \EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__( |
|
240 | - 'copy and paste the following into any other site\'s content to display this event:', |
|
241 | - 'event_espresso' |
|
242 | - ); |
|
243 | - \EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__( |
|
244 | - 'click anywhere outside of this window to close it.', |
|
245 | - 'event_espresso' |
|
246 | - ); |
|
247 | - wp_register_script( |
|
248 | - 'iframe_embed_button', |
|
249 | - plugin_dir_url(__FILE__) . 'iframe-embed-button.js', |
|
250 | - array('ee-dialog'), |
|
251 | - EVENT_ESPRESSO_VERSION, |
|
252 | - true |
|
253 | - ); |
|
254 | - wp_enqueue_script('iframe_embed_button'); |
|
255 | - } |
|
234 | + /** |
|
235 | + * enqueue iframe button js |
|
236 | + */ |
|
237 | + public function embedButtonAssets() |
|
238 | + { |
|
239 | + \EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__( |
|
240 | + 'copy and paste the following into any other site\'s content to display this event:', |
|
241 | + 'event_espresso' |
|
242 | + ); |
|
243 | + \EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__( |
|
244 | + 'click anywhere outside of this window to close it.', |
|
245 | + 'event_espresso' |
|
246 | + ); |
|
247 | + wp_register_script( |
|
248 | + 'iframe_embed_button', |
|
249 | + plugin_dir_url(__FILE__) . 'iframe-embed-button.js', |
|
250 | + array('ee-dialog'), |
|
251 | + EVENT_ESPRESSO_VERSION, |
|
252 | + true |
|
253 | + ); |
|
254 | + wp_enqueue_script('iframe_embed_button'); |
|
255 | + } |
|
256 | 256 | |
257 | 257 | |
258 | - /** |
|
259 | - * generates embed button sections for admin pages |
|
260 | - * |
|
261 | - * @param array $embed_buttons |
|
262 | - * @return string |
|
263 | - */ |
|
264 | - public function addIframeEmbedButtonsSection(array $embed_buttons) |
|
265 | - { |
|
266 | - $embed_buttons = (array) apply_filters( |
|
267 | - 'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons', |
|
268 | - $embed_buttons |
|
269 | - ); |
|
270 | - if (empty($embed_buttons)) { |
|
271 | - return ''; |
|
272 | - } |
|
273 | - // add button for iframe code to event editor. |
|
274 | - $html = \EEH_HTML::br(2); |
|
275 | - $html .= \EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso')); |
|
276 | - $html .= \EEH_HTML::p( |
|
277 | - esc_html__( |
|
278 | - 'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.', |
|
279 | - 'event_espresso' |
|
280 | - ) |
|
281 | - ); |
|
282 | - $html .= ' ' . implode(' ', $embed_buttons) . ' '; |
|
283 | - $html .= \EEH_HTML::br(2); |
|
284 | - return $html; |
|
285 | - } |
|
258 | + /** |
|
259 | + * generates embed button sections for admin pages |
|
260 | + * |
|
261 | + * @param array $embed_buttons |
|
262 | + * @return string |
|
263 | + */ |
|
264 | + public function addIframeEmbedButtonsSection(array $embed_buttons) |
|
265 | + { |
|
266 | + $embed_buttons = (array) apply_filters( |
|
267 | + 'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons', |
|
268 | + $embed_buttons |
|
269 | + ); |
|
270 | + if (empty($embed_buttons)) { |
|
271 | + return ''; |
|
272 | + } |
|
273 | + // add button for iframe code to event editor. |
|
274 | + $html = \EEH_HTML::br(2); |
|
275 | + $html .= \EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso')); |
|
276 | + $html .= \EEH_HTML::p( |
|
277 | + esc_html__( |
|
278 | + 'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.', |
|
279 | + 'event_espresso' |
|
280 | + ) |
|
281 | + ); |
|
282 | + $html .= ' ' . implode(' ', $embed_buttons) . ' '; |
|
283 | + $html .= \EEH_HTML::br(2); |
|
284 | + return $html; |
|
285 | + } |
|
286 | 286 | } |
@@ -96,7 +96,7 @@ discard block |
||
96 | 96 | $id |
97 | 97 | ) { |
98 | 98 | // make sure this is ONLY when editing and the event id has been set. |
99 | - if (! empty($id)) { |
|
99 | + if ( ! empty($id)) { |
|
100 | 100 | $post = get_post($id); |
101 | 101 | // if NOT event then let's get out. |
102 | 102 | if ($post->post_type !== 'espresso_events') { |
@@ -169,8 +169,8 @@ discard block |
||
169 | 169 | : array($this->route_name => $embedButtonHtml) + $filterable_content; |
170 | 170 | } else { |
171 | 171 | $filterable_content = $this->append_filterable_content |
172 | - ? $filterable_content . $embedButtonHtml |
|
173 | - : $embedButtonHtml . $filterable_content; |
|
172 | + ? $filterable_content.$embedButtonHtml |
|
173 | + : $embedButtonHtml.$filterable_content; |
|
174 | 174 | } |
175 | 175 | return $filterable_content; |
176 | 176 | } |
@@ -195,7 +195,7 @@ discard block |
||
195 | 195 | $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes']) |
196 | 196 | ? \EE_Registry::$i18n_js_strings['iframe_module_routes'] |
197 | 197 | : array(); |
198 | - $iframe_module_routes[ $this->route_name ] = $this->route_name; |
|
198 | + $iframe_module_routes[$this->route_name] = $this->route_name; |
|
199 | 199 | \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes; |
200 | 200 | $iframe_embed_html = \EEH_HTML::link( |
201 | 201 | '#', |
@@ -208,9 +208,9 @@ discard block |
||
208 | 208 | \EEH_Inflector::add_indefinite_article($this->iframe_name) |
209 | 209 | ), |
210 | 210 | "{$this->route_name}-iframe-embed-trigger-js", |
211 | - 'iframe-embed-trigger-js button ' . $button_class, |
|
211 | + 'iframe-embed-trigger-js button '.$button_class, |
|
212 | 212 | '', |
213 | - ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"' |
|
213 | + ' data-iframe_embed_button="#'.$this->route_name.'-iframe-js" tabindex="-1"' |
|
214 | 214 | ); |
215 | 215 | $iframe_embed_html .= \EEH_HTML::div( |
216 | 216 | '', |
@@ -220,7 +220,7 @@ discard block |
||
220 | 220 | ); |
221 | 221 | $iframe_embed_html .= esc_html( |
222 | 222 | \EEH_HTML::div( |
223 | - '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>', |
|
223 | + '<iframe src="'.add_query_arg($query_args, site_url()).'" width="100%" height="100%"></iframe>', |
|
224 | 224 | '', |
225 | 225 | '', |
226 | 226 | 'width:100%; height: 500px;' |
@@ -246,7 +246,7 @@ discard block |
||
246 | 246 | ); |
247 | 247 | wp_register_script( |
248 | 248 | 'iframe_embed_button', |
249 | - plugin_dir_url(__FILE__) . 'iframe-embed-button.js', |
|
249 | + plugin_dir_url(__FILE__).'iframe-embed-button.js', |
|
250 | 250 | array('ee-dialog'), |
251 | 251 | EVENT_ESPRESSO_VERSION, |
252 | 252 | true |
@@ -279,7 +279,7 @@ discard block |
||
279 | 279 | 'event_espresso' |
280 | 280 | ) |
281 | 281 | ); |
282 | - $html .= ' ' . implode(' ', $embed_buttons) . ' '; |
|
282 | + $html .= ' '.implode(' ', $embed_buttons).' '; |
|
283 | 283 | $html .= \EEH_HTML::br(2); |
284 | 284 | return $html; |
285 | 285 | } |
@@ -20,85 +20,85 @@ |
||
20 | 20 | class Read |
21 | 21 | { |
22 | 22 | |
23 | - /** |
|
24 | - * @param WP_REST_Request $request |
|
25 | - * @param string $version |
|
26 | - * @return EE_Config|WP_Error |
|
27 | - */ |
|
28 | - public static function handleRequest(WP_REST_Request $request, $version) |
|
29 | - { |
|
30 | - $cap = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
|
31 | - if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) { |
|
32 | - return EE_Config::instance(); |
|
33 | - } else { |
|
34 | - return new WP_Error( |
|
35 | - 'cannot_read_config', |
|
36 | - sprintf( |
|
37 | - __( |
|
38 | - 'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data', |
|
39 | - 'event_espresso' |
|
40 | - ), |
|
41 | - $cap |
|
42 | - ), |
|
43 | - array('status' => 403) |
|
44 | - ); |
|
45 | - } |
|
46 | - } |
|
23 | + /** |
|
24 | + * @param WP_REST_Request $request |
|
25 | + * @param string $version |
|
26 | + * @return EE_Config|WP_Error |
|
27 | + */ |
|
28 | + public static function handleRequest(WP_REST_Request $request, $version) |
|
29 | + { |
|
30 | + $cap = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
|
31 | + if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) { |
|
32 | + return EE_Config::instance(); |
|
33 | + } else { |
|
34 | + return new WP_Error( |
|
35 | + 'cannot_read_config', |
|
36 | + sprintf( |
|
37 | + __( |
|
38 | + 'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data', |
|
39 | + 'event_espresso' |
|
40 | + ), |
|
41 | + $cap |
|
42 | + ), |
|
43 | + array('status' => 403) |
|
44 | + ); |
|
45 | + } |
|
46 | + } |
|
47 | 47 | |
48 | 48 | |
49 | - /** |
|
50 | - * Handles the request for public site info |
|
51 | - * |
|
52 | - * @global $wp_json_basic_auth_success boolean set by the basic auth plugin, indicates if the |
|
53 | - * current user could be authenticated using basic auth |
|
54 | - * data |
|
55 | - * @global $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if |
|
56 | - * basic auth data was somehow received |
|
57 | - * @param WP_REST_Request $request |
|
58 | - * @param string $version |
|
59 | - * @return array|WP_Error |
|
60 | - */ |
|
61 | - public static function handleRequestSiteInfo(WP_REST_Request $request, $version) |
|
62 | - { |
|
63 | - global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data; |
|
64 | - $insecure_usage_of_basic_auth = apply_filters( |
|
65 | - // @codingStandardsIgnoreStart |
|
66 | - 'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth', |
|
67 | - // @codingStandardsIgnoreEnd |
|
68 | - $wp_json_basic_auth_success && ! is_ssl(), |
|
69 | - $request |
|
70 | - ); |
|
71 | - if ($insecure_usage_of_basic_auth) { |
|
72 | - $warning = sprintf( |
|
73 | - esc_html__( |
|
74 | - // @codingStandardsIgnoreStart |
|
75 | - 'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s', |
|
76 | - // @codingStandardsIgnoreEnd |
|
77 | - 'event_espresso' |
|
78 | - ), |
|
79 | - '<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">', |
|
80 | - '</a>' |
|
81 | - ); |
|
82 | - } else { |
|
83 | - $warning = ''; |
|
84 | - } |
|
85 | - return apply_filters( |
|
86 | - 'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val', |
|
87 | - array( |
|
88 | - 'default_timezone' => array( |
|
89 | - 'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(), |
|
90 | - 'string' => get_option('timezone_string'), |
|
91 | - 'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(), |
|
92 | - ), |
|
93 | - 'default_currency' => EE_Config::instance()->currency, |
|
94 | - 'authentication' => array( |
|
95 | - 'received_basic_auth_data' => (bool) $wp_json_basic_auth_received_data, |
|
96 | - 'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth, |
|
97 | - 'warning' => $warning, |
|
98 | - ), |
|
99 | - ) |
|
100 | - ); |
|
101 | - } |
|
49 | + /** |
|
50 | + * Handles the request for public site info |
|
51 | + * |
|
52 | + * @global $wp_json_basic_auth_success boolean set by the basic auth plugin, indicates if the |
|
53 | + * current user could be authenticated using basic auth |
|
54 | + * data |
|
55 | + * @global $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if |
|
56 | + * basic auth data was somehow received |
|
57 | + * @param WP_REST_Request $request |
|
58 | + * @param string $version |
|
59 | + * @return array|WP_Error |
|
60 | + */ |
|
61 | + public static function handleRequestSiteInfo(WP_REST_Request $request, $version) |
|
62 | + { |
|
63 | + global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data; |
|
64 | + $insecure_usage_of_basic_auth = apply_filters( |
|
65 | + // @codingStandardsIgnoreStart |
|
66 | + 'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth', |
|
67 | + // @codingStandardsIgnoreEnd |
|
68 | + $wp_json_basic_auth_success && ! is_ssl(), |
|
69 | + $request |
|
70 | + ); |
|
71 | + if ($insecure_usage_of_basic_auth) { |
|
72 | + $warning = sprintf( |
|
73 | + esc_html__( |
|
74 | + // @codingStandardsIgnoreStart |
|
75 | + 'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s', |
|
76 | + // @codingStandardsIgnoreEnd |
|
77 | + 'event_espresso' |
|
78 | + ), |
|
79 | + '<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">', |
|
80 | + '</a>' |
|
81 | + ); |
|
82 | + } else { |
|
83 | + $warning = ''; |
|
84 | + } |
|
85 | + return apply_filters( |
|
86 | + 'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val', |
|
87 | + array( |
|
88 | + 'default_timezone' => array( |
|
89 | + 'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(), |
|
90 | + 'string' => get_option('timezone_string'), |
|
91 | + 'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(), |
|
92 | + ), |
|
93 | + 'default_currency' => EE_Config::instance()->currency, |
|
94 | + 'authentication' => array( |
|
95 | + 'received_basic_auth_data' => (bool) $wp_json_basic_auth_received_data, |
|
96 | + 'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth, |
|
97 | + 'warning' => $warning, |
|
98 | + ), |
|
99 | + ) |
|
100 | + ); |
|
101 | + } |
|
102 | 102 | } |
103 | 103 | |
104 | 104 | // End of file Read.php |
@@ -30,325 +30,325 @@ |
||
30 | 30 | { |
31 | 31 | |
32 | 32 | |
33 | - public function __construct() |
|
34 | - { |
|
35 | - parent::__construct(); |
|
36 | - EE_Registry::instance()->load_helper('Inflector'); |
|
37 | - } |
|
33 | + public function __construct() |
|
34 | + { |
|
35 | + parent::__construct(); |
|
36 | + EE_Registry::instance()->load_helper('Inflector'); |
|
37 | + } |
|
38 | 38 | |
39 | 39 | |
40 | - /** |
|
41 | - * Handles requests to get all (or a filtered subset) of entities for a particular model |
|
42 | - * |
|
43 | - * @param WP_REST_Request $request |
|
44 | - * @param string $version |
|
45 | - * @param string $model_name |
|
46 | - * @return WP_REST_Response|\WP_Error |
|
47 | - */ |
|
48 | - public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name) |
|
49 | - { |
|
50 | - $controller = new Write(); |
|
51 | - try { |
|
52 | - $controller->setRequestedVersion($version); |
|
53 | - return $controller->sendResponse( |
|
54 | - $controller->insert( |
|
55 | - $controller->getModelVersionInfo()->loadModel($model_name), |
|
56 | - $request |
|
57 | - ) |
|
58 | - ); |
|
59 | - } catch (\Exception $e) { |
|
60 | - return $controller->sendResponse($e); |
|
61 | - } |
|
62 | - } |
|
40 | + /** |
|
41 | + * Handles requests to get all (or a filtered subset) of entities for a particular model |
|
42 | + * |
|
43 | + * @param WP_REST_Request $request |
|
44 | + * @param string $version |
|
45 | + * @param string $model_name |
|
46 | + * @return WP_REST_Response|\WP_Error |
|
47 | + */ |
|
48 | + public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name) |
|
49 | + { |
|
50 | + $controller = new Write(); |
|
51 | + try { |
|
52 | + $controller->setRequestedVersion($version); |
|
53 | + return $controller->sendResponse( |
|
54 | + $controller->insert( |
|
55 | + $controller->getModelVersionInfo()->loadModel($model_name), |
|
56 | + $request |
|
57 | + ) |
|
58 | + ); |
|
59 | + } catch (\Exception $e) { |
|
60 | + return $controller->sendResponse($e); |
|
61 | + } |
|
62 | + } |
|
63 | 63 | |
64 | 64 | |
65 | - /** |
|
66 | - * Handles a request from \WP_REST_Server to update an EE model |
|
67 | - * |
|
68 | - * @param WP_REST_Request $request |
|
69 | - * @param string $version |
|
70 | - * @param string $model_name |
|
71 | - * @return WP_REST_Response|\WP_Error |
|
72 | - */ |
|
73 | - public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name) |
|
74 | - { |
|
75 | - $controller = new Write(); |
|
76 | - try { |
|
77 | - $controller->setRequestedVersion($version); |
|
78 | - return $controller->sendResponse( |
|
79 | - $controller->update( |
|
80 | - $controller->getModelVersionInfo()->loadModel($model_name), |
|
81 | - $request |
|
82 | - ) |
|
83 | - ); |
|
84 | - } catch (\Exception $e) { |
|
85 | - return $controller->sendResponse($e); |
|
86 | - } |
|
87 | - } |
|
65 | + /** |
|
66 | + * Handles a request from \WP_REST_Server to update an EE model |
|
67 | + * |
|
68 | + * @param WP_REST_Request $request |
|
69 | + * @param string $version |
|
70 | + * @param string $model_name |
|
71 | + * @return WP_REST_Response|\WP_Error |
|
72 | + */ |
|
73 | + public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name) |
|
74 | + { |
|
75 | + $controller = new Write(); |
|
76 | + try { |
|
77 | + $controller->setRequestedVersion($version); |
|
78 | + return $controller->sendResponse( |
|
79 | + $controller->update( |
|
80 | + $controller->getModelVersionInfo()->loadModel($model_name), |
|
81 | + $request |
|
82 | + ) |
|
83 | + ); |
|
84 | + } catch (\Exception $e) { |
|
85 | + return $controller->sendResponse($e); |
|
86 | + } |
|
87 | + } |
|
88 | 88 | |
89 | 89 | |
90 | - /** |
|
91 | - * Deletes a single model object and returns it. Unless |
|
92 | - * |
|
93 | - * @param WP_REST_Request $request |
|
94 | - * @param string $version |
|
95 | - * @param string $model_name |
|
96 | - * @return WP_REST_Response|\WP_Error |
|
97 | - */ |
|
98 | - public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name) |
|
99 | - { |
|
100 | - $controller = new Write(); |
|
101 | - try { |
|
102 | - $controller->setRequestedVersion($version); |
|
103 | - return $controller->sendResponse( |
|
104 | - $controller->delete( |
|
105 | - $controller->getModelVersionInfo()->loadModel($model_name), |
|
106 | - $request |
|
107 | - ) |
|
108 | - ); |
|
109 | - } catch (\Exception $e) { |
|
110 | - return $controller->sendResponse($e); |
|
111 | - } |
|
112 | - } |
|
90 | + /** |
|
91 | + * Deletes a single model object and returns it. Unless |
|
92 | + * |
|
93 | + * @param WP_REST_Request $request |
|
94 | + * @param string $version |
|
95 | + * @param string $model_name |
|
96 | + * @return WP_REST_Response|\WP_Error |
|
97 | + */ |
|
98 | + public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name) |
|
99 | + { |
|
100 | + $controller = new Write(); |
|
101 | + try { |
|
102 | + $controller->setRequestedVersion($version); |
|
103 | + return $controller->sendResponse( |
|
104 | + $controller->delete( |
|
105 | + $controller->getModelVersionInfo()->loadModel($model_name), |
|
106 | + $request |
|
107 | + ) |
|
108 | + ); |
|
109 | + } catch (\Exception $e) { |
|
110 | + return $controller->sendResponse($e); |
|
111 | + } |
|
112 | + } |
|
113 | 113 | |
114 | 114 | |
115 | - /** |
|
116 | - * Inserts a new model object according to the $request |
|
117 | - * |
|
118 | - * @param EEM_Base $model |
|
119 | - * @param WP_REST_Request $request |
|
120 | - * @return array |
|
121 | - * @throws EE_Error |
|
122 | - * @throws RestException |
|
123 | - */ |
|
124 | - public function insert(EEM_Base $model, WP_REST_Request $request) |
|
125 | - { |
|
126 | - Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create'); |
|
127 | - $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
|
128 | - if (! current_user_can($default_cap_to_check_for)) { |
|
129 | - throw new RestException( |
|
130 | - 'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
131 | - sprintf( |
|
132 | - esc_html__( |
|
133 | - // @codingStandardsIgnoreStart |
|
134 | - 'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.', |
|
135 | - // @codingStandardsIgnoreEnd |
|
136 | - 'event_espresso' |
|
137 | - ), |
|
138 | - $default_cap_to_check_for |
|
139 | - ), |
|
140 | - array('status' => 403) |
|
141 | - ); |
|
142 | - } |
|
143 | - $submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params()); |
|
144 | - $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels( |
|
145 | - $submitted_json_data, |
|
146 | - $model, |
|
147 | - $this->getModelVersionInfo()->requestedVersion(), |
|
148 | - true |
|
149 | - ); |
|
150 | - $model_obj = EE_Registry::instance()->load_class( |
|
151 | - $model->get_this_model_name(), |
|
152 | - array($model_data, $model->get_timezone()), |
|
153 | - false, |
|
154 | - false |
|
155 | - ); |
|
156 | - $model_obj->save(); |
|
157 | - $new_id = $model_obj->ID(); |
|
158 | - if (! $new_id) { |
|
159 | - throw new RestException( |
|
160 | - 'rest_insertion_failed', |
|
161 | - sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name()) |
|
162 | - ); |
|
163 | - } |
|
164 | - return $this->returnModelObjAsJsonResponse($model_obj, $request); |
|
165 | - } |
|
115 | + /** |
|
116 | + * Inserts a new model object according to the $request |
|
117 | + * |
|
118 | + * @param EEM_Base $model |
|
119 | + * @param WP_REST_Request $request |
|
120 | + * @return array |
|
121 | + * @throws EE_Error |
|
122 | + * @throws RestException |
|
123 | + */ |
|
124 | + public function insert(EEM_Base $model, WP_REST_Request $request) |
|
125 | + { |
|
126 | + Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create'); |
|
127 | + $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
|
128 | + if (! current_user_can($default_cap_to_check_for)) { |
|
129 | + throw new RestException( |
|
130 | + 'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
131 | + sprintf( |
|
132 | + esc_html__( |
|
133 | + // @codingStandardsIgnoreStart |
|
134 | + 'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.', |
|
135 | + // @codingStandardsIgnoreEnd |
|
136 | + 'event_espresso' |
|
137 | + ), |
|
138 | + $default_cap_to_check_for |
|
139 | + ), |
|
140 | + array('status' => 403) |
|
141 | + ); |
|
142 | + } |
|
143 | + $submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params()); |
|
144 | + $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels( |
|
145 | + $submitted_json_data, |
|
146 | + $model, |
|
147 | + $this->getModelVersionInfo()->requestedVersion(), |
|
148 | + true |
|
149 | + ); |
|
150 | + $model_obj = EE_Registry::instance()->load_class( |
|
151 | + $model->get_this_model_name(), |
|
152 | + array($model_data, $model->get_timezone()), |
|
153 | + false, |
|
154 | + false |
|
155 | + ); |
|
156 | + $model_obj->save(); |
|
157 | + $new_id = $model_obj->ID(); |
|
158 | + if (! $new_id) { |
|
159 | + throw new RestException( |
|
160 | + 'rest_insertion_failed', |
|
161 | + sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name()) |
|
162 | + ); |
|
163 | + } |
|
164 | + return $this->returnModelObjAsJsonResponse($model_obj, $request); |
|
165 | + } |
|
166 | 166 | |
167 | 167 | |
168 | - /** |
|
169 | - * Updates an existing model object according to the $request |
|
170 | - * |
|
171 | - * @param EEM_Base $model |
|
172 | - * @param WP_REST_Request $request |
|
173 | - * @return array |
|
174 | - * @throws EE_Error |
|
175 | - */ |
|
176 | - public function update(EEM_Base $model, WP_REST_Request $request) |
|
177 | - { |
|
178 | - Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit'); |
|
179 | - $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
|
180 | - if (! current_user_can($default_cap_to_check_for)) { |
|
181 | - throw new RestException( |
|
182 | - 'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
183 | - sprintf( |
|
184 | - esc_html__( |
|
185 | - // @codingStandardsIgnoreStart |
|
186 | - 'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.', |
|
187 | - // @codingStandardsIgnoreEnd |
|
188 | - 'event_espresso' |
|
189 | - ), |
|
190 | - $default_cap_to_check_for |
|
191 | - ), |
|
192 | - array('status' => 403) |
|
193 | - ); |
|
194 | - } |
|
195 | - $obj_id = $request->get_param('id'); |
|
196 | - if (! $obj_id) { |
|
197 | - throw new RestException( |
|
198 | - 'rest_edit_failed', |
|
199 | - sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name()) |
|
200 | - ); |
|
201 | - } |
|
202 | - $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels( |
|
203 | - $this->getBodyParams($request), |
|
204 | - $model, |
|
205 | - $this->getModelVersionInfo()->requestedVersion(), |
|
206 | - true |
|
207 | - ); |
|
208 | - $model_obj = $model->get_one_by_ID($obj_id); |
|
209 | - if (! $model_obj instanceof EE_Base_Class) { |
|
210 | - $lowercase_model_name = strtolower($model->get_this_model_name()); |
|
211 | - throw new RestException( |
|
212 | - sprintf('rest_%s_invalid_id', $lowercase_model_name), |
|
213 | - sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name), |
|
214 | - array('status' => 404) |
|
215 | - ); |
|
216 | - } |
|
217 | - $model_obj->save($model_data); |
|
218 | - return $this->returnModelObjAsJsonResponse($model_obj, $request); |
|
219 | - } |
|
168 | + /** |
|
169 | + * Updates an existing model object according to the $request |
|
170 | + * |
|
171 | + * @param EEM_Base $model |
|
172 | + * @param WP_REST_Request $request |
|
173 | + * @return array |
|
174 | + * @throws EE_Error |
|
175 | + */ |
|
176 | + public function update(EEM_Base $model, WP_REST_Request $request) |
|
177 | + { |
|
178 | + Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit'); |
|
179 | + $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
|
180 | + if (! current_user_can($default_cap_to_check_for)) { |
|
181 | + throw new RestException( |
|
182 | + 'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
183 | + sprintf( |
|
184 | + esc_html__( |
|
185 | + // @codingStandardsIgnoreStart |
|
186 | + 'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.', |
|
187 | + // @codingStandardsIgnoreEnd |
|
188 | + 'event_espresso' |
|
189 | + ), |
|
190 | + $default_cap_to_check_for |
|
191 | + ), |
|
192 | + array('status' => 403) |
|
193 | + ); |
|
194 | + } |
|
195 | + $obj_id = $request->get_param('id'); |
|
196 | + if (! $obj_id) { |
|
197 | + throw new RestException( |
|
198 | + 'rest_edit_failed', |
|
199 | + sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name()) |
|
200 | + ); |
|
201 | + } |
|
202 | + $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels( |
|
203 | + $this->getBodyParams($request), |
|
204 | + $model, |
|
205 | + $this->getModelVersionInfo()->requestedVersion(), |
|
206 | + true |
|
207 | + ); |
|
208 | + $model_obj = $model->get_one_by_ID($obj_id); |
|
209 | + if (! $model_obj instanceof EE_Base_Class) { |
|
210 | + $lowercase_model_name = strtolower($model->get_this_model_name()); |
|
211 | + throw new RestException( |
|
212 | + sprintf('rest_%s_invalid_id', $lowercase_model_name), |
|
213 | + sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name), |
|
214 | + array('status' => 404) |
|
215 | + ); |
|
216 | + } |
|
217 | + $model_obj->save($model_data); |
|
218 | + return $this->returnModelObjAsJsonResponse($model_obj, $request); |
|
219 | + } |
|
220 | 220 | |
221 | 221 | |
222 | - /** |
|
223 | - * Updates an existing model object according to the $request |
|
224 | - * |
|
225 | - * @param EEM_Base $model |
|
226 | - * @param WP_REST_Request $request |
|
227 | - * @return array of either the soft-deleted item, or |
|
228 | - * @throws EE_Error |
|
229 | - */ |
|
230 | - public function delete(EEM_Base $model, WP_REST_Request $request) |
|
231 | - { |
|
232 | - Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete'); |
|
233 | - $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
|
234 | - if (! current_user_can($default_cap_to_check_for)) { |
|
235 | - throw new RestException( |
|
236 | - 'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
237 | - sprintf( |
|
238 | - esc_html__( |
|
239 | - // @codingStandardsIgnoreStart |
|
240 | - 'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.', |
|
241 | - // @codingStandardsIgnoreEnd |
|
242 | - 'event_espresso' |
|
243 | - ), |
|
244 | - $default_cap_to_check_for |
|
245 | - ), |
|
246 | - array('status' => 403) |
|
247 | - ); |
|
248 | - } |
|
249 | - $obj_id = $request->get_param('id'); |
|
250 | - // this is where we would apply more fine-grained caps |
|
251 | - $model_obj = $model->get_one_by_ID($obj_id); |
|
252 | - if (! $model_obj instanceof EE_Base_Class) { |
|
253 | - $lowercase_model_name = strtolower($model->get_this_model_name()); |
|
254 | - throw new RestException( |
|
255 | - sprintf('rest_%s_invalid_id', $lowercase_model_name), |
|
256 | - sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name), |
|
257 | - array('status' => 404) |
|
258 | - ); |
|
259 | - } |
|
260 | - $requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN); |
|
261 | - $requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN); |
|
262 | - if ($requested_permanent_delete) { |
|
263 | - $previous = $this->returnModelObjAsJsonResponse($model_obj, $request); |
|
264 | - $deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking); |
|
265 | - return array( |
|
266 | - 'deleted' => $deleted, |
|
267 | - 'previous' => $previous, |
|
268 | - ); |
|
269 | - } else { |
|
270 | - if ($model instanceof EEM_Soft_Delete_Base) { |
|
271 | - $model->delete_by_ID($obj_id, $requested_allow_blocking); |
|
272 | - return $this->returnModelObjAsJsonResponse($model_obj, $request); |
|
273 | - } else { |
|
274 | - throw new RestException( |
|
275 | - 'rest_trash_not_supported', |
|
276 | - 501, |
|
277 | - sprintf( |
|
278 | - esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'), |
|
279 | - EEH_Inflector::pluralize($model->get_this_model_name()) |
|
280 | - ) |
|
281 | - ); |
|
282 | - } |
|
283 | - } |
|
284 | - } |
|
222 | + /** |
|
223 | + * Updates an existing model object according to the $request |
|
224 | + * |
|
225 | + * @param EEM_Base $model |
|
226 | + * @param WP_REST_Request $request |
|
227 | + * @return array of either the soft-deleted item, or |
|
228 | + * @throws EE_Error |
|
229 | + */ |
|
230 | + public function delete(EEM_Base $model, WP_REST_Request $request) |
|
231 | + { |
|
232 | + Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete'); |
|
233 | + $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
|
234 | + if (! current_user_can($default_cap_to_check_for)) { |
|
235 | + throw new RestException( |
|
236 | + 'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
237 | + sprintf( |
|
238 | + esc_html__( |
|
239 | + // @codingStandardsIgnoreStart |
|
240 | + 'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.', |
|
241 | + // @codingStandardsIgnoreEnd |
|
242 | + 'event_espresso' |
|
243 | + ), |
|
244 | + $default_cap_to_check_for |
|
245 | + ), |
|
246 | + array('status' => 403) |
|
247 | + ); |
|
248 | + } |
|
249 | + $obj_id = $request->get_param('id'); |
|
250 | + // this is where we would apply more fine-grained caps |
|
251 | + $model_obj = $model->get_one_by_ID($obj_id); |
|
252 | + if (! $model_obj instanceof EE_Base_Class) { |
|
253 | + $lowercase_model_name = strtolower($model->get_this_model_name()); |
|
254 | + throw new RestException( |
|
255 | + sprintf('rest_%s_invalid_id', $lowercase_model_name), |
|
256 | + sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name), |
|
257 | + array('status' => 404) |
|
258 | + ); |
|
259 | + } |
|
260 | + $requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN); |
|
261 | + $requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN); |
|
262 | + if ($requested_permanent_delete) { |
|
263 | + $previous = $this->returnModelObjAsJsonResponse($model_obj, $request); |
|
264 | + $deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking); |
|
265 | + return array( |
|
266 | + 'deleted' => $deleted, |
|
267 | + 'previous' => $previous, |
|
268 | + ); |
|
269 | + } else { |
|
270 | + if ($model instanceof EEM_Soft_Delete_Base) { |
|
271 | + $model->delete_by_ID($obj_id, $requested_allow_blocking); |
|
272 | + return $this->returnModelObjAsJsonResponse($model_obj, $request); |
|
273 | + } else { |
|
274 | + throw new RestException( |
|
275 | + 'rest_trash_not_supported', |
|
276 | + 501, |
|
277 | + sprintf( |
|
278 | + esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'), |
|
279 | + EEH_Inflector::pluralize($model->get_this_model_name()) |
|
280 | + ) |
|
281 | + ); |
|
282 | + } |
|
283 | + } |
|
284 | + } |
|
285 | 285 | |
286 | 286 | |
287 | - /** |
|
288 | - * Returns an array ready to be converted into a JSON response, based solely on the model object |
|
289 | - * |
|
290 | - * @param EE_Base_Class $model_obj |
|
291 | - * @param WP_REST_Request $request |
|
292 | - * @return array ready for a response |
|
293 | - */ |
|
294 | - protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request) |
|
295 | - { |
|
296 | - $model = $model_obj->get_model(); |
|
297 | - // create an array exactly like the wpdb results row, |
|
298 | - // so we can pass it to controllers/model/Read::create_entity_from_wpdb_result() |
|
299 | - $simulated_db_row = array(); |
|
300 | - foreach ($model->field_settings(true) as $field_name => $field_obj) { |
|
301 | - // we need to reconstruct the normal wpdb results, including the db-only fields |
|
302 | - // like a secondary table's primary key. The models expect those (but don't care what value they have) |
|
303 | - if ($field_obj instanceof EE_DB_Only_Field_Base) { |
|
304 | - $raw_value = true; |
|
305 | - } elseif ($field_obj instanceof EE_Datetime_Field) { |
|
306 | - $raw_value = $model_obj->get_DateTime_object($field_name); |
|
307 | - } else { |
|
308 | - $raw_value = $model_obj->get_raw($field_name); |
|
309 | - } |
|
310 | - $simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value); |
|
311 | - } |
|
312 | - $read_controller = new Read(); |
|
313 | - $read_controller->setRequestedVersion($this->getRequestedVersion()); |
|
314 | - // the simulates request really doesn't need any info downstream |
|
315 | - $simulated_request = new WP_REST_Request('GET'); |
|
316 | - return $read_controller->createEntityFromWpdbResult( |
|
317 | - $model_obj->get_model(), |
|
318 | - $simulated_db_row, |
|
319 | - $simulated_request |
|
320 | - ); |
|
321 | - } |
|
287 | + /** |
|
288 | + * Returns an array ready to be converted into a JSON response, based solely on the model object |
|
289 | + * |
|
290 | + * @param EE_Base_Class $model_obj |
|
291 | + * @param WP_REST_Request $request |
|
292 | + * @return array ready for a response |
|
293 | + */ |
|
294 | + protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request) |
|
295 | + { |
|
296 | + $model = $model_obj->get_model(); |
|
297 | + // create an array exactly like the wpdb results row, |
|
298 | + // so we can pass it to controllers/model/Read::create_entity_from_wpdb_result() |
|
299 | + $simulated_db_row = array(); |
|
300 | + foreach ($model->field_settings(true) as $field_name => $field_obj) { |
|
301 | + // we need to reconstruct the normal wpdb results, including the db-only fields |
|
302 | + // like a secondary table's primary key. The models expect those (but don't care what value they have) |
|
303 | + if ($field_obj instanceof EE_DB_Only_Field_Base) { |
|
304 | + $raw_value = true; |
|
305 | + } elseif ($field_obj instanceof EE_Datetime_Field) { |
|
306 | + $raw_value = $model_obj->get_DateTime_object($field_name); |
|
307 | + } else { |
|
308 | + $raw_value = $model_obj->get_raw($field_name); |
|
309 | + } |
|
310 | + $simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value); |
|
311 | + } |
|
312 | + $read_controller = new Read(); |
|
313 | + $read_controller->setRequestedVersion($this->getRequestedVersion()); |
|
314 | + // the simulates request really doesn't need any info downstream |
|
315 | + $simulated_request = new WP_REST_Request('GET'); |
|
316 | + return $read_controller->createEntityFromWpdbResult( |
|
317 | + $model_obj->get_model(), |
|
318 | + $simulated_db_row, |
|
319 | + $simulated_request |
|
320 | + ); |
|
321 | + } |
|
322 | 322 | |
323 | 323 | |
324 | - /** |
|
325 | - * Gets the item affected by this request |
|
326 | - * |
|
327 | - * @param EEM_Base $model |
|
328 | - * @param WP_REST_Request $request |
|
329 | - * @param int|string $obj_id |
|
330 | - * @return \WP_Error|array |
|
331 | - */ |
|
332 | - protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id) |
|
333 | - { |
|
334 | - $requested_version = $this->getRequestedVersion($request->get_route()); |
|
335 | - $get_request = new WP_REST_Request( |
|
336 | - 'GET', |
|
337 | - EED_Core_Rest_Api::ee_api_namespace |
|
338 | - . $requested_version |
|
339 | - . '/' |
|
340 | - . EEH_Inflector::pluralize_and_lower($model->get_this_model_name()) |
|
341 | - . '/' |
|
342 | - . $obj_id |
|
343 | - ); |
|
344 | - $get_request->set_url_params( |
|
345 | - array( |
|
346 | - 'id' => $obj_id, |
|
347 | - 'include' => $request->get_param('include'), |
|
348 | - ) |
|
349 | - ); |
|
350 | - $read_controller = new Read(); |
|
351 | - $read_controller->setRequestedVersion($this->getRequestedVersion()); |
|
352 | - return $read_controller->getEntityFromModel($model, $get_request); |
|
353 | - } |
|
324 | + /** |
|
325 | + * Gets the item affected by this request |
|
326 | + * |
|
327 | + * @param EEM_Base $model |
|
328 | + * @param WP_REST_Request $request |
|
329 | + * @param int|string $obj_id |
|
330 | + * @return \WP_Error|array |
|
331 | + */ |
|
332 | + protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id) |
|
333 | + { |
|
334 | + $requested_version = $this->getRequestedVersion($request->get_route()); |
|
335 | + $get_request = new WP_REST_Request( |
|
336 | + 'GET', |
|
337 | + EED_Core_Rest_Api::ee_api_namespace |
|
338 | + . $requested_version |
|
339 | + . '/' |
|
340 | + . EEH_Inflector::pluralize_and_lower($model->get_this_model_name()) |
|
341 | + . '/' |
|
342 | + . $obj_id |
|
343 | + ); |
|
344 | + $get_request->set_url_params( |
|
345 | + array( |
|
346 | + 'id' => $obj_id, |
|
347 | + 'include' => $request->get_param('include'), |
|
348 | + ) |
|
349 | + ); |
|
350 | + $read_controller = new Read(); |
|
351 | + $read_controller->setRequestedVersion($this->getRequestedVersion()); |
|
352 | + return $read_controller->getEntityFromModel($model, $get_request); |
|
353 | + } |
|
354 | 354 | } |
@@ -125,9 +125,9 @@ discard block |
||
125 | 125 | { |
126 | 126 | Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create'); |
127 | 127 | $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
128 | - if (! current_user_can($default_cap_to_check_for)) { |
|
128 | + if ( ! current_user_can($default_cap_to_check_for)) { |
|
129 | 129 | throw new RestException( |
130 | - 'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
130 | + 'rest_cannot_create_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
131 | 131 | sprintf( |
132 | 132 | esc_html__( |
133 | 133 | // @codingStandardsIgnoreStart |
@@ -155,7 +155,7 @@ discard block |
||
155 | 155 | ); |
156 | 156 | $model_obj->save(); |
157 | 157 | $new_id = $model_obj->ID(); |
158 | - if (! $new_id) { |
|
158 | + if ( ! $new_id) { |
|
159 | 159 | throw new RestException( |
160 | 160 | 'rest_insertion_failed', |
161 | 161 | sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name()) |
@@ -177,9 +177,9 @@ discard block |
||
177 | 177 | { |
178 | 178 | Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit'); |
179 | 179 | $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
180 | - if (! current_user_can($default_cap_to_check_for)) { |
|
180 | + if ( ! current_user_can($default_cap_to_check_for)) { |
|
181 | 181 | throw new RestException( |
182 | - 'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
182 | + 'rest_cannot_edit_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
183 | 183 | sprintf( |
184 | 184 | esc_html__( |
185 | 185 | // @codingStandardsIgnoreStart |
@@ -193,7 +193,7 @@ discard block |
||
193 | 193 | ); |
194 | 194 | } |
195 | 195 | $obj_id = $request->get_param('id'); |
196 | - if (! $obj_id) { |
|
196 | + if ( ! $obj_id) { |
|
197 | 197 | throw new RestException( |
198 | 198 | 'rest_edit_failed', |
199 | 199 | sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name()) |
@@ -206,7 +206,7 @@ discard block |
||
206 | 206 | true |
207 | 207 | ); |
208 | 208 | $model_obj = $model->get_one_by_ID($obj_id); |
209 | - if (! $model_obj instanceof EE_Base_Class) { |
|
209 | + if ( ! $model_obj instanceof EE_Base_Class) { |
|
210 | 210 | $lowercase_model_name = strtolower($model->get_this_model_name()); |
211 | 211 | throw new RestException( |
212 | 212 | sprintf('rest_%s_invalid_id', $lowercase_model_name), |
@@ -231,9 +231,9 @@ discard block |
||
231 | 231 | { |
232 | 232 | Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete'); |
233 | 233 | $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
234 | - if (! current_user_can($default_cap_to_check_for)) { |
|
234 | + if ( ! current_user_can($default_cap_to_check_for)) { |
|
235 | 235 | throw new RestException( |
236 | - 'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
236 | + 'rest_cannot_delete_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())), |
|
237 | 237 | sprintf( |
238 | 238 | esc_html__( |
239 | 239 | // @codingStandardsIgnoreStart |
@@ -249,7 +249,7 @@ discard block |
||
249 | 249 | $obj_id = $request->get_param('id'); |
250 | 250 | // this is where we would apply more fine-grained caps |
251 | 251 | $model_obj = $model->get_one_by_ID($obj_id); |
252 | - if (! $model_obj instanceof EE_Base_Class) { |
|
252 | + if ( ! $model_obj instanceof EE_Base_Class) { |
|
253 | 253 | $lowercase_model_name = strtolower($model->get_this_model_name()); |
254 | 254 | throw new RestException( |
255 | 255 | sprintf('rest_%s_invalid_id', $lowercase_model_name), |
@@ -307,7 +307,7 @@ discard block |
||
307 | 307 | } else { |
308 | 308 | $raw_value = $model_obj->get_raw($field_name); |
309 | 309 | } |
310 | - $simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value); |
|
310 | + $simulated_db_row[$field_obj->get_qualified_column()] = $field_obj->prepare_for_use_in_db($raw_value); |
|
311 | 311 | } |
312 | 312 | $read_controller = new Read(); |
313 | 313 | $read_controller->setRequestedVersion($this->getRequestedVersion()); |
@@ -23,122 +23,122 @@ |
||
23 | 23 | { |
24 | 24 | |
25 | 25 | |
26 | - /** |
|
27 | - * @param \WP_REST_Request $request |
|
28 | - * @param string $version |
|
29 | - * @return array|\WP_REST_Response |
|
30 | - */ |
|
31 | - public static function handleRequestModelsMeta(\WP_REST_Request $request, $version) |
|
32 | - { |
|
33 | - $controller = new Meta(); |
|
34 | - try { |
|
35 | - $controller->setRequestedVersion($version); |
|
36 | - return $controller->sendResponse($controller->getModelsMetadataEntity()); |
|
37 | - } catch (Exception $e) { |
|
38 | - return $controller->sendResponse($e); |
|
39 | - } |
|
40 | - } |
|
26 | + /** |
|
27 | + * @param \WP_REST_Request $request |
|
28 | + * @param string $version |
|
29 | + * @return array|\WP_REST_Response |
|
30 | + */ |
|
31 | + public static function handleRequestModelsMeta(\WP_REST_Request $request, $version) |
|
32 | + { |
|
33 | + $controller = new Meta(); |
|
34 | + try { |
|
35 | + $controller->setRequestedVersion($version); |
|
36 | + return $controller->sendResponse($controller->getModelsMetadataEntity()); |
|
37 | + } catch (Exception $e) { |
|
38 | + return $controller->sendResponse($e); |
|
39 | + } |
|
40 | + } |
|
41 | 41 | |
42 | 42 | |
43 | - /* |
|
43 | + /* |
|
44 | 44 | * Gets the model metadata resource entity |
45 | 45 | * @return array for JSON response, describing all the models available in teh requested version |
46 | 46 | */ |
47 | - protected function getModelsMetadataEntity() |
|
48 | - { |
|
49 | - $response = array(); |
|
50 | - foreach ($this->getModelVersionInfo()->modelsForRequestedVersion() as $model_name => $model_classname) { |
|
51 | - $model = $this->getModelVersionInfo()->loadModel($model_name); |
|
52 | - $fields_json = array(); |
|
53 | - foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field_obj) { |
|
54 | - if ($this->getModelVersionInfo()->fieldIsIgnored($field_obj)) { |
|
55 | - continue; |
|
56 | - } |
|
57 | - if ($field_obj instanceof EE_Boolean_Field) { |
|
58 | - $datatype = 'Boolean'; |
|
59 | - } elseif ($field_obj->get_wpdb_data_type() == '%d') { |
|
60 | - $datatype = 'Number'; |
|
61 | - } elseif ($field_name instanceof EE_Serialized_Text_Field) { |
|
62 | - $datatype = 'Object'; |
|
63 | - } else { |
|
64 | - $datatype = 'String'; |
|
65 | - } |
|
66 | - $default_value = ModelDataTranslator::prepareFieldValueForJson( |
|
67 | - $field_obj, |
|
68 | - $field_obj->get_default_value(), |
|
69 | - $this->getModelVersionInfo()->requestedVersion() |
|
70 | - ); |
|
71 | - $field_json = array( |
|
72 | - 'name' => $field_name, |
|
73 | - 'nicename' => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES), |
|
74 | - 'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj), |
|
75 | - 'has_pretty_format' => $this->getModelVersionInfo()->fieldHasPrettyFormat($field_obj), |
|
76 | - 'type' => str_replace('EE_', '', get_class($field_obj)), |
|
77 | - 'datatype' => $datatype, |
|
78 | - 'nullable' => $field_obj->is_nullable(), |
|
79 | - 'default' => $default_value, |
|
80 | - 'table_alias' => $field_obj->get_table_alias(), |
|
81 | - 'table_column' => $field_obj->get_table_column(), |
|
82 | - ); |
|
83 | - $fields_json[ $field_json['name'] ] = $field_json; |
|
84 | - } |
|
85 | - $fields_json = array_merge( |
|
86 | - $fields_json, |
|
87 | - $this->getModelVersionInfo()->extraResourcePropertiesForModel($model) |
|
88 | - ); |
|
89 | - $response[ $model_name ]['fields'] = apply_filters( |
|
90 | - 'FHEE__Meta__handle_request_models_meta__fields', |
|
91 | - $fields_json, |
|
92 | - $model |
|
93 | - ); |
|
94 | - $relations_json = array(); |
|
95 | - foreach ($model->relation_settings() as $relation_name => $relation_obj) { |
|
96 | - $relation_json = array( |
|
97 | - 'name' => $relation_name, |
|
98 | - 'type' => str_replace('EE_', '', get_class($relation_obj)), |
|
99 | - 'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false, |
|
100 | - ); |
|
101 | - $relations_json[ $relation_name ] = $relation_json; |
|
102 | - } |
|
103 | - $response[ $model_name ]['relations'] = apply_filters( |
|
104 | - 'FHEE__Meta__handle_request_models_meta__relations', |
|
105 | - $relations_json, |
|
106 | - $model |
|
107 | - ); |
|
108 | - } |
|
109 | - return $response; |
|
110 | - } |
|
47 | + protected function getModelsMetadataEntity() |
|
48 | + { |
|
49 | + $response = array(); |
|
50 | + foreach ($this->getModelVersionInfo()->modelsForRequestedVersion() as $model_name => $model_classname) { |
|
51 | + $model = $this->getModelVersionInfo()->loadModel($model_name); |
|
52 | + $fields_json = array(); |
|
53 | + foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field_obj) { |
|
54 | + if ($this->getModelVersionInfo()->fieldIsIgnored($field_obj)) { |
|
55 | + continue; |
|
56 | + } |
|
57 | + if ($field_obj instanceof EE_Boolean_Field) { |
|
58 | + $datatype = 'Boolean'; |
|
59 | + } elseif ($field_obj->get_wpdb_data_type() == '%d') { |
|
60 | + $datatype = 'Number'; |
|
61 | + } elseif ($field_name instanceof EE_Serialized_Text_Field) { |
|
62 | + $datatype = 'Object'; |
|
63 | + } else { |
|
64 | + $datatype = 'String'; |
|
65 | + } |
|
66 | + $default_value = ModelDataTranslator::prepareFieldValueForJson( |
|
67 | + $field_obj, |
|
68 | + $field_obj->get_default_value(), |
|
69 | + $this->getModelVersionInfo()->requestedVersion() |
|
70 | + ); |
|
71 | + $field_json = array( |
|
72 | + 'name' => $field_name, |
|
73 | + 'nicename' => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES), |
|
74 | + 'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj), |
|
75 | + 'has_pretty_format' => $this->getModelVersionInfo()->fieldHasPrettyFormat($field_obj), |
|
76 | + 'type' => str_replace('EE_', '', get_class($field_obj)), |
|
77 | + 'datatype' => $datatype, |
|
78 | + 'nullable' => $field_obj->is_nullable(), |
|
79 | + 'default' => $default_value, |
|
80 | + 'table_alias' => $field_obj->get_table_alias(), |
|
81 | + 'table_column' => $field_obj->get_table_column(), |
|
82 | + ); |
|
83 | + $fields_json[ $field_json['name'] ] = $field_json; |
|
84 | + } |
|
85 | + $fields_json = array_merge( |
|
86 | + $fields_json, |
|
87 | + $this->getModelVersionInfo()->extraResourcePropertiesForModel($model) |
|
88 | + ); |
|
89 | + $response[ $model_name ]['fields'] = apply_filters( |
|
90 | + 'FHEE__Meta__handle_request_models_meta__fields', |
|
91 | + $fields_json, |
|
92 | + $model |
|
93 | + ); |
|
94 | + $relations_json = array(); |
|
95 | + foreach ($model->relation_settings() as $relation_name => $relation_obj) { |
|
96 | + $relation_json = array( |
|
97 | + 'name' => $relation_name, |
|
98 | + 'type' => str_replace('EE_', '', get_class($relation_obj)), |
|
99 | + 'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false, |
|
100 | + ); |
|
101 | + $relations_json[ $relation_name ] = $relation_json; |
|
102 | + } |
|
103 | + $response[ $model_name ]['relations'] = apply_filters( |
|
104 | + 'FHEE__Meta__handle_request_models_meta__relations', |
|
105 | + $relations_json, |
|
106 | + $model |
|
107 | + ); |
|
108 | + } |
|
109 | + return $response; |
|
110 | + } |
|
111 | 111 | |
112 | 112 | |
113 | - /** |
|
114 | - * Adds EE metadata to the index |
|
115 | - * |
|
116 | - * @param \WP_REST_Response $rest_response_obj |
|
117 | - * @return \WP_REST_Response |
|
118 | - */ |
|
119 | - public static function filterEeMetadataIntoIndex(\WP_REST_Response $rest_response_obj) |
|
120 | - { |
|
121 | - $response_data = $rest_response_obj->get_data(); |
|
122 | - $addons = array(); |
|
123 | - foreach (EE_Registry::instance()->addons as $addon) { |
|
124 | - $addon_json = array( |
|
125 | - 'name' => $addon->name(), |
|
126 | - 'version' => $addon->version(), |
|
127 | - ); |
|
128 | - $addons[ $addon_json['name'] ] = $addon_json; |
|
129 | - } |
|
130 | - $response_data['ee'] = array( |
|
131 | - 'version' => EEM_System_Status::instance()->get_ee_version(), |
|
132 | - // @codingStandardsIgnoreStart |
|
133 | - 'documentation_url' => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API', |
|
134 | - // @codingStandardsIgnoreEnd |
|
135 | - 'addons' => $addons, |
|
136 | - 'maintenance_mode' => EE_Maintenance_Mode::instance()->real_level(), |
|
137 | - 'served_core_versions' => array_keys(EED_Core_Rest_Api::versions_served()), |
|
138 | - ); |
|
139 | - $rest_response_obj->set_data($response_data); |
|
140 | - return $rest_response_obj; |
|
141 | - } |
|
113 | + /** |
|
114 | + * Adds EE metadata to the index |
|
115 | + * |
|
116 | + * @param \WP_REST_Response $rest_response_obj |
|
117 | + * @return \WP_REST_Response |
|
118 | + */ |
|
119 | + public static function filterEeMetadataIntoIndex(\WP_REST_Response $rest_response_obj) |
|
120 | + { |
|
121 | + $response_data = $rest_response_obj->get_data(); |
|
122 | + $addons = array(); |
|
123 | + foreach (EE_Registry::instance()->addons as $addon) { |
|
124 | + $addon_json = array( |
|
125 | + 'name' => $addon->name(), |
|
126 | + 'version' => $addon->version(), |
|
127 | + ); |
|
128 | + $addons[ $addon_json['name'] ] = $addon_json; |
|
129 | + } |
|
130 | + $response_data['ee'] = array( |
|
131 | + 'version' => EEM_System_Status::instance()->get_ee_version(), |
|
132 | + // @codingStandardsIgnoreStart |
|
133 | + 'documentation_url' => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API', |
|
134 | + // @codingStandardsIgnoreEnd |
|
135 | + 'addons' => $addons, |
|
136 | + 'maintenance_mode' => EE_Maintenance_Mode::instance()->real_level(), |
|
137 | + 'served_core_versions' => array_keys(EED_Core_Rest_Api::versions_served()), |
|
138 | + ); |
|
139 | + $rest_response_obj->set_data($response_data); |
|
140 | + return $rest_response_obj; |
|
141 | + } |
|
142 | 142 | } |
143 | 143 | |
144 | 144 |
@@ -80,13 +80,13 @@ discard block |
||
80 | 80 | 'table_alias' => $field_obj->get_table_alias(), |
81 | 81 | 'table_column' => $field_obj->get_table_column(), |
82 | 82 | ); |
83 | - $fields_json[ $field_json['name'] ] = $field_json; |
|
83 | + $fields_json[$field_json['name']] = $field_json; |
|
84 | 84 | } |
85 | 85 | $fields_json = array_merge( |
86 | 86 | $fields_json, |
87 | 87 | $this->getModelVersionInfo()->extraResourcePropertiesForModel($model) |
88 | 88 | ); |
89 | - $response[ $model_name ]['fields'] = apply_filters( |
|
89 | + $response[$model_name]['fields'] = apply_filters( |
|
90 | 90 | 'FHEE__Meta__handle_request_models_meta__fields', |
91 | 91 | $fields_json, |
92 | 92 | $model |
@@ -98,9 +98,9 @@ discard block |
||
98 | 98 | 'type' => str_replace('EE_', '', get_class($relation_obj)), |
99 | 99 | 'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false, |
100 | 100 | ); |
101 | - $relations_json[ $relation_name ] = $relation_json; |
|
101 | + $relations_json[$relation_name] = $relation_json; |
|
102 | 102 | } |
103 | - $response[ $model_name ]['relations'] = apply_filters( |
|
103 | + $response[$model_name]['relations'] = apply_filters( |
|
104 | 104 | 'FHEE__Meta__handle_request_models_meta__relations', |
105 | 105 | $relations_json, |
106 | 106 | $model |
@@ -125,7 +125,7 @@ discard block |
||
125 | 125 | 'name' => $addon->name(), |
126 | 126 | 'version' => $addon->version(), |
127 | 127 | ); |
128 | - $addons[ $addon_json['name'] ] = $addon_json; |
|
128 | + $addons[$addon_json['name']] = $addon_json; |
|
129 | 129 | } |
130 | 130 | $response_data['ee'] = array( |
131 | 131 | 'version' => EEM_System_Status::instance()->get_ee_version(), |
@@ -19,124 +19,124 @@ |
||
19 | 19 | class CalculatedModelFields |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * @var array |
|
24 | - */ |
|
25 | - protected $mapping; |
|
22 | + /** |
|
23 | + * @var array |
|
24 | + */ |
|
25 | + protected $mapping; |
|
26 | 26 | |
27 | 27 | |
28 | - /** |
|
29 | - * @param bool $refresh |
|
30 | - * @return array top-level-keys are model names (eg "Event") |
|
31 | - * next-level are the calculated field names AND method names on classes |
|
32 | - * which perform calculations, values are the fully qualified classnames which do the calculations |
|
33 | - * These callbacks should accept as arguments: |
|
34 | - * the wpdb row results, |
|
35 | - * the WP_Request object, |
|
36 | - * the controller object |
|
37 | - */ |
|
38 | - public function mapping($refresh = false) |
|
39 | - { |
|
40 | - if (! $this->mapping || $refresh) { |
|
41 | - $this->mapping = $this->generateNewMapping(); |
|
42 | - } |
|
43 | - return $this->mapping; |
|
44 | - } |
|
28 | + /** |
|
29 | + * @param bool $refresh |
|
30 | + * @return array top-level-keys are model names (eg "Event") |
|
31 | + * next-level are the calculated field names AND method names on classes |
|
32 | + * which perform calculations, values are the fully qualified classnames which do the calculations |
|
33 | + * These callbacks should accept as arguments: |
|
34 | + * the wpdb row results, |
|
35 | + * the WP_Request object, |
|
36 | + * the controller object |
|
37 | + */ |
|
38 | + public function mapping($refresh = false) |
|
39 | + { |
|
40 | + if (! $this->mapping || $refresh) { |
|
41 | + $this->mapping = $this->generateNewMapping(); |
|
42 | + } |
|
43 | + return $this->mapping; |
|
44 | + } |
|
45 | 45 | |
46 | 46 | |
47 | - /** |
|
48 | - * Generates anew mapping between model calculated fields and their callbacks |
|
49 | - * |
|
50 | - * @return array |
|
51 | - */ |
|
52 | - protected function generateNewMapping() |
|
53 | - { |
|
54 | - $rest_api_calculations_namespace = 'EventEspresso\core\libraries\rest_api\calculations\\'; |
|
55 | - $event_calculations_class = $rest_api_calculations_namespace . 'Event'; |
|
56 | - $datetime_calculations_class = $rest_api_calculations_namespace . 'Datetime'; |
|
57 | - $registration_class = $rest_api_calculations_namespace . 'Registration'; |
|
58 | - return apply_filters( |
|
59 | - 'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping', |
|
60 | - array( |
|
61 | - 'Event' => array( |
|
62 | - 'optimum_sales_at_start' => $event_calculations_class, |
|
63 | - 'optimum_sales_now' => $event_calculations_class, |
|
64 | - 'spots_taken' => $event_calculations_class, |
|
65 | - 'spots_taken_pending_payment' => $event_calculations_class, |
|
66 | - 'spaces_remaining' => $event_calculations_class, |
|
67 | - 'registrations_checked_in_count' => $event_calculations_class, |
|
68 | - 'registrations_checked_out_count' => $event_calculations_class, |
|
69 | - 'image_thumbnail' => $event_calculations_class, |
|
70 | - 'image_medium' => $event_calculations_class, |
|
71 | - 'image_medium_large' => $event_calculations_class, |
|
72 | - 'image_large' => $event_calculations_class, |
|
73 | - 'image_post_thumbnail' => $event_calculations_class, |
|
74 | - 'image_full' => $event_calculations_class, |
|
75 | - ), |
|
76 | - 'Datetime' => array( |
|
77 | - 'spaces_remaining_considering_tickets' => $datetime_calculations_class, |
|
78 | - 'registrations_checked_in_count' => $datetime_calculations_class, |
|
79 | - 'registrations_checked_out_count' => $datetime_calculations_class, |
|
80 | - 'spots_taken_pending_payment' => $datetime_calculations_class, |
|
81 | - ), |
|
82 | - 'Registration' => array( |
|
83 | - 'datetime_checkin_stati' => $registration_class, |
|
84 | - ), |
|
85 | - ) |
|
86 | - ); |
|
87 | - } |
|
47 | + /** |
|
48 | + * Generates anew mapping between model calculated fields and their callbacks |
|
49 | + * |
|
50 | + * @return array |
|
51 | + */ |
|
52 | + protected function generateNewMapping() |
|
53 | + { |
|
54 | + $rest_api_calculations_namespace = 'EventEspresso\core\libraries\rest_api\calculations\\'; |
|
55 | + $event_calculations_class = $rest_api_calculations_namespace . 'Event'; |
|
56 | + $datetime_calculations_class = $rest_api_calculations_namespace . 'Datetime'; |
|
57 | + $registration_class = $rest_api_calculations_namespace . 'Registration'; |
|
58 | + return apply_filters( |
|
59 | + 'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping', |
|
60 | + array( |
|
61 | + 'Event' => array( |
|
62 | + 'optimum_sales_at_start' => $event_calculations_class, |
|
63 | + 'optimum_sales_now' => $event_calculations_class, |
|
64 | + 'spots_taken' => $event_calculations_class, |
|
65 | + 'spots_taken_pending_payment' => $event_calculations_class, |
|
66 | + 'spaces_remaining' => $event_calculations_class, |
|
67 | + 'registrations_checked_in_count' => $event_calculations_class, |
|
68 | + 'registrations_checked_out_count' => $event_calculations_class, |
|
69 | + 'image_thumbnail' => $event_calculations_class, |
|
70 | + 'image_medium' => $event_calculations_class, |
|
71 | + 'image_medium_large' => $event_calculations_class, |
|
72 | + 'image_large' => $event_calculations_class, |
|
73 | + 'image_post_thumbnail' => $event_calculations_class, |
|
74 | + 'image_full' => $event_calculations_class, |
|
75 | + ), |
|
76 | + 'Datetime' => array( |
|
77 | + 'spaces_remaining_considering_tickets' => $datetime_calculations_class, |
|
78 | + 'registrations_checked_in_count' => $datetime_calculations_class, |
|
79 | + 'registrations_checked_out_count' => $datetime_calculations_class, |
|
80 | + 'spots_taken_pending_payment' => $datetime_calculations_class, |
|
81 | + ), |
|
82 | + 'Registration' => array( |
|
83 | + 'datetime_checkin_stati' => $registration_class, |
|
84 | + ), |
|
85 | + ) |
|
86 | + ); |
|
87 | + } |
|
88 | 88 | |
89 | 89 | |
90 | - /** |
|
91 | - * Gets the known calculated fields for model |
|
92 | - * |
|
93 | - * @param EEM_Base $model |
|
94 | - * @return array allowable values for this field |
|
95 | - */ |
|
96 | - public function retrieveCalculatedFieldsForModel(EEM_Base $model) |
|
97 | - { |
|
98 | - $mapping = $this->mapping(); |
|
99 | - if (isset($mapping[ $model->get_this_model_name() ])) { |
|
100 | - return array_keys($mapping[ $model->get_this_model_name() ]); |
|
101 | - } else { |
|
102 | - return array(); |
|
103 | - } |
|
104 | - } |
|
90 | + /** |
|
91 | + * Gets the known calculated fields for model |
|
92 | + * |
|
93 | + * @param EEM_Base $model |
|
94 | + * @return array allowable values for this field |
|
95 | + */ |
|
96 | + public function retrieveCalculatedFieldsForModel(EEM_Base $model) |
|
97 | + { |
|
98 | + $mapping = $this->mapping(); |
|
99 | + if (isset($mapping[ $model->get_this_model_name() ])) { |
|
100 | + return array_keys($mapping[ $model->get_this_model_name() ]); |
|
101 | + } else { |
|
102 | + return array(); |
|
103 | + } |
|
104 | + } |
|
105 | 105 | |
106 | 106 | |
107 | - /** |
|
108 | - * Retrieves the value for this calculation |
|
109 | - * |
|
110 | - * @param EEM_Base $model |
|
111 | - * @param string $field_name |
|
112 | - * @param array $wpdb_row |
|
113 | - * @param \WP_REST_Request |
|
114 | - * @param \EventEspresso\core\libraries\rest_api\controllers\Base $controller |
|
115 | - * @return mixed|null |
|
116 | - * @throws \EE_Error |
|
117 | - */ |
|
118 | - public function retrieveCalculatedFieldValue( |
|
119 | - EEM_Base $model, |
|
120 | - $field_name, |
|
121 | - $wpdb_row, |
|
122 | - $rest_request, |
|
123 | - Base $controller |
|
124 | - ) { |
|
125 | - $mapping = $this->mapping(); |
|
126 | - if (isset($mapping[ $model->get_this_model_name() ]) |
|
127 | - && isset($mapping[ $model->get_this_model_name() ][ $field_name ]) |
|
128 | - ) { |
|
129 | - $classname = $mapping[ $model->get_this_model_name() ][ $field_name ]; |
|
130 | - $class_method_name = EEH_Inflector::camelize_all_but_first($field_name); |
|
131 | - return call_user_func(array($classname, $class_method_name), $wpdb_row, $rest_request, $controller); |
|
132 | - } |
|
133 | - throw new RestException( |
|
134 | - 'calculated_field_does_not_exist', |
|
135 | - sprintf( |
|
136 | - __('There is no calculated field %1$s on resource %2$s', 'event_espresso'), |
|
137 | - $field_name, |
|
138 | - $model->get_this_model_name() |
|
139 | - ) |
|
140 | - ); |
|
141 | - } |
|
107 | + /** |
|
108 | + * Retrieves the value for this calculation |
|
109 | + * |
|
110 | + * @param EEM_Base $model |
|
111 | + * @param string $field_name |
|
112 | + * @param array $wpdb_row |
|
113 | + * @param \WP_REST_Request |
|
114 | + * @param \EventEspresso\core\libraries\rest_api\controllers\Base $controller |
|
115 | + * @return mixed|null |
|
116 | + * @throws \EE_Error |
|
117 | + */ |
|
118 | + public function retrieveCalculatedFieldValue( |
|
119 | + EEM_Base $model, |
|
120 | + $field_name, |
|
121 | + $wpdb_row, |
|
122 | + $rest_request, |
|
123 | + Base $controller |
|
124 | + ) { |
|
125 | + $mapping = $this->mapping(); |
|
126 | + if (isset($mapping[ $model->get_this_model_name() ]) |
|
127 | + && isset($mapping[ $model->get_this_model_name() ][ $field_name ]) |
|
128 | + ) { |
|
129 | + $classname = $mapping[ $model->get_this_model_name() ][ $field_name ]; |
|
130 | + $class_method_name = EEH_Inflector::camelize_all_but_first($field_name); |
|
131 | + return call_user_func(array($classname, $class_method_name), $wpdb_row, $rest_request, $controller); |
|
132 | + } |
|
133 | + throw new RestException( |
|
134 | + 'calculated_field_does_not_exist', |
|
135 | + sprintf( |
|
136 | + __('There is no calculated field %1$s on resource %2$s', 'event_espresso'), |
|
137 | + $field_name, |
|
138 | + $model->get_this_model_name() |
|
139 | + ) |
|
140 | + ); |
|
141 | + } |
|
142 | 142 | } |
@@ -37,7 +37,7 @@ discard block |
||
37 | 37 | */ |
38 | 38 | public function mapping($refresh = false) |
39 | 39 | { |
40 | - if (! $this->mapping || $refresh) { |
|
40 | + if ( ! $this->mapping || $refresh) { |
|
41 | 41 | $this->mapping = $this->generateNewMapping(); |
42 | 42 | } |
43 | 43 | return $this->mapping; |
@@ -52,9 +52,9 @@ discard block |
||
52 | 52 | protected function generateNewMapping() |
53 | 53 | { |
54 | 54 | $rest_api_calculations_namespace = 'EventEspresso\core\libraries\rest_api\calculations\\'; |
55 | - $event_calculations_class = $rest_api_calculations_namespace . 'Event'; |
|
56 | - $datetime_calculations_class = $rest_api_calculations_namespace . 'Datetime'; |
|
57 | - $registration_class = $rest_api_calculations_namespace . 'Registration'; |
|
55 | + $event_calculations_class = $rest_api_calculations_namespace.'Event'; |
|
56 | + $datetime_calculations_class = $rest_api_calculations_namespace.'Datetime'; |
|
57 | + $registration_class = $rest_api_calculations_namespace.'Registration'; |
|
58 | 58 | return apply_filters( |
59 | 59 | 'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping', |
60 | 60 | array( |
@@ -96,8 +96,8 @@ discard block |
||
96 | 96 | public function retrieveCalculatedFieldsForModel(EEM_Base $model) |
97 | 97 | { |
98 | 98 | $mapping = $this->mapping(); |
99 | - if (isset($mapping[ $model->get_this_model_name() ])) { |
|
100 | - return array_keys($mapping[ $model->get_this_model_name() ]); |
|
99 | + if (isset($mapping[$model->get_this_model_name()])) { |
|
100 | + return array_keys($mapping[$model->get_this_model_name()]); |
|
101 | 101 | } else { |
102 | 102 | return array(); |
103 | 103 | } |
@@ -123,10 +123,10 @@ discard block |
||
123 | 123 | Base $controller |
124 | 124 | ) { |
125 | 125 | $mapping = $this->mapping(); |
126 | - if (isset($mapping[ $model->get_this_model_name() ]) |
|
127 | - && isset($mapping[ $model->get_this_model_name() ][ $field_name ]) |
|
126 | + if (isset($mapping[$model->get_this_model_name()]) |
|
127 | + && isset($mapping[$model->get_this_model_name()][$field_name]) |
|
128 | 128 | ) { |
129 | - $classname = $mapping[ $model->get_this_model_name() ][ $field_name ]; |
|
129 | + $classname = $mapping[$model->get_this_model_name()][$field_name]; |
|
130 | 130 | $class_method_name = EEH_Inflector::camelize_all_but_first($field_name); |
131 | 131 | return call_user_func(array($classname, $class_method_name), $wpdb_row, $rest_request, $controller); |
132 | 132 | } |
@@ -35,74 +35,74 @@ |
||
35 | 35 | abstract class ChangesInBase |
36 | 36 | { |
37 | 37 | |
38 | - /** |
|
39 | - * The version that these changes happened |
|
40 | - * |
|
41 | - * @var string |
|
42 | - */ |
|
43 | - protected $version = null; |
|
38 | + /** |
|
39 | + * The version that these changes happened |
|
40 | + * |
|
41 | + * @var string |
|
42 | + */ |
|
43 | + protected $version = null; |
|
44 | 44 | |
45 | 45 | |
46 | - /** |
|
47 | - * Called when an EE4 REST API request is made to an earlier version than |
|
48 | - * what is indicated in this class' name. |
|
49 | - * Uses WordPress' add_filter and add_action to modify the EE4 REST API's response |
|
50 | - * so that regardless of what version of EE4 core is running, API clients |
|
51 | - * will have a consistent response |
|
52 | - * |
|
53 | - * @return void |
|
54 | - */ |
|
55 | - abstract public function setHooks(); |
|
46 | + /** |
|
47 | + * Called when an EE4 REST API request is made to an earlier version than |
|
48 | + * what is indicated in this class' name. |
|
49 | + * Uses WordPress' add_filter and add_action to modify the EE4 REST API's response |
|
50 | + * so that regardless of what version of EE4 core is running, API clients |
|
51 | + * will have a consistent response |
|
52 | + * |
|
53 | + * @return void |
|
54 | + */ |
|
55 | + abstract public function setHooks(); |
|
56 | 56 | |
57 | 57 | |
58 | - /** |
|
59 | - * Returns whether or not this class' name indicates its hooks should |
|
60 | - * apply when a request comes in for $requested_version. A class can use |
|
61 | - * other conditions when determining whether to perform their callbacks or not, |
|
62 | - * but this will typically be enough |
|
63 | - * |
|
64 | - * @param string $requested_version eg "4.8.33" |
|
65 | - * @return boolean true: this class' name indicates its filters and actions |
|
66 | - * should take effect. False: this class' name indicates it shouldn't do anything |
|
67 | - */ |
|
68 | - public function appliesToVersion($requested_version) |
|
69 | - { |
|
70 | - if ($this->version() > $requested_version) { |
|
71 | - return true; |
|
72 | - } |
|
73 | - return false; |
|
74 | - } |
|
58 | + /** |
|
59 | + * Returns whether or not this class' name indicates its hooks should |
|
60 | + * apply when a request comes in for $requested_version. A class can use |
|
61 | + * other conditions when determining whether to perform their callbacks or not, |
|
62 | + * but this will typically be enough |
|
63 | + * |
|
64 | + * @param string $requested_version eg "4.8.33" |
|
65 | + * @return boolean true: this class' name indicates its filters and actions |
|
66 | + * should take effect. False: this class' name indicates it shouldn't do anything |
|
67 | + */ |
|
68 | + public function appliesToVersion($requested_version) |
|
69 | + { |
|
70 | + if ($this->version() > $requested_version) { |
|
71 | + return true; |
|
72 | + } |
|
73 | + return false; |
|
74 | + } |
|
75 | 75 | |
76 | 76 | |
77 | - /** |
|
78 | - * Gets the EE core version when this changes were made to the rest api. |
|
79 | - * Any requests to earlier versions should have modifications made to them |
|
80 | - * by the callbacks of this class. |
|
81 | - * |
|
82 | - * @return string eg "4.8.33" |
|
83 | - * @throws EE_Error |
|
84 | - */ |
|
85 | - public function version() |
|
86 | - { |
|
87 | - if ($this->version === null) { |
|
88 | - $matches = array(); |
|
89 | - $regex = '~ChangesIn(\d)(\d\d)(\d\d)$~'; |
|
90 | - $success = preg_match( |
|
91 | - $regex, |
|
92 | - get_class($this), |
|
93 | - $matches |
|
94 | - ); |
|
95 | - if (! $success) { |
|
96 | - throw new EE_Error( |
|
97 | - sprintf( |
|
98 | - __('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'), |
|
99 | - get_class($this), |
|
100 | - $regex |
|
101 | - ) |
|
102 | - ); |
|
103 | - } |
|
104 | - $this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3]; |
|
105 | - } |
|
106 | - return $this->version; |
|
107 | - } |
|
77 | + /** |
|
78 | + * Gets the EE core version when this changes were made to the rest api. |
|
79 | + * Any requests to earlier versions should have modifications made to them |
|
80 | + * by the callbacks of this class. |
|
81 | + * |
|
82 | + * @return string eg "4.8.33" |
|
83 | + * @throws EE_Error |
|
84 | + */ |
|
85 | + public function version() |
|
86 | + { |
|
87 | + if ($this->version === null) { |
|
88 | + $matches = array(); |
|
89 | + $regex = '~ChangesIn(\d)(\d\d)(\d\d)$~'; |
|
90 | + $success = preg_match( |
|
91 | + $regex, |
|
92 | + get_class($this), |
|
93 | + $matches |
|
94 | + ); |
|
95 | + if (! $success) { |
|
96 | + throw new EE_Error( |
|
97 | + sprintf( |
|
98 | + __('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'), |
|
99 | + get_class($this), |
|
100 | + $regex |
|
101 | + ) |
|
102 | + ); |
|
103 | + } |
|
104 | + $this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3]; |
|
105 | + } |
|
106 | + return $this->version; |
|
107 | + } |
|
108 | 108 | } |
@@ -92,7 +92,7 @@ discard block |
||
92 | 92 | get_class($this), |
93 | 93 | $matches |
94 | 94 | ); |
95 | - if (! $success) { |
|
95 | + if ( ! $success) { |
|
96 | 96 | throw new EE_Error( |
97 | 97 | sprintf( |
98 | 98 | __('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'), |
@@ -101,7 +101,7 @@ discard block |
||
101 | 101 | ) |
102 | 102 | ); |
103 | 103 | } |
104 | - $this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3]; |
|
104 | + $this->version = (int) $matches[1].'.'.(int) $matches[2].'.'.(int) $matches[3]; |
|
105 | 105 | } |
106 | 106 | return $this->version; |
107 | 107 | } |