Commit | Line | Data |
---|---|---|
dcef11bd TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
dcef11bd | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
dcef11bd TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
dcef11bd TO |
27 | |
28 | namespace Civi\API\Subscriber; | |
8882ff5c | 29 | |
dcef11bd TO |
30 | use Civi\API\Events; |
31 | use Symfony\Component\EventDispatcher\EventSubscriberInterface; | |
32 | ||
33 | /** | |
34 | * This class determines what fields are allowed for a request | |
35 | * and validates that the fields are provided correctly. | |
36 | */ | |
37 | class APIv3SchemaAdapter implements EventSubscriberInterface { | |
6550386a EM |
38 | /** |
39 | * @return array | |
40 | */ | |
dcef11bd TO |
41 | public static function getSubscribedEvents() { |
42 | return array( | |
43 | Events::PREPARE => array( | |
44 | array('onApiPrepare', Events::W_MIDDLE), | |
45 | array('onApiPrepare_validate', Events::W_LATE), | |
46 | ), | |
47 | ); | |
48 | } | |
49 | ||
6550386a EM |
50 | /** |
51 | * @param \Civi\API\Event\PrepareEvent $event | |
8882ff5c | 52 | * API preparation event. |
6550386a EM |
53 | * |
54 | * @throws \API_Exception | |
55 | */ | |
dcef11bd TO |
56 | public function onApiPrepare(\Civi\API\Event\PrepareEvent $event) { |
57 | $apiRequest = $event->getApiRequest(); | |
c65db512 TO |
58 | if ($apiRequest['version'] > 3) { |
59 | return; | |
60 | } | |
dcef11bd TO |
61 | |
62 | $apiRequest['fields'] = _civicrm_api3_api_getfields($apiRequest); | |
63 | ||
64 | _civicrm_api3_swap_out_aliases($apiRequest, $apiRequest['fields']); | |
65 | if (strtolower($apiRequest['action']) != 'getfields') { | |
66 | if (empty($apiRequest['params']['id'])) { | |
67 | $apiRequest['params'] = array_merge($this->getDefaults($apiRequest['fields']), $apiRequest['params']); | |
68 | } | |
8882ff5c | 69 | // Note: If 'id' is set then verify_mandatory will only check 'version'. |
dcef11bd TO |
70 | civicrm_api3_verify_mandatory($apiRequest['params'], NULL, $this->getRequired($apiRequest['fields'])); |
71 | } | |
72 | ||
73 | $event->setApiRequest($apiRequest); | |
74 | } | |
75 | ||
6550386a EM |
76 | /** |
77 | * @param \Civi\API\Event\Event $event | |
8882ff5c | 78 | * API preparation event. |
6550386a EM |
79 | * |
80 | * @throws \Exception | |
81 | */ | |
dcef11bd | 82 | public function onApiPrepare_validate(\Civi\API\Event\Event $event) { |
8882ff5c TO |
83 | $apiRequest = $event->getApiRequest(); |
84 | // Not sure why this is omitted for generic actions. It would make sense | |
85 | // to omit 'getfields', but that's only one generic action. | |
dcef11bd TO |
86 | |
87 | if (isset($apiRequest['function']) && !$apiRequest['is_generic'] && isset($apiRequest['fields'])) { | |
88 | _civicrm_api3_validate_fields($apiRequest['entity'], $apiRequest['action'], $apiRequest['params'], $apiRequest['fields']); | |
89 | $event->setApiRequest($apiRequest); | |
90 | } | |
91 | } | |
92 | ||
93 | /** | |
8882ff5c | 94 | * Return array of defaults for the given API (function is a wrapper on getfields). |
257e7666 EM |
95 | * @param $fields |
96 | * @return array | |
dcef11bd TO |
97 | */ |
98 | public function getDefaults($fields) { | |
99 | $defaults = array(); | |
100 | ||
101 | foreach ($fields as $field => $values) { | |
102 | if (isset($values['api.default'])) { | |
103 | $defaults[$field] = $values['api.default']; | |
104 | } | |
105 | } | |
106 | return $defaults; | |
107 | } | |
108 | ||
109 | /** | |
8882ff5c | 110 | * Return array of required fields for the given API (function is a wrapper on getfields). |
257e7666 EM |
111 | * @param $fields |
112 | * @return array | |
dcef11bd TO |
113 | */ |
114 | public function getRequired($fields) { | |
115 | $required = array('version'); | |
116 | ||
117 | foreach ($fields as $field => $values) { | |
118 | if (!empty($values['api.required'])) { | |
119 | $required[] = $field; | |
120 | } | |
121 | } | |
122 | return $required; | |
123 | } | |
96025800 | 124 | |
6550386a | 125 | } |