Page 1 of 1

comment in PHP should be marked properly

Posted: Mon Dec 22, 2003 4:59 pm
by Flink

Code: Select all

<?php
/***************************************************************
*  Copyright notice
*  
*  (c) 1999-2003 Kasper Skårhøj (kasper@typo3.com)
*  All rights reserved
*
*  This script is part of the Typo3 project. The Typo3 project is 
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
* 
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license 
*  from the author is found in LICENSE.txt distributed with these scripts.
*
* 
*  This script 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 General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/** 
 * TBE init
 *
 * This script is called by every backend script. The script autheticates the backend user.
 * In addition this script also initializes the database and other stuff by including the script localconf.php
 * 
 * IMPORTANT:
 * This script exits if no user is logged in. 
 * If you want the script to return, you must define the constant TYPO3_PROCEED_IF_NO_USER=1 before you include this script.
 *
 * 
 * This script does the following:
 * - extracts and defines path's
 * - includes certain libraries
 * - authenticates the user
 * - sets the configuration values (localconf.php)
 * - includes tables.php that sets more values and possibly overrides others
 * - load the groupdata for the user and set filemounts / webmounts
 *
 * @author	Kasper Skårhøj <kasper@typo3.com>
 */
/***************************************************************
Global Variables in Typo3 after this script:
	$BE_USER	:			(object) The user object
	$WEBMOUNTS	:			Array of uid's to be mounted in the page-tree
	$FILEMOUNTS	: 			Array of filepaths on the server to be mountet in the directory tree
	$FILEICONS	:			Assoc. array; keys are the type (eg. "tif") and values are the filename (without path)
	$PARSETIME_START
	$CLIENT

Constants:
	PATH_typo3	:	Absolute path to the typo3 folder
	PATH_typo3_mod	:	Relative path (from the PATH_typo3) to a properly configured module
	PATH_site	:	Absolute path to the site (the folder right before the typo3/ folder)
	PATH_temp	:	Path to temporary folder used for gifs and stuff in the interface
	PATH_t3lib	:	Path to the t3lib
	PATH_typo3conf	:	Path to the typo3conf/ folder
	
See "Inside Typo" for more details on the TBE (Typo3 BackEnd)
*/