diff options
| author | Igor Wiedler <igor@wiedler.ch> | 2012-11-19 22:28:12 +0100 |
|---|---|---|
| committer | Igor Wiedler <igor@wiedler.ch> | 2012-11-19 22:28:12 +0100 |
| commit | b453f359ff6dab58b0eaf94548c4e58110fb02ec (patch) | |
| tree | 9202c97ffd6ba11920d848c4ee8cb74f860b826a /phpBB/includes/controller/helper.php | |
| parent | f4fedfe95bdebe276563e9718cf3f3480dc2b8b9 (diff) | |
| parent | 305f41cf1a540984fd7a71b61a601b1794e3bd04 (diff) | |
| download | forums-b453f359ff6dab58b0eaf94548c4e58110fb02ec.tar forums-b453f359ff6dab58b0eaf94548c4e58110fb02ec.tar.gz forums-b453f359ff6dab58b0eaf94548c4e58110fb02ec.tar.bz2 forums-b453f359ff6dab58b0eaf94548c4e58110fb02ec.tar.xz forums-b453f359ff6dab58b0eaf94548c4e58110fb02ec.zip | |
Merge remote-tracking branch 'imkingdavid/feature/controller-new' into develop
* imkingdavid/feature/controller-new: (67 commits)
[feature/controller] Fix misnamed route for functional test
[feature/controller] Fix comments, check against more general HttpException
[feature/controller] Check for proper status codes from controllers
[feature/controller] Correctly create Symfony object from globals
[feature/controller] Add documentation about input being HTML-escaped
[feature/controller] Create Symfony Request in new function
[feature/controller] Remove unused language strings
[feature/controller] Don't use $user->lang() before container compilation
[feature/controller] Update routing documentation for using query string
[feature/controller] Remove now-unused code
[feature/controller] Remove url rewriting until we use pathinfo in controllers
[feature/controller] Fix functional tests to use query string for controllers
[feature/controller] Allow injecting Symfony Request into controllers
[feature/controller] Use query string, not path info, for controller access
[feature/controller] Fix line endings and permissions, and check responses
[feature/controller] Remove URL rewriting by default
[feature/controller] Add controller functional test with template
[feature/controller] Use warning instead of echo for copy() and unlink()
[feature/controller] Flip method parameters, require $message
[feature/controller] Rename $root_path class property to $phpbb_root_path
...
Diffstat (limited to 'phpBB/includes/controller/helper.php')
| -rw-r--r-- | phpBB/includes/controller/helper.php | 117 |
1 files changed, 117 insertions, 0 deletions
diff --git a/phpBB/includes/controller/helper.php b/phpBB/includes/controller/helper.php new file mode 100644 index 0000000000..6cacc8fefa --- /dev/null +++ b/phpBB/includes/controller/helper.php @@ -0,0 +1,117 @@ +<?php +/** +* +* @package controller +* @copyright (c) 2012 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +use Symfony\Component\HttpFoundation\Response; + +/** +* Controller helper class, contains methods that do things for controllers +* @package phpBB3 +*/ +class phpbb_controller_helper +{ + /** + * Template object + * @var phpbb_template + */ + protected $template; + + /** + * User object + * @var phpbb_user + */ + protected $user; + + /** + * phpBB root path + * @var string + */ + protected $phpbb_root_path; + + /** + * PHP extension + * @var string + */ + protected $php_ext; + + /** + * Constructor + * + * @param phpbb_template $template Template object + * @param phpbb_user $user User object + * @param string $phpbb_root_path phpBB root path + * @param string $php_ext PHP extension + */ + public function __construct(phpbb_template $template, phpbb_user $user, $phpbb_root_path, $php_ext) + { + $this->template = $template; + $this->user = $user; + $this->phpbb_root_path = $phpbb_root_path; + $this->php_ext = $php_ext; + } + + /** + * Automate setting up the page and creating the response object. + * + * @param string $handle The template handle to render + * @param string $page_title The title of the page to output + * @param int $status_code The status code to be sent to the page header + * @return Response object containing rendered page + */ + public function render($template_file, $page_title = '', $status_code = 200) + { + page_header($page_title); + + $this->template->set_filenames(array( + 'body' => $template_file, + )); + + page_footer(true, false, false); + + return new Response($this->template->assign_display('body'), $status_code); + } + + /** + * Easily generate a URL + * + * @param array $url_parts Each array element is a 'folder' + * i.e. array('my', 'ext') maps to ./app.php/my/ext + * @param mixed $query The Query string, passed directly into the second + * argument of append_sid() + * @return string A URL that has already been run through append_sid() + */ + public function url(array $url_parts, $query = '') + { + return append_sid($this->phpbb_root_path . implode('/', $url_parts), $query); + } + + /** + * Output an error, effectively the same thing as trigger_error + * + * @param string $message The error message + * @param string $code The error code (e.g. 404, 500, 503, etc.) + * @return Response A Reponse instance + */ + public function error($message, $code = 500) + { + $this->template->assign_vars(array( + 'MESSAGE_TEXT' => $message, + 'MESSAGE_TITLE' => $this->user->lang('INFORMATION'), + )); + + return $this->render('message_body.html', $this->user->lang('INFORMATION'), $code); + } +} |