<?php
-// $Id$
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.3 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
*
* @package CiviCRM_APIv3
* @subpackage API_MailerGroup
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
/**
* Subscribe from mailing group
*
- * @param array $params Associative array of property
+ * @param array $params Associative array of property
* name/value pairs to insert in new 'survey'
*
+ * @throws API_Exception
* @return array api result array
* {@getfields mailing_event_subscribe_create}
* @access public
$group->is_active = 1;
$group->id = (int)$group_id;
if (!$group->find(TRUE)) {
- return civicrm_api3_create_error('Invalid Group id');
+ throw new API_Exception('Invalid Group id');
}
$subscribe = CRM_Mailing_Event_BAO_Subscribe::subscribe($group_id, $email, $contact_id);
$subscribe->send_confirm_request($email);
$values = array();
- $values['contact_id'] = $subscribe->contact_id;
- $values['subscribe_id'] = $subscribe->id;
- $values['hash'] = $subscribe->hash;
- $values['is_error'] = 0;
+ $values[$subscribe->id]['contact_id'] = $subscribe->contact_id;
+ $values[$subscribe->id]['subscribe_id'] = $subscribe->id;
+ $values[$subscribe->id]['hash'] = $subscribe->hash;
return civicrm_api3_create_success($values);
}
return civicrm_api3_create_error('Subscription failed');
}
-/*
+
+/**
* Adjust Metadata for Create action
- *
+ *
* The metadata is used for setting defaults, documentation & validation
* @param array $params array or parameters determined by getfields
*/