From efa837c8af9ee07ebd3d6fff1baae8cd516f1fd5 Mon Sep 17 00:00:00 2001
From: Wouter Wolters <typo3@wouterwolters.nl>
Date: Tue, 12 Jun 2012 20:09:40 +0200
Subject: [PATCH] [TASK] Clean up phpDoc comments in typo3/
Clean up phpDoc comments for the following classes:
* typo3/index.php
* typo3/index_re.php
* typo3/init.php
* typo3/listframe_loader.php
* typo3/login_frameset.php
* typo3/logout.php
* typo3/mod.php
* typo3/move_el.php
Clean up provides:
* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)
Change-Id: I330e941921ba7b718d084d0e21463ebc31f296b5
Resolves: #37971
Releases: 6.0
Reviewed-on: http://review.typo3.org/12000
Reviewed-by: Oliver Klee
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
---
typo3/index.php | 158 ++++++++++++++++++-------------------
typo3/index_re.php | 4 +-
typo3/init.php | 25 ++----
typo3/listframe_loader.php | 30 +++----
typo3/login_frameset.php | 30 +++----
typo3/logout.php | 15 ++--
typo3/mod.php | 7 +-
typo3/move_el.php | 148 +++++++++++++---------------------
8 files changed, 175 insertions(+), 242 deletions(-)
diff --git a/typo3/index.php b/typo3/index.php
index eb058789147f..1be16853429c 100644
--- a/typo3/index.php
+++ b/typo3/index.php
@@ -24,73 +24,69 @@
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
+
/**
* Login-screen of TYPO3.
*
* Revised for TYPO3 3.6 December/2003 by Kasper Skårhøj
* XHTML compliant
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
*/
-
define('TYPO3_PROCEED_IF_NO_USER', 1);
require('init.php');
require('template.php');
-
-
-
-
-
-
-
-
-
-
-
-
-
-
/**
* Script Class for rendering the login form
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
class SC_index {
// Internal, GPvars:
- var $redirect_url; // GPvar: redirect_url; The URL to redirect to after login.
- var $GPinterface; // GPvar: Defines which interface to load (from interface selector)
- var $u; // GPvar: preset username
- var $p; // GPvar: preset password
- var $L; // GPvar: If "L" is "OUT", then any logged in used is logged out. If redirect_url is given, we redirect to it
- var $loginRefresh; // Login-refresh boolean; The backend will call this script with this value set when the login is close to being expired and the form needs to be redrawn.
- var $commandLI; // Value of forms submit button for login.
+ // GPvar: redirect_url; The URL to redirect to after login.
+ var $redirect_url;
+ // GPvar: Defines which interface to load (from interface selector)
+ var $GPinterface;
+ // GPvar: preset username
+ var $u;
+ // GPvar: preset password
+ var $p;
+ // GPvar: If "L" is "OUT", then any logged in used is logged out. If redirect_url is given, we redirect to it
+ var $L;
+ // Login-refresh boolean; The backend will call this script with this value set when the login is close to being expired and the form needs to be redrawn.
+ var $loginRefresh;
+ // Value of forms submit button for login.
+ var $commandLI;
// Internal, static:
- var $redirectToURL; // Set to the redirect URL of the form (may be redirect_url or "backend.php")
+ // Set to the redirect URL of the form (may be redirect_url or "backend.php")
+ var $redirectToURL;
// Internal, dynamic:
- var $content; // Content accumulation
-
- var $interfaceSelector; // A selector box for selecting value for "interface" may be rendered into this variable
- var $interfaceSelector_jump; // A selector box for selecting value for "interface" may be rendered into this variable - this will have an onchange action which will redirect the user to the selected interface right away
- var $interfaceSelector_hidden; // A hidden field, if the interface is not set.
- var $addFields_hidden = ''; // Additional hidden fields to be placed at the login form
-
- // sets the level of security. *'normal' = clear-text. 'challenged' = hashed password/username from form in $formfield_uident. 'superchallenged' = hashed password hashed again with username.
+ // Content accumulation
+ var $content;
+ // A selector box for selecting value for "interface" may be rendered into this variable
+ var $interfaceSelector;
+ // A selector box for selecting value for "interface" may be rendered into this variable
+ // this will have an onchange action which will redirect the user to the selected interface right away
+ var $interfaceSelector_jump;
+ // A hidden field, if the interface is not set.
+ var $interfaceSelector_hidden;
+ // Additional hidden fields to be placed at the login form
+ var $addFields_hidden = '';
+
+ // sets the level of security. *'normal' = clear-text. 'challenged' = hashed
+ // password/username from form in $formfield_uident. 'superchallenged' = hashed password hashed again with username.
var $loginSecurityLevel = 'superchallenged';
-
-
-
-
/**
* Initialize the login box. Will also react on a &L=OUT flag and exit.
*
- * @return void
+ * @return void
*/
function init() {
// We need a PHP session session for most login levels
@@ -114,14 +110,14 @@ class SC_index {
// Value of "Login" button. If set, the login button was pressed.
$this->commandLI = t3lib_div::_GP('commandLI');
- // sets the level of security from conf vars
+ // Sets the level of security from conf vars
if ($GLOBALS['TYPO3_CONF_VARS']['BE']['loginSecurityLevel']) {
$this->loginSecurityLevel = $GLOBALS['TYPO3_CONF_VARS']['BE']['loginSecurityLevel'];
}
- // try to get the preferred browser language
+ // Try to get the preferred browser language
$preferredBrowserLanguage = $GLOBALS['LANG']->csConvObj->getPreferredClientLanguage(t3lib_div::getIndpEnv('HTTP_ACCEPT_LANGUAGE'));
- // if we found a $preferredBrowserLanguage and it is not the default language and no be_user is logged in
+ // If we found a $preferredBrowserLanguage and it is not the default language and no be_user is logged in
// initialize $GLOBALS['LANG'] again with $preferredBrowserLanguage
if ($preferredBrowserLanguage != 'default' && !$GLOBALS['BE_USER']->user['uid']) {
$GLOBALS['LANG']->init($preferredBrowserLanguage);
@@ -142,11 +138,10 @@ class SC_index {
}
}
-
/**
* Main function - creating the login/logout form
*
- * @return void
+ * @return void
*/
function main() {
// Initialize template object:
@@ -183,15 +178,15 @@ class SC_index {
$this->content .= $GLOBALS['TBE_TEMPLATE']->startPage('TYPO3 Login: ' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'], FALSE);
// Add login form:
- $this->content.=$this->wrapLoginForm($loginForm);
+ $this->content .= $this->wrapLoginForm($loginForm);
- $this->content.= $GLOBALS['TBE_TEMPLATE']->endPage();
+ $this->content .= $GLOBALS['TBE_TEMPLATE']->endPage();
}
/**
* Outputting the accumulated content to screen
*
- * @return void
+ * @return void
*/
function printContent() {
echo $this->content;
@@ -207,7 +202,7 @@ class SC_index {
* Creates the login form
* This is drawn when NO login exists.
*
- * @return string HTML output
+ * @return string HTML output
*/
function makeLoginForm() {
$content = t3lib_parsehtml::getSubpart($GLOBALS['TBE_TEMPLATE']->moduleTemplate, '###LOGIN_FORM###');
@@ -217,7 +212,7 @@ class SC_index {
'VALUE_SUBMIT' => $GLOBALS['LANG']->getLL('labels.submitLogin', TRUE),
);
- // show an error message if the login command was successful already, otherwise remove the subpart
+ // Show an error message if the login command was successful already, otherwise remove the subpart
if (!$this->isLoginInProgress()) {
$content = t3lib_parsehtml::substituteSubpart($content, '###LOGIN_ERROR###', '');
} else {
@@ -226,8 +221,7 @@ class SC_index {
$markers['ERROR_LOGIN_DESCRIPTION'] = $GLOBALS['LANG']->getLL('error.login.description', TRUE);
}
-
- // remove the interface selector markers if it's not available
+ // Remove the interface selector markers if it's not available
if (!($this->interfaceSelector && !$this->loginRefresh)) {
$content = t3lib_parsehtml::substituteSubpart($content, '###INTERFACE_SELECTOR###', '');
} else {
@@ -238,12 +232,11 @@ class SC_index {
return t3lib_parsehtml::substituteMarkerArray($content, $markers, '###|###');
}
-
/**
* Creates the logout form
* This is drawn if a user login already exists.
*
- * @return string HTML output
+ * @return string HTML output
*/
function makeLogoutForm() {
$content = t3lib_parsehtml::getSubpart($GLOBALS['TBE_TEMPLATE']->moduleTemplate, '###LOGOUT_FORM###');
@@ -253,7 +246,7 @@ class SC_index {
'VALUE_SUBMIT' => $GLOBALS['LANG']->getLL('labels.submitLogout', TRUE),
);
- // remove the interface selector markers if it's not available
+ // Remove the interface selector markers if it's not available
if (!$this->interfaceSelector_jump) {
$content = t3lib_parsehtml::substituteSubpart($content, '###INTERFACE_SELECTOR###', '');
} else {
@@ -264,12 +257,11 @@ class SC_index {
return t3lib_parsehtml::substituteMarkerArray($content, $markers, '###|###');
}
-
/**
* Wrapping the login form table in another set of tables etc:
*
- * @param string HTML content for the login form
- * @return string The HTML for the page.
+ * @param string HTML content for the login form
+ * @return string The HTML for the page.
*/
function wrapLoginForm($content) {
$mainContent = t3lib_parsehtml::getSubpart($GLOBALS['TBE_TEMPLATE']->moduleTemplate, '###PAGE###');
@@ -298,7 +290,7 @@ class SC_index {
'CSS_ERRORCLASS' => ($this->isLoginInProgress() ? ' class="error"' : ''),
'CSS_OPENIDCLASS' => 't3-login-openid-' . (t3lib_extMgm::isLoaded('openid') ? 'enabled' : 'disabled'),
- // the labels will be replaced later on, thus the other parts above
+ // The labels will be replaced later on, thus the other parts above
// can use these markers as well and it will be replaced
'HEADLINE' => $GLOBALS['LANG']->getLL('headline', TRUE),
'INFO_ABOUT' => $GLOBALS['LANG']->getLL('info.about', TRUE),
@@ -321,17 +313,16 @@ class SC_index {
'LOGIN_PROCESS' => $GLOBALS['LANG']->getLL('login_process', TRUE),
'SITELINK' => '<a href="/">###SITENAME###</a>',
- // global variables will now be replaced (at last)
+ // Global variables will now be replaced (at last)
'SITENAME' => htmlspecialchars($GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'])
);
return t3lib_parsehtml::substituteMarkerArray($mainContent, $markers, '###|###');
}
-
/**
* Checking, if we should perform some sort of redirection OR closing of windows.
*
- * @return void
+ * @return void
*/
function checkRedirect() {
// Do redirect:
@@ -340,7 +331,7 @@ class SC_index {
// If no cookie has been set previously we tell people that this is a problem. This assumes that a cookie-setting script (like this one) has been hit at least once prior to this instance.
if (!$_COOKIE[t3lib_beUserAuth::getCookieName()]) {
- if ($this->commandLI=='setCookie') {
+ if ($this->commandLI == 'setCookie') {
// we tried it a second time but still no cookie
// 26/4 2005: This does not work anymore, because the saving of challenge values in $_SESSION means the system will act as if the password was wrong.
throw new RuntimeException('Login-error: Yeah, that\'s a classic. No cookies, no TYPO3.<br /><br />Please accept cookies from TYPO3 - otherwise you\'ll not be able to use the system.', 1294586846);
@@ -390,14 +381,15 @@ class SC_index {
');
}
} elseif (!$GLOBALS['BE_USER']->user['uid'] && $this->isLoginInProgress()) {
- sleep(5); // Wrong password, wait for 5 seconds
+ // Wrong password, wait for 5 seconds
+ sleep(5);
}
}
/**
* Making interface selector:
*
- * @return void
+ * @return void
*/
function makeInterfaceSelectorBox() {
// Reset variables:
@@ -408,22 +400,23 @@ class SC_index {
// If interfaces are defined AND no input redirect URL in GET vars:
if ($GLOBALS['TYPO3_CONF_VARS']['BE']['interfaces'] && ($this->isLoginInProgress() || !$this->redirect_url)) {
$parts = t3lib_div::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['BE']['interfaces']);
- if (count($parts)>1) { // Only if more than one interface is defined will we show the selector:
+ // Only if more than one interface is defined will we show the selector:
+ if (count($parts) > 1) {
// Initialize:
- $labels=array();
+ $labels = array();
$labels['backend'] = $GLOBALS['LANG']->getLL('interface.backend');
$labels['backend_old'] = $GLOBALS['LANG']->getLL('interface.backend_old');
$labels['frontend'] = $GLOBALS['LANG']->getLL('interface.frontend');
- $jumpScript=array();
+ $jumpScript = array();
$jumpScript['backend'] = 'backend.php';
$jumpScript['backend_old'] = 'backend.php';
$jumpScript['frontend'] = '../';
// Traverse the interface keys:
- foreach($parts as $valueStr) {
+ foreach ($parts as $valueStr) {
$this->interfaceSelector.='
<option value="'.htmlspecialchars($valueStr).'"'.(t3lib_div::_GP('interface')==htmlspecialchars($valueStr) ? ' selected="selected"' : '').'>'.htmlspecialchars($labels[$valueStr]).'</option>';
$this->interfaceSelector_jump.='
@@ -451,7 +444,7 @@ class SC_index {
* According to the GPL license an interactive application must show such a notice on start-up ('If the program is interactive, make it output a short notice... ' - see GPL.txt)
* Therefore preventing this notice from being properly shown is a violation of the license, regardless of whether you remove it or use a stylesheet to obstruct the display.
*
- * @return string Text/Image (HTML) for copyright notice.
+ * @return string Text/Image (HTML) for copyright notice.
*/
function makeCopyrightNotice() {
@@ -485,11 +478,12 @@ class SC_index {
/**
* Returns the login box image, whether the default or an image from the rotation folder.
*
- * @return string HTML image tag.
+ * @return string HTML image tag.
*/
function makeLoginBoxImage() {
$loginboxImage = '';
- if ($GLOBALS['TBE_STYLES']['loginBoxImage_rotationFolder']) { // Look for rotation image folder:
+ // Look for rotation image folder:
+ if ($GLOBALS['TBE_STYLES']['loginBoxImage_rotationFolder']) {
$absPath = t3lib_div::resolveBackPath(PATH_typo3.$GLOBALS['TBE_STYLES']['loginBoxImage_rotationFolder']);
// Get rotation folder:
@@ -513,8 +507,8 @@ class SC_index {
}
}
} else { // If no rotation folder configured, print default image:
-
- if (strstr(TYPO3_version, '-dev')) { // development version
+ // Development version
+ if (strstr(TYPO3_version, '-dev')) {
$loginImage = 'loginbox_image_dev.png';
$imagecopy = 'You are running a development version of TYPO3 '.TYPO3_branch;
} else {
@@ -543,7 +537,7 @@ class SC_index {
// Traverse news array IF there are records in it:
if (is_array($systemNews) && count($systemNews) && !t3lib_div::_GP('loginRefresh')) {
$htmlParser = t3lib_div::makeInstance('t3lib_parsehtml_proc');
- // get the main news template, and replace the subpart after looped through
+ // Get the main news template, and replace the subpart after looped through
$newsContent = t3lib_parsehtml::getSubpart($GLOBALS['TBE_TEMPLATE']->moduleTemplate, '###LOGIN_NEWS###');
$newsItemTemplate = t3lib_parsehtml::getSubpart($newsContent, '###NEWS_ITEM###');
@@ -582,7 +576,7 @@ class SC_index {
* Gets news from sys_news and converts them into a format suitable for
* showing them at the login screen.
*
- * @return array An array of login news.
+ * @return array An array of login news.
*/
protected function getSystemNews() {
$systemNewsTable = 'sys_news';
@@ -615,19 +609,19 @@ class SC_index {
/**
* Returns the form tag
*
- * @return string Opening form tag string
+ * @return string Opening form tag string
*/
function startForm() {
$output = '';
- // The form defaults to 'no login'. This prevents plain
- // text logins to the Backend. The 'sv' extension changes the form to
- // use superchallenged method and rsaauth extension makes rsa authetication.
+ // The form defaults to 'no login'. This prevents plain
+ // text logins to the Backend. The 'sv' extension changes the form to
+ // use superchallenged method and rsaauth extension makes rsa authetication.
$form = '<form action="index.php" method="post" name="loginform" ' .
'onsubmit="alert(\'No authentication methods available. Please, ' .
'contact your TYPO3 administrator.\');return false">';
- // Call hooks. If they do not return anything, we fail to login
+ // Call hooks. If they do not return anything, we fail to login
if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/index.php']['loginFormHook'])) {
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/index.php']['loginFormHook'] as $function) {
$params = array();
@@ -652,7 +646,7 @@ class SC_index {
/**
* Creates JavaScript for the login form
*
- * @return string JavaScript code
+ * @return string JavaScript code
*/
function getJScode() {
$JSCode = '';
@@ -741,7 +735,7 @@ class SC_index {
/**
* Checks if login credentials are currently submitted
*
- * @return boolean
+ * @return boolean
*/
protected function isLoginInProgress() {
$username = t3lib_div::_GP('username');
@@ -749,7 +743,7 @@ class SC_index {
}
}
-// Make instance:
+ // Make instance:
$SOBE = t3lib_div::makeInstance('SC_index');
$SOBE->init();
$SOBE->main();
diff --git a/typo3/index_re.php b/typo3/index_re.php
index 4e410104559f..927936606d9f 100644
--- a/typo3/index_re.php
+++ b/typo3/index_re.php
@@ -33,12 +33,12 @@
* RewriteRule ^typo3$ typo3/index_re.php
* ... and this document will redirect to the right script.
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
define('TYPO3_PROCEED_IF_NO_USER', 1);
-require ('init.php');
+require('init.php');
t3lib_utility_Http::redirect(t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR') . 'index.php');
?>
\ No newline at end of file
diff --git a/typo3/init.php b/typo3/init.php
index 3748172306e3..e3732c10936a 100644
--- a/typo3/init.php
+++ b/typo3/init.php
@@ -24,6 +24,7 @@
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
+
/**
* TYPO3 Backend initialization
*
@@ -54,19 +55,15 @@
* @subpackage core
*/
-// *******************************
-// Prevent any unwanted output that may corrupt AJAX/compression. Note: this does
-// not interfeer with "die()" or "echo"+"exit()" messages!
-// *******************************
+ // Prevent any unwanted output that may corrupt AJAX/compression. Note: this does
+ // not interfeer with "die()" or "echo"+"exit()" messages!
ob_start();
-// *******************************
-// Define constants
-// *******************************
+ // Define constants
define('TYPO3_MODE', 'BE');
- // We use require instead of require_once here so we get a fatal error if Bootstrap.php is accidentally included twice
- // (which would indicate a clear bug).
+ // We use require instead of require_once here so we get a fatal error if
+ // Bootstrap.php is accidentally included twice (which would indicate a clear bug).
require('Bootstrap.php');
Typo3_Bootstrap::checkEnvironmentOrDie();
Typo3_Bootstrap::defineBaseConstants();
@@ -74,7 +71,6 @@ Typo3_Bootstrap::defineAndCheckPaths('typo3/');
Typo3_Bootstrap::requireBaseClasses();
Typo3_Bootstrap::setUpEnvironment();
-
require(PATH_t3lib . 'config_default.php');
Typo3_Bootstrap::initializeTypo3DbGlobal(FALSE);
@@ -82,9 +78,7 @@ Typo3_Bootstrap::checkLockedBackendAndRedirectOrDie();
Typo3_Bootstrap::checkBackendIpOrDie();
Typo3_Bootstrap::checkSslBackendAndRedirectIfNeeded();
-// *************************
-// Connect to the database
-// *************************
+ // Connect to the database
// Redirect to install tool if database host and database are not defined
if (!TYPO3_db_host && !TYPO3_db) {
t3lib_utility_Http::redirect('install/index.php?mode=123&step=1&password=joh316');
@@ -92,10 +86,7 @@ if (!TYPO3_db_host && !TYPO3_db) {
$TYPO3_DB->connectDB();
}
-
-// *******************************
-// Checks for proper browser
-// *******************************
+ // Checks for proper browser
if (!$CLIENT['BROWSER']) {
throw new RuntimeException('Browser Error: Your browser version looks incompatible with this TYPO3 version!', 1294587023);
}
diff --git a/typo3/listframe_loader.php b/typo3/listframe_loader.php
index 57287674bb6f..29976366370e 100644
--- a/typo3/listframe_loader.php
+++ b/typo3/listframe_loader.php
@@ -24,31 +24,23 @@
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
+
/**
* Redirects to real module if shortcut pressed
*
* Revised for TYPO3 3.6 2/2003 by Kasper Skårhøj
* XHTML-trans compliant
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
*/
-require ('init.php');
-require ('template.php');
-
-
-
-
-
-
-
-
-
+require('init.php');
+require('template.php');
/**
* Script Class for redirecting shortcut actions to the correct script
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
@@ -57,24 +49,24 @@ class SC_listframe_loader {
/**
* Main content generated
*
- * @return void
+ * @return void
*/
function main() {
- $GLOBALS['TBE_TEMPLATE']->divClass='';
- $this->content.=$GLOBALS['TBE_TEMPLATE']->startPage('List Frame Loader');
- $this->content.=$GLOBALS['TBE_TEMPLATE']->wrapScriptTags('
+ $GLOBALS['TBE_TEMPLATE']->divClass = '';
+ $this->content .= $GLOBALS['TBE_TEMPLATE']->startPage('List Frame Loader');
+ $this->content .= $GLOBALS['TBE_TEMPLATE']->wrapScriptTags('
var theUrl = top.getModuleUrl("");
if (theUrl) window.location.href=theUrl;
');
// End page:
- $this->content.=$GLOBALS['TBE_TEMPLATE']->endPage();
+ $this->content .= $GLOBALS['TBE_TEMPLATE']->endPage();
// Output:
echo $this->content;
}
}
-// Make instance:
+ // Make instance:
$SOBE = t3lib_div::makeInstance('SC_listframe_loader');
$SOBE->main();
diff --git a/typo3/login_frameset.php b/typo3/login_frameset.php
index 18a4074c78d9..78ce0b3dcab6 100644
--- a/typo3/login_frameset.php
+++ b/typo3/login_frameset.php
@@ -24,6 +24,7 @@
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
+
/**
* Login frameset
*
@@ -31,25 +32,18 @@
* Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
* XHTML-frames compatible.
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
define('TYPO3_PROCEED_IF_NO_USER', 1);
-require ('init.php');
-require ('template.php');
-
-
-
-
-
-
-
+require('init.php');
+require('template.php');
/**
* Script Class, putting the frameset together.
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
@@ -62,38 +56,38 @@ class SC_login_frameset {
* Main function.
* Creates the header code in XHTML, then the frameset for the two frames.
*
- * @return void
+ * @return void
*/
function main() {
// Set doktype:
- $GLOBALS['TBE_TEMPLATE']->docType='xhtml_frames';
+ $GLOBALS['TBE_TEMPLATE']->docType = 'xhtml_frames';
$title = 'TYPO3 Re-Login ('.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].')';
- $this->content.=$GLOBALS['TBE_TEMPLATE']->startPage($title);
+ $this->content .= $GLOBALS['TBE_TEMPLATE']->startPage($title);
// Create the frameset for the window:
- $this->content.='
+ $this->content .= '
<frameset rows="*,1">
<frame name="login" src="index.php?loginRefresh=1" marginwidth="0" marginheight="0" scrolling="no" noresize="noresize" />
<frame name="dummy" src="dummy.php" marginwidth="0" marginheight="0" scrolling="auto" noresize="noresize" />
</frameset>
';
- $this->content.='
+ $this->content .= '
</html>';
}
/**
* Outputs the page content.
*
- * @return void
+ * @return void
*/
function printContent() {
echo $this->content;
}
}
-// Make instance:
+ // Make instance:
$SOBE = t3lib_div::makeInstance('SC_login_frameset');
$SOBE->main();
$SOBE->printContent();
diff --git a/typo3/logout.php b/typo3/logout.php
index a77bc721652f..836282afff2c 100644
--- a/typo3/logout.php
+++ b/typo3/logout.php
@@ -24,24 +24,21 @@
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
+
/**
* Logout script for the backend
* This script saves the interface positions and calls the closeTypo3Windows in the frameset
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
*/
-require ('init.php');
-
-
-
-
+require('init.php');
/**
* Script Class for logging a user out.
* Does not display any content, just calls the logout-function for the current user and then makes a redirect.
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
@@ -50,7 +47,7 @@ class SC_logout {
/**
* Performs the logout processing
*
- * @return void
+ * @return void
*/
function logout() {
// Logout written to log
@@ -63,7 +60,7 @@ class SC_logout {
}
}
-// Make instance:
+ // Make instance:
$SOBE = t3lib_div::makeInstance('SC_logout');
$SOBE->logout();
diff --git a/typo3/mod.php b/typo3/mod.php
index 994630080d06..6a79825d62bc 100644
--- a/typo3/mod.php
+++ b/typo3/mod.php
@@ -24,17 +24,18 @@
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
+
/**
* Module Dispatch script
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
*/
unset($MCONF);
require('init.php');
require('template.php');
-// Find module path:
+ // Find module path:
$temp_M = (string)t3lib_div::_GET('M');
$isDispatched = FALSE;
@@ -63,4 +64,4 @@ if ($isDispatched === FALSE) {
Typo3_Bootstrap::shutdown();
-?>
+?>
\ No newline at end of file
diff --git a/typo3/move_el.php b/typo3/move_el.php
index 8c4511612633..08e7b78fd652 100644
--- a/typo3/move_el.php
+++ b/typo3/move_el.php
@@ -31,30 +31,20 @@
* Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
* XHTML compatible.
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
*/
-
-$BACK_PATH='';
+$BACK_PATH = '';
require('init.php');
require('template.php');
// Include local language labels:
$LANG->includeLLFile('EXT:lang/locallang_misc.xml');
-
-
-
-
-
-
-
-
-
/**
* Local extension of the page tree class
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
@@ -63,29 +53,19 @@ class localPageTree extends t3lib_pageTree {
/**
* Inserting uid-information in title-text for an icon
*
- * @param string Icon image
- * @param array Item row
- * @return string Wrapping icon image.
+ * @param string $icon Icon image
+ * @param array $row Item row
+ * @return string Wrapping icon image.
*/
function wrapIcon($icon, $row) {
return $this->addTagAttributes($icon, ' title="id='.htmlspecialchars($row['uid']).'"');
}
}
-
-
-
-
-
-
-
-
-
-
/**
* Extension of position map for pages
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
@@ -95,9 +75,9 @@ class ext_posMap_pages extends t3lib_positionMap {
/**
* Creates the onclick event for the insert-icons.
*
- * @param integer The pid.
- * @param integer New page id.
- * @return string Onclick attribute content
+ * @param integer $pid The pid.
+ * @param integer $newPagePID New page id.
+ * @return string Onclick attribute content
*/
function onClickEvent($pid, $newPagePID) {
return 'window.location.href=\'tce_db.php?cmd[pages][' . $GLOBALS['SOBE']->moveUid . '][' . $this->moveOrCopy . ']=' . $pid .
@@ -110,43 +90,32 @@ class ext_posMap_pages extends t3lib_positionMap {
/**
* Wrapping page title.
*
- * @param string Page title.
- * @param array Page record (?)
- * @return string Wrapped title.
+ * @param string $str Page title.
+ * @param array $rec Page record (?)
+ * @return string Wrapped title.
*/
function linkPageTitle($str, $rec) {
- $url = t3lib_div::linkThisScript(array('uid'=>intval($rec['uid']), 'moveUid'=>$GLOBALS['SOBE']->moveUid));
+ $url = t3lib_div::linkThisScript(array('uid' => intval($rec['uid']), 'moveUid' => $GLOBALS['SOBE']->moveUid));
return '<a href="'.htmlspecialchars($url).'">'.$str.'</a>';
}
/**
* Wrap $t_code in bold IF the $dat uid matches $id
*
- * @param string Title string
- * @param array Infomation array with record array inside.
- * @param integer The current id.
- * @return string The title string.
+ * @param string $t_code Title string
+ * @param array $dat Infomation array with record array inside.
+ * @param integer $id The current id.
+ * @return string The title string.
*/
function boldTitle($t_code, $dat, $id) {
return parent::boldTitle($t_code, $dat, $GLOBALS['SOBE']->moveUid);
}
}
-
-
-
-
-
-
-
-
-
-
-
/**
* Extension of position map for content elements
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
@@ -156,9 +125,9 @@ class ext_posMap_tt_content extends t3lib_positionMap {
/**
* Wrapping page title.
*
- * @param string Page title.
- * @param array Page record (?)
- * @return string Wrapped title.
+ * @param string $str Page title.
+ * @param array $rec Page record (?)
+ * @return string Wrapped title.
*/
function linkPageTitle($str, $rec) {
$url = t3lib_div::linkThisScript(array('uid'=>intval($rec['uid']), 'moveUid'=>$GLOBALS['SOBE']->moveUid));
@@ -168,9 +137,9 @@ class ext_posMap_tt_content extends t3lib_positionMap {
/**
* Wrapping the title of the record.
*
- * @param string The title value.
- * @param array The record row.
- * @return string Wrapped title string.
+ * @param string $str The title value.
+ * @param array $row The record row.
+ * @return string Wrapped title string.
*/
function wrapRecordTitle($str, $row) {
if ($GLOBALS['SOBE']->moveUid==$row['uid']) $str = '<strong>'.$str.'</strong>';
@@ -178,25 +147,17 @@ class ext_posMap_tt_content extends t3lib_positionMap {
}
}
-
-
-
-
-
-
-
-
/**
* Script Class for rendering the move-element wizard display
*
- * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
class SC_move_el {
// Internal, static (eg. from GPvars):
- var $sys_language=0;
+ var $sys_language = 0;
var $page_id;
var $table;
var $R_URI;
@@ -210,24 +171,25 @@ class SC_move_el {
* @var mediumDoc
*/
var $doc;
- var $perms_clause; // Pages-select clause
+ // Pages-select clause
+ var $perms_clause;
// Internal, dynamic:
- var $content; // Content for module accumulated here.
-
+ // Content for module accumulated here.
+ var $content;
/**
* Constructor, initializing internal variables.
*
- * @return void
+ * @return void
*/
function init() {
// Setting internal vars:
$this->sys_language = intval(t3lib_div::_GP('sys_language'));
- $this->page_id=intval(t3lib_div::_GP('uid'));
- $this->table=t3lib_div::_GP('table');
- $this->R_URI=t3lib_div::sanitizeLocalUrl(t3lib_div::_GP('returnUrl'));
+ $this->page_id = intval(t3lib_div::_GP('uid'));
+ $this->table = t3lib_div::_GP('table');
+ $this->R_URI = t3lib_div::sanitizeLocalUrl(t3lib_div::_GP('returnUrl'));
$this->input_moveUid = t3lib_div::_GP('moveUid');
$this->moveUid = $this->input_moveUid ? $this->input_moveUid : $this->page_id;
$this->makeCopy = t3lib_div::_GP('makeCopy');
@@ -239,7 +201,7 @@ class SC_move_el {
$this->doc = t3lib_div::makeInstance('template');
$this->doc->backPath = $GLOBALS['BACK_PATH'];
$this->doc->setModuleTemplate('templates/move_el.html');
- $this->doc->JScode='';
+ $this->doc->JScode = '';
// Starting document content (header):
$this->content = '';
@@ -249,7 +211,7 @@ class SC_move_el {
/**
* Creating the module output.
*
- * @return void
+ * @return void
*/
function main() {
if ($this->page_id) {
@@ -259,7 +221,7 @@ class SC_move_el {
// Headerline: Icon, record title:
$hline = t3lib_iconWorks::getSpriteIconForRecord($this->table, $elRow, array('id' => 'c-recIcon', 'title' => htmlspecialchars(t3lib_BEfunc::getRecordIconAltText($elRow, $this->table))));
- $hline.= t3lib_BEfunc::getRecordTitle($this->table, $elRow, TRUE);
+ $hline .= t3lib_BEfunc::getRecordTitle($this->table, $elRow, TRUE);
// Make-copy checkbox (clicking this will reload the page with the GET var makeCopy set differently):
$hline .= $this->doc->spacer(5);
@@ -272,11 +234,11 @@ class SC_move_el {
$GLOBALS['LANG']->getLL('makeCopy', 1) . '</label>';
// Add the header-content to the module content:
- $this->content.=$this->doc->section('', $hline, FALSE, TRUE);
- $this->content.=$this->doc->spacer(20);
+ $this->content .= $this->doc->section('', $hline, FALSE, TRUE);
+ $this->content .= $this->doc->spacer(20);
// Reset variable to pick up the module content in:
- $code='';
+ $code = '';
// IF the table is "pages":
if ((string)$this->table=='pages') {
@@ -293,12 +255,12 @@ class SC_move_el {
$pidPageInfo = t3lib_BEfunc::readPageAccess($pageinfo['pid'], $this->perms_clause);
if (is_array($pidPageInfo)) {
if ($GLOBALS['BE_USER']->isInWebMount($pidPageInfo['pid'], $this->perms_clause)) {
- $code.= '<a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('uid'=>intval($pageinfo['pid']), 'moveUid'=>$this->moveUid))).'">'.
+ $code .= '<a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('uid'=>intval($pageinfo['pid']), 'moveUid'=>$this->moveUid))).'">'.
t3lib_iconWorks::getSpriteIcon('actions-view-go-up') .
t3lib_BEfunc::getRecordTitle('pages', $pidPageInfo, TRUE).
'</a><br />';
} else {
- $code.= t3lib_iconWorks::getSpriteIconForRecord('pages', $pidPageInfo) .
+ $code .= t3lib_iconWorks::getSpriteIconForRecord('pages', $pidPageInfo) .
t3lib_BEfunc::getRecordTitle('pages', $pidPageInfo, TRUE).
'<br />';
}
@@ -306,18 +268,18 @@ class SC_move_el {
}
// Create the position tree:
- $code.= $posMap->positionTree($this->page_id, $pageinfo, $this->perms_clause, $this->R_URI);
+ $code .= $posMap->positionTree($this->page_id, $pageinfo, $this->perms_clause, $this->R_URI);
}
}
// IF the table is "tt_content":
- if ((string)$this->table=='tt_content') {
+ if ((string)$this->table == 'tt_content') {
// First, get the record:
$tt_content_rec = t3lib_BEfunc::getRecord('tt_content', $this->moveUid);
// ?
- if (!$this->input_moveUid) $this->page_id = $tt_content_rec['pid'];
+ if (!$this->input_moveUid) $this->page_id = $tt_content_rec['pid'];
// Checking if the parent page is readable:
$pageinfo = t3lib_BEfunc::readPageAccess($this->page_id, $this->perms_clause);
@@ -333,12 +295,14 @@ class SC_move_el {
$hline .= t3lib_BEfunc::getRecordTitle('pages', $pageinfo, TRUE);
// Load SHARED page-TSconfig settings and retrieve column list from there, if applicable:
- $modTSconfig_SHARED = t3lib_BEfunc::getModTSconfig($this->page_id, 'mod.SHARED'); // SHARED page-TSconfig settings.
+ // SHARED page-TSconfig settings.
+ $modTSconfig_SHARED = t3lib_BEfunc::getModTSconfig($this->page_id, 'mod.SHARED');
$colPosArray = t3lib_div::callUserFunction('EXT:cms/classes/class.tx_cms_backendlayout.php:tx_cms_BackendLayout->getColPosListItemsParsed', $this->page_id, $this);
foreach ($colPosArray as $colPos) {
$colPosList .= $colPosList != '' ? ',' . $colPos[1] : $colPos[1];
}
- $colPosList = implode(',', array_unique(t3lib_div::intExplode(',', $colPosList))); // Removing duplicates, if any
+ // Removing duplicates, if any
+ $colPosList = implode(',', array_unique(t3lib_div::intExplode(',', $colPosList)));
// Adding parent page-header and the content element columns from position-map:
$code = $hline . '<br />';
@@ -367,7 +331,7 @@ class SC_move_el {
}
// Create the position tree (for pages):
- $code.= $posMap->positionTree($this->page_id, $pageinfo, $this->perms_clause, $this->R_URI);
+ $code .= $posMap->positionTree($this->page_id, $pageinfo, $this->perms_clause, $this->R_URI);
}
}
@@ -382,15 +346,15 @@ class SC_move_el {
// Build the <body> for the module
$this->content = $this->doc->startPage($GLOBALS['LANG']->getLL('movingElement'));
- $this->content.= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers);
- $this->content.= $this->doc->endPage();
+ $this->content .= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers);
+ $this->content .= $this->doc->endPage();
$this->content = $this->doc->insertStylesAndJS($this->content);
}
/**
* Print out the accumulated content:
*
- * @return void
+ * @return void
*/
function printContent() {
echo $this->content;
@@ -399,7 +363,7 @@ class SC_move_el {
/**
* Create the panel of buttons for submitting the form or otherwise perform operations.
*
- * @return array all available buttons as an assoc. array
+ * @return array All available buttons as an assoc. array
*/
protected function getButtons() {
$buttons = array(
@@ -428,7 +392,7 @@ class SC_move_el {
}
}
-// Make instance:
+ // Make instance:
$SOBE = t3lib_div::makeInstance('SC_move_el');
$SOBE->init();
$SOBE->main();
--
GitLab