[TASK] Clean up phpDoc comments in typo3/
[Packages/TYPO3.CMS.git] / typo3 / move_el.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 * Move element wizard:
29 * Moving pages or content elements (tt_content) around in the system via a page tree navigation.
30 *
31 * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
32 * XHTML compatible.
33 *
34 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
35 */
36
37 $BACK_PATH = '';
38 require('init.php');
39 require('template.php');
40
41 // Include local language labels:
42 $LANG->includeLLFile('EXT:lang/locallang_misc.xml');
43
44 /**
45 * Local extension of the page tree class
46 *
47 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
48 * @package TYPO3
49 * @subpackage core
50 */
51 class localPageTree extends t3lib_pageTree {
52
53 /**
54 * Inserting uid-information in title-text for an icon
55 *
56 * @param string $icon Icon image
57 * @param array $row Item row
58 * @return string Wrapping icon image.
59 */
60 function wrapIcon($icon, $row) {
61 return $this->addTagAttributes($icon, ' title="id='.htmlspecialchars($row['uid']).'"');
62 }
63 }
64
65 /**
66 * Extension of position map for pages
67 *
68 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
69 * @package TYPO3
70 * @subpackage core
71 */
72 class ext_posMap_pages extends t3lib_positionMap {
73 var $l_insertNewPageHere = 'movePageToHere';
74
75 /**
76 * Creates the onclick event for the insert-icons.
77 *
78 * @param integer $pid The pid.
79 * @param integer $newPagePID New page id.
80 * @return string Onclick attribute content
81 */
82 function onClickEvent($pid, $newPagePID) {
83 return 'window.location.href=\'tce_db.php?cmd[pages][' . $GLOBALS['SOBE']->moveUid . '][' . $this->moveOrCopy . ']=' . $pid .
84 '&redirect=' . rawurlencode($this->R_URI) .
85 '&prErr=1&uPT=1&vC=' . $GLOBALS['BE_USER']->veriCode() .
86 t3lib_BEfunc::getUrlToken('tceAction') .
87 '\';return false;';
88 }
89
90 /**
91 * Wrapping page title.
92 *
93 * @param string $str Page title.
94 * @param array $rec Page record (?)
95 * @return string Wrapped title.
96 */
97 function linkPageTitle($str, $rec) {
98 $url = t3lib_div::linkThisScript(array('uid' => intval($rec['uid']), 'moveUid' => $GLOBALS['SOBE']->moveUid));
99 return '<a href="'.htmlspecialchars($url).'">'.$str.'</a>';
100 }
101
102 /**
103 * Wrap $t_code in bold IF the $dat uid matches $id
104 *
105 * @param string $t_code Title string
106 * @param array $dat Infomation array with record array inside.
107 * @param integer $id The current id.
108 * @return string The title string.
109 */
110 function boldTitle($t_code, $dat, $id) {
111 return parent::boldTitle($t_code, $dat, $GLOBALS['SOBE']->moveUid);
112 }
113 }
114
115 /**
116 * Extension of position map for content elements
117 *
118 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
119 * @package TYPO3
120 * @subpackage core
121 */
122 class ext_posMap_tt_content extends t3lib_positionMap {
123 var $dontPrintPageInsertIcons = 1;
124
125 /**
126 * Wrapping page title.
127 *
128 * @param string $str Page title.
129 * @param array $rec Page record (?)
130 * @return string Wrapped title.
131 */
132 function linkPageTitle($str, $rec) {
133 $url = t3lib_div::linkThisScript(array('uid'=>intval($rec['uid']), 'moveUid'=>$GLOBALS['SOBE']->moveUid));
134 return '<a href="'.htmlspecialchars($url).'">'.$str.'</a>';
135 }
136
137 /**
138 * Wrapping the title of the record.
139 *
140 * @param string $str The title value.
141 * @param array $row The record row.
142 * @return string Wrapped title string.
143 */
144 function wrapRecordTitle($str, $row) {
145 if ($GLOBALS['SOBE']->moveUid==$row['uid']) $str = '<strong>'.$str.'</strong>';
146 return parent::wrapRecordTitle($str, $row);
147 }
148 }
149
150 /**
151 * Script Class for rendering the move-element wizard display
152 *
153 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
154 * @package TYPO3
155 * @subpackage core
156 */
157 class SC_move_el {
158
159 // Internal, static (eg. from GPvars):
160 var $sys_language = 0;
161 var $page_id;
162 var $table;
163 var $R_URI;
164 var $input_moveUid;
165 var $moveUid;
166 var $makeCopy;
167
168 /**
169 * Document template object
170 *
171 * @var mediumDoc
172 */
173 var $doc;
174 // Pages-select clause
175 var $perms_clause;
176
177 // Internal, dynamic:
178 // Content for module accumulated here.
179 var $content;
180
181 /**
182 * Constructor, initializing internal variables.
183 *
184 * @return void
185 */
186 function init() {
187
188 // Setting internal vars:
189 $this->sys_language = intval(t3lib_div::_GP('sys_language'));
190 $this->page_id = intval(t3lib_div::_GP('uid'));
191 $this->table = t3lib_div::_GP('table');
192 $this->R_URI = t3lib_div::sanitizeLocalUrl(t3lib_div::_GP('returnUrl'));
193 $this->input_moveUid = t3lib_div::_GP('moveUid');
194 $this->moveUid = $this->input_moveUid ? $this->input_moveUid : $this->page_id;
195 $this->makeCopy = t3lib_div::_GP('makeCopy');
196
197 // Select-pages where clause for read-access:
198 $this->perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1);
199
200 // Starting the document template object:
201 $this->doc = t3lib_div::makeInstance('template');
202 $this->doc->backPath = $GLOBALS['BACK_PATH'];
203 $this->doc->setModuleTemplate('templates/move_el.html');
204 $this->doc->JScode = '';
205
206 // Starting document content (header):
207 $this->content = '';
208 $this->content .= $this->doc->header($GLOBALS['LANG']->getLL('movingElement'));
209 }
210
211 /**
212 * Creating the module output.
213 *
214 * @return void
215 */
216 function main() {
217 if ($this->page_id) {
218
219 // Get record for element:
220 $elRow = t3lib_BEfunc::getRecordWSOL($this->table, $this->moveUid);
221
222 // Headerline: Icon, record title:
223 $hline = t3lib_iconWorks::getSpriteIconForRecord($this->table, $elRow, array('id' => 'c-recIcon', 'title' => htmlspecialchars(t3lib_BEfunc::getRecordIconAltText($elRow, $this->table))));
224 $hline .= t3lib_BEfunc::getRecordTitle($this->table, $elRow, TRUE);
225
226 // Make-copy checkbox (clicking this will reload the page with the GET var makeCopy set differently):
227 $hline .= $this->doc->spacer(5);
228 $onClick = 'window.location.href=\''.t3lib_div::linkThisScript(array('makeCopy'=>!$this->makeCopy)).'\';';
229 $hline .= $this->doc->spacer(5);
230 $hline .= '<input type="hidden" name="makeCopy" value="0" />' .
231 '<input type="checkbox" name="makeCopy" id="makeCopy" value="1"' .
232 ($this->makeCopy ? ' checked="checked"' : '') .
233 ' onclick="' . htmlspecialchars($onClick) . '" /> <label for="makeCopy" class="t3-label-valign-top">' .
234 $GLOBALS['LANG']->getLL('makeCopy', 1) . '</label>';
235
236 // Add the header-content to the module content:
237 $this->content .= $this->doc->section('', $hline, FALSE, TRUE);
238 $this->content .= $this->doc->spacer(20);
239
240 // Reset variable to pick up the module content in:
241 $code = '';
242
243 // IF the table is "pages":
244 if ((string)$this->table=='pages') {
245 // Get page record (if accessible):
246 $pageinfo = t3lib_BEfunc::readPageAccess($this->page_id, $this->perms_clause);
247 if (is_array($pageinfo) && $GLOBALS['BE_USER']->isInWebMount($pageinfo['pid'], $this->perms_clause)) {
248
249 // Initialize the position map:
250 $posMap = t3lib_div::makeInstance('ext_posMap_pages');
251 $posMap->moveOrCopy = $this->makeCopy?'copy':'move';
252
253 // Print a "go-up" link IF there is a real parent page (and if the user has read-access to that page).
254 if ($pageinfo['pid']) {
255 $pidPageInfo = t3lib_BEfunc::readPageAccess($pageinfo['pid'], $this->perms_clause);
256 if (is_array($pidPageInfo)) {
257 if ($GLOBALS['BE_USER']->isInWebMount($pidPageInfo['pid'], $this->perms_clause)) {
258 $code .= '<a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('uid'=>intval($pageinfo['pid']), 'moveUid'=>$this->moveUid))).'">'.
259 t3lib_iconWorks::getSpriteIcon('actions-view-go-up') .
260 t3lib_BEfunc::getRecordTitle('pages', $pidPageInfo, TRUE).
261 '</a><br />';
262 } else {
263 $code .= t3lib_iconWorks::getSpriteIconForRecord('pages', $pidPageInfo) .
264 t3lib_BEfunc::getRecordTitle('pages', $pidPageInfo, TRUE).
265 '<br />';
266 }
267 }
268 }
269
270 // Create the position tree:
271 $code .= $posMap->positionTree($this->page_id, $pageinfo, $this->perms_clause, $this->R_URI);
272 }
273 }
274
275 // IF the table is "tt_content":
276 if ((string)$this->table == 'tt_content') {
277
278 // First, get the record:
279 $tt_content_rec = t3lib_BEfunc::getRecord('tt_content', $this->moveUid);
280
281 // ?
282 if (!$this->input_moveUid) $this->page_id = $tt_content_rec['pid'];
283
284 // Checking if the parent page is readable:
285 $pageinfo = t3lib_BEfunc::readPageAccess($this->page_id, $this->perms_clause);
286 if (is_array($pageinfo) && $GLOBALS['BE_USER']->isInWebMount($pageinfo['pid'], $this->perms_clause)) {
287
288 // Initialize the position map:
289 $posMap = t3lib_div::makeInstance('ext_posMap_tt_content');
290 $posMap->moveOrCopy = $this->makeCopy?'copy':'move';
291 $posMap->cur_sys_language = $this->sys_language;
292
293 // Headerline for the parent page: Icon, record title:
294 $hline = t3lib_iconWorks::getSpriteIconForRecord('pages', $pageinfo, array('title' => htmlspecialchars(t3lib_BEfunc::getRecordIconAltText($pageinfo, 'pages'))));
295 $hline .= t3lib_BEfunc::getRecordTitle('pages', $pageinfo, TRUE);
296
297 // Load SHARED page-TSconfig settings and retrieve column list from there, if applicable:
298 // SHARED page-TSconfig settings.
299 $modTSconfig_SHARED = t3lib_BEfunc::getModTSconfig($this->page_id, 'mod.SHARED');
300 $colPosArray = t3lib_div::callUserFunction('EXT:cms/classes/class.tx_cms_backendlayout.php:tx_cms_BackendLayout->getColPosListItemsParsed', $this->page_id, $this);
301 foreach ($colPosArray as $colPos) {
302 $colPosList .= $colPosList != '' ? ',' . $colPos[1] : $colPos[1];
303 }
304 // Removing duplicates, if any
305 $colPosList = implode(',', array_unique(t3lib_div::intExplode(',', $colPosList)));
306
307 // Adding parent page-header and the content element columns from position-map:
308 $code = $hline . '<br />';
309 $code .= $posMap->printContentElementColumns($this->page_id, $this->moveUid, $colPosList, 1, $this->R_URI);
310
311 // Print a "go-up" link IF there is a real parent page (and if the user has read-access to that page).
312 $code .= '<br />';
313 $code .= '<br />';
314 if ($pageinfo['pid']) {
315 $pidPageInfo = t3lib_BEfunc::readPageAccess($pageinfo['pid'], $this->perms_clause);
316 if (is_array($pidPageInfo)) {
317 if ($GLOBALS['BE_USER']->isInWebMount($pidPageInfo['pid'], $this->perms_clause)) {
318 $code .= '<a href="' . htmlspecialchars(t3lib_div::linkThisScript(array(
319 'uid' => intval($pageinfo['pid']),
320 'moveUid' => $this->moveUid)
321 )) . '">'
322 . t3lib_iconWorks::getSpriteIcon('actions-view-go-up')
323 . t3lib_BEfunc::getRecordTitle('pages', $pidPageInfo, TRUE)
324 . '</a><br />';
325 } else {
326 $code.= t3lib_iconWorks::getSpriteIconForRecord('pages', $pidPageInfo)
327 . t3lib_BEfunc::getRecordTitle('pages', $pidPageInfo, TRUE)
328 . '<br />';
329 }
330 }
331 }
332
333 // Create the position tree (for pages):
334 $code .= $posMap->positionTree($this->page_id, $pageinfo, $this->perms_clause, $this->R_URI);
335 }
336 }
337
338 // Add the $code content as a new section to the module:
339 $this->content .= $this->doc->section($GLOBALS['LANG']->getLL('selectPositionOfElement'), $code, FALSE, TRUE);
340 }
341
342 // Setting up the buttons and markers for docheader
343 $docHeaderButtons = $this->getButtons();
344 $markers['CSH'] = $docHeaderButtons['csh'];
345 $markers['CONTENT'] = $this->content;
346
347 // Build the <body> for the module
348 $this->content = $this->doc->startPage($GLOBALS['LANG']->getLL('movingElement'));
349 $this->content .= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers);
350 $this->content .= $this->doc->endPage();
351 $this->content = $this->doc->insertStylesAndJS($this->content);
352 }
353
354 /**
355 * Print out the accumulated content:
356 *
357 * @return void
358 */
359 function printContent() {
360 echo $this->content;
361 }
362
363 /**
364 * Create the panel of buttons for submitting the form or otherwise perform operations.
365 *
366 * @return array All available buttons as an assoc. array
367 */
368 protected function getButtons() {
369 $buttons = array(
370 'csh' => '',
371 'back' => ''
372 );
373
374 if ($this->page_id) {
375 if ((string)$this->table == 'pages') {
376 // CSH
377 $buttons['csh'] = t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'move_el_pages', $GLOBALS['BACK_PATH'], '', TRUE);
378 } elseif((string)$this->table == 'tt_content') {
379 // CSH
380 $buttons['csh'] = t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'move_el_cs', $GLOBALS['BACK_PATH'], '', TRUE);
381 }
382
383 if ($this->R_URI) {
384 // Back
385 $buttons['back'] ='<a href="' . htmlspecialchars($this->R_URI) . '" class="typo3-goBack" title="' . $GLOBALS['LANG']->getLL('goBack', TRUE) .'">' .
386 t3lib_iconWorks::getSpriteIcon('actions-view-go-back') .
387 '</a>';
388 }
389 }
390
391 return $buttons;
392 }
393 }
394
395 // Make instance:
396 $SOBE = t3lib_div::makeInstance('SC_move_el');
397 $SOBE->init();
398 $SOBE->main();
399 $SOBE->printContent();
400
401 ?>