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 db953772ed44c1f112fe351f6f833bf0fb338611..626232974f9a55eb8aa7988e344c04b61b0d25e6 100644 (file)
--- a/api/v3/MailingComponent.php
+++ b/api/v3/MailingComponent.php
@@ -26,7 +26,7 @@
  */
 
 /**
- * This api exposes CiviCRM MailingComponent.
+ * This api exposes CiviCRM MailingComponent (header and footer).
  *
  * @package CiviCRM_APIv3
  */
@@ -44,6 +44,19 @@ 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 MailingComponent.
  *
@@ -56,6 +69,16 @@ 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.
  *