Merge pull request #4897 from totten/master-cleanup2

[civicrm-core.git] / tests / phpunit / CiviTest / Custom.php

<?php

/**
 * Class Custom
 */
class Custom extends CiviUnitTestCase {
  /**
   * Helper function to create Custom Group
   *
   * @deprecated - use functions on test case parent class
   *
   * @param $group
   * @param null $extends
   * @param bool $isMultiple
   *
   * @return object
   *   of created group
   */
  public static function createGroup($group, $extends = NULL, $isMultiple = FALSE) {
    if (empty($group)) {
      if (isset($extends) &&
        !is_array($extends)
      ) {
        $extends = array($extends);
      }
      $group = array(
        'title' => 'Test_Group',
        'name' => 'test_group',
        'extends' => $extends,
        'style' => 'Inline',
        'is_multiple' => $isMultiple,
        'is_active' => 1,
        'version' => 3,
      );
    }
    else {
      // this is done for backward compatibility
      // with tests older than 3.2.3
      if (isset($group['extends']) &&
        !is_array($group['extends'])
      ) {
        $group['extends'] = array($group['extends']);
      }
    }

    $result = civicrm_api('custom_group', 'create', $group);

    if ($result['is_error']) {
      return NULL;
    }

    // this is done for backward compatibility
    // with tests older than 3.2.3
    require_once 'CRM/Core/BAO/CustomGroup.php';
    $group = new CRM_Core_BAO_CustomGroup();
    $group->id = $result['id'];
    $group->find(TRUE);

    return $group;
  }

  /**
   * Helper function to create Custom Field
   * @deprecated use parent object create fn
   * @param array $params
   * @param null $fields
   * @return object
   *   of created field
   */
  public static function createField($params, $fields = NULL) {
    if (empty($params)) {
      $params = array(
        'custom_group_id' => $fields['groupId'],
        'label' => empty($fields['label']) ? 'test_' . CRM_Utils_Array::value('dataType', $fields) : $fields['label'],
        'html_type' => CRM_Utils_Array::value('htmlType', $fields),
        'data_type' => CRM_Utils_Array::value('dataType', $fields),
        'weight' => 4,
        'is_required' => 1,
        'is_searchable' => 0,
        'is_active' => 1,
        'version' => 3,
      );
    }

    $result = civicrm_api('custom_field', 'create', $params);

    if ($result['is_error']) {
      print_r($result);
      return NULL;
    }

    // this is done for backward compatibility
    // with tests older than 3.2.3
    $customField = new CRM_Core_DAO_CustomField();
    $customField->id = $result['id'];
    $customField->find(TRUE);

    return $customField;
  }

  /**
   * Helper function to delete custom field
   * @deprecated use function on parent class
   * @param object of Custom Field to delete
   */
  public static function deleteField($params) {
    require_once 'CRM/Core/BAO/CustomField.php';
    CRM_Core_BAO_CustomField::deleteField($params);
  }

  /**
   * Helper function to delete custom group
   * @deprecated use function on parent class
   * @param object Custom Group to delete
   * @return boolean
   *   true if Group deleted, false otherwise
   */
  public static function deleteGroup($params) {
    require_once 'CRM/Core/BAO/CustomGroup.php';
    $deleteCustomGroup = CRM_Core_BAO_CustomGroup::deleteGroup($params, TRUE);
    return $deleteCustomGroup;
  }
}