<?php /* +--------------------------------------------------------------------+ | CiviCRM version 4.7 | +--------------------------------------------------------------------+ | Copyright CiviCRM LLC (c) 2004-2017 | +--------------------------------------------------------------------+ | This file is a part of CiviCRM. | | | | CiviCRM is free software; you can copy, modify, and distribute it | | under the terms of the GNU Affero General Public License | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | | | CiviCRM is distributed in the hope that it will be useful, but | | WITHOUT ANY WARRANTY; without even the implied warranty of | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | See the GNU Affero General Public License for more details. | | | | You should have received a copy of the GNU Affero General Public | | License and the CiviCRM Licensing Exception along | | with this program; if not, contact CiviCRM LLC | | at info[AT]civicrm[DOT]org. If you have questions about the | | GNU Affero General Public License or the licensing of CiviCRM, | | see the CiviCRM license FAQ at http://civicrm.org/licensing | +--------------------------------------------------------------------+ */ /** * This api exposes CiviCRM MailingComponent (header and footer). * * @package CiviCRM_APIv3 */ /** * Save a MailingComponent. * * @param array $params * * @throws API_Exception * @return array * API result array. */ function civicrm_api3_mailing_component_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** * Adjust Metadata for Create action. * * The metadata is used for setting defaults, documentation & validation. * * @param array $spec * Array of parameters determined by getfields. */ function _civicrm_api3_mailing_component_create_spec(&$spec) { $spec['is_active']['api.default'] = 1; $spec['name']['api.required'] = 1; $spec['component_type']['api.required'] = 1; } /** * Get a MailingComponent. * * @param array $params * * @return array * API result array. */ function civicrm_api3_mailing_component_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** * Adjust metadata for get. * * @param array $params */ function _civicrm_api3_mailing_component_get_spec(&$params) { // fetch active records by default $params['is_active']['api.default'] = 1; } /** * Delete a MailingComponent. * * @param array $params * * @throws API_Exception * @return array * API result array. */ function civicrm_api3_mailing_component_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); }