Fab\Vidi\ViewHelpers\Result\AbstractToFormatViewHelper

Complexity

Total Complexity

15

Size/Duplication

Total Lines	172
Duplicated Lines	9.3 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	writeZipFile()	0	16	2
A	initializeEnvironment()	0	16	1
A	collectFiles()	0	9	3
A	hasCollectedFiles()	0	4	1
A	hasFileFields()	0	4	1
A	checkWhetherObjectMayIncludeFiles()	0	12	4
A	sendZipHttpHeaders()	15	15	1
A	getRowsView()	0	4	1
A	getDatabaseConnection()	0	4	1

<?php
namespace Fab\Vidi\ViewHelpers\Result;

/*
 * This file is part of the Fab/Vidi project under GPLv2 or later.
 *
 * For the full copyright and license information, please read the
 * LICENSE.md file that was distributed with this source code.
 */

use Fab\Vidi\Tca\FieldType;
use Fab\Vidi\View\Grid\Rows;
use TYPO3\CMS\Core\Resource\File;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use Fab\Vidi\Domain\Model\Content;
use Fab\Vidi\Service\FileReferenceService;
use Fab\Vidi\Tca\Tca;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;

/**
 * Abstract View helper for rendering an Export request.
 */
abstract class AbstractToFormatViewHelper extends AbstractViewHelper
{

    /**
     * Store fields of type "file".
     *
     * @var array
     */
    protected $fileTypeProperties = [];

    /**
     * @var File[]
     */
    protected $collectedFiles = [];

    /**
     * @var string
     */
    protected $exportFileNameAndPath;

    /**
     * @var string
     */
    protected $zipFileNameAndPath;

    /**
     * @var string
     */
    protected $temporaryDirectory;


    /**
     * Write the zip file to a temporary location.
     *
     * @return void
     * @throws \RuntimeException
     */
    protected function writeZipFile()
    {

        $zip = new \ZipArchive();
        $zip->open($this->zipFileNameAndPath, \ZipArchive::CREATE);

        // Add the CSV content into the zipball.
        $zip->addFile($this->exportFileNameAndPath, basename($this->exportFileNameAndPath));

        // Add the files into the zipball.
        foreach ($this->collectedFiles as $file) {
            $zip->addFile($file->getForLocalProcessing(false), $file->getIdentifier());
        }

        $zip->close();
    }

    /**
     * Initialize some properties
     *
     * @param array $objects
     * @return void
     */
    protected function initializeEnvironment(array $objects)
    {

        /** @var \Fab\Vidi\Domain\Model\Content $object */
        $object = reset($objects);

        $this->temporaryDirectory = PATH_site . 'typo3temp/' . uniqid() . '/';
        GeneralUtility::mkdir($this->temporaryDirectory);

        // Compute file name and path variable
        $this->exportFileNameAndPath = $this->temporaryDirectory . $object->getDataType() . '-' . date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy']);

        // Compute file name and path variable for zip
        $zipFileName = $object->getDataType() . '-' . date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy']) . '.zip';
        $this->zipFileNameAndPath = $this->temporaryDirectory . $zipFileName;
    }

    /**
     * Fetch the files given an object.
     *
     * @param \Fab\Vidi\Domain\Model\Content $object
     * @return void
     */
    protected function collectFiles(Content $object)
    {
        foreach ($this->fileTypeProperties as $property) {
            $files = FileReferenceService::getInstance()->findReferencedBy($property, $object);
            foreach ($files as $file) {
                $this->collectedFiles[$file->getUid()] = $file;
            }
        }
    }

    /**
     * Tells whether the object has fields containing files.
     *
     * @return boolean
     */
    protected function hasCollectedFiles()
    {
        return !empty($this->collectedFiles);
    }

    /**
     * Tells whether the object has fields containing files.
     *
     * @return boolean
     */
    protected function hasFileFields()
    {
        return !empty($this->fileTypeProperties);
    }

    /**
     * Check whether the given object is meant to include files in some fields.
     *
     * @param Content $object
     * @return void
     * @throws \Fab\Vidi\Exception\NotExistingClassException
     */
    protected function checkWhetherObjectMayIncludeFiles(Content $object)
    {
        if (Tca::grid($object->getDataType())->areFilesIncludedInExport()) {
            foreach ($object->toFields() as $fieldName) {
                $fieldType = Tca::table($object->getDataType())->field($fieldName)->getType();

                if ($fieldType === FieldType::FILE) {
                    $this->fileTypeProperties[] = GeneralUtility::camelCaseToLowerCaseUnderscored($fieldName);
                }
            }
        }
    }

    /**
     * @return void
     * @throws \InvalidArgumentException
     * @throws \TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException
     */
    protected function sendZipHttpHeaders()

This method seems to be duplicated in your project.

    {
        /** @var \TYPO3\CMS\Extbase\Mvc\Web\Response $response */
        $response = $this->templateVariableContainer->get('response');
        $response->setHeader('Pragma', 'public');
        $response->setHeader('Expires', '0');
        $response->setHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0');
        $response->setHeader('Content-Type', 'application/zip');
        $response->setHeader('Content-Disposition', 'attachment; filename="' . basename($this->zipFileNameAndPath) . '"');
        $response->setHeader('Content-Length', filesize($this->zipFileNameAndPath));
        $response->setHeader('Content-Description', 'File Transfer');
        $response->setHeader('Content-Transfer-Encoding', 'binary');

        $response->sendHeaders();
    }

    /**
     * @return Rows|object
     */
    protected function getRowsView()
    {
        return GeneralUtility::makeInstance(Rows::class);
    }

    /**
     * Returns a pointer to the database.
     *
     * @return \Fab\Vidi\Database\DatabaseConnection
     */
    protected function getDatabaseConnection()
    {
        return $GLOBALS['TYPO3_DB'];
    }
}