api/v3/LocBlock.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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 /**
  29  * This api exposes CiviCRM LocBlock records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Create or update a LocBlock.
  36  *
  37  * @param array $params
  38  *   Name/value pairs to insert in new 'LocBlock'.
  39  *
  40  * @return array
  41  *   API result array.
  42  *
  43  * @throws \API_Exception
  44  * @throws \CiviCRM_API3_Exception
  45  */
  46 function civicrm_api3_loc_block_create($params) {
  47   $entities = [];
  48   $any_mandatory = [
  49     'address',
  50     'address_id',
  51     'phone',
  52     'phone_id',
  53     'im',
  54     'im_id',
  55     'email',
  56     'email_id',
  57   ];
  58   civicrm_api3_verify_one_mandatory($params, NULL, $any_mandatory);
  59   // Call the appropriate api to create entities if any are passed in the params.
  60   // This is basically chaining but in reverse - we create the sub-entities first
  61   // because chaining does not work in reverse, or with keys like 'email_2'.
  62   $items = ['address', 'email', 'phone', 'im'];
  63   foreach ($items as $item) {
  64     foreach (['', '_2'] as $suf) {
  65       $key = $item . $suf;
  66       if (!empty($params[$key]) && is_array($params[$key])) {
  67         $info = $params[$key];
  68         // If all we get is an id don't bother calling the api.
  69         if (count($info) == 1 && !empty($info['id'])) {
  70           $params[$key . '_id'] = $info['id'];
  71         }
  72         // Bother calling the api.
  73         else {
  74           $info['contact_id'] = CRM_Utils_Array::value('contact_id', $info, 'null');
  75           $result = civicrm_api3($item, 'create', $info);
  76           $entities[$key] = $result['values'][$result['id']];
  77           $params[$key . '_id'] = $result['id'];
  78         }
  79       }
  80     }
  81   }
  82   $dao = new CRM_Core_DAO_LocBlock();
  83   $dao->copyValues($params);
  84   $dao->save();
  85   if (!empty($dao->id)) {
  86     $values = [$dao->id => $entities];
  87     _civicrm_api3_object_to_array($dao, $values[$dao->id]);
  88     return civicrm_api3_create_success($values, $params, 'LocBlock', 'create', $dao);
  89   }
  90   throw new API_Exception('Unable to create LocBlock. Please check your params.');
  91 }
  92
  93 /**
  94  * Returns array of loc_blocks matching a set of one or more properties.
  95  *
  96  * @param array $params
  97  *   Array of one or more valid property_name=>value pairs. If $params is set.
  98  *   as null, all loc_blocks will be returned (default limit is 25).
  99  *
 100  * @return array
 101  *   API result array.
 102  */
 103 function civicrm_api3_loc_block_get($params) {
 104   $options = _civicrm_api3_get_options_from_params($params);
 105   // If a return param has been set then fetch the appropriate fk objects
 106   // This is a helper because api chaining does not work with a key like 'email_2'.
 107   if (!empty($options['return'])) {
 108     unset($params['return']);
 109     $values = [];
 110     $items = ['address', 'email', 'phone', 'im'];
 111     $returnAll = !empty($options['return']['all']);
 112     foreach (_civicrm_api3_basic_get('CRM_Core_DAO_LocBlock', $params, FALSE) as $val) {
 113       foreach ($items as $item) {
 114         foreach (['', '_2'] as $suf) {
 115           $key = $item . $suf;
 116           if (!empty($val[$key . '_id']) && ($returnAll || !empty($options['return'][$key]))) {
 117             $val[$key] = civicrm_api($item, 'getsingle', ['version' => 3, 'id' => $val[$key . '_id']]);
 118           }
 119         }
 120       }
 121       $values[$val['id']] = $val;
 122     }
 123     return civicrm_api3_create_success($values, $params, 'LocBlock', 'get');
 124   }
 125   return _civicrm_api3_basic_get('CRM_Core_DAO_LocBlock', $params);
 126 }
 127
 128 /**
 129  * Delete an existing LocBlock.
 130  *
 131  * @param array $params
 132  *   Array containing id of the record to be deleted.
 133  *
 134  * @return array
 135  *   API result array.
 136  */
 137 function civicrm_api3_loc_block_delete($params) {
 138   return _civicrm_api3_basic_delete('CRM_Core_DAO_LocBlock', $params);
 139 }