api/v3/Domain.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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 = array();
  62       $locparams = array(
  63         'contact_id' => $domain['contact_id'],
  64       );
  65       $values['location'] = CRM_Core_BAO_Location::getValues($locparams, TRUE);
  66
  67       $address_array = array(
  68         'street_address', 'supplemental_address_1', 'supplemental_address_2',
  69         'city', 'state_province_id', 'postal_code', 'country_id',
  70         'geo_code_1', 'geo_code_2',
  71       );
  72
  73       if (!empty($values['location']['email'])) {
  74         $domain['domain_email'] = CRM_Utils_Array::value('email', $values['location']['email'][1]);
  75       }
  76
  77       if (!empty($values['location']['phone'])) {
  78         $domain['domain_phone'] = array(
  79           'phone_type' => CRM_Core_OptionGroup::getLabel(
  80           'phone_type',
  81           CRM_Utils_Array::value(
  82             'phone_type_id',
  83           $values['location']['phone'][1]
  84           )
  85           ),
  86           'phone' => CRM_Utils_Array::value(
  87           'phone',
  88           $values['location']['phone'][1]
  89           ),
  90         );
  91       }
  92
  93       if (!empty($values['location']['address'])) {
  94         foreach ($address_array as $value) {
  95           $domain['domain_address'][$value] = CRM_Utils_Array::value($value,
  96           $values['location']['address'][1]
  97           );
  98         }
  99       }
 100
 101       list($domain['from_name'],
 102         $domain['from_email']
 103       ) = CRM_Core_BAO_Domain::getNameAndEmail(TRUE);
 104       $domains[$domain['id']] = array_merge($domains[$domain['id']], $domain);
 105     }
 106   }
 107
 108   return civicrm_api3_create_success($domains, $params, 'Domain', 'get', $bao);
 109 }
 110
 111 /**
 112  * Adjust Metadata for Get action.
 113  *
 114  * The metadata is used for setting defaults, documentation & validation.
 115  *
 116  * @param array $params
 117  *   Array of parameters determined by getfields.
 118  */
 119 function _civicrm_api3_domain_get_spec(&$params) {
 120   $params['current_domain'] = array(
 121     'title' => "Current Domain",
 122     'description' => "get loaded domain",
 123   );
 124 }
 125
 126 /**
 127  * Create a new Domain.
 128  *
 129  * @param array $params
 130  *
 131  * @return array
 132  */
 133 function civicrm_api3_domain_create($params) {
 134   $params['version'] = $params['domain_version'];
 135   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 136 }
 137
 138 /**
 139  * Adjust Metadata for Create action.
 140  *
 141  * The metadata is used for setting defaults, documentation & validation.
 142  *
 143  * @param array $params
 144  *   Array of parameters determined by getfields.
 145  */
 146 function _civicrm_api3_domain_create_spec(&$params) {
 147   $params['domain_version'] = $params['version'];
 148   $params['domain_version']['api.required'] = 1;
 149   unset($params['version']);
 150   $params['name']['api.required'] = 1;
 151 }