api/v3/UFGroup.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 profile group.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Adjust metadata for create action.
  36  *
  37  * @param array $params
  38  */
  39 function _civicrm_api3_uf_group_create_spec(&$params) {
  40   $session = CRM_Core_Session::singleton();
  41   $params['title']['api.required'] = 1;
  42   $params['is_active']['api.default'] = 1;
  43   $params['is_update_dupe']['api.default'] = 1;
  44   // Default to the logged in user.
  45   $params['created_id']['api.default'] = 'user_contact_id';
  46   $params['created_date']['api.default'] = 'now';
  47 }
  48
  49 /**
  50  * Use this API to create a new group.
  51  *
  52  * See the CRM Data Model for uf_group property definitions
  53  *
  54  * @param array $params
  55  *   Array per getfields metadata.
  56  *
  57  * @return array
  58  *   API result array
  59  */
  60 function civicrm_api3_uf_group_create($params) {
  61   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  62 }
  63
  64 /**
  65  * Returns array of uf groups (profiles) matching a set of one or more group properties.
  66  *
  67  * @param array $params
  68  *   Array of properties. If empty, all records will be returned.
  69  *
  70  * @return array
  71  *   Array of matching profiles
  72  */
  73 function civicrm_api3_uf_group_get($params) {
  74
  75   return _civicrm_api3_basic_get('CRM_Core_BAO_UFGroup', $params);
  76 }
  77
  78 /**
  79  * Delete uf group.
  80  *
  81  * @param array $params
  82  *
  83  * @return array
  84  */
  85 function civicrm_api3_uf_group_delete($params) {
  86   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  87 }
  88
  89 /**
  90  * Set default getlist parameters.
  91  *
  92  * @see _civicrm_api3_generic_getlist_defaults
  93  *
  94  * @param array $request
  95  *
  96  * @return array
  97  */
  98 function _civicrm_api3_uf_group_getlist_defaults(&$request) {
  99   return array(
 100     'description_field' => array(
 101       'description',
 102       'group_type',
 103     ),
 104     'params' => array(
 105       'is_active' => 1,
 106     ),
 107   );
 108 }
 109
 110 /**
 111  * Format getlist output
 112  *
 113  * @see _civicrm_api3_generic_getlist_output
 114  *
 115  * @param array $result
 116  * @param array $request
 117  * @param string $entity
 118  * @param array $fields
 119  *
 120  * @return array
 121  */
 122 function _civicrm_api3_uf_group_getlist_output($result, $request, $entity, $fields) {
 123   $output = array();
 124   if (!empty($result['values'])) {
 125     foreach ($result['values'] as $row) {
 126       $data = array(
 127         'id' => $row[$request['id_field']],
 128         'label' => $row[$request['label_field']],
 129       );
 130       if (!empty($request['description_field'])) {
 131         $data['description'] = array();
 132         foreach ((array) $request['description_field'] as $field) {
 133           if (!empty($row[$field])) {
 134             // Special formatting for group_type field
 135             if ($field == 'group_type') {
 136               $groupTypes = CRM_UF_Page_Group::extractGroupTypes($row[$field]);
 137               $data['description'][] = CRM_UF_Page_Group::formatGroupTypes($groupTypes);
 138               continue;
 139             }
 140             if (!isset($fields[$field]['pseudoconstant'])) {
 141               $data['description'][] = $row[$field];
 142             }
 143             else {
 144               $data['description'][] = CRM_Core_PseudoConstant::getLabel(
 145                 _civicrm_api3_get_BAO($entity),
 146                 $field,
 147                 $row[$field]
 148               );
 149             }
 150           }
 151         }
 152       };
 153       if (!empty($request['image_field'])) {
 154         $data['image'] = isset($row[$request['image_field']]) ? $row[$request['image_field']] : '';
 155       }
 156       $output[] = $data;
 157     }
 158   }
 159   return $output;
 160 }