api/v3/LocBlock.php

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