CRM-13296 membership api enotice fix & tests

diff --git a/api/v3/Membership.php b/api/v3/Membership.php
index 3d4d54140b788d7cdd230fe8ae85d53ee9b3cf58..d00ca9fb3d154668dfda0ebfb5372e44e8a7b928 100644 (file)
--- a/api/v3/Membership.php
+++ b/api/v3/Membership.php
@@ -199,11 +199,49 @@ function civicrm_api3_membership_get($params) {
     $membershipValues = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE);
   }
 
-  if (empty($membershipValues)) {
-    // No results is NOT an error!
-    return civicrm_api3_create_success($membershipValues, $params);
+  $options = _civicrm_api3_get_options_from_params($params, TRUE,'membership','get');
+  $return = $options['return'];
+  if(empty($membershipValues) ||
+    (!empty($return)
+      && !array_key_exists('related_contact_id', $return)
+      && !array_key_exists('relationship_name', $return)
+    )
+    ) {
+    return civicrm_api3_create_success($membershipValues, $params, 'membership', 'get');
   }
 
+  $members =  _civicrm_api3_membership_relationsship_get_customv2behaviour($params, $membershipValues, $contactID );
+  return civicrm_api3_create_success($members, $params, 'membership', 'get');
+}
+
+/**
+ * When we copied apiv3 from api v2 we brought across some custom behaviours - in the case of
+ * membership a complicated return array is constructed. The original
+ * behaviour made contact_id a required field. We still need to keep this for v3 when contact_id
+ * is passed in as part of the reasonable expectation developers have that we will keep the api
+ * as stable as possible
+ *
+ * @param array $params parameters passed into get function
+ * @return array result for calling function
+ */
+function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTypeId, $activeOnly) {
+  // get the membership for the given contact ID
+  $membershipParams = array('contact_id' => $params['contact_id']);
+  if ($membershipTypeId) {
+    $membershipParams['membership_type_id'] = $membershipTypeId;
+  }
+  $membershipValues = array();
+  CRM_Member_BAO_Membership::getValues($membershipParams, $membershipValues, $activeOnly);
+  return $membershipValues;
+}
+
+
+/**
+ * non-standard behaviour inherited from v2
+* @param array $params parameters passed into get function
+* @return array result for calling function
+*/
+function _civicrm_api3_membership_relationsship_get_customv2behaviour(&$params, $membershipValues, $contactID) {
   $relationships = array();
   foreach ($membershipValues as $membershipId => $values) {
     // populate the membership type name for the membership type id
@@ -246,27 +284,5 @@ function civicrm_api3_membership_get($params) {
 
     }
   }
-
-  return civicrm_api3_create_success($members, $params, 'membership', 'get');
-}
-
-/**
- * When we copied apiv3 from api v2 we brought across some custom behaviours - in the case of
- * membership a complicated return array is constructed. The original
- * behaviour made contact_id a required field. We still need to keep this for v3 when contact_id
- * is passed in as part of the reasonable expectation developers have that we will keep the api
- * as stable as possible
- *
- * @param array $params parameters passed into get function
- * @return array result for calling function
- */
-function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTypeId, $activeOnly) {
-  // get the membership for the given contact ID
-  $membershipParams = array('contact_id' => $params['contact_id']);
-  if ($membershipTypeId) {
-    $membershipParams['membership_type_id'] = $membershipTypeId;
-  }
-  $membershipValues = array();
-  CRM_Member_BAO_Membership::getValues($membershipParams, $membershipValues, $activeOnly);
-  return $membershipValues;
+  return $members;
 }

