1. class
  2. Neos
  3. \
  4. FluidAdaptor
  5. \
  6. ViewHelpers
  7. \
  8. Format
  9. \
  10. BytesViewHelper

BytesViewHelper

class BytesViewHelper extends AbstractLocaleAwareViewHelper (View source)

Formats an integer with a byte count into human-readable form.

= Examples =

{fileSize -> f:format.bytes()}

<output>
123 KB
// depending on the value of {fileSize}
</output>

<code title="With all parameters">
{fileSize -> f:format.bytes(decimals: 2, decimalSeparator: ',', thousandsSeparator: ',')}
1,023.00 B // depending on the value of {fileSize}

{fileSize -> f:format.bytes(forceLocale: true)}

<output>
6.543,21 KB
// depending on the value of {fileSize} and the current locale
</output>

<code title="Inline notation with specific locale used">
{fileSize -> f:format.bytes(forceLocale: 'de_CH')}
1'337.42 MB // depending on the value of {fileSize}

Constants

protected SIZE_UNITS

Supported file size units

Properties

protected ControllerContext $controllerContext

Controller Context to use

 from  AbstractViewHelper
protected ObjectManagerInterface $objectManager from  AbstractViewHelper
protected LoggerInterface $logger from  AbstractViewHelper
protected Service $localizationService from  AbstractLocaleAwareViewHelper
protected NumberFormatter $numberFormatter

Methods

void
setRenderingContext(RenderingContextInterface $renderingContext)

No description

from  AbstractViewHelper
void
injectObjectManager(ObjectManagerInterface $objectManager)

No description

from  AbstractViewHelper
void
injectLogger(LoggerInterface $logger)

Injects the (system) logger based on PSR-3.

from  AbstractViewHelper
bool
isEscapingInterceptorEnabled()

No description

from  AbstractViewHelper
__construct()

Constructor

from  AbstractLocaleAwareViewHelper
injectLocalizationService(Service $localizationService)

No description

from  AbstractLocaleAwareViewHelper
Locale
getLocale()

Get the locale to use for all locale specific functionality.

from  AbstractLocaleAwareViewHelper
static array
maximizeUnit(float $bytes)

No description

void
initializeArguments()

Initialize the arguments.

string
render()

Render the supplied byte count as a human readable string.

Details

in AbstractViewHelper at line 52
void setRenderingContext(RenderingContextInterface $renderingContext)

No description

Parameters

RenderingContextInterface $renderingContext

Return Value

void

in AbstractViewHelper at line 65
void injectObjectManager(ObjectManagerInterface $objectManager)

No description

Parameters

ObjectManagerInterface $objectManager

Return Value

void

in AbstractViewHelper at line 76
void injectLogger(LoggerInterface $logger)

Injects the (system) logger based on PSR-3.

Parameters

LoggerInterface $logger

Return Value

void

in AbstractViewHelper at line 84
bool isEscapingInterceptorEnabled()

No description

Return Value

bool

in AbstractLocaleAwareViewHelper at line 34
__construct()

Constructor

in AbstractLocaleAwareViewHelper at line 42
injectLocalizationService(Service $localizationService)

No description

Parameters

Service $localizationService

in AbstractLocaleAwareViewHelper at line 53
protected Locale getLocale()

Get the locale to use for all locale specific functionality.

Return Value

Locale

The locale to use or NULL if locale should not be used

Exceptions

InvalidVariableException

at line 77
static protected array maximizeUnit(float $bytes)

No description

Parameters

float $bytes

Return Value

array

at line 96
void initializeArguments()

Initialize the arguments.

Return Value

void

at line 118
string render()

Render the supplied byte count as a human readable string.

Return Value

string

Formatted byte count

Exceptions

Exception