api/v3/RelationshipType.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  * new version of civicrm apis. See blog post at
  30  * http://civicrm.org/node/131
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Contact
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * $Id: Contact.php 30415 2010-10-29 12:02:47Z shot $
  36  */
  37
  38 /**
  39  * Create relationship type.
  40  *
  41  * @param array $params
  42  *   Array per getfields metadata.
  43  *
  44  * @return array
  45  */
  46 function civicrm_api3_relationship_type_create($params) {
  47
  48   if (!isset($params['label_a_b'])) {
  49
  50     $params['label_a_b'] = $params['name_a_b'];
  51   }
  52
  53   if (!isset($params['label_b_a'])) {
  54
  55     $params['label_b_a'] = $params['name_b_a'];
  56   }
  57
  58   $ids = array();
  59   if (isset($params['id']) && !CRM_Utils_Rule::integer($params['id'])) {
  60     return civicrm_api3_create_error('Invalid value for relationship type ID');
  61   }
  62   else {
  63     $ids['relationshipType'] = CRM_Utils_Array::value('id', $params);
  64   }
  65
  66   $relationType = CRM_Contact_BAO_RelationshipType::add($params, $ids);
  67
  68   $relType = array();
  69
  70   _civicrm_api3_object_to_array($relationType, $relType[$relationType->id]);
  71
  72   return civicrm_api3_create_success($relType, $params, 'relationship_type', 'create', $relationType);
  73 }
  74
  75 /**
  76  * Adjust Metadata for Create action.
  77  *
  78  * The metadata is used for setting defaults, documentation & validation.
  79  *
  80  * @param array $params
  81  *   Array or parameters determined by getfields.
  82  */
  83 function _civicrm_api3_relationship_type_create_spec(&$params) {
  84   $params['contact_type_a']['api.required'] = 1;
  85   $params['contact_type_b']['api.required'] = 1;
  86   $params['name_a_b']['api.required'] = 1;
  87   $params['name_b_a']['api.required'] = 1;
  88   $params['is_active']['api.default'] = 1;
  89 }
  90
  91 /**
  92  * Get all relationship types.
  93  *
  94  * @param array $params
  95  *
  96  * @return array
  97  */
  98 function civicrm_api3_relationship_type_get($params) {
  99   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 100 }
 101
 102 /**
 103  * Delete a relationship type.
 104  *
 105  * @param array $params
 106  *
 107  * @return array
 108  *   API Result Array
 109  */
 110 function civicrm_api3_relationship_type_delete($params) {
 111   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 112 }
 113
 114 /**
 115  * Get list defaults for relationship types.
 116  *
 117  * @see _civicrm_api3_generic_getlist_defaults
 118  *
 119  * @param array $request
 120  * @return array
 121  */
 122 function _civicrm_api3_relationship_type_getlist_defaults($request) {
 123   return array(
 124     'label_field' => 'label_a_b',
 125     'search_field' => 'label_a_b',
 126   );
 127 }