3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
28 namespace Civi\API\Subscriber
;
31 use Symfony\Component\EventDispatcher\EventSubscriberInterface
;
34 * This class determines what fields are allowed for a request
35 * and validates that the fields are provided correctly.
37 class APIv3SchemaAdapter
implements EventSubscriberInterface
{
41 public static function getSubscribedEvents() {
43 Events
::PREPARE
=> array(
44 array('onApiPrepare', Events
::W_MIDDLE
),
45 array('onApiPrepare_validate', Events
::W_LATE
),
51 * @param \Civi\API\Event\PrepareEvent $event
52 * API preparation event.
54 * @throws \API_Exception
56 public function onApiPrepare(\Civi\API\Event\PrepareEvent
$event) {
57 $apiRequest = $event->getApiRequest();
58 if ($apiRequest['version'] > 3) {
62 $apiRequest['fields'] = _civicrm_api3_api_getfields($apiRequest);
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']);
69 // Note: If 'id' is set then verify_mandatory will only check 'version'.
70 civicrm_api3_verify_mandatory($apiRequest['params'], NULL, $this->getRequired($apiRequest['fields']));
73 $event->setApiRequest($apiRequest);
77 * @param \Civi\API\Event\Event $event
78 * API preparation event.
82 public function onApiPrepare_validate(\Civi\API\Event\Event
$event) {
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.
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);
94 * Return array of defaults for the given API (function is a wrapper on getfields).
98 public function getDefaults($fields) {
101 foreach ($fields as $field => $values) {
102 if (isset($values['api.default'])) {
103 $defaults[$field] = $values['api.default'];
110 * Return array of required fields for the given API (function is a wrapper on getfields).
114 public function getRequired($fields) {
115 $required = array('version');
117 foreach ($fields as $field => $values) {
118 if (!empty($values['api.required'])) {
119 $required[] = $field;