Merge pull request #136 from cakephp/cyclic-objects

Don't loop infinitely with cyclic references.

Author: markstory

Test/Case/View/Helper/HtmlToolbarHelperTest.php

@@ -126,6 +126,37 @@ public function testMakeNeatArrayBasic() {
 		$this->assertTags($result, $expected);
 	}
 
+/**
+ * Test that cyclic references can be printed.
+ *
+ * @return void
+ */
+	public function testMakeNeatArrayCyclicObjects() {
+		$a = new StdClass;
+		$b = new StdClass;
+		$a->child = $b;
+		$b->parent = $a;
+
+		$in = array('obj' => $a);
+		$result = $this->Toolbar->makeNeatArray($in);
+		$expected = array(
+			array('ul' => array('class' => 'neat-array depth-0')),
+			'<li', '<strong', 'obj', '/strong', '(object)',
+			array('ul' => array('class' => 'neat-array depth-1')),
+			'<li', '<strong', 'child', '/strong', '(object)',
+			array('ul' => array('class' => 'neat-array depth-2')),
+			'<li', '<strong', 'parent', '/strong',
+			'(object) - recursion',
+			'/li',
+			'/ul',
+			'/li',
+			'/ul',
+			'/li',
+			'/ul'
+		);
+		$this->assertTags($result, $expected);
+	}
+
 /**
  * Test Neat Array formatting
  *

View/Helper/HtmlToolbarHelper.php

@@ -50,6 +50,10 @@ class HtmlToolbarHelper extends ToolbarHelper {
  * @return string
  */
 	public function makeNeatArray($values, $openDepth = 0, $currentDepth = 0, $doubleEncode = false) {
+		static $printedObjects = null;
+		if ($currentDepth === 0) {
+			$printedObjects = new SplObjectStorage();
+		}
 		$className = "neat-array depth-$currentDepth";
 		if ($openDepth > $currentDepth) {
 			$className .= ' expanded';
@@ -90,7 +94,24 @@ public function makeNeatArray($values, $openDepth = 0, $currentDepth = 0, $doubl
 				$value = 'function';
 			}
 
-			if (($value instanceof ArrayAccess || $value instanceof Iterator || is_array($value) || is_object($value)) && !empty($value)) {
+			$isObject = is_object($value);
+			if ($isObject && $printedObjects->contains($value)) {
+				$isObject = false;
+				$value = ' - recursion';
+			}
+
+			if ($isObject) {
+				$printedObjects->attach($value);
+			}
+
+			if (
+				(
+				$value instanceof ArrayAccess ||
+				$value instanceof Iterator ||
+				is_array($value) ||
+				$isObject
+				) && !empty($value)
+			) {
 				$out .= $this->makeNeatArray($value, $openDepth, $nextDepth, $doubleEncode);
 			} else {
 				$out .= h($value, $doubleEncode);