class Bytes in Drupal 9

Provides helper methods for byte conversions.

Hierarchy

• class \Drupal\Component\Utility\Bytes

11 files declare their use of Bytes

BytesTest.php in core/tests/Drupal/Tests/Component/Utility/BytesTest.php

color.module in core/modules/color/color.module

Allows users to change the color scheme of themes.

common.inc in core/includes/common.inc

Common functions that many Drupal modules will need to reference.

EditorImageDialog.php in core/modules/editor/src/Form/EditorImageDialog.php

FileItem.php in core/modules/file/src/Plugin/Field/FieldType/FileItem.php

... See full list

File

core/lib/Drupal/Component/Utility/Bytes.php, line 8

Namespace

Drupal\Component\Utility

class Bytes {

  /**
   * The number of bytes in a kilobyte.
   *
   * @see http://wikipedia.org/wiki/Kilobyte
   */
  const KILOBYTE = 1024;

  /**
   * The allowed suffixes of a bytes string in lowercase.
   *
   * @see http://wikipedia.org/wiki/Kilobyte
   */
  const ALLOWED_SUFFIXES = [
    '',
    'b',
    'byte',
    'bytes',
    'k',
    'kb',
    'kilobyte',
    'kilobytes',
    'm',
    'mb',
    'megabyte',
    'megabytes',
    'g',
    'gb',
    'gigabyte',
    'gigabytes',
    't',
    'tb',
    'terabyte',
    'terabytes',
    'p',
    'pb',
    'petabyte',
    'petabytes',
    'e',
    'eb',
    'exabyte',
    'exabytes',
    'z',
    'zb',
    'zettabyte',
    'zettabytes',
    'y',
    'yb',
    'yottabyte',
    'yottabytes',
  ];

  /**
   * Parses a given byte size.
   *
   * @param mixed $size
   *   An integer or string size expressed as a number of bytes with optional SI
   *   or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8 bytes, 9mbytes).
   *
   * @return int
   *   An integer representation of the size in bytes.
   *
   * @deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Use \Drupal\Component\Utility\Bytes::toNumber() instead
   *
   * @see https://www.drupal.org/node/3162663
   */
  public static function toInt($size) {
    @trigger_error('\\Drupal\\Component\\Utility\\Bytes::toInt() is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Use \\Drupal\\Component\\Utility\\Bytes::toNumber() instead. See https://www.drupal.org/node/3162663', E_USER_DEPRECATED);
    return self::toNumber($size);
  }

  /**
   * Parses a given byte size.
   *
   * @param int|float|string $size
   *   An integer, float, or string size expressed as a number of bytes with
   *   optional SI or IEC binary unit prefix (e.g. 2, 2.4, 3K, 5MB, 10G, 6GiB,
   *   8 bytes, 9mbytes).
   *
   * @return float
   *   The floating point value of the size in bytes.
   */
  public static function toNumber($size) : float {

    // Remove the non-unit characters from the size.
    $unit = preg_replace('/[^bkmgtpezy]/i', '', $size);

    // Remove the non-numeric characters from the size.
    $size = preg_replace('/[^0-9\\.]/', '', $size);
    if ($unit) {

      // Find the position of the unit in the ordered string which is the power
      // of magnitude to multiply a kilobyte by.
      return round($size * pow(self::KILOBYTE, stripos('bkmgtpezy', $unit[0])));
    }
    else {

      // Ensure size is a proper number type.
      return round((double) $size);
    }
  }

  /**
   * Validate that a string is a representation of a number of bytes.
   *
   * @param string $string
   *   The string to validate.
   *
   * @return bool
   *   TRUE if the string is valid, FALSE otherwise.
   */
  public static function validate($string) : bool {

    // Ensure that the string starts with a numeric character.
    if (!preg_match('/^[0-9]/', $string)) {
      return FALSE;
    }

    // Remove the numeric characters from the beginning of the value.
    $string = preg_replace('/^[0-9\\.]+/', '', $string);

    // Remove remaining spaces from the value.
    $string = trim($string);
    return in_array(strtolower($string), self::ALLOWED_SUFFIXES);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Bytes::ALLOWED_SUFFIXES		constant	The allowed suffixes of a bytes string in lowercase.
Bytes::KILOBYTE		constant	The number of bytes in a kilobyte.
Bytes::toInt Deprecated	public static	function	Parses a given byte size.
Bytes::toNumber	public static	function	Parses a given byte size.
Bytes::validate	public static	function	Validate that a string is a representation of a number of bytes.