Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / install / updates / class.tx_coreupdates_notinmenu.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2011 Sebastian Kurfürst <sebastian@garbage-group.de>
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 * Contains the update class for not in menu pages. Used by the update wizard in the install tool.
30 *
31 * @author Sebastian Kurfürst <sebastian@garbage-group.de>
32 * @author Steffen Kamper <info@sk-typo3.de>
33 * @version $Id$
34 */
35 class tx_coreupdates_notinmenu extends Tx_Install_Updates_Base {
36 protected $title = 'Update Pages with Doktype "Not in menu"';
37
38
39 /**
40 * Checks if an update is needed
41 *
42 * @param string &$description: The description for the update
43 * @return boolean whether an update is needed (true) or not (false)
44 */
45 public function checkForUpdate(&$description) {
46 $result = false;
47 $description = 'Removes the deprecated pages doktype "Not in menu". It sets the successing flag "Not in menu" for the corresponding pages instead.';
48
49 if ($this->versionNumber >= 4002000) {
50 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', 'pages', 'doktype=5', '', '', '1');
51 if($GLOBALS['TYPO3_DB']->sql_num_rows($res)) {
52 $result = true;
53 }
54 $GLOBALS['TYPO3_DB']->sql_free_result($res);
55 }
56 return $result;
57 }
58
59
60 /**
61 * Performs the database update. Changes the doktype from 5 ("not in menu") to 1 (standard) and sets the "nav_hide" flag to 1
62 *
63 * @param array &$dbQueries: queries done in this update
64 * @param mixed &$customMessages: custom messages
65 * @return boolean whether it worked (true) or not (false)
66 */
67 public function performUpdate(&$dbQueries, &$customMessages) {
68 $result = false;
69 if($this->versionNumber >= 4002000) {
70 $updateArray = array(
71 'doktype' => 1,
72 'nav_hide' => 1
73 );
74
75 $res = $GLOBALS['TYPO3_DB']->exec_UPDATEquery('pages', 'doktype=5', $updateArray);
76 $dbQueries[] = str_replace(chr(10), ' ', $GLOBALS['TYPO3_DB']->debug_lastBuiltQuery);
77
78 if ($GLOBALS['TYPO3_DB']->sql_error()) {
79 $customMessages = 'SQL-ERROR: ' . htmlspecialchars($GLOBALS['TYPO3_DB']->sql_error());
80 } else {
81 $result = true;
82 }
83 }
84 return $result;
85 }
86 }
87 ?>