3899099496b3023e10aed1fd7bbdd31eb0d309d2
[Packages/TYPO3.CMS.git] / typo3 / sysext / install / Classes / ViewHelpers / Be / ContainerViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Install\ViewHelpers\Be;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * View helper which allows you to create extbase based modules in the
19 * style of TYPO3 default modules.
20 * Note: This feature is experimental!
21 *
22 * = Examples =
23 *
24 * <code title="Simple">
25 * <f:be.container>your module content</f:be.container>
26 * </code>
27 * <output>
28 * "your module content" wrapped with proper head & body tags.
29 * Default backend CSS styles and JavaScript will be included
30 * </output>
31 *
32 * <code title="All options">
33 * <f:be.container pageTitle="foo">your module content</f:be.container>
34 * </code>
35 * <output>
36 * "your module content" wrapped with proper head & body tags.
37 * Custom CSS file EXT:your_extension/Resources/Public/styles/backend.css and JavaScript file EXT:your_extension/Resources/Public/scripts/main.js will be loaded
38 * </output>
39 *
40 * @internal
41 */
42 class ContainerViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper
43 {
44 /**
45 * @var bool
46 */
47 protected $escapeOutput = false;
48
49 /**
50 * @var bool
51 */
52 protected $escapeChildren = false;
53
54 /**
55 * Render start page with \TYPO3\CMS\Backend\Template\DocumentTemplate and pageTitle
56 *
57 * @param string $pageTitle title tag of the module. Not required by default, as BE modules are shown in a frame
58 * @param array $addCssFiles Custom CSS files to be loaded
59 * @param array $addJsFiles Custom JavaScript files to be loaded
60 *
61 * @return string
62 * @see \TYPO3\CMS\Backend\Template\DocumentTemplate
63 * @see \TYPO3\CMS\Core\Page\PageRenderer
64 */
65 public function render($pageTitle = '', $addCssFiles = array(), $addJsFiles = array())
66 {
67 $doc = $this->getDocInstance();
68 $pageRenderer = $this->getPageRenderer();
69
70 if (is_array($addCssFiles) && !empty($addCssFiles)) {
71 foreach ($addCssFiles as $addCssFile) {
72 $pageRenderer->addCssFile($addCssFile);
73 }
74 }
75 if (is_array($addJsFiles) && !empty($addJsFiles)) {
76 foreach ($addJsFiles as $addJsFile) {
77 $pageRenderer->addJsFile($addJsFile);
78 }
79 }
80 $output = $this->renderChildren();
81 $output = $doc->startPage($pageTitle) . $output;
82 $output .= $doc->endPage();
83 return $output;
84 }
85 }