<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
- * File for the CiviCRM APIv3 entity tag functions
+ * This api exposes CiviCRM EntityTag records.
*
- * @package CiviCRM_APIv3
- * @subpackage API_EntityTag
+ * Use this api to add/remove tags from a contact/activity/etc.
+ * To create/update/delete the tags themselves, use the Tag api.
*
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: EntityTag.php 30879 2010-11-22 15:45:55Z shot $
- */
-
-/**
- * Include utility functions
+ * @package CiviCRM_APIv3
*/
/**
- * {@getfields EntityTag_get}
- * @example EntityTagGet.php
+ * Get entity tags.
*
* @param array $params
*
*/
function civicrm_api3_entity_tag_get($params) {
- if(empty($params['entity_id'])) {
+ if (empty($params['entity_id'])) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
- else{
+ else {
//do legacy non-standard behaviour
$values = CRM_Core_BAO_EntityTag::getTag($params['entity_id'], $params['entity_table']);
$result = array();
foreach ($values as $v) {
$result[$v] = array('tag_id' => $v);
}
- return civicrm_api3_create_success($result, $params);
+ return civicrm_api3_create_success($result, $params, 'EntityTag');
}
}
/**
- * Adjust Metadata for Get action
+ * Adjust Metadata for Get action.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_entity_tag_get_spec(&$params) {
$params['entity_id']['api.aliases'] = array('contact_id');
}
/**
+ * Create an entity tag.
*
* @param array $params
*
* @return array
- * {@getfields EntityTag_create}
- * @example EntityTagCreate.php
*/
function civicrm_api3_entity_tag_create($params) {
return _civicrm_api3_entity_tag_common($params, 'add');
}
/**
- *{@getfields EntityTag_delete}
- * @example EntityTagGet.php
+ * Mark entity tag as removed.
*
* @param array $params
*
}
/**
- * modify metadata
+ * Modify metadata.
+ *
+ * @param array $params
*/
function _civicrm_api3_entity_tag_delete_spec(&$params) {
// set as not required as tag_id also acceptable & no either/or std yet
}
/**
+ * Helper function for formatting tags (part of api v2 legacy).
*
- * @param <type> $params
+ * @param array $params
* @param string $op
*
- * @return array <type>
+ * @return array
*/
function _civicrm_api3_entity_tag_common($params, $op = 'add') {
$entityIDs = array();
- $tagsIDs = array();
$entityTable = 'civicrm_contact';
if (is_array($params)) {
foreach ($params as $n => $v) {
}
return $values;
}
-