tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

BUGFIX: ArrayList now discards keys of the array passed in and keeps the numerically indexed array sequential.

Browse Source 
This fixes FirstLast and EvenOdd in templates, and makes ArrayList more consistent, as several methods already discarded the keys.
This commit is contained in:
Andrew O'Neil 2012-11-12 16:25:55 +13:00 committed by Ingo Schommer
parent 0fd6d14f94
commit 9d74c99e08
2 changed files with 81 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
model/ArrayList.php
View File

@ -19,7 +19,7 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
* @param array $items - an initial array to fill this object with * @param array $items - an initial array to fill this object with
*/ */
public function __construct(array $items = array()) { public function __construct(array $items = array()) {
$this->items = $items; $this->items = array_values($items);
parent::__construct(); parent::__construct();
} }
@ -137,10 +137,15 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
* @param mixed $item * @param mixed $item
*/ */
public function remove($item) { public function remove($item) {
$renumberKeys = false;
foreach ($this->items as $key => $value) { foreach ($this->items as $key => $value) {
if ($item === $value) unset($this->items[$key]); if ($item === $value) {
$renumberKeys = true;
unset($this->items[$key]);
} }
} }
if($renumberKeys) $this->items = array_values($this->items);
}
/** /**
* Replaces an item in this list with another item. * Replaces an item in this list with another item.
@ -176,16 +181,20 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
*/ */
public function removeDuplicates($field = 'ID') { public function removeDuplicates($field = 'ID') {
$seen = array(); $seen = array();
$renumberKeys = false;
foreach ($this->items as $key => $item) { foreach ($this->items as $key => $item) {
$value = $this->extractValue($item, $field); $value = $this->extractValue($item, $field);
if (array_key_exists($value, $seen)) { if (array_key_exists($value, $seen)) {
$renumberKeys = true;
unset($this->items[$key]); unset($this->items[$key]);
} }
$seen[$value] = true; $seen[$value] = true;
} }
if($renumberKeys) $this->items = array_values($this->items);
} }
/** /**
@ -473,7 +482,6 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
} }
} }
$itemsToKeep = array();
$hitsRequiredToRemove = count($removeUs); $hitsRequiredToRemove = count($removeUs);
$matches = array(); $matches = array();
@ -488,13 +496,17 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
} }
$keysToRemove = array_keys($matches,$hitsRequiredToRemove); $keysToRemove = array_keys($matches,$hitsRequiredToRemove);
// TODO 3.1: This currently mutates existing array
$list = /* clone */ $this;
foreach($keysToRemove as $itemToRemoveIdx){ $itemsToKeep = array();
$list->remove($this->items[$itemToRemoveIdx]); foreach($this->items as $key => $value) {
if(!in_array($key, $keysToRemove)) {
$itemsToKeep[] = $value;
}
} }
// TODO 3.1: This currently mutates existing array
$list = /* clone */ $this;
$list->items = $itemsToKeep;
return $list; return $list;
} }

124
tests/model/ArrayListTest.php
View File

