ENHANCEMENT SiteTree->getStatusFlags() which makes SiteTree->getTreeT…

…itle() extensible
silverstripe · Apr 4, 2012 · c1b248e · c1b248e
1 parent de573e0
commit c1b248e
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 19 deletions.
diff --git a/code/model/SiteTree.php b/code/model/SiteTree.php
@@ -2438,6 +2438,36 @@ function setMenuTitle($value) {
 		}
 	}
 
+	/**
+	 * A flag provides the user with additional data about the current page status,
+	 * for example a "removed from draft" status. Each page can have more than one status flag.
+	 * Returns a map of a unique key to a (localized) title for the flag.
+	 * The unique key can be reused as a CSS class.
+	 * Use the 'updateStatusFlags' extension point to customize the flags.
+	 * Example: "deletedonlive" => "Deleted"
+	 * 
+	 * @return array
+	 */
+	function getStatusFlags() {
+		$flags = array();
+		if($this->IsDeletedFromStage) {
+			if($this->ExistsOnLive) {
+				$flags['removedfromdraft'] = _t('SiteTree.REMOVEDFROMDRAFTSHORT', 'Removed from draft');
+			} else {
+				$flags['deletedonlive'] = _t('SiteTree.DELETEDPAGESHORT', 'Deleted');
+			}
+		} else if($this->IsAddedToStage) {
+			$flags['addedtodraft'] = _t('SiteTree.ADDEDTODRAFTSHORT', 'New');
+		} else if($this->IsModifiedOnStage) {
+			$flags['modified'] = _t('SiteTree.MODIFIEDONDRAFTSHORT', 'Modified');
+		}
+
+		$this->extend('updateStatusFlags', $flags);
+
+		return $flags;
+	}
+
+
 	/**
 	 * @deprecated 3.0 Use getTreeTitle()
 	 */
@@ -2447,29 +2477,27 @@ function TreeTitle() {
 	}
 
 	/**
-	 * TitleWithStatus will return the title in an <ins>, <del> or
-	 * <span class=\"modified\"> tag depending on its publication status.
+	 * getTreeTitle will return three <span> html DOM elements, an empty <span> with
+	 * the class 'jstree-pageicon' in front, following by a <span> wrapping around its
+	 * MenutTitle, then following by a <span> indicating its publication status. 
 	 *
-	 * @return string
+	 * @return string a html string ready to be directly used in a template
 	 */
 	function getTreeTitle() {
-		$text = Convert::raw2xml(str_replace(array("\n","\r"),"",$this->MenuTitle));
-		if($this->IsDeletedFromStage) {
-			if($this->ExistsOnLive) {
-				$tag ="<span class=\"del item\" title=\"" . _t('SiteTree.REMOVEDFROMDRAFTSHORT', 'Removed from draft') . "\" >{$text}</span> <span class=\"badge removedfromdraft\">" .  _t('SiteTree.REMOVEDFROMDRAFTSHORT', 'Removed from draft') . "</span>";
-			} else {
-				$tag ="<span class=\"del item\" title=\"" . _t('SiteTree.DELETEDPAGESHORT', 'Deleted') . "\">{$text}</span> <span class=\"badge deletedonlive\">". _t('SiteTree.DELETEDPAGESHORT', 'Deleted') . "</span>";
-			}
-		} elseif($this->IsAddedToStage) {
-			$tag = "<span class=\"ins item\" title=\"" . _t('SiteTree.ADDEDTODRAFTSHORT', 'New') . "\">{$text}</span> <span class=\"badge addedtodraft\">". _t('SiteTree.ADDEDTODRAFTSHORT', 'New') . "</span>";
-		} elseif($this->IsModifiedOnStage) {
-			$tag = "<span title=\"" . _t('SiteTree.MODIFIEDONDRAFTSHORT', 'Modified') . "\" class=\"ins item\">{$text}</span> <span class=\"badge modified\">" . _t('SiteTree.MODIFIEDONDRAFTSHORT', 'Modified') . "</span>";
-		} else {
-			$tag = '';
+		$flags = $this->getStatusFlags();
+		$treeTitle = sprintf(
+			"<span class=\"jstree-pageicon\"></span><span class=\"item\">%s</span>",
+			Convert::raw2xml(str_replace(array("\n","\r"),"",$this->MenuTitle))
+		);
+		foreach($flags as $class => $title) {
+			$treeTitle .= sprintf(
+				"<span class=\"badge %s\">%s</span>",
+				Convert::raw2xml($class),
+				Convert::raw2xml($title)
+			);
 		}
-
-
-		return ($tag) ? "<span class=\"jstree-pageicon\"></span>". $tag : "<span class=\"jstree-pageicon\"></span>". $text;
+
+		return $treeTitle;
 	}
 
 	/**

diff --git a/tests/model/SiteTreeTest.php b/tests/model/SiteTreeTest.php
@@ -17,6 +17,7 @@ class SiteTreeTest extends SapphireTest {
 		'SiteTreeTest_ClassD',
 		'SiteTreeTest_ClassCext',
 		'SiteTreeTest_NotRoot',
+		'SiteTreeTest_StageStatusInherit',
 	);
 
 	/**
@@ -866,7 +867,15 @@ function testCanBeRoot() {
 		} 
 
 		if(!$isDetected) $this->fail('Fails validation with $can_be_root=false');
+	}	
+
+	function testModifyStatusFlagByInheritance(){
+		$node = new SiteTreeTest_StageStatusInherit();
+		$treeTitle = $node->getTreeTitle();
+		$this->assertContains('InheritedTitle', $treeTitle);
+		$this->assertContains('inherited-class', $treeTitle);
 	}
+
 }
 
 /**#@+
@@ -928,4 +937,12 @@ class SiteTreeTest_ClassCext extends SiteTreeTest_ClassC implements TestOnly {
 
 class SiteTreeTest_NotRoot extends Page implements TestOnly {
 	static $can_be_root = false;
+}
+
+class SiteTreeTest_StageStatusInherit extends SiteTree implements TestOnly {
+	function getStatusFlags(){
+		$flags = parent::getStatusFlags();
+		$flags['inherited-class'] = "InheritedTitle";
+		return $flags;
+	}
 }