tests/phpunit/CRM/Utils/ArrayTest.php

   1 <?php
   2
   3 /**
   4  * Class CRM_Utils_ArrayTest
   5  * @group headless
   6  */
   7 class CRM_Utils_ArrayTest extends CiviUnitTestCase {
   8
   9   public function testIndexArray() {
  10     $inputs = array();
  11     $inputs[] = array(
  12       'lang' => 'en',
  13       'msgid' => 'greeting',
  14       'familiar' => FALSE,
  15       'value' => 'Hello',
  16     );
  17     $inputs[] = array(
  18       'lang' => 'en',
  19       'msgid' => 'parting',
  20       'value' => 'Goodbye',
  21     );
  22     $inputs[] = array(
  23       'lang' => 'fr',
  24       'msgid' => 'greeting',
  25       'value' => 'Bon jour',
  26     );
  27     $inputs[] = array(
  28       'lang' => 'fr',
  29       'msgid' => 'parting',
  30       'value' => 'Au revoir',
  31     );
  32     $inputs[] = array(
  33       'lang' => 'en',
  34       'msgid' => 'greeting',
  35       'familiar' => TRUE,
  36       'value' => 'Hey',
  37     );
  38     $inputs[] = array(
  39       'msgid' => 'greeting',
  40       'familiar' => TRUE,
  41       'value' => 'Universal greeting',
  42     );
  43
  44     $byLangMsgid = CRM_Utils_Array::index(array('lang', 'msgid'), $inputs);
  45     $this->assertEquals($inputs[4], $byLangMsgid['en']['greeting']);
  46     $this->assertEquals($inputs[1], $byLangMsgid['en']['parting']);
  47     $this->assertEquals($inputs[2], $byLangMsgid['fr']['greeting']);
  48     $this->assertEquals($inputs[3], $byLangMsgid['fr']['parting']);
  49     $this->assertEquals($inputs[5], $byLangMsgid[NULL]['greeting']);
  50   }
  51
  52   public function testCollect() {
  53     $arr = array(
  54       array('catWord' => 'cat', 'dogWord' => 'dog'),
  55       array('catWord' => 'chat', 'dogWord' => 'chien'),
  56       array('catWord' => 'gato'),
  57     );
  58     $expected = array('cat', 'chat', 'gato');
  59     $this->assertEquals($expected, CRM_Utils_Array::collect('catWord', $arr));
  60
  61     $arr = array();
  62     $arr['en'] = (object) array('catWord' => 'cat', 'dogWord' => 'dog');
  63     $arr['fr'] = (object) array('catWord' => 'chat', 'dogWord' => 'chien');
  64     $arr['es'] = (object) array('catWord' => 'gato');
  65     $expected = array('en' => 'cat', 'fr' => 'chat', 'es' => 'gato');
  66     $this->assertEquals($expected, CRM_Utils_Array::collect('catWord', $arr));
  67   }
  68
  69   public function testProduct0() {
  70     $actual = CRM_Utils_Array::product(
  71       array(),
  72       array('base data' => 1)
  73     );
  74     $this->assertEquals(array(
  75       array('base data' => 1),
  76     ), $actual);
  77   }
  78
  79   public function testProduct1() {
  80     $actual = CRM_Utils_Array::product(
  81       array('dim1' => array('a', 'b')),
  82       array('base data' => 1)
  83     );
  84     $this->assertEquals(array(
  85       array('base data' => 1, 'dim1' => 'a'),
  86       array('base data' => 1, 'dim1' => 'b'),
  87     ), $actual);
  88   }
  89
  90   public function testProduct3() {
  91     $actual = CRM_Utils_Array::product(
  92       array('dim1' => array('a', 'b'), 'dim2' => array('alpha', 'beta'), 'dim3' => array('one', 'two')),
  93       array('base data' => 1)
  94     );
  95     $this->assertEquals(array(
  96       array('base data' => 1, 'dim1' => 'a', 'dim2' => 'alpha', 'dim3' => 'one'),
  97       array('base data' => 1, 'dim1' => 'a', 'dim2' => 'alpha', 'dim3' => 'two'),
  98       array('base data' => 1, 'dim1' => 'a', 'dim2' => 'beta', 'dim3' => 'one'),
  99       array('base data' => 1, 'dim1' => 'a', 'dim2' => 'beta', 'dim3' => 'two'),
 100       array('base data' => 1, 'dim1' => 'b', 'dim2' => 'alpha', 'dim3' => 'one'),
 101       array('base data' => 1, 'dim1' => 'b', 'dim2' => 'alpha', 'dim3' => 'two'),
 102       array('base data' => 1, 'dim1' => 'b', 'dim2' => 'beta', 'dim3' => 'one'),
 103       array('base data' => 1, 'dim1' => 'b', 'dim2' => 'beta', 'dim3' => 'two'),
 104     ), $actual);
 105   }
 106
 107   public function testIsSubset() {
 108     $this->assertTrue(CRM_Utils_Array::isSubset(array(), array()));
 109     $this->assertTrue(CRM_Utils_Array::isSubset(array('a'), array('a')));
 110     $this->assertTrue(CRM_Utils_Array::isSubset(array('a'), array('b', 'a', 'c')));
 111     $this->assertTrue(CRM_Utils_Array::isSubset(array('b', 'd'), array('a', 'b', 'c', 'd')));
 112     $this->assertFalse(CRM_Utils_Array::isSubset(array('a'), array()));
 113     $this->assertFalse(CRM_Utils_Array::isSubset(array('a'), array('b')));
 114     $this->assertFalse(CRM_Utils_Array::isSubset(array('a'), array('b', 'c', 'd')));
 115   }
 116
 117   public function testRemove() {
 118     $data = array(
 119       'one' => 1,
 120       'two' => 2,
 121       'three' => 3,
 122       'four' => 4,
 123       'five' => 5,
 124       'six' => 6,
 125     );
 126     CRM_Utils_Array::remove($data, 'one', 'two', array('three', 'four'), 'five');
 127     $this->assertEquals($data, array('six' => 6));
 128   }
 129
 130   public function testGetSetPathParts() {
 131     $arr = array(
 132       'one' => '1',
 133       'two' => array(
 134         'half' => 2,
 135       ),
 136     );
 137     $this->assertEquals('1', CRM_Utils_Array::pathGet($arr, array('one')));
 138     $this->assertEquals('2', CRM_Utils_Array::pathGet($arr, array('two', 'half')));
 139     $this->assertEquals(NULL, CRM_Utils_Array::pathGet($arr, array('zoo', 'half')));
 140     CRM_Utils_Array::pathSet($arr, array('zoo', 'half'), '3');
 141     $this->assertEquals(3, CRM_Utils_Array::pathGet($arr, array('zoo', 'half')));
 142     $this->assertEquals(3, $arr['zoo']['half']);
 143   }
 144
 145   public function getSortExamples() {
 146     $red = array('label' => 'Red', 'id' => 1, 'weight' => '90');
 147     $orange = array('label' => 'Orange', 'id' => 2, 'weight' => '70');
 148     $yellow = array('label' => 'Yellow', 'id' => 3, 'weight' => '10');
 149     $green = array('label' => 'Green', 'id' => 4, 'weight' => '70');
 150     $blue = array('label' => 'Blue', 'id' => 5, 'weight' => '70');
 151
 152     $examples = array();
 153     $examples[] = array(
 154       array(
 155         'r' => $red,
 156         'y' => $yellow,
 157         'g' => $green,
 158         'o' => $orange,
 159         'b' => $blue,
 160       ),
 161       'id',
 162       array(
 163         'r' => $red,
 164         'o' => $orange,
 165         'y' => $yellow,
 166         'g' => $green,
 167         'b' => $blue,
 168       ),
 169     );
 170     $examples[] = array(
 171       array(
 172         'r' => $red,
 173         'y' => $yellow,
 174         'g' => $green,
 175         'o' => $orange,
 176         'b' => $blue,
 177       ),
 178       'label',
 179       array(
 180         'b' => $blue,
 181         'g' => $green,
 182         'o' => $orange,
 183         'r' => $red,
 184         'y' => $yellow,
 185       ),
 186     );
 187     $examples[] = array(
 188       array(
 189         'r' => $red,
 190         'g' => $green,
 191         'y' => $yellow,
 192         'o' => $orange,
 193         'b' => $blue,
 194       ),
 195       array('weight', 'id'),
 196       array(
 197         'y' => $yellow,
 198         'o' => $orange,
 199         'g' => $green,
 200         'b' => $blue,
 201         'r' => $red,
 202       ),
 203     );
 204
 205     return $examples;
 206   }
 207
 208   /**
 209    * @param array $array
 210    * @param string|array $field
 211    * @param $expected
 212    * @dataProvider getSortExamples
 213    */
 214   public function testCrmArraySortByField($array, $field, $expected) {
 215     $actual = CRM_Utils_Array::crmArraySortByField($array, $field);
 216
 217     // assertEquals() has nicer error output, but it's not precise about order.
 218     $this->assertEquals($expected, $actual);
 219
 220     $aIter = new ArrayIterator($actual);
 221     $eIter = new ArrayIterator($expected);
 222     $this->assertEquals($eIter->count(), $aIter->count());
 223     $pos = 0;
 224     while ($aIter->valid()) {
 225       $this->assertEquals($eIter->key(), $aIter->key(), "Keys at offset $pos do not match");
 226       $this->assertEquals($eIter->current(), $aIter->current(), "Values at offset $pos do not match");
 227       $aIter->next();
 228       $eIter->next();
 229       $pos++;
 230     }
 231   }
 232
 233 }