projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Checkstyle fix - one pesky whitespace
[civicrm-core.git]
/
api
/
v3
/
MailingGroup.php
diff --git
a/api/v3/MailingGroup.php
b/api/v3/MailingGroup.php
index 29c3acc388237d95d1d3c7a29853a853aa6f71be..7f973036f2125effce93bd1724d113b25cac6891 100644
(file)
--- a/
api/v3/MailingGroup.php
+++ b/
api/v3/MailingGroup.php
@@
-3,7
+3,7
@@
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-201
4
|
+ | Copyright CiviCRM LLC (c) 2004-201
5
|
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
@@
-26,27
+26,26
@@
*/
/**
*/
/**
- *
* APIv3 functions for registering/processing mailing group events.
*
* APIv3 functions for registering/processing mailing group events.
*
+ * @deprecated
* @package CiviCRM_APIv3
* @package CiviCRM_APIv3
- * @subpackage API_MailerGroup
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
*/
/**
*/
/**
+ * Declare deprecated functions.
+ *
* @deprecated api notice
* @return string
* to indicate this entire api entity is deprecated
*/
function _civicrm_api3_mailing_group_deprecation() {
* @deprecated api notice
* @return string
* to indicate this entire api entity is deprecated
*/
function _civicrm_api3_mailing_group_deprecation() {
- return 'The
mailing_g
roup api is deprecated. Use the mailing_event apis instead.';
+ return 'The
MailingG
roup api is deprecated. Use the mailing_event apis instead.';
}
/**
}
/**
- * Handle an unsubscribe event
+ * Handle an unsubscribe event.
+ *
* @deprecated
*
* @param array $params
* @deprecated
*
* @param array $params
@@
-58,7
+57,8
@@
function civicrm_api3_mailing_group_event_unsubscribe($params) {
}
/**
}
/**
- * Handle a site-level unsubscribe event
+ * Handle a site-level unsubscribe event.
+ *
* @deprecated
*
* @param array $params
* @deprecated
*
* @param array $params
@@
-71,7
+71,8
@@
function civicrm_api3_mailing_group_event_domain_unsubscribe($params) {
}
/**
}
/**
- * Handle a resubscription event
+ * Handle a re-subscription event.
+ *
* @deprecated
*
* @param array $params
* @deprecated
*
* @param array $params
@@
-83,7
+84,8
@@
function civicrm_api3_mailing_group_event_resubscribe($params) {
}
/**
}
/**
- * Handle a subscription event
+ * Handle a subscription event.
+ *
* @deprecated
*
* @param array $params
* @deprecated
*
* @param array $params
@@
-95,7
+97,10
@@
function civicrm_api3_mailing_group_event_subscribe($params) {
}
/**
}
/**
+ * Create mailing group.
+ *
* @param array $params
* @param array $params
+ *
* @return array
* @throws \API_Exception
*/
* @return array
* @throws \API_Exception
*/
@@
-104,6
+109,8
@@
function civicrm_api3_mailing_group_create($params) {
}
/**
}
/**
+ * Get mailing group.
+ *
* @param array $params
*
* @return array
* @param array $params
*
* @return array
@@
-113,7
+120,10
@@
function civicrm_api3_mailing_group_get($params) {
}
/**
}
/**
+ * Delete mailing group.
+ *
* @param array $params
* @param array $params
+ *
* @return array
* @throws \API_Exception
*/
* @return array
* @throws \API_Exception
*/
@@
-122,7
+132,10
@@
function civicrm_api3_mailing_group_delete($params) {
}
/**
}
/**
+ * Get metadata for mailing group functions.
+ *
* @param array $params
* @param array $params
+ *
* @return array
*/
function civicrm_api3_mailing_group_getfields($params) {
* @return array
*/
function civicrm_api3_mailing_group_getfields($params) {
@@
-142,5
+155,5
@@
function civicrm_api3_mailing_group_getfields($params) {
unset($field['pseudoconstant']);
}
unset($field['pseudoconstant']);
}
- return civicrm_api3_create_success($fields, $params, '
mailing_g
roup', 'getfields');
+ return civicrm_api3_create_success($fields, $params, '
MailingG
roup', 'getfields');
}
}