<?php
namespace FluidTYPO3\Vhs\ViewHelpers\Resource;

/*
 * This file is part of the FluidTYPO3/Vhs 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 FluidTYPO3\Vhs\Traits\TemplateVariableViewHelperTrait;

/**
 * ViewHelper to output or assign FAL sys_file records.
 */
class FileViewHelper extends AbstractResourceViewHelper
{
    use TemplateVariableViewHelperTrait;

    public function initializeArguments(): void
    {
        parent::initializeArguments();
        $this->registerAsArgument();
        $this->registerArgument(
            'onlyProperties',
            'boolean',
            'Whether to return only the properties array of the sys_file record and not the File object itself',
            false,
            true
        );
    }

    /**
     * @return mixed
     */
    public function render()
    {
        /** @var boolean $onlyProperties */
        $onlyProperties = $this->arguments['onlyProperties'];
        $files = (array) $this->getFiles($onlyProperties);
        if (1 === count($files)) {
            $files = array_shift($files);
        }
        return $this->renderChildrenWithVariableOrReturnInput($files);
    }
}