Civi/API/Subscriber/APIv3SchemaAdapter.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  +--------------------------------------------------------------------+
  26 */
  27
  28 namespace Civi\API\Subscriber;
  29 use Civi\API\Events;
  30 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  31
  32 /**
  33  * This class determines what fields are allowed for a request
  34  * and validates that the fields are provided correctly.
  35  */
  36 class APIv3SchemaAdapter implements EventSubscriberInterface {
  37   public static function getSubscribedEvents() {
  38     return array(
  39       Events::PREPARE => array(
  40         array('onApiPrepare', Events::W_MIDDLE),
  41         array('onApiPrepare_validate', Events::W_LATE),
  42       ),
  43     );
  44   }
  45
  46   public function onApiPrepare(\Civi\API\Event\PrepareEvent $event) {
  47     $apiRequest = $event->getApiRequest();
  48     if ($apiRequest['version'] > 3) {
  49       return;
  50     }
  51
  52     $apiRequest['fields'] = _civicrm_api3_api_getfields($apiRequest);
  53
  54     _civicrm_api3_swap_out_aliases($apiRequest, $apiRequest['fields']);
  55     if (strtolower($apiRequest['action']) != 'getfields') {
  56       if (empty($apiRequest['params']['id'])) {
  57         $apiRequest['params'] = array_merge($this->getDefaults($apiRequest['fields']), $apiRequest['params']);
  58       }
  59       //if 'id' is set then only 'version' will be checked but should still be checked for consistency
  60       civicrm_api3_verify_mandatory($apiRequest['params'], NULL, $this->getRequired($apiRequest['fields']));
  61     }
  62
  63     $event->setApiRequest($apiRequest);
  64   }
  65
  66   public function onApiPrepare_validate(\Civi\API\Event\Event $event) {
  67      $apiRequest = $event->getApiRequest();
  68     // Not sure why this is omitted for generic actions. It would make sense to omit 'getfields', but that's only one generic action.
  69
  70     if (isset($apiRequest['function']) && !$apiRequest['is_generic'] && isset($apiRequest['fields'])) {
  71       _civicrm_api3_validate_fields($apiRequest['entity'], $apiRequest['action'], $apiRequest['params'], $apiRequest['fields']);
  72       $event->setApiRequest($apiRequest);
  73     }
  74   }
  75
  76   /**
  77    * Return array of defaults for the given API (function is a wrapper on getfields)
  78    */
  79   public function getDefaults($fields) {
  80     $defaults = array();
  81
  82     foreach ($fields as $field => $values) {
  83       if (isset($values['api.default'])) {
  84         $defaults[$field] = $values['api.default'];
  85       }
  86     }
  87     return $defaults;
  88   }
  89
  90   /**
  91    * Return array of required fields for the given API (function is a wrapper on getfields)
  92    */
  93   public function getRequired($fields) {
  94     $required = array('version');
  95
  96     foreach ($fields as $field => $values) {
  97       if (!empty($values['api.required'])) {
  98         $required[] = $field;
  99       }
 100     }
 101     return $required;
 102   }
 103 }