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

/*
 * 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\CompileWithRenderStatic;
use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
use FluidTYPO3\Vhs\Core\ViewHelper\AbstractViewHelper;

/**
 * ### System: Unique ID
 *
 * Returns a unique ID based on PHP's uniqid-function.
 *
 * Comes in useful when handling/generating html-element-IDs
 * for usage with JavaScript.
 */
class UniqIdViewHelper extends AbstractViewHelper
{
    use CompileWithRenderStatic;

    /**
     * @var boolean
     */
    protected $escapeOutput = false;

    public function initializeArguments(): void
    {
        $this->registerArgument(
            'prefix',
            'string',
            'An optional prefix for making sure it\'s unique across environments',
            false,
            ''
        );
        $this->registerArgument(
            'moreEntropy',
            'boolean',
            'Add some pseudo random strings. Refer to uniqid()\'s Reference.',
            false,
            false
        );
    }

    /**
     * @return mixed
     */
    public static function renderStatic(
        array $arguments,
        \Closure $renderChildrenClosure,
        RenderingContextInterface $renderingContext
    ) {
        /** @var string $prefix */
        $prefix = $arguments['prefix'];
        /** @var boolean $moreEntropy */
        $moreEntropy = $arguments['moreEntropy'];
        $uniqueId = uniqid($prefix, $moreEntropy);
        return $uniqueId;
    }
}