CRM-21216 Replace member_BAO_membershiptype_getMembershipTypesByOrg with API eq…

[mattwire]

…uivalent

Overview

Replace the BAO function getMembershipTypesByOrg with generic API function.

Before

Custom code that does the same as the API

After

Generic API is used to retrieve the same information in the same format.

Technical Details

The API supports the necessary parameters to retrieve the information that is being retrieved by the custom function.

[seamuslee001]

I like the changes here, I haven't tested them but the code looks correct to me. @eileenmcnaughton Eileen any thoughts?

[eileenmcnaughton]

In order to test this I put the following code

    $memberTypesSameParentOrg = civicrm_api3('MembershipType', 'get', array(
      'member_of_contact_id' => $orgID,
    ));
    return CRM_Utils_Array::value('values', $memberTypesSameParentOrg, array());

into the existing getMembershipTypesByOrg function & ran the tests identified in this PR - they still passed.

I am going to merge this as the code looks good & I believe the tests adequately cover it. But I wonder if we shouldn't change the function to be more deprected ie change the function to

  public static function getMembershipTypesByOrg($orgID) {
    Civi::log()->warning('Deprecated function getMembershipTypesByOrg, please user membership_type api', array('civi.tag' => 'deprecated'));
    $memberTypesSameParentOrg = civicrm_api3('MembershipType', 'get', array(
      'member_of_contact_id' => $orgID,
    ));
    return CRM_Utils_Array::value('values', $memberTypesSameParentOrg, array());
  }

[tschuettler]

This does look like it will run into problems when there are more than 25 membership types due to API requests having a default limit of 25 values.

[eileenmcnaughton]

arg true!

[eileenmcnaughton]

@mattwire did you see that comment?

[mattwire]

:-( Please see new PR #11029 that fixes this and also updates deprecated function based on your comments @eileenmcnaughton @tschuettler