Blame view

sources/lib/private/template/base.php 3.22 KB
31b7f2792   Kload   Upgrade to ownclo...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  <?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
  	private $theme; // theme defaults
6d9380f96   Cédric Dupont   Update sources OC...
16
17
18
19
20
  	/**
  	 * @param string $template
  	 * @param \OC_L10N $l10n
  	 * @param \OC_Defaults $theme
  	 */
31b7f2792   Kload   Upgrade to ownclo...
21
22
23
24
25
26
27
  	public function __construct( $template, $requesttoken, $l10n, $theme ) {
  		$this->vars = array();
  		$this->vars['requesttoken'] = $requesttoken;
  		$this->l10n = $l10n;
  		$this->template = $template;
  		$this->theme = $theme;
  	}
6d9380f96   Cédric Dupont   Update sources OC...
28
29
30
31
32
33
  	/**
  	 * @param string $serverroot
  	 * @param string|false $app_dir
  	 * @param string $theme
  	 * @param string $app
  	 */
31b7f2792   Kload   Upgrade to ownclo...
34
35
36
37
38
39
40
41
42
43
44
45
46
  	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/',
  		);
  	}
6d9380f96   Cédric Dupont   Update sources OC...
47
48
49
50
  	/**
  	 * @param string $serverroot
  	 * @param string $theme
  	 */
31b7f2792   Kload   Upgrade to ownclo...
51
52
53
54
55
56
57
58
  	protected function getCoreTemplateDirs($theme, $serverroot) {
  		return array(
  			$serverroot.'/themes/'.$theme.'/core/templates/',
  			$serverroot.'/core/templates/',
  		);
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
59
  	 * Assign variables
31b7f2792   Kload   Upgrade to ownclo...
60
  	 * @param string $key key
6d9380f96   Cédric Dupont   Update sources OC...
61
  	 * @param array|bool|integer|string $value value
31b7f2792   Kload   Upgrade to ownclo...
62
63
64
65
66
67
68
69
70
71
72
73
74
  	 * @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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
75
  	 * Appends a variable
31b7f2792   Kload   Upgrade to ownclo...
76
  	 * @param string $key key
6d9380f96   Cédric Dupont   Update sources OC...
77
78
  	 * @param mixed $value value
  	 * @return boolean|null
31b7f2792   Kload   Upgrade to ownclo...
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
  	 *
  	 * 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 );
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
94
  	 * Prints the proceeded template
31b7f2792   Kload   Upgrade to ownclo...
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
  	 * @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;
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
111
112
  	 * Process the template
  	 * @return string
31b7f2792   Kload   Upgrade to ownclo...
113
114
115
116
117
118
119
120
  	 *
  	 * This function processes the template.
  	 */
  	public function fetchPage() {
  		return $this->load($this->template);
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
121
122
  	 * doing the actual work
  	 * @param string $file
31b7f2792   Kload   Upgrade to ownclo...
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
  	 * @return string content
  	 *
  	 * Includes the template file, fetches its output
  	 */
  	protected function load( $file, $additionalparams = null ) {
  		// Register the variables
  		$_ = $this->vars;
  		$l = $this->l10n;
  		$theme = $this->theme;
  
  		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;
  	}
  
  }