Use options array.

cakephp · Jun 1, 2015 · 4ad001b · 4ad001b
1 parent 670d93b
commit 4ad001b
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 18 deletions.
diff --git a/lib/Cake/Model/Behavior/TreeBehavior.php b/lib/Cake/Model/Behavior/TreeBehavior.php
@@ -450,7 +450,7 @@ public function generateTreeList(Model $Model, $conditions = null, $keyPath = nu
 		$order = $Model->escapeField($left) . ' asc';
 		$results = $Model->find('all', compact('conditions', 'fields', 'order', 'recursive'));
 
-		return $this->formatTreeList($Model, $results, $keyPath, $valuePath);
+		return $this->formatTreeList($Model, $results, compact('keyPath', 'valuePath', 'spacer'));
 	}
 
 /**
@@ -461,30 +461,37 @@ public function generateTreeList(Model $Model, $conditions = null, $keyPath = nu
  *
  * @param Model $Model Model using this behavior
  * @param array $results Result array of a find() call
+ * @param array $options Options
  * @param null $keyPath A string path to the key, i.e. "{n}.Post.id"
  * @param null $valuePath A string path to the value, i.e. "{n}.Post.title"
  * @param string $spacer The character or characters which will be repeated
  * @return array An associative array of records, where the id is the key, and the display field is the value
  */
-	public function formatTreeList(Model $Model, array $results, $keyPath = null, $valuePath = null, $spacer = '_') {
+	public function formatTreeList(Model $Model, array $results, array $options = array()) {
 		if (empty($results)) {
 			return array();
 		}
+		$defaults = array(
+			'keyPath' => null,
+			'valuePath' => null,
+			'spacer' => '_'
+		);
+		$options += $defaults;
 
 		extract($this->settings[$Model->alias]);
 
-		if (!$keyPath) {
-			$keyPath = '{n}.' . $Model->alias . '.' . $Model->primaryKey;
+		if (!$options['keyPath']) {
+			$options['keyPath'] = '{n}.' . $Model->alias . '.' . $Model->primaryKey;
 		}
 
-		if (!$valuePath) {
-			$valuePath = array('%s%s', '{n}.tree_prefix', '{n}.' . $Model->alias . '.' . $Model->displayField);
+		if (!$options['valuePath']) {
+			$options['valuePath'] = array('%s%s', '{n}.tree_prefix', '{n}.' . $Model->alias . '.' . $Model->displayField);
 
-		} elseif (is_string($valuePath)) {
-			$valuePath = array('%s%s', '{n}.tree_prefix', $valuePath);
+		} elseif (is_string($options['valuePath'])) {
+			$options['valuePath'] = array('%s%s', '{n}.tree_prefix', $options['valuePath']);
 
 		} else {
-			array_unshift($valuePath, '%s' . $valuePath[0], '{n}.tree_prefix');
+			array_unshift($options['valuePath'], '%s' . $options['valuePath'][0], '{n}.tree_prefix');
 		}
 
 		$stack = array();
@@ -495,11 +502,11 @@ public function formatTreeList(Model $Model, array $results, $keyPath = null, $v
 				array_pop($stack);
 				$count--;
 			}
-			$results[$i]['tree_prefix'] = str_repeat($spacer, $count);
+			$results[$i]['tree_prefix'] = str_repeat($options['spacer'], $count);
 			$stack[] = $result[$Model->alias][$right];
 		}
 
-		return Hash::combine($results, $keyPath, $valuePath);
+		return Hash::combine($results, $options['keyPath'], $options['valuePath']);
 	}
 
 /**

diff --git a/lib/Cake/Test/Case/Model/Behavior/TreeBehaviorNumberTest.php b/lib/Cake/Test/Case/Model/Behavior/TreeBehaviorNumberTest.php
@@ -1446,14 +1446,14 @@ public function testFormatTreeList() {
 		$options = array('order' => array('lft' => 'asc'));
 		$records = $this->Tree->find('all', $options);
 
-		$result = $this->Tree->formatTreeList(
-			$records,
-			"{n}.$modelClass.id",
-			array('%s - %s', "{n}.$modelClass.id", "{n}.$modelClass.name")
-		);
+		$options = array(
+			'keyPath' => "{n}.$modelClass.id",
+			'valuePath' => array('%s - %s', "{n}.$modelClass.id", "{n}.$modelClass.name"),
+			'spacer' => '--');
+		$result = $this->Tree->formatTreeList($records, $options);
 		$this->assertEquals('1 - 1. Root', $result[1]);
-		$this->assertEquals('_2 - 1.1', $result[2]);
-		$this->assertEquals('__3 - 1.1.1', $result[3]);
+		$this->assertEquals('--2 - 1.1', $result[2]);
+		$this->assertEquals('----3 - 1.1.1', $result[3]);
 	}
 
 /**