diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2012-12-20 22:51:38 +0100 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2012-12-20 22:51:38 +0100 |
| commit | e34b8ed094affdaedbf457406c98b29c125e5d8b (patch) | |
| tree | 7cc51ba4ead71cb48a76747770edf622f8fe85f9 /phpBB/includes/controller/helper.php | |
| parent | 70a409d4b5411bf9e50a70d1cf3855b686304bbe (diff) | |
| parent | d11829567603e6ac37170b919efc4659b2be20cb (diff) | |
| download | forums-e34b8ed094affdaedbf457406c98b29c125e5d8b.tar forums-e34b8ed094affdaedbf457406c98b29c125e5d8b.tar.gz forums-e34b8ed094affdaedbf457406c98b29c125e5d8b.tar.bz2 forums-e34b8ed094affdaedbf457406c98b29c125e5d8b.tar.xz forums-e34b8ed094affdaedbf457406c98b29c125e5d8b.zip | |
Merge branch 'develop' of https://github.com/phpbb/phpbb3 into feature/softdelete-1-permission-rebase
* 'develop' of https://github.com/phpbb/phpbb3: (544 commits)
[feature/events] Fix improperly named event in documentation
[feature/events] Fix alphabetization of events
[feature/events] Put events in alphabetical order
[feature/events] Make EVENTS.md lowercase
[ticket/11285] Use more granularity in dependency checks in compress test
[ticket/10880] The m_approve permisson no longer implies f_noapprove.
[ticket/10803] Show failure message until user dismisses it
[ticket/10954] Add missing semi-colon
[ticket/10954] Make sure to mark subforums unread and add small fixes
[feature/events] Use ` to escape HTML tags in markdown
[feature/events] Remove HTML tags from markdown so they don't get parsed
[ticket/10954] Miscellaneous coding fixes
[feature/events] Remove extraneous space
[feature/events] Add markdown template event documentation file
[feature/events] forumlist_body_last_post_title_after -> _prepend (subsilver2)
[feature/events] Fix overall_footer_end -> overall_footer_after (subsilver2)
[feature/events] Fix typo in event name
[ticket/10763] Use self when calling get_extension() in filespec class
[feature/events] Fix more subsilver2 events
[feature/events] Fix some subsilver2 events
...
Conflicts:
phpBB/install/database_update.php
phpBB/posting.php
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); + } +} |