api/v3/examples/UFGroupGet.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function uf_group_get_example(){
   7 $params = array(
   8   'add_captcha' => 1,
   9   'add_contact_to_group' => 2,
  10   'cancel_URL' => 'http://example.org/cancel',
  11   'created_date' => '2009-06-27 00:00:00',
  12   'created_id' => 69,
  13   'group' => 2,
  14   'group_type' => 'Individual,Contact',
  15   'help_post' => 'help post',
  16   'help_pre' => 'help pre',
  17   'is_active' => 0,
  18   'is_cms_user' => 1,
  19   'is_edit_link' => 1,
  20   'is_map' => 1,
  21   'is_reserved' => 1,
  22   'is_uf_link' => 1,
  23   'is_update_dupe' => 1,
  24   'name' => 'Test_Group',
  25   'notify' => 'admin@example.org',
  26   'post_URL' => 'http://example.org/post',
  27   'title' => 'Test Group',
  28   'version' => 3,
  29 );
  30
  31   $result = civicrm_api( 'uf_group','get',$params );
  32
  33   return $result;
  34 }
  35
  36 /*
  37  * Function returns array of result expected from previous function
  38  */
  39 function uf_group_get_expectedresult(){
  40
  41   $expectedResult = array(
  42   'is_error' => 0,
  43   'version' => 3,
  44   'count' => 1,
  45   'id' => 12,
  46   'values' => array(
  47       '12' => array(
  48           'id' => '12',
  49           'is_active' => 0,
  50           'group_type' => 'Individual,Contact',
  51           'title' => 'Test Group',
  52           'help_pre' => 'help pre',
  53           'help_post' => 'help post',
  54           'limit_listings_group_id' => '2',
  55           'post_URL' => 'http://example.org/post',
  56           'add_to_group_id' => '2',
  57           'add_captcha' => '1',
  58           'is_map' => '1',
  59           'is_edit_link' => '1',
  60           'is_uf_link' => '1',
  61           'is_update_dupe' => '1',
  62           'cancel_URL' => 'http://example.org/cancel',
  63           'is_cms_user' => '1',
  64           'notify' => 'admin@example.org',
  65           'is_reserved' => '1',
  66           'name' => 'Test_Group_12',
  67           'created_id' => '69',
  68           'created_date' => '20120130621222105',
  69           'is_proximity_search' => 0,
  70         ),
  71     ),
  72 );
  73
  74   return $expectedResult  ;
  75 }
  76
  77
  78 /*
  79 * This example has been generated from the API test suite. The test that created it is called
  80 *
  81 * testUFGroupGet and can be found in
  82 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/UFGroupTest.php
  83 *
  84 * You can see the outcome of the API tests at
  85 * http://tests.dev.civicrm.org/trunk/results-api_v3
  86 *
  87 * To Learn about the API read
  88 * http://book.civicrm.org/developer/current/techniques/api/
  89 *
  90 * and review the wiki at
  91 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  92 *
  93 * Read more about testing here
  94 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  95 *
  96 * API Standards documentation:
  97 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  98 */