Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / em / interfaces / interface.tx_em_index_checkdatabaseupdateshook.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2010-2011 Xavier Perseguers <typo3@perseguers.ch>
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 * Interface for hook in SC_mod_tools_em_index::checkDBupdates.
30 *
31 * @author Xavier Perseguers <typo3@perseguers.ch>
32 * @package TYPO3
33 * @subpackage em
34 */
35 interface tx_em_Index_CheckDatabaseUpdatesHook {
36
37 /**
38 * Hook that allows pre-processing of database structure modifications.
39 * The hook implementation may return a user form that will temporarily
40 * replace the standard database update form. This allows additional
41 * operations to be performed before the database structure gets updated.
42 *
43 * @param string $extKey: Extension key
44 * @param array $extInfo: Extension information array
45 * @param array $diff: Database differences
46 * @param t3lib_install $instObj: Instance of the installer
47 * @param SC_mod_tools_em_index $parent: The calling parent object
48 * @return string Either empty string or a pre-processing user form
49 */
50 public function preProcessDatabaseUpdates($extKey, array $extInfo, array $diff, t3lib_install $instObj, SC_mod_tools_em_index $parent);
51
52 }
53
54 ?>