FrontendContentAdapterService.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Resource\Service;

class FrontendContentAdapterService {

    static protected $availableMigrationFields = array(
        'paths',
        'titleTexts',
        'captions',
        'links',
        'alternativeTexts'
    );

    static protected $migrateFields = array(
        'tt_content' => array(
            'image' => array(
                'paths' => 'image',
                'titleTexts' => 'titleText',
                'captions' => 'imagecaption',
                'links' => 'image_link',
                'alternativeTexts' => 'altText',
                '__typeMatch' => array(
                    'typeField' => 'CType',
                    'types' => array('image', 'textpic'),
                )
            ),
            'media' => array(
                'paths' => 'media',
                'captions' => 'imagecaption',
                '__typeMatch' => array(
                    'typeField' => 'CType',
                    'types' => array('uploads'),
                )
            )
        ),
        'pages' => array(
            'media' => array(
                'paths' => 'media'
            )
        )
    );

    static public function modifyDBRow(&$row, $table) {
        if (isset($row['_MIGRATED']) && $row['_MIGRATED'] === TRUE) {
            return;
        }
        if (array_key_exists($table, static::$migrateFields)) {
            foreach (static::$migrateFields[$table] as $migrateFieldName => $oldFieldNames) {
                if ($row !== NULL && isset($row[$migrateFieldName]) && self::fieldIsInType($migrateFieldName, $table, $row)) {
                    $files = self::getPageRepository()->getFileReferences($table, $migrateFieldName, $row);
                    $fileFieldContents = array(
                        'paths' => array(),
                        'titleTexts' => array(),
                        'captions' => array(),
                        'links' => array(),
                        'alternativeTexts' => array(),
                        $migrateFieldName . '_fileUids' => array(),
                        $migrateFieldName . '_fileReferenceUids' => array(),
                    );
                    $oldFieldNames[$migrateFieldName . '_fileUids'] = $migrateFieldName . '_fileUids';
                    $oldFieldNames[$migrateFieldName . '_fileReferenceUids'] = $migrateFieldName . '_fileReferenceUids';

                    foreach ($files as $file) {
                        $fileProperties = $file->getProperties();
                        $fileFieldContents['paths'][] = '../../' . $file->getPublicUrl();
                        $fileFieldContents['titleTexts'][] = $fileProperties['title'];
                        $fileFieldContents['captions'][] = $fileProperties['description'];
                        $fileFieldContents['links'][] = $fileProperties['link'];
                        $fileFieldContents['alternativeTexts'][] = $fileProperties['alternative'];
                        $fileFieldContents[$migrateFieldName .  '_fileUids'][] = $file->getOriginalFile()->getUid();
                        $fileFieldContents[$migrateFieldName .  '_fileReferenceUids'][] = $file->getUid();
                    }
                    foreach ($oldFieldNames as $oldFieldType => $oldFieldName) {
                        if ($oldFieldType === '__typeMatch') {
                            continue;
                        }
                        if ($oldFieldType === 'paths' || substr($oldFieldType, -9) == '_fileUids' || substr($oldFieldType, -18) == '_fileReferenceUids') {
                            // For paths and uids, make comma separated list
                            $fieldContents = implode(',', $fileFieldContents[$oldFieldType]);
                        } else {
                            // For all other fields, separate by LF

                            $value = $fileFieldContents[$oldFieldType];

                            // Field content first has to be stripped of any LFs, else the concatenation
                            // will result in wrong indices upon splitting for FE rendering due to
                            // splitting on LF.
                            // LF can usually be replaced by CR to maintain formatting on browsers where
                            // possible.
                            $value = str_replace(CRLF, CR, $value);
                            $value = str_replace(LF, CR, $value);

                            $fieldContents = implode(LF, $value);
                        }
                        $row[$oldFieldName] = $fieldContents;
                    }
                }
            }
        }
        $row['_MIGRATED'] = TRUE;
    }

    static public function registerAdditionalTypeForMigration($table, $field, $additionalType) {

        if (!isset(static::$migrateFields[$table][$field]['__typeMatch'])) {
            throw new \RuntimeException('Additional types can only be added when there is already an existing type match configuration for the given table and field.', 1377600978);
        }

        self::$migrateFields[$table][$field]['__typeMatch']['types'][] = $additionalType;
    }

    static public function registerFieldForMigration($table, $field, $migrationField, $oldFieldName, $typeField = NULL, array $types = array()) {

        if (array_search($migrationField, static::$availableMigrationFields) === FALSE) {
            throw new \InvalidArgumentException('The value for $migrationField is invalid. Valid values can be found in the $availableMigrationFields array.', 1377600978);
        }

        self::$migrateFields[$table][$field][$migrationField] = $oldFieldName;

        if (isset($typeField) && (count($types) > 0)) {
            self::$migrateFields[$table][$field]['__typeMatch']['types'] = $types;
            self::$migrateFields[$table][$field]['__typeMatch']['typeField'] = (string)$typeField;
        }
    }

    static protected function fieldIsInType($fieldName, $table, array $row) {
        $fieldConfiguration = static::$migrateFields[$table][$fieldName];
        if (empty($fieldConfiguration['__typeMatch'])) {
            return TRUE;
        } else {
            return in_array($row[$fieldConfiguration['__typeMatch']['typeField']], $fieldConfiguration['__typeMatch']['types']);
        }
    }

    static protected function getPageRepository() {
        return $GLOBALS['TSFE']->sys_page;
    }

}