api/v3/Domain.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 Domain configuration settings.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Get CiviCRM Domain details.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  * @throws \API_Exception
  41  */
  42 function civicrm_api3_domain_get($params) {
  43
  44   $params['version'] = CRM_Utils_Array::value('domain_version', $params);
  45   unset($params['version']);
  46
  47   $bao = new CRM_Core_BAO_Domain();
  48   if (!empty($params['current_domain'])) {
  49     $domainBAO = CRM_Core_Config::domainID();
  50     $params['id'] = $domainBAO;
  51   }
  52   if (!empty($params['options']) && !empty($params['options']['is_count'])) {
  53     return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  54   }
  55
  56   _civicrm_api3_dao_set_filter($bao, $params, TRUE);
  57   $domains = _civicrm_api3_dao_to_array($bao, $params, TRUE, 'Domain');
  58
  59   foreach ($domains as $domain) {
  60     if (!empty($domain['contact_id'])) {
  61       $values = [];
  62       $locparams = [
  63         'contact_id' => $domain['contact_id'],
  64       ];
  65       $values['location'] = CRM_Core_BAO_Location::getValues($locparams, TRUE);
  66       $address_array = [
  67         'street_address', 'supplemental_address_1', 'supplemental_address_2', 'supplemental_address_3',
  68         'city', 'state_province_id', 'postal_code', 'country_id',
  69         'geo_code_1', 'geo_code_2',
  70       ];
  71
  72       if (!empty($values['location']['email'])) {
  73         $domain['domain_email'] = CRM_Utils_Array::value('email', $values['location']['email'][1]);
  74       }
  75
  76       if (!empty($values['location']['phone'])) {
  77         $domain['domain_phone'] = [
  78           'phone_type' => CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_Phone', 'phone_type_id',
  79             CRM_Utils_Array::value('phone_type_id', $values['location']['phone'][1])),
  80           'phone' => CRM_Utils_Array::value('phone', $values['location']['phone'][1]),
  81         ];
  82       }
  83
  84       if (!empty($values['location']['address'])) {
  85         foreach ($address_array as $value) {
  86           $domain['domain_address'][$value] = CRM_Utils_Array::value($value,
  87           $values['location']['address'][1]
  88           );
  89         }
  90       }
  91
  92       list($domain['from_name'],
  93         $domain['from_email']
  94       ) = CRM_Core_BAO_Domain::getNameAndEmail(TRUE);
  95
  96       // Rename version to domain_version, see CRM-17430.
  97       $domain['domain_version'] = $domain['version'];
  98       unset($domain['version']);
  99       $domains[$domain['id']] = array_merge($domains[$domain['id']], $domain);
 100     }
 101   }
 102
 103   return civicrm_api3_create_success($domains, $params, 'Domain', 'get', $bao);
 104 }
 105
 106 /**
 107  * Adjust Metadata for Get action.
 108  *
 109  * The metadata is used for setting defaults, documentation & validation.
 110  *
 111  * @param array $params
 112  *   Array of parameters determined by getfields.
 113  */
 114 function _civicrm_api3_domain_get_spec(&$params) {
 115   $params['current_domain'] = [
 116     'title' => "Current Domain",
 117     'description' => "get loaded domain",
 118   ];
 119 }
 120
 121 /**
 122  * Create a new Domain.
 123  *
 124  * @param array $params
 125  *
 126  * @return array
 127  */
 128 function civicrm_api3_domain_create($params) {
 129   if (isset($params['domain_version'])) {
 130     $params['version'] = $params['domain_version'];
 131   }
 132   else {
 133     unset($params['version']);
 134   }
 135   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Domain');
 136
 137   $result_value = CRM_Utils_Array::first($result['values']);
 138   if (isset($result_value['version'])) {
 139     // Rename version to domain_version, see CRM-17430.
 140     $result_value['domain_version'] = $result_value['version'];
 141     unset($result_value['version']);
 142     $result['values'][$result['id']] = $result_value;
 143   }
 144   return $result;
 145 }
 146
 147 /**
 148  * Adjust Metadata for Create action.
 149  *
 150  * The metadata is used for setting defaults, documentation & validation.
 151  *
 152  * @param array $params
 153  *   Array of parameters determined by getfields.
 154  */
 155 function _civicrm_api3_domain_create_spec(&$params) {
 156   $params['domain_version'] = [
 157     'title' => "CiviCRM Version",
 158     'description' => "The civicrm version this instance is running",
 159     'type' => CRM_Utils_Type::T_STRING,
 160   ];
 161   $params['domain_version']['api.required'] = 1;
 162   unset($params['version']);
 163   $params['name']['api.required'] = 1;
 164 }