1492435df6c22cce1f888dce6fe10e750f3facdb
[Packages/TYPO3.CMS.git] / typo3 / sysext / install / Classes / CheckTheDatabaseHookInterface.php
1 <?php
2 namespace TYPO3\CMS\Install;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2011-2013 Thomas Maroschik <tmaroschik@dfau.de>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the textfile GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29 /**
30 * Interface for hook in tx_install::checkTheDatabase
31 *
32 * @author Thomas Maroschik <tmaroschik@dfau.de>
33 */
34 interface CheckTheDatabaseHookInterface
35 {
36 /**
37 * Hook that allows to dynamically extend the table definitions on a per extension base
38 * for e.g. custom caches. The hook implementation may return table create strings that
39 * will be respected by the install tool.
40 *
41 * @param string $extKey: Extension key
42 * @param array $loadedExtConf: The extension's configuration from $GLOBALS['TYPO3_LOADED_EXT']
43 * @param string $extensionSqlContent: The content of the extensions ext_tables.sql
44 * @param \TYPO3\CMS\Install\Sql\SchemaMigrator $instSqlObj: Instance of the installer sql object
45 * @param tx_em_Install $parent: The calling parent object
46 * @return string Either empty string or table create strings
47 */
48 public function appendExtensionTableDefinitions($extKey, array $loadedExtConf, $extensionSqlContent, \TYPO3\CMS\Install\Sql\SchemaMigrator $instSqlObj, \TYPO3\CMS\Install\Installer $parent);
49
50 /**
51 * Hook that allows to dynamically extend the table definitions for the whole system
52 * for e.g. custom caches. The hook implementation may return table create strings that
53 * will be respected by the install tool.
54 *
55 * @param string $allSqlContent: The content of all relevant sql files
56 * @param \TYPO3\CMS\Install\Sql\SchemaMigrator $instSqlObj: Instance of the installer sql object
57 * @param tx_em_Install $parent: The calling parent object
58 * @return string Either empty string or table create strings
59 */
60 public function appendGlobalTableDefinitions($allSqlContent, \TYPO3\CMS\Install\Sql\SchemaMigrator $instSqlObj, \TYPO3\CMS\Install\Installer $parent);
61
62 }
63
64 ?>