Merge pull request FluidTYPO3#641 from Cash2m/add-preserve-keys

[TASK] Add argument to preserve array keys on ChunkViewHelper
netresearch · Jul 23, 2014 · 689d3c2 · 689d3c2
2 parents f769135 + 922e859
commit 689d3c2
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/Classes/ViewHelpers/Iterator/ChunkViewHelper.php b/Classes/ViewHelpers/Iterator/ChunkViewHelper.php
@@ -43,10 +43,11 @@ class ChunkViewHelper extends AbstractViewHelper {
 	 * @param boolean $fixed Whether to allocate items to a fixed number of chunks or not
 	 * @param mixed $subject The subject Traversable/Array instance to shift
 	 * @param string $as If specified, inserts a template variable with this name, then renders the child content, then removes the variable
+	 * @param boolean $preserveKeys If set to true, the original array keys will be preserved in the chunks
 	 * @throws \Exception
 	 * @return array
 	 */
-	public function render($count, $fixed = FALSE, $subject = NULL, $as = NULL) {
+	public function render($count, $fixed = FALSE, $subject = NULL, $as = NULL, $preserveKeys = FALSE) {
 		if (NULL === $subject) {
 			$subject = $this->renderChildren();
 		}
@@ -63,15 +64,15 @@ public function render($count, $fixed = FALSE, $subject = NULL, $as = NULL) {
 			$subjectSize = count($subject);
 			if (0 < $subjectSize) {
 				$chunkSize = ceil($subjectSize / $count);
-				$output = array_chunk($subject, $chunkSize);
+				$output = array_chunk($subject, $chunkSize, $preserveKeys);
 			}
 			// Fill the resulting array with empty items to get the desired element count
 			$elementCount = count($output);
 			if ($elementCount < $count) {
 				$output += array_fill($elementCount, $count - $elementCount, NULL);
 			}
 		} else {
-			$output = array_chunk($subject, $count);
+			$output = array_chunk($subject, $count, $preserveKeys);
 		}
 		if (NULL !== $as) {
 			$variables = array($as => $output);

diff --git a/Tests/Unit/ViewHelpers/Iterator/ChunkViewHelperTest.php b/Tests/Unit/ViewHelpers/Iterator/ChunkViewHelperTest.php
@@ -95,4 +95,19 @@ public function returnsEmptyResultForZeroCount() {
 		$this->assertCount(0, $result);
 	}
 
+	/**
+	 * @test
+	 */
+	public function preservesArrayKeysIfRequested() {
+		$arguments = array(
+			'count' => 2,
+			'subject' => array('a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5),
+			'preserveKeys' => TRUE,
+		);
+		$result = $this->executeViewHelper($arguments);
+
+		$expected = array(array('a' => 1, 'b' => 2), array('c' => 3, 'd' => 4), array('e' => 5));
+		$this->assertEquals($expected, $result);
+	}
+
 }