[TASK] Clean up phpDoc comments in typo3/
[Packages/TYPO3.CMS.git] / typo3 / login_frameset.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * Login frameset
30 *
31 * This script generates a login-frameset used when the user must relogin.
32 * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
33 * XHTML-frames compatible.
34 *
35 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
36 * @package TYPO3
37 * @subpackage core
38 */
39 define('TYPO3_PROCEED_IF_NO_USER', 1);
40 require('init.php');
41 require('template.php');
42
43 /**
44 * Script Class, putting the frameset together.
45 *
46 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
47 * @package TYPO3
48 * @subpackage core
49 */
50 class SC_login_frameset {
51
52 // Internal, dynamic
53 var $content;
54
55 /**
56 * Main function.
57 * Creates the header code in XHTML, then the frameset for the two frames.
58 *
59 * @return void
60 */
61 function main() {
62 // Set doktype:
63 $GLOBALS['TBE_TEMPLATE']->docType = 'xhtml_frames';
64
65 $title = 'TYPO3 Re-Login ('.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].')';
66 $this->content .= $GLOBALS['TBE_TEMPLATE']->startPage($title);
67
68 // Create the frameset for the window:
69 $this->content .= '
70 <frameset rows="*,1">
71 <frame name="login" src="index.php?loginRefresh=1" marginwidth="0" marginheight="0" scrolling="no" noresize="noresize" />
72 <frame name="dummy" src="dummy.php" marginwidth="0" marginheight="0" scrolling="auto" noresize="noresize" />
73 </frameset>
74 ';
75
76 $this->content .= '
77 </html>';
78 }
79
80 /**
81 * Outputs the page content.
82 *
83 * @return void
84 */
85 function printContent() {
86 echo $this->content;
87 }
88 }
89
90 // Make instance:
91 $SOBE = t3lib_div::makeInstance('SC_login_frameset');
92 $SOBE->main();
93 $SOBE->printContent();
94
95 ?>