api/v3/RelationshipType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  35  * $Id: Contact.php 30415 2010-10-29 12:02:47Z shot $
  36  *
  37  */
  38
  39 /**
  40  * Function to create relationship type
  41  *
  42  * @param  array $params   Associative array of property name/value pairs to insert in new relationship type.
  43  *
  44  * @return Newly created Relationship_type object
  45  * {@getfields RelationshipType_create}
  46  * @access public
  47  * {@schema Contact/RelationshipType.xml}
  48  */
  49 function civicrm_api3_relationship_type_create($params) {
  50
  51   if (!isset($params['label_a_b'])) {
  52
  53     $params['label_a_b'] = $params['name_a_b'];
  54   }
  55
  56   if (!isset($params['label_b_a'])) {
  57
  58     $params['label_b_a'] = $params['name_b_a'];
  59   }
  60
  61   $ids = array();
  62   if (isset($params['id']) && !CRM_Utils_Rule::integer($params['id'])) {
  63     return civicrm_api3_create_error('Invalid value for relationship type ID');
  64   }
  65   else {
  66     $ids['relationshipType'] = CRM_Utils_Array::value('id', $params);
  67   }
  68
  69   $relationType = new CRM_Contact_BAO_RelationshipType();
  70   $relationType = CRM_Contact_BAO_RelationshipType::add($params, $ids);
  71
  72   $relType = array();
  73
  74   _civicrm_api3_object_to_array($relationType, $relType[$relationType->id]);
  75
  76   return civicrm_api3_create_success($relType, $params, 'relationship_type', 'create', $relationType);
  77 }
  78
  79 /**
  80  * Adjust Metadata for Create action
  81  *
  82  * The metadata is used for setting defaults, documentation & validation
  83  * @param array $params array or parameters determined by getfields
  84  */
  85 function _civicrm_api3_relationship_type_create_spec(&$params) {
  86   $params['contact_type_a']['api.required'] = 1;
  87   $params['contact_type_b']['api.required'] = 1;
  88   $params['name_a_b']['api.required'] = 1;
  89   $params['name_b_a']['api.required'] = 1;
  90 }
  91
  92 /**
  93  * Function to get all relationship type
  94  * retruns  An array of Relationship_type
  95  * @access  public
  96  * {@getfields RelationshipType_get}
  97  * @example RelationshipTypeGet.php
  98  */
  99 function civicrm_api3_relationship_type_get($params) {
 100   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 101 }
 102
 103 /**
 104  * Delete a relationship type delete
 105  *
 106  * @param  id of relationship type  $id
 107  *
 108  * @return array API Result Array
 109  * {@getfields RelationshipType_delete}
 110  * @static void
 111  * @access public
 112  */
 113 function civicrm_api3_relationship_type_delete($params) {
 114   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 115 }
 116