DatabaseUtility.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extensionmanager\Utility;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class DatabaseUtility implements \TYPO3\CMS\Core\SingletonInterface
{
    const MULTI_LINEBREAKS = '


';
    public function dumpStaticTables($dbFields)
    {
        $out = '';
        // Traverse the table list and dump each:
        foreach ($dbFields as $table => $fields) {
            if (is_array($dbFields[$table]['fields'])) {
                $header = $this->dumpHeader();
                $tableHeader = $this->dumpTableHeader($table, $dbFields[$table], true);
                $insertStatements = $this->dumpTableContent($table, $dbFields[$table]['fields']);
                $out .= $header . self::MULTI_LINEBREAKS . $tableHeader . self::MULTI_LINEBREAKS . $insertStatements . self::MULTI_LINEBREAKS;
            }
        }
        return $out;
    }

    protected function dumpHeader()
    {
        return trim('
# TYPO3 Extension Manager dump 1.1
#
# Host: ' . TYPO3_db_host . '    Database: ' . TYPO3_db . '
#--------------------------------------------------------
');
    }

    protected function dumpTableHeader($table, array $fieldKeyInfo, $dropTableIfExists = false)
    {
        $lines = [];
        $dump = '';
        // Create field definitions
        if (is_array($fieldKeyInfo['fields'])) {
            foreach ($fieldKeyInfo['fields'] as $fieldN => $data) {
                $lines[] = '  ' . $fieldN . ' ' . $data;
            }
        }
        // Create index key definitions
        if (is_array($fieldKeyInfo['keys'])) {
            foreach ($fieldKeyInfo['keys'] as $fieldN => $data) {
                $lines[] = '  ' . $data;
            }
        }
        // Compile final output:
        if (!empty($lines)) {
            $dump = trim('
#
# Table structure for table "' . $table . '"
#
' . ($dropTableIfExists ? 'DROP TABLE IF EXISTS ' . $table . ';
' : '') . 'CREATE TABLE ' . $table . ' (
' . implode((',' . LF), $lines) . '
);');
        }
        return $dump;
    }

    protected function dumpTableContent($table, array $fieldStructure)
    {
        // Substitution of certain characters (borrowed from phpMySQL):
        $search = ['\\', '\'', "\0", "\n", "\r", "\x1A"];
        $replace = ['\\\\', '\\\'', '\\0', '\\n', '\\r', '\\Z'];
        $lines = [];
        // Select all rows from the table:
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable($table);
        $queryBuilder->getRestrictions()
            ->removeAll();
        $result = $queryBuilder->select('*')
            ->from($table)
            ->execute();
        // Traverse the selected rows and dump each row as a line in the file:
        while ($row = $result->fetch()) {
            $values = [];
            foreach ($fieldStructure as $field => $structure) {
                $values[] = isset($row[$field]) ? '\'' . str_replace($search, $replace, $row[$field]) . '\'' : 'NULL';
            }
            $lines[] = 'INSERT INTO ' . $table . ' VALUES (' . implode(', ', $values) . ');';
        }
        // Implode lines and return:
        return implode(LF, $lines);
    }
}