@ -443,15 +443,15 @@ class ArrayListTest extends SapphireTest {
*/ */
public function testSimpleExclude() { public function testSimpleExclude() {
$list = new ArrayList(array( $list = new ArrayList(array(
0=>array('Name' => 'Steve'), array('Name' => 'Steve'),
1=>array('Name' => 'Bob'), array('Name' => 'Bob'),
2=>array('Name' => 'John') array('Name' => 'John')
)); ));
$list->exclude('Name', 'Bob'); $list->exclude('Name', 'Bob');
$expected = array( $expected = array(
0=>array('Name' => 'Steve'), array('Name' => 'Steve'),
2=>array('Name' => 'John') array('Name' => 'John')
); );
$this->assertEquals(2, $list->count()); $this->assertEquals(2, $list->count());
$this->assertEquals($expected, $list->toArray(), 'List should not contain Bob'); $this->assertEquals($expected, $list->toArray(), 'List should not contain Bob');
@ -481,12 +481,12 @@ class ArrayListTest extends SapphireTest {
*/ */
public function testSimpleExcludeWithArray() { public function testSimpleExcludeWithArray() {
$list = new ArrayList(array( $list = new ArrayList(array(
0=>array('Name' => 'Steve'), array('Name' => 'Steve'),
1=>array('Name' => 'Bob'), array('Name' => 'Bob'),
2=>array('Name' => 'John') array('Name' => 'John')
)); ));
$list->exclude('Name', array('Steve','John')); $list->exclude('Name', array('Steve','John'));
$expected = array(1=>array('Name' => 'Bob')); $expected = array(array('Name' => 'Bob'));
$this->assertEquals(1, $list->count()); $this->assertEquals(1, $list->count());
$this->assertEquals($expected, $list->toArray(), 'List should only contain Bob'); $this->assertEquals($expected, $list->toArray(), 'List should only contain Bob');
} }
@ -496,16 +496,16 @@ class ArrayListTest extends SapphireTest {
*/ */
public function testExcludeWithTwoArrays() { public function testExcludeWithTwoArrays() {
$list = new ArrayList(array( $list = new ArrayList(array(
0=>array('Name' => 'Bob' , 'Age' => 21), array('Name' => 'Bob' , 'Age' => 21),
1=>array('Name' => 'Bob' , 'Age' => 32), array('Name' => 'Bob' , 'Age' => 32),
2=>array('Name' => 'John', 'Age' => 21) array('Name' => 'John', 'Age' => 21)
)); ));
$list->exclude(array('Name' => 'Bob', 'Age' => 21)); $list->exclude(array('Name' => 'Bob', 'Age' => 21));
$expected = array( $expected = array(
1=>array('Name' => 'Bob', 'Age' => 32), array('Name' => 'Bob', 'Age' => 32),
2=>array('Name' => 'John', 'Age' => 21) array('Name' => 'John', 'Age' => 21)
); );
$this->assertEquals(2, $list->count()); $this->assertEquals(2, $list->count());
@ -517,23 +517,23 @@ class ArrayListTest extends SapphireTest {
*/ */
public function testMultipleExclude() { public function testMultipleExclude() {
$list = new ArrayList(array( $list = new ArrayList(array(
0 => array('Name' => 'bob', 'Age' => 10), array('Name' => 'bob', 'Age' => 10),
1 => array('Name' => 'phil', 'Age' => 11), array('Name' => 'phil', 'Age' => 11),
2 => array('Name' => 'bob', 'Age' => 12), array('Name' => 'bob', 'Age' => 12),
3 => array('Name' => 'phil', 'Age' => 12), array('Name' => 'phil', 'Age' => 12),
4 => array('Name' => 'bob', 'Age' => 14), array('Name' => 'bob', 'Age' => 14),
5 => array('Name' => 'phil', 'Age' => 14), array('Name' => 'phil', 'Age' => 14),
6 => array('Name' => 'bob', 'Age' => 16), array('Name' => 'bob', 'Age' => 16),
7 => array('Name' => 'phil', 'Age' => 16) array('Name' => 'phil', 'Age' => 16)
)); ));
$list->exclude(array('Name'=>array('bob','phil'),'Age'=>array(10, 16))); $list->exclude(array('Name'=>array('bob','phil'),'Age'=>array(10, 16)));
$expected = array( $expected = array(
1 => array('Name' => 'phil', 'Age' => 11), array('Name' => 'phil', 'Age' => 11),
2 => array('Name' => 'bob', 'Age' => 12), array('Name' => 'bob', 'Age' => 12),
3 => array('Name' => 'phil', 'Age' => 12), array('Name' => 'phil', 'Age' => 12),
4 => array('Name' => 'bob', 'Age' => 14), array('Name' => 'bob', 'Age' => 14),
5 => array('Name' => 'phil', 'Age' => 14), array('Name' => 'phil', 'Age' => 14),
); );
$this->assertEquals($expected, $list->toArray()); $this->assertEquals($expected, $list->toArray());
} }
@ -543,26 +543,26 @@ class ArrayListTest extends SapphireTest {
*/ */
public function testMultipleExcludeNoMatch() { public function testMultipleExcludeNoMatch() {
$list = new ArrayList(array( $list = new ArrayList(array(
0 => array('Name' => 'bob', 'Age' => 10), array('Name' => 'bob', 'Age' => 10),
1 => array('Name' => 'phil', 'Age' => 11), array('Name' => 'phil', 'Age' => 11),
2 => array('Name' => 'bob', 'Age' => 12), array('Name' => 'bob', 'Age' => 12),
3 => array('Name' => 'phil', 'Age' => 12), array('Name' => 'phil', 'Age' => 12),
4 => array('Name' => 'bob', 'Age' => 14), array('Name' => 'bob', 'Age' => 14),
5 => array('Name' => 'phil', 'Age' => 14), array('Name' => 'phil', 'Age' => 14),
6 => array('Name' => 'bob', 'Age' => 16), array('Name' => 'bob', 'Age' => 16),
7 => array('Name' => 'phil', 'Age' => 16) array('Name' => 'phil', 'Age' => 16)
)); ));
$list->exclude(array('Name'=>array('bob','phil'),'Age'=>array(10, 16),'Bananas'=>true)); $list->exclude(array('Name'=>array('bob','phil'),'Age'=>array(10, 16),'Bananas'=>true));
$expected = array( $expected = array(
0 => array('Name' => 'bob', 'Age' => 10), array('Name' => 'bob', 'Age' => 10),
1 => array('Name' => 'phil', 'Age' => 11), array('Name' => 'phil', 'Age' => 11),
2 => array('Name' => 'bob', 'Age' => 12), array('Name' => 'bob', 'Age' => 12),
3 => array('Name' => 'phil', 'Age' => 12), array('Name' => 'phil', 'Age' => 12),
4 => array('Name' => 'bob', 'Age' => 14), array('Name' => 'bob', 'Age' => 14),
5 => array('Name' => 'phil', 'Age' => 14), array('Name' => 'phil', 'Age' => 14),
6 => array('Name' => 'bob', 'Age' => 16), array('Name' => 'bob', 'Age' => 16),
7 => array('Name' => 'phil', 'Age' => 16) array('Name' => 'phil', 'Age' => 16)
); );
$this->assertEquals($expected, $list->toArray()); $this->assertEquals($expected, $list->toArray());
} }
@ -572,29 +572,29 @@ class ArrayListTest extends SapphireTest {
*/ */
public function testMultipleExcludeThreeArguments() { public function testMultipleExcludeThreeArguments() {
$list = new ArrayList(array( $list = new ArrayList(array(
0 => array('Name' => 'bob', 'Age' => 10, 'HasBananas'=>false), array('Name' => 'bob', 'Age' => 10, 'HasBananas'=>false),
1 => array('Name' => 'phil','Age' => 11, 'HasBananas'=>true), array('Name' => 'phil','Age' => 11, 'HasBananas'=>true),
2 => array('Name' => 'bob', 'Age' => 12, 'HasBananas'=>true), array('Name' => 'bob', 'Age' => 12, 'HasBananas'=>true),
3 => array('Name' => 'phil','Age' => 12, 'HasBananas'=>true), array('Name' => 'phil','Age' => 12, 'HasBananas'=>true),
4 => array('Name' => 'bob', 'Age' => 14, 'HasBananas'=>false), array('Name' => 'bob', 'Age' => 14, 'HasBananas'=>false),
4 => array('Name' => 'ann', 'Age' => 14, 'HasBananas'=>true), array('Name' => 'ann', 'Age' => 14, 'HasBananas'=>true),
5 => array('Name' => 'phil','Age' => 14, 'HasBananas'=>false), array('Name' => 'phil','Age' => 14, 'HasBananas'=>false),
6 => array('Name' => 'bob', 'Age' => 16, 'HasBananas'=>false), array('Name' => 'bob', 'Age' => 16, 'HasBananas'=>false),
7 => array('Name' => 'phil','Age' => 16, 'HasBananas'=>true), array('Name' => 'phil','Age' => 16, 'HasBananas'=>true),
8 => array('Name' => 'clair','Age' => 16, 'HasBananas'=>true) array('Name' => 'clair','Age' => 16, 'HasBananas'=>true)
)); ));
$list->exclude(array('Name'=>array('bob','phil'),'Age'=>array(10, 16),'HasBananas'=>true)); $list->exclude(array('Name'=>array('bob','phil'),'Age'=>array(10, 16),'HasBananas'=>true));
$expected = array( $expected = array(
0 => array('Name' => 'bob', 'Age' => 10, 'HasBananas'=>false), array('Name' => 'bob', 'Age' => 10, 'HasBananas'=>false),
1 => array('Name' => 'phil','Age' => 11, 'HasBananas'=>true), array('Name' => 'phil','Age' => 11, 'HasBananas'=>true),
2 => array('Name' => 'bob', 'Age' => 12, 'HasBananas'=>true), array('Name' => 'bob', 'Age' => 12, 'HasBananas'=>true),
3 => array('Name' => 'phil','Age' => 12, 'HasBananas'=>true), array('Name' => 'phil','Age' => 12, 'HasBananas'=>true),
4 => array('Name' => 'bob', 'Age' => 14, 'HasBananas'=>false), array('Name' => 'bob', 'Age' => 14, 'HasBananas'=>false),
4 => array('Name' => 'ann', 'Age' => 14, 'HasBananas'=>true), array('Name' => 'ann', 'Age' => 14, 'HasBananas'=>true),
5 => array('Name' => 'phil','Age' => 14, 'HasBananas'=>false), array('Name' => 'phil','Age' => 14, 'HasBananas'=>false),
6 => array('Name' => 'bob', 'Age' => 16, 'HasBananas'=>false), array('Name' => 'bob', 'Age' => 16, 'HasBananas'=>false),
8 => array('Name' => 'clair','Age' => 16, 'HasBananas'=>true) array('Name' => 'clair','Age' => 16, 'HasBananas'=>true)
); );
$this->assertEquals($expected, $list->toArray()); $this->assertEquals($expected, $list->toArray());
} }