API Documentation
\

\Horde_View_Helper_Number

View helpers for numbers.

All helpers hold a link back to the instance of the view. The undefined property handlers (get()/call() methods) are used to mix helpers together, effectively placing them on the same pane of glass (the view) and allowing any helper to call any other.

Summary

Methods
Properties
Constants
__construct()
__get()
__set()
__call()
numberToHumanSize()
No public properties found
No constants found
No protected methods found
$_view
N/A
No private methods found
No private properties found
N/A

Properties

$_view

$_view : \Horde_View

The parent view invoking the helper.

Type

\Horde_View

Methods

__construct()

__construct(\Horde_View  $view)

Creates a helper for $view.

Parameters

\Horde_View $view

The view to help.

__get()

__get(  $name)

Proxy on undefined property access (get).

Parameters

$name

__set()

__set(  $name,   $value)

Proxy on undefined property access (set).

Parameters

$name
$value

__call()

__call(string  $method, array  $args) : mixed

Call chaining so members of the view can be called (including other helpers).

Parameters

string $method

The method.
array $args

The parameters for the method.

Returns

mixed —

The result of the method.

numberToHumanSize()

numberToHumanSize(integer|float  $size,   $precision = 1) : string

Formats the bytes in $size into a more understandable representation.

Useful for reporting file sizes to users. This method returns NULL if $size cannot be converted into a number. You can change the default precision of 1 in $precision.

$this->numberToHumanSize(123)           => 123 Bytes
$this->numberToHumanSize(1234)          => 1.2 KB
$this->numberToHumanSize(12345)         => 12.1 KB
$this->numberToHumanSize(1234567)       => 1.2 MB
$this->numberToHumanSize(1234567890)    => 1.1 GB
$this->numberToHumanSize(1234567890123) => 1.1 TB
$this->numberToHumanSize(1234567, 2)    => 1.18 MB

Parameters

integer|float $size

Size to format.
$precision

Returns

string —

Formatted size value.