api/v3/MailingGroup.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * APIv3 functions for registering/processing mailing group events.
  14  *
  15  * @deprecated
  16  * @package CiviCRM_APIv3
  17  */
  18
  19 /**
  20  * Declare deprecated functions.
  21  *
  22  * @deprecated api notice
  23  * @return string
  24  *   to indicate this entire api entity is deprecated
  25  */
  26 function _civicrm_api3_mailing_group_deprecation() {
  27   $message = 'This action is deprecated. Use the mailing_event API instead.';
  28   return [
  29     'event_unsubscribe' => $message,
  30     'event_domain_unsubscribe' => $message,
  31     'event_resubscribe' => $message,
  32     'event_subscribe' => $message,
  33   ];
  34 }
  35
  36 /**
  37  * Handle an unsubscribe event.
  38  *
  39  * @deprecated
  40  *
  41  * @param array $params
  42  *
  43  * @return array
  44  */
  45 function civicrm_api3_mailing_group_event_unsubscribe($params) {
  46   return civicrm_api('mailing_event_unsubscribe', 'create', $params);
  47 }
  48
  49 /**
  50  * Handle a site-level unsubscribe event.
  51  *
  52  * @deprecated
  53  *
  54  * @param array $params
  55  *
  56  * @return array
  57  */
  58 function civicrm_api3_mailing_group_event_domain_unsubscribe($params) {
  59   $params['org_unsubscribe'] = 1;
  60   return civicrm_api('mailing_event_unsubscribe', 'create', $params);
  61 }
  62
  63 /**
  64  * Handle a re-subscription event.
  65  *
  66  * @deprecated
  67  *
  68  * @param array $params
  69  *
  70  * @return array
  71  */
  72 function civicrm_api3_mailing_group_event_resubscribe($params) {
  73   return civicrm_api('mailing_event_resubscribe', 'create', $params);
  74 }
  75
  76 /**
  77  * Handle a subscription event.
  78  *
  79  * @deprecated
  80  *
  81  * @param array $params
  82  *
  83  * @return array
  84  */
  85 function civicrm_api3_mailing_group_event_subscribe($params) {
  86   return civicrm_api('mailing_event_subscribe', 'create', $params);
  87 }
  88
  89 /**
  90  * Create mailing group.
  91  *
  92  * @param array $params
  93  *
  94  * @return array
  95  * @throws \API_Exception
  96  */
  97 function civicrm_api3_mailing_group_create($params) {
  98   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  99 }
 100
 101 /**
 102  * Get mailing group.
 103  *
 104  * @param array $params
 105  *
 106  * @return array
 107  */
 108 function civicrm_api3_mailing_group_get($params) {
 109   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 110 }
 111
 112 /**
 113  * Delete mailing group.
 114  *
 115  * @param array $params
 116  *
 117  * @return array
 118  * @throws \API_Exception
 119  */
 120 function civicrm_api3_mailing_group_delete($params) {
 121   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 122 }