diff --git a/api/v3/examples/Membership/filterIsCurrent.php b/api/v3/examples/Membership/filterIsCurrent.php
index b5fab187f9ca5cb4266d3dea4c5ff5f606c430e4..e014948de674601d10bfb3c8a1566fcb2796f05f 100644 (file)
--- a/api/v3/examples/Membership/filterIsCurrent.php
+++ b/api/v3/examples/Membership/filterIsCurrent.php
@@ -5,7 +5,7 @@
  */
 function membership_get_example(){
 $params = array(
-  'contact_id' => 13,
+  'contact_id' => 17,
   'filters' => array(
       'is_current' => 1,
     ),
@@ -39,9 +39,9 @@ function membership_get_expectedresult(){
       '1' => array(
           'id' => '1',
           'membership_id' => '1',
-          'contact_id' => '13',
-          'membership_contact_id' => '13',
-          'membership_type_id' => '21',
+          'contact_id' => '17',
+          'membership_contact_id' => '17',
+          'membership_type_id' => '25',
           'join_date' => '2009-01-21',
           'start_date' => '2013-07-29 00:00:00',
           'membership_start_date' => '2009-01-21',
@@ -49,7 +49,7 @@ function membership_get_expectedresult(){
           'membership_end_date' => '2009-12-21',
           'source' => 'Payment',
           'membership_source' => 'Payment',
-          'status_id' => '18',
+          'status_id' => '20',
           'is_override' => '1',
           'is_test' => 0,
           'member_is_test' => 0,

diff --git a/api/v3/examples/MembershipCreate.php b/api/v3/examples/MembershipCreate.php
index fe7eb3a610cfb19fea310347c80a91770b860a62..6ab9557be84d0d141ed0d6406409f7963a83eeea 100644 (file)
--- a/api/v3/examples/MembershipCreate.php
+++ b/api/v3/examples/MembershipCreate.php
@@ -5,14 +5,14 @@
  */
 function membership_create_example(){
 $params = array(
-  'contact_id' => 25,
-  'membership_type_id' => 42,
+  'contact_id' => 30,
+  'membership_type_id' => 48,
   'join_date' => '2009-01-21',
   'start_date' => '2009-01-21',
   'end_date' => '2009-12-21',
   'source' => 'Payment',
   'is_override' => 1,
-  'status_id' => 28,
+  'status_id' => 31,
   'custom_1' => 'custom string',
 );
 
@@ -43,17 +43,17 @@ function membership_create_expectedresult(){
   'values' => array(
       '1' => array(
           'id' => '1',
-          'contact_id' => '25',
-          'membership_type_id' => '42',
+          'contact_id' => '30',
+          'membership_type_id' => '48',
           'join_date' => '20090121000000',
           'start_date' => '2013-07-29 00:00:00',
           'end_date' => '2013-08-04 00:00:00',
           'source' => 'Payment',
-          'status_id' => '28',
+          'status_id' => '31',
           'is_override' => '1',
           'owner_membership_id' => '',
           'max_related' => '',
-          'is_test' => '',
+          'is_test' => 0,
           'is_pay_later' => '',
           'contribution_recur_id' => '',
           'campaign_id' => '',

diff --git a/api/v3/examples/MembershipGet.php b/api/v3/examples/MembershipGet.php
index 3094dfb50dac5c667bf1a034503bd243a2a663ca..315ff70e93a9b244e88f7def9b4a6e5e7c6fa9c5 100644 (file)
--- a/api/v3/examples/MembershipGet.php
+++ b/api/v3/examples/MembershipGet.php
@@ -5,7 +5,7 @@
  */
 function membership_get_example(){
 $params = array(
-  'membership_type_id' => 15,
+  'membership_type_id' => 19,
 );
 
 try{
@@ -35,13 +35,13 @@ function membership_get_expectedresult(){
   'values' => array(
       '1' => array(
           'id' => '1',
-          'contact_id' => '10',
-          'membership_type_id' => '15',
+          'contact_id' => '14',
+          'membership_type_id' => '19',
           'join_date' => '2009-01-21',
           'start_date' => '2013-07-29 00:00:00',
           'end_date' => '2013-08-04 00:00:00',
           'source' => 'Payment',
-          'status_id' => '15',
+          'status_id' => '17',
           'is_override' => '1',
           'is_test' => 0,
           'is_pay_later' => 0,

diff --git a/api/v3/examples/MembershipUpdate.php b/api/v3/examples/MembershipUpdate.php
index ea36ab409fdc872a8e66ddf153b9bd4ec5a636d6..dbe01b116f2471f9c898cb11dcd24dfbc3a7b36e 100644 (file)
--- a/api/v3/examples/MembershipUpdate.php
+++ b/api/v3/examples/MembershipUpdate.php
@@ -5,14 +5,14 @@
  */
 function membership_update_example(){
 $params = array(
-  'contact_id' => 31,
-  'membership_type_id' => 54,
+  'contact_id' => 36,
+  'membership_type_id' => 60,
   'join_date' => '2009-01-21',
   'start_date' => '2009-01-21',
   'end_date' => '2009-12-21',
   'source' => 'Payment',
   'is_override' => 1,
-  'status_id' => 34,
+  'status_id' => 37,
   'custom_1' => 'custom string',
 );
 
@@ -43,17 +43,17 @@ function membership_update_expectedresult(){
   'values' => array(
       '1' => array(
           'id' => '1',
-          'contact_id' => '31',
-          'membership_type_id' => '54',
+          'contact_id' => '36',
+          'membership_type_id' => '60',
           'join_date' => '20090121000000',
           'start_date' => '2013-07-29 00:00:00',
           'end_date' => '2013-08-04 00:00:00',
           'source' => 'Payment',
-          'status_id' => '34',
+          'status_id' => '37',
           'is_override' => '1',
           'owner_membership_id' => '',
           'max_related' => '',
-          'is_test' => '',
+          'is_test' => 0,
           'is_pay_later' => '',
           'contribution_recur_id' => '',
           'campaign_id' => '',

diff --git a/tests/phpunit/api/v3/MembershipTest.php b/tests/phpunit/api/v3/MembershipTest.php
index 0137833ba72fb18ba9f1f2c12db6f2b376f34c8d..0e00afbd87e7c00c04e7f4b08bbd807b6af87773 100644 (file)
--- a/tests/phpunit/api/v3/MembershipTest.php
+++ b/tests/phpunit/api/v3/MembershipTest.php
@@ -413,6 +413,16 @@ class api_v3_MembershipTest extends CiviUnitTestCase {
     $this->contactDelete($memberContactId);
   }
 
+  /**
+   * We are checking for no enotices + only id & end_date returned
+   */
+  function testMembershipGetWithReturn() {
+    $membershipID = $this->contactMembershipCreate($this->_params);
+    $result = $this->callAPISuccess('membership', 'get', array('return' => 'end_date'));
+    foreach ($result['values']  as $membership) {
+      $this->assertEquals(array('id', 'end_date'), array_keys($membership));
+    }
+  }
   ///////////////// civicrm_membership_create methods
 
   /**