Merge remote-tracking branch 'upstream/4.5' into 4.5-master-2015-03-09-21-44-34

[civicrm-core.git] / api / v3 / MailingComponent.php

diff --git a/api/v3/MailingComponent.php b/api/v3/MailingComponent.php
index 93bfddab0ea367055cb1d864d3912c9662b6eb7b..626232974f9a55eb8aa7988e344c04b61b0d25e6 100644 (file)
--- a/api/v3/MailingComponent.php
+++ b/api/v3/MailingComponent.php
@@ -26,14 +26,13 @@
  */
 
 /**
- * This api exposes CiviCRM mailing_component.
+ * This api exposes CiviCRM MailingComponent (header and footer).
  *
  * @package CiviCRM_APIv3
- * @subpackage API_mailing_component
  */
 
 /**
- * Save a mailing_component.
+ * Save a MailingComponent.
  *
  * @param array $params
  *
@@ -45,8 +44,21 @@ 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;
+}
+
 /**
- * Get a mailing_component.
+ * Get a MailingComponent.
  *
  * @param array $params
  *
@@ -58,7 +70,17 @@ function civicrm_api3_mailing_component_get($params) {
 }
 
 /**
- * Delete a mailing_component.
+ * 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
  *