CommaSeparatedValueProcessor.php

Go to the documentation of this file.

<?php
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Frontend\DataProcessing;
 
use ‪TYPO3\CMS\Core\Utility\CsvUtility;
use ‪TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
use ‪TYPO3\CMS\Frontend\ContentObject\DataProcessorInterface;
 
class ‪CommaSeparatedValueProcessor implements ‪DataProcessorInterface
{
    public function ‪process(‪ContentObjectRenderer $cObj, array $contentObjectConfiguration, array $processorConfiguration, array $processedData)
    {
        if (isset($processorConfiguration['if.']) && !$cObj->‪checkIf($processorConfiguration['if.'])) {
            return $processedData;
        }
 
        // The field name to process
        $fieldName = $cObj->‪stdWrapValue('fieldName', $processorConfiguration);
        if (empty($fieldName)) {
            return $processedData;
        }
 
        $originalValue = (string)$cObj->data[$fieldName];
 
        // Set the target variable
        $targetVariableName = $cObj->‪stdWrapValue('as', $processorConfiguration, $fieldName);
 
        // Set the maximum amount of columns
        $maximumColumns = $cObj->‪stdWrapValue('maximumColumns', $processorConfiguration, 0);
 
        // Set the field delimiter which is "," by default
        $fieldDelimiter = (string)$cObj->‪stdWrapValue('fieldDelimiter', $processorConfiguration, ',');
 
        // Set the field enclosure which is " by default
        $fieldEnclosure = (string)$cObj->‪stdWrapValue('fieldEnclosure', $processorConfiguration, '"');
 
        $processedData[$targetVariableName] = ‪CsvUtility::csvToArray(
            $originalValue,
            $fieldDelimiter,
            $fieldEnclosure,
            (int)$maximumColumns
        );
 
        return $processedData;
    }
}