ENHANCEMENT Hierarchy->Breadcrumbs()

silverstripe · Mar 2, 2012 · e5c4b0a · e5c4b0a · sminnee · Mar 5, 2012
1 parent fda7a6a
commit e5c4b0a
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/model/Hierarchy.php b/model/Hierarchy.php
@@ -605,6 +605,21 @@ public function getAncestors() {
 
 		return $ancestors;
 	}
+
+	/**
+	 * Returns a human-readable, flattened representation of the path to the object,
+	 * using its {@link Title()} attribute.
+	 * 
+	 * @param String
+	 * @return String
+	 */
+	public function getBreadcrumbs($separator = ' &raquo; ') {
+		$crumbs = array();
+		$ancestors = array_reverse($this->owner->getAncestors()->toArray());
+		foreach($ancestors as $ancestor) $crumbs[] = $ancestor->Title;
+		$crumbs[] = $this->owner->Title;
+		return implode($separator, $crumbs);
+	}
 
 	/**
 	 * Get the next node in the tree of the type. If there is no instance of the className descended from this node,

diff --git a/tests/model/HierarchyTest.php b/tests/model/HierarchyTest.php
@@ -150,6 +150,17 @@ function testLiveChildrenOnlyDeletedFromStage() {
 		$this->assertNotContains("Obj 2b", $children);
 	}
 
+	function testBreadcrumbs() {
+		$obj1 = $this->objFromFixture('HierarchyTest_Object', 'obj1');
+		$obj2 = $this->objFromFixture('HierarchyTest_Object', 'obj2');
+		$obj2a = $this->objFromFixture('HierarchyTest_Object', 'obj2a');
+		$obj2aa = $this->objFromFixture('HierarchyTest_Object', 'obj2aa');
+
+		$this->assertEquals('Obj 1', $obj1->getBreadcrumbs());
+		$this->assertEquals('Obj 2 &raquo; Obj 2a', $obj2a->getBreadcrumbs());
+		$this->assertEquals('Obj 2 &raquo; Obj 2a &raquo; Obj 2aa', $obj2aa->getBreadcrumbs());
+	}
+
 }
 
 class HierarchyTest_Object extends DataObject implements TestOnly {