/**
* Deletes an existing contact Membership.
*
* @param array $params
* Array array holding id - Id of the contact membership to be deleted.
*
* @return array
* API result array.
*/
function civicrm_api3_membership_delete($params)
{
if (isset($params['preserve_contribution'])) {
if (CRM_Member_BAO_Membership::del($params['id'], $params['preserve_contribution'])) {
return civicrm_api3_create_success(TRUE, $params);
} else {
throw new API_Exception(ts('Could not delete membership'));
}
} else {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
}
/**
* Delete any existing assignment activity.
* Activity id is required
*
* @param array $params (reference) array containing id of the group
* to be deleted
*
* @return array (referance) returns flag true if successfull, error
* message otherwise
* {@getfields assignment_delete}
* @access public
*/
function civicrm_api3_volunteer_assignment_delete($params)
{
return _civicrm_api3_basic_delete('CRM_Activity_BAO_Activity', $params);
}
/**
* Deletes an existing ActivityContact record
*
* @param array $params
*
* @return array Api Result
*
* @example ActivityContact.php
* @access public
*/
function civicrm_api3_activity_contact_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Deletes an existing Location Type
*
* @param array $params
*
* @example LocationTypeDelete.php Standard Delete Example
*
* @return boolean | error true if successfull, error otherwise
* {@getfields LocationType_delete}
* @access public
*/
function civicrm_api3_location_type_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* HRJobPension.delete API
*
* @param array $params
* @return array API result descriptor
* @throws API_Exception
*/
function civicrm_api3_h_r_job_pension_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete message template.
*
* @param array $params
*
* @return bool
* API result array
*/
function civicrm_api3_message_template_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Deletes an existing Mandate
*
* @param array $params
*
* @return boolean | error true if successfull, error otherwise
* {@getfields sepa_mandate_delete}
* @access public
*/
function civicrm_api3_sepa_mandate_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete an sms_provider.
*
* @param array $params
*
* @return array
* Array of deleted values.
*/
function civicrm_api3_sms_provider_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete an existing campaign.
*
* This method is used to delete any existing campaign.
* Id of the campaign to be deleted is required field in $params array
*
* @param array $params
* array containing id of the group to be deleted
*
* @return array
*/
function civicrm_api3_campaign_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete a CiviCRM UF_Join
*
* @param array $params
* Array of name/value pairs.
*/
function civicrm_api3_uf_join_delete($params)
{
return _civicrm_api3_basic_delete('CRM_Core_BAO_UFJoin', $params);
}
/**
* Delete an existing project contact
*
* This method is used to delete the relationship(s) between a contact and a
* project.
*
* @param array $params array containing id of the project
* to be deleted
*
* @return array returns flag true if successfull, error
* message otherwise
* {@getfields volunteer_project_delete}
* @access public
*/
function civicrm_api3_volunteer_project_contact_delete($params)
{
$projectId = CRM_Core_DAO::getFieldValue("CRM_Volunteer_DAO_ProjectContact", $params['id'], "project_id");
if (!$params['check_permissions'] || CRM_Volunteer_Permission::checkProjectPerms(CRM_Core_Action::UPDATE, $projectId)) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
} else {
return civicrm_api3_create_error(ts('You do not have permission to modify contacts for this project'));
}
}
/**
* Deletes an existing ReportInstance.
*
* @param array $params
*
* @return array
*/
function civicrm_api3_recurring_entity_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete an existing MailSettings.
*
* @param array $params
* [id]
*
* @return array
* API result array.
*/
function civicrm_api3_mail_settings_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Deletes an existing Country.
*
* @param array $params
*
* @return array
*/
function civicrm_api3_country_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params);
}
/**
* Deletes an existing contact membership
*
* This API is used for deleting a contact membership
*
* @param $params array array holding id - Id of the contact membership to be deleted
*
* @return array api result
* {@getfields membership_delete}
* @access public
*/
function civicrm_api3_membership_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete a banking account entry
*
* @param array $params (reference ) input parameters
*
* @return array (reference )
* @access public
*/
function civicrm_api3_banking_account_reference_delete($params)
{
return _civicrm_api3_basic_delete("CRM_Banking_BAO_BankAccountReference", $params);
}
/**
* Delete a FinancialAccount.
*
* @param array $params
*
* @return array
* Array of deleted values.
*/
function civicrm_api3_financial_account_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Handle a delete event.
*
* @param array $params
* @param array $ids
*
* @return array API Success Array
*/
function civicrm_api3_mailing_delete($params, $ids = array())
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete a Entity Financial Trxn.
*
* @param array $params
*
* @return array
* Array of deleted values.
*/
function civicrm_api3_entity_financial_trxn_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete an existing LocBlock.
*
* @param array $params
* Array containing id of the record to be deleted.
*
* @return array
* API result array.
*/
function civicrm_api3_loc_block_delete($params)
{
return _civicrm_api3_basic_delete('CRM_Core_DAO_LocBlock', $params);
}
/**
* Delete an existing ContributionRecur.
*
* This method is used to delete an existing ContributionRecur given its id.
*
* @param array $params
* [id]
*
* @return array
* API result array
*/
function civicrm_api3_contribution_recur_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Deletes an existing ReportInstance.
*
* @param array $params
*
* @return array
* API result array
*/
function civicrm_api3_report_instance_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Deletes an existing PaymentProcessor.
*
* @param array $params
*
* @return array
* API result array
*/
function civicrm_api3_payment_processor_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete an existing ActionSchedule.
*
* @param array $params
* Array containing id of the action_schedule to be deleted.
*
* @return array
* API result array
*/
function civicrm_api3_action_schedule_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete a mailing_component
*
* Allowed @params array keys are:
* {@getfields mailing_component_delete}
* @example mailing_componentCreate.php
*
* @return array of deleted values.
* @access public
*/
function civicrm_api3_mailing_component_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete an existing discount code.
*
* This method is used to delete any existing item.
* Id of the item to be deleted is required in $params array.
*
* @param array $params
* Array containing id of the item to be deleted.
*
* @return array
* API result Array
*/
function civicrm_api3_discount_code_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete an existing PriceSet.
*
* This method is used to delete any existing PriceSet given its id.
*
* @param array $params
* Array containing id of the group to be deleted.
*
* @return array
* API result array
*/
function civicrm_api3_price_set_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* MyEmmaAccount.Delete API
*
* @param array $params
* @return array API result descriptor
* @see civicrm_api3_create_success
* @see civicrm_api3_create_error
* @throws API_Exception
*/
function civicrm_api3_my_emma_field_map_delete($params)
{
return _civicrm_api3_basic_delete('CRM_Myemma_BAO_MyEmmaFieldMap', $params);
}
/**
* delete an existing need
*
* This method is used to delete any existing need. id of the group
* to be deleted is required field in $params array
*
* @param array $params (reference) array containing id of the group
* to be deleted
*
* @return array (referance) returns flag true if successfull, error
* message otherwise
* {@getfields need_delete}
* @access public
*/
function civicrm_api3_volunteer_need_delete($params)
{
return _civicrm_api3_basic_delete('CRM_Volunteer_BAO_Need', $params);
}
/**
* Delete an existing Option Group.
*
* This method is used to delete any existing OptionGroup given its id.
*
* @param array $params
* [id]
*
* @return array
* API Result Array
*/
function civicrm_api3_option_group_delete($params)
{
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
