added @var phpDoc comments to various variables
[Packages/TYPO3.CMS.git] / typo3 / sysext / install / updates / class.tx_coreupdates_notinmenu.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2006 Sebastian Kurfuerst (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 * Contains the update class for not in menu pages. Used by the update wizard in the install tool.
29 *
30 * @author Sebastian Kurfuerst <sebastian@garbage-group.de
31 */
32 class tx_coreupdates_notinmenu {
33 var $versionNumber; // version number coming from t3lib_div::int_from_ver()
34
35 /**
36 * parent object
37 *
38 * @var tx_install
39 */
40 var $pObj;
41 var $userInput; // user input
42
43 function checkForUpdate(&$description) {
44 $description = 'Removes the doctype "Not in menu" which is deprecated and sets the successing page flag "Not in menu" instead.';
45
46 if ($this->versionNumber >= 3009000) {
47 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid','pages','doktype=5');
48 if($GLOBALS['TYPO3_DB']->sql_num_rows($res)) {
49 return 1;
50 }
51 }
52 return 0;
53 }
54
55 /**
56 * [Describe function...]
57 *
58 * @param [type] $$dbQueries: ...
59 * @param [type] $customMessages: ...
60 * @return [type] ...
61 */
62 function performUpdate(&$dbQueries, &$customMessages) {
63 if($this->versionNumber >= 3009000) {
64 $updateArray = array(
65 'doktype' => 1,
66 'nav_hide' => 1
67 );
68
69 $res = $GLOBALS['TYPO3_DB']->exec_UPDATEquery('pages', 'doktype=5', $updateArray);
70 $dbQueries[] = str_replace(chr(10), ' ', $GLOBALS['TYPO3_DB']->debug_lastBuiltQuery);
71
72 if ($GLOBALS['TYPO3_DB']->sql_error()) {
73 return 0; // something went wrong
74 }
75 return 1;
76 }
77 }
78 }
79 ?>