Move basic template functions to their own class

2 files changed, 174 insertions, 0 deletions

diff --git a/lib/template/base.php b/lib/template/base.php
new file mode 100644
index 00000000000..c7ddaa2e8e1
--- /dev/null
+++ b/lib/template/base.php
@@ -0,0 +1,131 @@
+<?php
+/**
+ * Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OC\Template;
+
+class Base {
+	private $template; // The template
+	private $vars; // Vars
+	private $l10n; // The l10n-Object
+
+	public function __construct( $template, $requesttoken, $l10n ) {
+		$this->vars = array();
+		$this->vars['requesttoken'] = $requesttoken;
+		$this->l10n = $l10n;
+		$this->template = $template;
+	}
+
+	protected function getAppTemplateDirs($theme, $app, $serverroot, $app_dir) {
+		// Check if the app is in the app folder or in the root
+		if( file_exists($app_dir.'/templates/' )) {
+			return array(
+				$serverroot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
+				$app_dir.'/templates/',
+			);
+		}
+		return array(
+			$serverroot.'/themes/'.$theme.'/'.$app.'/templates/',
+			$serverroot.'/'.$app.'/templates/',
+		);
+	}
+
+	protected function getCoreTemplateDirs($theme, $serverroot) {
+		return array(
+			$serverroot.'/themes/'.$theme.'/core/templates/',
+			$serverroot.'/core/templates/',
+		);
+	}
+
+	/**
+	 * @brief Assign variables
+	 * @param string $key key
+	 * @param string $value value
+	 * @return bool
+	 *
+	 * This function assigns a variable. It can be accessed via $_[$key] in
+	 * the template.
+	 *
+	 * If the key existed before, it will be overwritten
+	 */
+	public function assign( $key, $value) {
+		$this->vars[$key] = $value;
+		return true;
+	}
+
+	/**
+	 * @brief Appends a variable
+	 * @param string $key key
+	 * @param string $value value
+	 * @return bool
+	 *
+	 * This function assigns a variable in an array context. If the key already
+	 * exists, the value will be appended. It can be accessed via
+	 * $_[$key][$position] in the template.
+	 */
+	public function append( $key, $value ) {
+		if( array_key_exists( $key, $this->vars )) {
+			$this->vars[$key][] = $value;
+		}
+		else{
+			$this->vars[$key] = array( $value );
+		}
+	}
+
+	/**
+	 * @brief Prints the proceeded template
+	 * @return bool
+	 *
+	 * This function proceeds the template and prints its output.
+	 */
+	public function printPage() {
+		$data = $this->fetchPage();
+		if( $data === false ) {
+			return false;
+		}
+		else{
+			print $data;
+			return true;
+		}
+	}
+
+	/**
+	 * @brief Process the template
+	 * @return bool
+	 *
+	 * This function processes the template.
+	 */
+	public function fetchPage() {
+		return $this->load($this->template);
+	}
+
+	/**
+	 * @brief doing the actual work
+	 * @return string content
+	 *
+	 * Includes the template file, fetches its output
+	 */
+	protected function load( $file, $additionalparams = null ) {
+		// Register the variables
+		$_ = $this->vars;
+		$l = $this->l10n;
+
+		if( !is_null($additionalparams)) {
+			$_ = array_merge( $additionalparams, $this->vars );
+		}
+
+		// Include
+		ob_start();
+		include $file;
+		$data = ob_get_contents();
+		@ob_end_clean();
+
+		// Return data
+		return $data;
+	}
+
+}
diff --git a/lib/template/templatefilelocator.php b/lib/template/templatefilelocator.php
new file mode 100644
index 00000000000..eeb27c139a7
--- /dev/null
+++ b/lib/template/templatefilelocator.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OC\Template;
+
+class TemplateFileLocator {
+	protected $form_factor;
+	protected $dirs;
+
+	public function __construct( $form_factor, $dirs ) {
+		$this->form_factor = $form_factor;
+		$this->dirs = $dirs;
+	}
+
+	public function find( $template ) {
+		if ($template == '') {
+			throw new \InvalidArgumentException('Empty template name');
+		}
+
+		foreach($this->dirs as $dir) {
+			$file = $dir.$template.$this->form_factor.'.php';
+			if (is_file($file)) {
+				$this->path = $dir;
+				return $file;
+			}
+			$file = $dir.$template.'.php';
+			if (is_file($file)) {
+				$this->path = $dir;
+				return $file;
+			}
+		}
+		throw new \Exception('template file not found: template:'.$template.' formfactor:'.$this->form_factor);
+	}
+
+	public function getPath() {
+		return $this->path;
+	}
+}