This class provides the data size with additional information to remove the work to calculate the size to different unit like GiB, GB usw. More...

Collaboration diagram for ILIAS\Data\DataSize:

Public Member Functions
	__construct (int $size, int $unit)
	DataSize constructor. More...

	getSize ()
	The calculated data size. More...

	getUnit ()
	The unit which equals the class constant used to calculate the data size. More...

	inBytes ()
	Get the size in bytes. More...

	__toString ()
	Returns the data size in a human readable manner. More...

Data Fields
const	Byte = 1

const	KiB = 1024

const	MiB = 1_048_576

const	GiB = 1_073_741_824

const	TiB = 1_099_511_627_776

const	KB = 1000

const	MB = 1_000_000

const	GB = 1_000_000_000

const	TB = 1_000_000_000_000

Static Public Attributes
static array	$abbreviations

Private Member Functions
	mapUnitToSuffix (int $unit)

Private Attributes
const	SIZE_FACTOR = 1000

const	PRECISION = 2

static array float	$size

int	$unit

string	$suffix

Detailed Description

This class provides the data size with additional information to remove the work to calculate the size to different unit like GiB, GB usw.

Author: Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 30 of file DataSize.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Data\DataSize::__construct	(	int	$size,
		int	$unit
	)

DataSize constructor.

Parameters

int	$size	The data size in bytes.
int	$unit	The unit which is used to calculate the data size.

Exceptions

Definition at line 85 of file DataSize.php.

References ILIAS\Data\DataSize\$unit, and ILIAS\Data\DataSize\mapUnitToSuffix().

     {
         $this->suffix = $this->mapUnitToSuffix($unit);
         $this->size = (float) $size / (float) $unit; // the div operation can return int and float
         $this->unit = $unit;
     }

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

ILIAS\Data\DataSize::__toString ( )

Returns the data size in a human readable manner.

Example output: 950 B 3922 GB

Definition at line 144 of file DataSize.php.

References ILIAS\Data\DataSize\Byte, ILIAS\Data\DataSize\GB, ILIAS\Data\DataSize\inBytes(), ILIAS\Data\DataSize\KB, ILIAS\Data\DataSize\mapUnitToSuffix(), ILIAS\Data\DataSize\MB, and ILIAS\Data\DataSize\TB.

                                 : string
     {
         $size = $this->inBytes();
         // can be switched to match in ILIAS 9
         switch (true) {
             case $size > self::SIZE_FACTOR * self::SIZE_FACTOR * self::SIZE_FACTOR * self::SIZE_FACTOR:
                 $unit = DataSize::TB;
                 break;
             case $size > self::SIZE_FACTOR * self::SIZE_FACTOR * self::SIZE_FACTOR:
                 $unit = DataSize::GB;
                 break;
             case $size > self::SIZE_FACTOR * self::SIZE_FACTOR:
                 $unit = DataSize::MB;
                 break;
             case $size > self::SIZE_FACTOR:
                 $unit = DataSize::KB;
                 break;
             default:
                 $unit = DataSize::Byte;
                 break;
         }
 
         $size = round($size / (float) $unit, self::PRECISION);
 
         return "$size " . $this->mapUnitToSuffix($unit);
     }

Here is the call graph for this function:

◆ getSize()

ILIAS\Data\DataSize::getSize ( )

The calculated data size.

Definition at line 119 of file DataSize.php.

References ILIAS\Data\DataSize\$size.

Referenced by ILIAS\Filesystem\FilesystemFacade\getSize(), and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess\getSize().

                              : float
     {
         return $this->size;
     }

Here is the caller graph for this function:

◆ getUnit()

ILIAS\Data\DataSize::getUnit ( )

The unit which equals the class constant used to calculate the data size.

(self::GiB, ...)

Definition at line 126 of file DataSize.php.

References ILIAS\Data\DataSize\$unit.

                              : int
     {
         return $this->unit;
     }

◆ inBytes()

ILIAS\Data\DataSize::inBytes ( )

Get the size in bytes.

Definition at line 133 of file DataSize.php.

References ILIAS\Data\DataSize\$unit.

Referenced by ILIAS\Data\DataSize\__toString().

                              : float
     {
         return $this->size * $this->unit;
     }

Here is the caller graph for this function:

◆ mapUnitToSuffix()

ILIAS\Data\DataSize::mapUnitToSuffix ( int $unit )

private

Definition at line 91 of file DataSize.php.

Referenced by ILIAS\Data\DataSize\__construct(), and ILIAS\Data\DataSize\__toString().

                                                : string
     {
         switch ($unit) {
             case self::Byte:
                 return 'B';
             case self::KiB:
                 return 'KiB';
             case self::MiB:
                 return 'MiB';
             case self::GiB:
                 return 'GiB';
             case self::TiB:
                 return 'TiB';
             case self::KB:
                 return 'KB';
             case self::MB:
                 return 'MB';
             case self::GB:
                 return 'GB';
             case self::TB:
                 return 'TB';
             default:
                 throw new \InvalidArgumentException('The given data size unit is not valid, please check the provided class constants of the DataSize class.');
         }
     }

Here is the caller graph for this function:

Field Documentation

◆ $abbreviations

array ILIAS\Data\DataSize::$abbreviations

static

Initial value:

= [

'B' => self::Byte

Definition at line 53 of file DataSize.php.

Referenced by ILIAS\Data\Factory\dataSize().

◆ $size

array float ILIAS\Data\DataSize::$size

private

Initial value:

=> self::KB,
        'K' => self::KiB,
        'k' => self::KiB,
        'KiB' => self::KiB,
        'MB' => self::MB,
        'M' => self::MiB,
        'm' => self::MiB,
        'MiB' => self::MiB,
        'GB' => self::GB,
        'G' => self::GiB,
        'g' => self::GiB,
        'GiB' => self::GiB,
        'TB' => self::TB,
        'TiB' => self::TiB,
    ]