3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 loc_block functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_LocBlock
34 * @copyright CiviCRM LLC (c) 20042012
38 * Create or update a loc_block.
40 * @param array $params
41 * Associative array of property.
42 * name/value pairs to insert in new 'loc_block'
47 function civicrm_api3_loc_block_create($params) {
49 // Call the appropriate api to create entities if any are passed in the params
50 // This is basically chaining but in reverse - we create the sub-entities first
51 // This exists because chainging does not work in reverse, or with keys like 'email_2'
52 $items = array('address', 'email', 'phone', 'im');
53 foreach ($items as $item) {
54 foreach (array('', '_2') as $suf) {
56 if (!empty($params[$key]) && is_array($params[$key])) {
57 $info = $params[$key];
58 // If all we get is an id don't bother calling the api
59 if (count($info) == 1 && !empty($info['id'])) {
60 $params[$key . '_id'] = $info['id'];
62 // Bother calling the api
64 $info['version'] = $params['version'];
65 $info['contact_id'] = CRM_Utils_Array
::value('contact_id', $info, 'null');
66 $result = civicrm_api($item, 'create', $info);
67 if (!empty($result['is_error'])) {
70 $entities[$key] = $result['values'][$result['id']];
71 $params[$key . '_id'] = $result['id'];
76 $dao = new CRM_Core_DAO_LocBlock();
77 $dao->copyValues($params);
79 if (!empty($dao->id
)) {
80 $values = array($dao->id
=> $entities);
81 _civicrm_api3_object_to_array($dao, $values[$dao->id
]);
82 return civicrm_api3_create_success($values, $params, 'loc_block', 'create', $dao);
84 return civicrm_api3_create_error('Unable to create LocBlock. Please check your params.');
88 * Returns array of loc_blocks matching a set of one or more properties.
90 * @param array $params
91 * Array of one or more valid property_name=>value pairs. If $params is set.
92 * as null, all loc_blocks will be returned (default limit is 25)
97 function civicrm_api3_loc_block_get($params) {
98 $options = _civicrm_api3_get_options_from_params($params);
99 // If a return param has been set then fetch the appropriate fk objects
100 // This is a helper because api chaining does not work with a key like 'email_2'
101 if (!empty($options['return'])) {
102 unset($params['return']);
104 $items = array('address', 'email', 'phone', 'im');
105 $returnAll = !empty($options['return']['all']);
106 foreach (_civicrm_api3_basic_get('CRM_Core_DAO_LocBlock', $params, FALSE) as $val) {
107 foreach ($items as $item) {
108 foreach (array('', '_2') as $suf) {
110 if (!empty($val[$key . '_id']) && ($returnAll ||
!empty($options['return'][$key]))) {
111 $val[$key] = civicrm_api($item, 'getsingle', array('version' => 3, 'id' => $val[$key . '_id']));
115 $values[$val['id']] = $val;
117 return civicrm_api3_create_success($values, $params, 'loc_block', 'get');
119 return _civicrm_api3_basic_get('CRM_Core_DAO_LocBlock', $params);
123 * Delete an existing loc_block.
125 * @param array $params
126 * Array containing id of the record to be deleted.
131 function civicrm_api3_loc_block_delete($params) {
132 return _civicrm_api3_basic_delete('CRM_Core_DAO_LocBlock', $params);