Merge pull request #5187 from mallezie/CRM-15982

[civicrm-core.git] / api / v3 / examples / UFGroup / Create.php

<?php
/**
 * Test Generated example of using uf_group create API.
 *
 * @return array
 *   API result array
 */
function uf_group_create_example() {
  $params = array(
    'add_captcha' => 1,
    'add_contact_to_group' => 1,
    'group' => 1,
    'cancel_URL' => 'http://example.org/cancel',
    'created_date' => '2009-06-27 00:00:00',
    'created_id' => 1,
    'group_type' => 'Individual,Contact',
    'help_post' => 'help post',
    'help_pre' => 'help pre',
    'is_active' => 0,
    'is_cms_user' => 1,
    'is_edit_link' => 1,
    'is_map' => 1,
    'is_reserved' => 1,
    'is_uf_link' => 1,
    'is_update_dupe' => 1,
    'name' => 'Test_Group',
    'notify' => 'admin@example.org',
    'post_URL' => 'http://example.org/post',
    'title' => 'Test Group',
  );

  try{
    $result = civicrm_api3('uf_group', 'create', $params);
  }
  catch (CiviCRM_API3_Exception $e) {
    // Handle error here.
    $errorMessage = $e->getMessage();
    $errorCode = $e->getErrorCode();
    $errorData = $e->getExtraParams();
    return array(
      'error' => $errorMessage,
      'error_code' => $errorCode,
      'error_data' => $errorData,
    );
  }

  return $result;
}

/**
 * Function returns array of result expected from previous function.
 *
 * @return array
 *   API result array
 */
function uf_group_create_expectedresult() {

  $expectedResult = array(
    'is_error' => 0,
    'version' => 3,
    'count' => 1,
    'id' => 2,
    'values' => array(
      '2' => array(
        'id' => '2',
        'is_active' => 0,
        'group_type' => 'Individual,Contact',
        'title' => 'Test Group',
        'description' => '',
        'help_pre' => 'help pre',
        'help_post' => 'help post',
        'limit_listings_group_id' => '1',
        'post_URL' => 'http://example.org/post',
        'add_to_group_id' => '1',
        'add_captcha' => '1',
        'is_map' => '1',
        'is_edit_link' => '1',
        'is_uf_link' => '1',
        'is_update_dupe' => '1',
        'cancel_URL' => 'http://example.org/cancel',
        'is_cms_user' => '1',
        'notify' => 'admin@example.org',
        'is_reserved' => '1',
        'name' => 'Test_Group_2',
        'created_id' => '1',
        'created_date' => '2013-07-28 08:49:19',
        'is_proximity_search' => '',
      ),
    ),
  );

  return $expectedResult;
}

/**
* This example has been generated from the API test suite.
* The test that created it is called
* testUFGroupCreate
* and can be found in
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFGroupTest.php
*
* You can see the outcome of the API tests at
* https://test.civicrm.org/job/CiviCRM-master-git/
*
* To Learn about the API read
* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
*
* Browse the api on your own site with the api explorer
* http://MYSITE.ORG/path/to/civicrm/api
*
* Read more about testing here
* http://wiki.civicrm.org/confluence/display/CRM/Testing
*
* API Standards documentation:
* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
*/