Introduce LayoutFactory to better instantiate customized layouts

Author: technicalguru

src/WebApp/Application.php

@@ -14,6 +14,7 @@ class Application {
 	public    $vault;
 	public    $database;
 	public    $dataModel;
+	public    $layoutFactory;
 	public    $serviceFactory;
 	public    $authentication;
 	public    $authorization;
@@ -28,6 +29,7 @@ public function __construct($config) {
 		$this->request   = $this->initRequest();
 		$this->principal = NULL;
 		I18N::addI18nFile(__DIR__.'/../i18n.php');
+		$this->layoutFactory = $this->createLayoutFactory();
 	}
 
 	protected function initRequest() {
@@ -206,6 +208,14 @@ protected function initMailQueue() {
 		}
 	}
 
+	protected function createLayoutFactory() {
+		return new LayoutFactory($this);
+	}
+
+	public function getLayoutFactory() {
+		return $this->layoutFactory;
+	}
+
 	public function getTheme() {
 		return $this->config->get('theme');
 	}

src/WebApp/LayoutFactory.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace WebApp;
+
+class LayoutFactory {
+
+	protected $app;
+	protected $layouts;
+
+	public function __construct($app) {
+		$this->app     = $app;
+		$this->layouts = array();
+	}
+
+	public function getLayout($theme, $page) {
+		$name = $page->getLayoutName();
+		if ($name == NULL) {
+			$name = $theme->getLayoutName();
+		}
+		if ($name == NULL) {
+			$name = 'default';
+		}
+
+		if (!isset($this->layouts[$name])) {
+			$this->layouts[$name] = $this->createLayout($name, $theme, $page);
+		}
+		return $this->layouts[$name];
+	}
+
+	/** Descendants shall override this method and fallback on parent implementation */
+	protected function createLayout($name, $theme, $page) {
+		$class     = new \ReflectionClass($theme);
+		$className = strpos($name, '\\') === FALSE ? $class->getNamespaceName().'\\'.ucfirst($name).'Layout' : $name;
+		if (class_exists($className)) {
+			$className = '\\'.$className;
+			return new $className($theme, $page);
+		}
+		$className = $class->getNamespaceName().'\\DefaultLayout';
+		if (class_exists($className)) {
+			$className = '\\'.$className;
+			return new $className($theme, $page);
+		}
+		return NULL;
+	}
+}
+

src/WebApp/Theme.php

@@ -35,16 +35,8 @@ public function __construct($app, $useCache = TRUE) {
 	public function render($page) {
 		$this->page = $page;
 
-		// Get the layout of the page
-		$layoutName = $page->getLayoutName();
-
-		// Fallback to default theme layout
-		if ($layoutName == NULL) {
-			$layoutName = $this->getLayoutName();
-		}
-
-		// get the layout
-		$layout = $this->getLayout($layoutName);
+		// Ask the layout factory
+		$layout = $this->app->getLayoutFactory()->getLayout($this, $page);
 
 		// Fallback to this object
 		if ($layout == NULL) {
@@ -64,29 +56,10 @@ public function render($page) {
      * depending on the current page object.
 	 * @return name of layout (this method returns 'default')
 	 */
-	protected function getLayoutName() {
+	public function getLayoutName() {
 		return 'default';
 	}
 
-	/** 
-     * Return a layout object for the given name. 
-     * @return the layout object (can be NULL)
-     */
-	protected function getLayout($name) {
-		if ($name == NULL) $name = 'default';
-		$className = strpos($name, '\\') === FALSE ? $this->class->getNamespaceName().'\\'.ucfirst($name).'Layout' : $name;
-		if (class_exists($className)) {
-			$className = '\\'.$className;
-			return new $className($this, $this->page);
-		}
-		$className = $this->class->getNamespaceName().'\\DefaultLayout';
-		if (class_exists($className)) {
-			$className = '\\'.$className;
-			return new $className($this, $this->page);
-		}
-		return NULL;
-	}
-
 	/**
      * A very basic rendering page.
      * @param object $page - the page to be rendered.