93 lines
3.2 KiB
PHP
93 lines
3.2 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* 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\Fluid\ViewHelpers\Format;
|
|
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
|
|
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
|
|
|
|
/**
|
|
* ViewHelper which formats an integer (byte count) into specific human-readable output.
|
|
*
|
|
* ```
|
|
* <f:format.bytes decimals="2" decimalSeparator="." thousandsSeparator=",">{file.size}</f:format.bytes>
|
|
* <f:format.bytes decimals="2" decimalSeparator="." thousandsSeparator="," units="KB,MB,GB" value="{file.size}" />
|
|
* ```
|
|
*
|
|
* @see https://docs.typo3.org/permalink/t3viewhelper:typo3-fluid-format-bytes
|
|
*/
|
|
final class BytesViewHelper extends AbstractViewHelper
|
|
{
|
|
/**
|
|
* Output is escaped already. We must not escape children, to avoid double encoding.
|
|
*
|
|
* @var bool
|
|
*/
|
|
protected $escapeChildren = false;
|
|
|
|
public function initializeArguments(): void
|
|
{
|
|
$this->registerArgument('value', 'int|float|string', 'The incoming data to convert, or NULL if VH children should be used');
|
|
$this->registerArgument('decimals', 'int', 'The number of digits after the decimal point', false, 0);
|
|
$this->registerArgument('decimalSeparator', 'string', 'The decimal point character', false, '.');
|
|
$this->registerArgument('thousandsSeparator', 'string', 'The character for grouping the thousand digits', false, ',');
|
|
$this->registerArgument('units', 'string', 'comma separated list of available units, default is LocalizationUtility::translate(\'viewhelper.format.bytes.units\', \'fluid\')');
|
|
}
|
|
|
|
/**
|
|
* Render the supplied byte count as a human-readable string.
|
|
*/
|
|
public function render(): string
|
|
{
|
|
if ($this->arguments['units'] !== null) {
|
|
$units = $this->arguments['units'];
|
|
} else {
|
|
$units = LocalizationUtility::translate('viewhelper.format.bytes.units', 'fluid');
|
|
}
|
|
$units = GeneralUtility::trimExplode(',', (string)$units, true);
|
|
$value = $this->renderChildren();
|
|
if (is_numeric($value)) {
|
|
$value = (float)$value;
|
|
} else {
|
|
$value = 0;
|
|
}
|
|
$bytes = max($value, 0);
|
|
$pow = floor(($bytes ? log($bytes) : 0) / log(1024));
|
|
$pow = min($pow, count($units) - 1);
|
|
$bytes /= 2 ** (10 * $pow);
|
|
return sprintf(
|
|
'%s %s',
|
|
number_format(
|
|
round($bytes, 4 * $this->arguments['decimals']),
|
|
(int)$this->arguments['decimals'],
|
|
$this->arguments['decimalSeparator'],
|
|
$this->arguments['thousandsSeparator']
|
|
),
|
|
$units[$pow]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Explicitly set argument name to be used as content.
|
|
*/
|
|
public function getContentArgumentName(): string
|
|
{
|
|
return 'value';
|
|
}
|
|
}
|