[TASK] Clean up phpDoc comments in typo3/
[Packages/TYPO3.CMS.git] / typo3 / wizard_edit.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 * Wizard to edit records from group/select lists in TCEforms
30 *
31 * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
32 *
33 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
34 */
35
36 $BACK_PATH = '';
37 require('init.php');
38 require('template.php');
39 $LANG->includeLLFile('EXT:lang/locallang_wizards.xml');
40
41 /**
42 * Script Class for redirecting a backend user to the editing form when an "Edit wizard" link was clicked in TCEforms somewhere
43 *
44 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
45 * @package TYPO3
46 * @subpackage core
47 */
48 class SC_wizard_edit {
49
50 // Internal, static: GPvars
51 // Wizard parameters, coming from TCEforms linking to the wizard.
52 var $P;
53 // Boolean; if set, the window will be closed by JavaScript
54 var $doClose;
55
56 /**
57 * Initialization of the script
58 *
59 * @return void
60 */
61 function init() {
62 $this->P = t3lib_div::_GP('P');
63 // Used for the return URL to alt_doc.php so that we can close the window.
64 $this->doClose = t3lib_div::_GP('doClose');
65 }
66
67 /**
68 * Main function
69 * Makes a header-location redirect to an edit form IF POSSIBLE from the passed data - otherwise the window will just close.
70 *
71 * @return void
72 */
73 function main() {
74 if ($this->doClose) {
75 $this->closeWindow();
76 } else {
77
78 // Initialize:
79 $table = $this->P['table'];
80 $field = $this->P['field'];
81 t3lib_div::loadTCA($table);
82 $config = $GLOBALS['TCA'][$table]['columns'][$field]['config'];
83 $fTable = $this->P['currentValue']<0 ? $config['neg_foreign_table'] : $config['foreign_table'];
84
85 // Detecting the various allowed field type setups and acting accordingly.
86 if (is_array($config) && $config['type']=='select' && !$config['MM'] && $config['maxitems']<=1 && t3lib_utility_Math::canBeInterpretedAsInteger($this->P['currentValue']) && $this->P['currentValue'] && $fTable) { // SINGLE value:
87 $redirectUrl = 'alt_doc.php?returnUrl=' . rawurlencode('wizard_edit.php?doClose=1') . '&edit[' . $fTable . '][' . $this->P['currentValue'] . ']=edit';
88 t3lib_utility_Http::redirect($redirectUrl);
89 } elseif (is_array($config) && $this->P['currentSelectedValues'] && (($config['type']=='select' && $config['foreign_table']) || ($config['type']=='group' && $config['internal_type']=='db'))) { // MULTIPLE VALUES:
90
91 // Init settings:
92 $allowedTables = $config['type']=='group' ? $config['allowed'] : $config['foreign_table'].','.$config['neg_foreign_table'];
93 $prependName = 1;
94 $params = '';
95
96 // Selecting selected values into an array:
97 $dbAnalysis = t3lib_div::makeInstance('t3lib_loadDBGroup');
98 $dbAnalysis->start($this->P['currentSelectedValues'], $allowedTables);
99 $value = $dbAnalysis->getValueArray($prependName);
100
101 // Traverse that array and make parameters for alt_doc.php:
102 foreach ($value as $rec) {
103 $recTableUidParts = t3lib_div::revExplode('_', $rec, 2);
104 $params.='&edit['.$recTableUidParts[0].']['.$recTableUidParts[1].']=edit';
105 }
106
107 // Redirect to alt_doc.php:
108 t3lib_utility_Http::redirect('alt_doc.php?returnUrl=' . rawurlencode('wizard_edit.php?doClose=1') . $params);
109 } else {
110 $this->closeWindow();
111 }
112 }
113 }
114
115 /**
116 * Printing a little JavaScript to close the open window.
117 *
118 * @return void
119 */
120 function closeWindow() {
121 echo '<script language="javascript" type="text/javascript">close();</script>';
122 exit;
123 }
124 }
125
126 // Make instance:
127 $SOBE = t3lib_div::makeInstance('SC_wizard_edit');
128 $SOBE->init();
129 $SOBE->main();
130
131 ?>