nextcloud/lib/public/appframework/http/templateresponse.php

144 lines
3.1 KiB
PHP
Raw Normal View History

2013-08-17 13:16:48 +04:00
<?php
/**
* ownCloud - App Framework
*
* @author Bernhard Posselt
* @copyright 2012 Bernhard Posselt nukeawhale@gmail.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* Public interface of ownCloud for apps to use.
* AppFramework\HTTP\TemplateResponse class
*/
2013-08-17 13:16:48 +04:00
2013-08-21 03:00:26 +04:00
namespace OCP\AppFramework\Http;
2013-08-17 13:16:48 +04:00
/**
* Response for a normal template
*/
class TemplateResponse extends Response {
/**
* name of the template
* @var string
*/
2013-08-17 13:16:48 +04:00
protected $templateName;
/**
* parameters
* @var array
*/
2013-08-17 13:16:48 +04:00
protected $params;
/**
* rendering type (admin, user, blank)
* @var string
*/
2013-08-17 13:16:48 +04:00
protected $renderAs;
/**
* app name
* @var string
*/
2013-08-17 13:16:48 +04:00
protected $appName;
/**
* constructor of TemplateResponse
* @param string $appName the name of the app to load the template from
* @param string $templateName the name of the template
2013-08-17 13:16:48 +04:00
*/
public function __construct($appName, $templateName) {
2013-08-17 13:16:48 +04:00
$this->templateName = $templateName;
$this->appName = $appName;
$this->params = array();
$this->renderAs = 'user';
}
/**
* Sets template parameters
* @param array $params an array with key => value structure which sets template
* variables
2014-03-10 12:31:30 +04:00
* @return TemplateResponse Reference to this object
2013-08-17 13:16:48 +04:00
*/
public function setParams(array $params){
$this->params = $params;
2014-03-10 02:01:16 +04:00
return $this;
2013-08-17 13:16:48 +04:00
}
/**
* Used for accessing the set parameters
* @return array the params
*/
public function getParams(){
return $this->params;
}
/**
* Used for accessing the name of the set template
* @return string the name of the used template
*/
public function getTemplateName(){
return $this->templateName;
}
/**
* Sets the template page
* @param string $renderAs admin, user or blank. Admin also prints the admin
* settings header and footer, user renders the normal
* normal page including footer and header and blank
* just renders the plain template
2014-03-10 12:31:30 +04:00
* @return TemplateResponse Reference to this object
2013-08-17 13:16:48 +04:00
*/
public function renderAs($renderAs){
$this->renderAs = $renderAs;
2014-03-10 02:01:16 +04:00
return $this;
2013-08-17 13:16:48 +04:00
}
/**
* Returns the set renderAs
* @return string the renderAs value
*/
public function getRenderAs(){
return $this->renderAs;
}
/**
* Returns the rendered html
* @return string the rendered html
*/
public function render(){
$template = new \OCP\Template($this->appName, $this->templateName, $this->renderAs);
2013-08-17 13:16:48 +04:00
foreach($this->params as $key => $value){
$template->assign($key, $value);
}
return $template->fetchPage();
}
}