From 850989e1584809eae919201cb59c8c611d883225 Mon Sep 17 00:00:00 2001
From: Sam Minnee <sam@silverstripe.com>
Date: Thu, 4 Dec 2008 03:49:40 +0000
Subject: [PATCH] Added diagrams to dev/viewmodel

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/branches/2.3@67427 467b73ca-7a2a-4603-9d3b-597d59a354a9
---
 dev/ModelViewer.php             | 70 +++++++++++++++++++++++++--------
 templates/ModelViewer.ss        |  2 +
 templates/ModelViewer_dotsrc.ss | 12 ++++++
 3 files changed, 68 insertions(+), 16 deletions(-)
 create mode 100644 templates/ModelViewer_dotsrc.ss

diff --git a/dev/ModelViewer.php b/dev/ModelViewer.php
index 83a48d4e1..b0e222916 100644
--- a/dev/ModelViewer.php
+++ b/dev/ModelViewer.php
@@ -5,6 +5,16 @@
  * Access at dev/viewmodel
  */
 class ModelViewer extends Controller {
+	static $url_handlers = array(
+		'$Module!' => 'handleModule',
+	);
+
+	protected $module = null;
+	
+	function handleModule($request) {
+		return new ModelViewer_Module($request->param('Module'));
+	}
+	
 	function init() {
 		parent::init();
 		if(!Permission::check("ADMIN")) Security::permissionFailure();
@@ -37,15 +47,16 @@ class ModelViewer extends Controller {
 			$modules[$model->Module]->push($model);
 		}
 		ksort($modules);
+		unset($modules['userforms']);
 		
-		if(isset($this->urlParams['Action']) && isset($modules[$this->urlParams['Action']])) {
-			$module = $this->urlParams['Action'];
-			$modules = array($module => $modules[$module]);
+		if($this->module) {
+			$modules = array($this->module => $modules[$this->module]);
 		}
 
 		$output = new DataObjectSet();
 		foreach($modules as $moduleName => $models) {
 			$output->push(new ArrayData(array(
+				'Link' => 'dev/viewcode/' . $moduleName,
 				'Name' => $moduleName,
 				'Models' => $models,
 			)));
@@ -53,7 +64,28 @@ class ModelViewer extends Controller {
 		
 		return $output;
 	}
+}
 
+class ModelViewer_Module extends ModelViewer {
+	static $url_handlers = array(
+		'graph' => 'graph',
+	);
+
+	/**
+	 * ModelViewer can be optionally constructed to restrict its output to a specific module
+	 */
+	function __construct($module = null) {
+		$this->module = $module;
+	}
+	
+	function graph() {
+		SSViewer::set_source_file_comments(false);
+		$dotContent = $this->renderWith("ModelViewer_dotsrc");
+		$CLI_dotContent = escapeshellarg($dotContent);
+		
+		header("Content-type: image/png");
+		echo `neato -Tpng:gd &> /dev/stdout`;
+	}
 }
 
 /**
@@ -87,13 +119,17 @@ class ModelViewer_Model extends ViewableData {
 	}
 	
 	function Fields() {
-		$db = singleton($this->className)->db();
 		$output = new DataObjectSet();
-		$output->push(new ModelViewer_Field('ID', 'PrimaryKey'));
-		$output->push(new ModelViewer_Field('Created', 'Datetime'));
-		$output->push(new ModelViewer_Field('LastEdited', 'Datetime'));
-		foreach($db as $k => $v) {
-			$output->push(new ModelViewer_Field($k, $v));
+		
+		$output->push(new ModelViewer_Field($this,'ID', 'PrimaryKey'));
+		if(!$this->ParentModel) {
+			$output->push(new ModelViewer_Field($this,'Created', 'Datetime'));
+			$output->push(new ModelViewer_Field($this,'LastEdited', 'Datetime'));
+		}
+
+		$db = singleton($this->className)->uninherited('db',true);
+		if($db) foreach($db as $k => $v) {
+			$output->push(new ModelViewer_Field($this, $k, $v));
 		}
 		return $output;		
 	}
@@ -102,9 +138,9 @@ class ModelViewer_Model extends ViewableData {
 		$output = new DataObjectSet();
 		
 		foreach(array('has_one','has_many','many_many') as $relType) {
-			$items = singleton($this->className)->$relType();
-			foreach($items as $k => $v) {
-				$output->push(new ModelViewer_Relation($k, $v, $relType));
+			$items = singleton($this->className)->uninherited($relType,true);
+			if($items) foreach($items as $k => $v) {
+				$output->push(new ModelViewer_Relation($this, $k, $v, $relType));
 			}
 		}
 		return $output;
@@ -112,18 +148,20 @@ class ModelViewer_Model extends ViewableData {
 }
 
 class ModelViewer_Field extends ViewableData {
-	public $Name, $Type;
+	public $Model, $Name, $Type;
 	
-	function __construct($name, $type) {
+	function __construct($model, $name, $type) {
+		$this->Model = $model;
 		$this->Name = $name;
 		$this->Type = $type;
 	}
 }
 
 class ModelViewer_Relation extends ViewableData {
-	public $Name, $RelationType, $RelatedClass;
+	public $Model, $Name, $RelationType, $RelatedClass;
 	
-	function __construct($name, $relatedClass, $relationType) {
+	function __construct($model, $name, $relatedClass, $relationType) {
+		$this->Model = $model;
 		$this->Name = $name;
 		$this->RelatedClass = $relatedClass;
 		$this->RelationType = $relationType;
diff --git a/templates/ModelViewer.ss b/templates/ModelViewer.ss
index 652e69cc4..cf6eb4eb0 100644
--- a/templates/ModelViewer.ss
+++ b/templates/ModelViewer.ss
@@ -8,6 +8,8 @@
 
 		<% control Modules %>
 		<h1>Module $Name</h1>
+		
+		<img src="$Link/graph" />
         
         <% control Models %>
         <h2>$Name <% if ParentModel %> (subclass of $ParentModel)<% end_if %></h2>
diff --git a/templates/ModelViewer_dotsrc.ss b/templates/ModelViewer_dotsrc.ss
new file mode 100644
index 000000000..f8e1f3d66
--- /dev/null
+++ b/templates/ModelViewer_dotsrc.ss
@@ -0,0 +1,12 @@
+digraph g {
+    edge[len=3]; 
+
+    <% control Modules %>
+    <% control Models %>
+        $Name [shape=record,label="{$Name|Field1\\nField2}"];
+        <% control Relations %>
+            $Model.Name -> $RelatedClass [label="$Name\\n$RelationType"];
+        <% end_control %>
+    <% end_control %>
+    <% end_control %>
+}
\ No newline at end of file