X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMailingComponent.php;h=626232974f9a55eb8aa7988e344c04b61b0d25e6;hb=b71cb96619f284fb007d4365c33f59f088573d8f;hp=804975114c4073e62c453f0890a40e8e66cb99bd;hpb=8b3bede6c663e2459a0efb06b03852643df81c48;p=civicrm-core.git

diff --git a/api/v3/MailingComponent.php b/api/v3/MailingComponent.php
index 804975114c..626232974f 100644
--- a/api/v3/MailingComponent.php
+++ b/api/v3/MailingComponent.php
@@ -23,61 +23,70 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 mailing_component functions
+ * This api exposes CiviCRM MailingComponent (header and footer).
  *
  * @package CiviCRM_APIv3
- * @subpackage API_mailing_component
- *
  */
 
 /**
- * Save a mailing_component
- *
- * Allowed @params array keys are:
- * {@getfields mailing_component_create}
- * @example mailing_componentCreate.php
+ * Save a MailingComponent.
  *
  * @param array $params
  *
  * @throws API_Exception
  * @return array
- *   Array of newly created mailing_component property values.
+ *   API result array.
  */
 function civicrm_api3_mailing_component_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
+
 /**
- * Get a mailing_component
+ * Adjust Metadata for Create action.
  *
- * Allowed @params array keys are:
- * {@getfields mailing_component_get}
- * @example mailing_componentCreate.php
+ * 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;
+}
+
+/**
+ * Get a MailingComponent.
  *
  * @param array $params
  *
  * @return array
- *   Array of retrieved mailing_component property values.
+ *   API result array.
  */
 function civicrm_api3_mailing_component_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Delete a mailing_component
+ * Adjust metadata for get.
  *
- * Allowed @params array keys are:
- * {@getfields mailing_component_delete}
- * @example mailing_componentCreate.php
+ * @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
- *   Array of deleted values.
+ *   API result array.
  */
 function civicrm_api3_mailing_component_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);