api/v3/EntityTag.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * File for the CiviCRM APIv3 entity tag functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_EntityTag
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * @version $Id: EntityTag.php 30879 2010-11-22 15:45:55Z shot $
  37  */
  38
  39 /**
  40  * Include utility functions
  41  */
  42
  43 /**
  44  * {@getfields EntityTag_get}
  45  * @example EntityTagGet.php
  46  *
  47  * @param array $params
  48  *
  49  * @return array
  50  */
  51 function civicrm_api3_entity_tag_get($params) {
  52
  53   if(empty($params['entity_id'])) {
  54     return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  55   }
  56   else{
  57     //do legacy non-standard behaviour
  58     $values = CRM_Core_BAO_EntityTag::getTag($params['entity_id'], $params['entity_table']);
  59     $result = array();
  60     foreach ($values as $v) {
  61       $result[$v] = array('tag_id' => $v);
  62     }
  63     return civicrm_api3_create_success($result, $params);
  64   }
  65 }
  66
  67 /**
  68  * Adjust Metadata for Get action
  69  *
  70  * The metadata is used for setting defaults, documentation & validation
  71  * @param array $params array or parameters determined by getfields
  72  */
  73 function _civicrm_api3_entity_tag_get_spec(&$params) {
  74   $params['entity_id']['api.aliases'] = array('contact_id');
  75   $params['entity_table']['api.default'] = 'civicrm_contact';
  76 }
  77
  78 /**
  79  *
  80  * @param array $params
  81  *
  82  * @return array
  83  * {@getfields EntityTag_create}
  84  * @example EntityTagCreate.php
  85  */
  86 function civicrm_api3_entity_tag_create($params) {
  87   return _civicrm_api3_entity_tag_common($params, 'add');
  88 }
  89
  90 /**
  91  *{@getfields EntityTag_delete}
  92  * @example EntityTagGet.php
  93  *
  94  * @param array $params
  95  *
  96  * @return array
  97  */
  98 function civicrm_api3_entity_tag_delete($params) {
  99
 100   return _civicrm_api3_entity_tag_common($params, 'remove');
 101 }
 102
 103 /**
 104  * modify metadata
 105  */
 106 function _civicrm_api3_entity_tag_delete_spec(&$params) {
 107   // set as not required as tag_id also acceptable & no either/or std yet
 108   $params['id']['api.required'] = 0;
 109 }
 110
 111 /**
 112  *
 113  * @param <type> $params
 114  * @param string $op
 115  *
 116  * @return array <type>
 117  */
 118 function _civicrm_api3_entity_tag_common($params, $op = 'add') {
 119
 120   $entityIDs   = array();
 121   $tagsIDs     = array();
 122   $entityTable = 'civicrm_contact';
 123   if (is_array($params)) {
 124     foreach ($params as $n => $v) {
 125       if ((substr($n, 0, 10) == 'contact_id') || (substr($n, 0, 9) == 'entity_id')) {
 126         $entityIDs[] = $v;
 127       }
 128       elseif (substr($n, 0, 6) == 'tag_id') {
 129         $tagIDs[] = $v;
 130       }
 131       elseif (substr($n, 0, 12) == 'entity_table') {
 132         $entityTable = $v;
 133       }
 134     }
 135   }
 136   if (empty($entityIDs)) {
 137     return civicrm_api3_create_error('contact_id is a required field');
 138   }
 139
 140   if (empty($tagIDs)) {
 141     return civicrm_api3_create_error('tag_id is a required field');
 142   }
 143
 144   $values = array('is_error' => 0);
 145   if ($op == 'add') {
 146     $values['total_count'] = $values['added'] = $values['not_added'] = 0;
 147     foreach ($tagIDs as $tagID) {
 148       list($te, $a, $na) = CRM_Core_BAO_EntityTag::addEntitiesToTag($entityIDs, $tagID, $entityTable);
 149       $values['total_count'] += $te;
 150       $values['added'] += $a;
 151       $values['not_added'] += $na;
 152     }
 153   }
 154   else {
 155     $values['total_count'] = $values['removed'] = $values['not_removed'] = 0;
 156     foreach ($tagIDs as $tagID) {
 157       list($te, $r, $nr) = CRM_Core_BAO_EntityTag::removeEntitiesFromTag($entityIDs, $tagID, $entityTable);
 158       $values['total_count'] += $te;
 159       $values['removed'] += $r;
 160       $values['not_removed'] += $nr;
 161     }
 162   }
 163   return $values;
 164 }
 165