Index

  1. \setasign\SetaPDF2
    1. Core
      1. BitConverter
      2. Canvas
      3. ColorSpace
      4. Core
      5. DataStructure
      6. Document
      7. Document
      8. EmbeddedFileStream
      9. Encoding
      10. Exception
      11. FileSpecification
      12. Filter
      13. Font
      14. Geometry
      15. IccProfile
      16. Image
      17. OutputIntent
      18. PageBoundaries
      19. PageFormats
      20. Parser
      21. Reader
      22. Resource
      23. SecHandler
      24. Text
      25. Tokenizer
      26. TransparencyGroup
      27. Type
      28. Writer
      29. XObject
      30. Xmp
      31. Zugferd

setasign\SetaPDF2\Core

BitConverter A class that allows you to convert base data types to bytes and vice versa.

File: /SetaPDF v2/Core/BitConverter.php
Old class name (alias): \SetaPDF_Core_BitConverter

Class hierarchy

Summary

Static Methods

Static Properties

Constants

Constants

BYTE

public const BitConverter::BYTE = 'UInt8'

BYTE_ORDER_BIG_ENDIAN

public const string BitConverter::BYTE_ORDER_BIG_ENDIAN = 'bigEndian'

Constant for big endian byte order.

BYTE_ORDER_LITTLE_ENDIAN

public const string BitConverter::BYTE_ORDER_LITTLE_ENDIAN = 'littleEndian'

Constant for little endian byte order.

CHAR

public const BitConverter::CHAR = 'Int8'

FIXED

public const BitConverter::FIXED = 'Fixed'

INT16

public const BitConverter::INT16 = 'Int16'

INT32

public const BitConverter::INT32 = 'Int32'

INT8

public const BitConverter::INT8 = 'Int8'

LONG

public const BitConverter::LONG = 'Int32'

SHORT

public const BitConverter::SHORT = 'Int16'

UINT16

public const BitConverter::UINT16 = 'UInt16'

UINT32

public const BitConverter::UINT32 = 'UInt32'

UINT8

public const BitConverter::UINT8 = 'UInt8'

ULONG

public const BitConverter::ULONG = 'UInt32'

USHORT

public const BitConverter::USHORT = 'UInt16'

Static Properties

$_machineByteOrder

static protected string BitConverter::$_machineByteOrder

The machine byte order.


Static Methods

formatFromFixed()

public static BitConverter::formatFromFixed (
string $bytes
): float

Reads a 32-bit signed fixed-point number.

Parameters
$bytes : string
 

formatFromInt()

public static BitConverter::formatFromInt (
string $byte,
int $size
): int

Reads a signed integer.

Parameters
$byte : string
 
$size : int
 

formatFromInt16()

public static BitConverter::formatFromInt16 (
string $bytes,
string $byteOrder = BitConverter::BYTE_ORDER_BIG_ENDIAN
): int

Reads a 16-bit signed integer.

Parameters
$bytes : string
 
$byteOrder : string
 

formatFromInt32()

public static BitConverter::formatFromInt32 (
string $bytes,
string $byteOrder = BitConverter::BYTE_ORDER_BIG_ENDIAN
): mixed

Reads a 32-bit signed integer.

Parameters
$bytes : string
 
$byteOrder : string
 

formatFromInt8()

public static BitConverter::formatFromInt8 (
string $byte
): int

Reads a 8-bit/1-byte signed integer.

Parameters
$byte : string
 

formatFromUInt()

public static BitConverter::formatFromUInt (
string $byte,
int $size
): int

Reads an unsigned integer.

Parameters
$byte : string
 
$size : int
 

formatFromUInt16()

public static BitConverter::formatFromUInt16 (
string $bytes,
string $byteOrder = BitConverter::BYTE_ORDER_BIG_ENDIAN
): int

Reads a 16-bit unsigned integer.

Parameters
$bytes : string
 
$byteOrder : string
 

formatFromUInt32()

public static BitConverter::formatFromUInt32 (
string $bytes,
string $byteOrder = BitConverter::BYTE_ORDER_BIG_ENDIAN
): mixed

Reads a 32-bit unsigned integer.

Parameters
$bytes : string
 
$byteOrder : string
 

formatFromUInt8()

public static BitConverter::formatFromUInt8 (
string $byte
): int

Reads a 8-bit/1-byte unsigned integer.

Parameters
$byte : string
 

formatToFixed()

public static BitConverter::formatToFixed (
float $float
): string

Writes a 32-bit signed fixed-point number.

Parameters
$float : float
 

formatToInt()

public static BitConverter::formatToInt (
int $int,
int $size
): string

Writes a signed integer.

Parameters
$int : int
 
$size : int
 

formatToInt16()

public static BitConverter::formatToInt16 (
int $int,
string $byteOrder = BitConverter::BYTE_ORDER_BIG_ENDIAN
): string

Writes a 16-bit signed integer.

Parameters
$int : int
 
$byteOrder : string
 

formatToInt32()

public static BitConverter::formatToInt32 (
int $int,
string $byteOrder = BitConverter::BYTE_ORDER_BIG_ENDIAN
): string

Writes a 32-bit signed integer.

Parameters
$int : int
 
$byteOrder : string
 

formatToInt8()

public static BitConverter::formatToInt8 (
int $int
): string

Writes a 8-bit/1-byte signed integer.

Parameters
$int : int
 

formatToUInt()

public static BitConverter::formatToUInt (
int $int,
int $size
): string

Writes an unsigned integer.

Parameters
$int : int
 
$size : int
 

formatToUInt16()

public static BitConverter::formatToUInt16 (
int $int,
string $byteOrder = BitConverter::BYTE_ORDER_BIG_ENDIAN
): string

Writes a 16-bit unsigned integer.

Parameters
$int : int
 
$byteOrder : string
 

formatToUInt32()

public static BitConverter::formatToUInt32 (
int $int,
string $byteOrder = BitConverter::BYTE_ORDER_BIG_ENDIAN
): mixed

Formats a 32-bit unsigned integer.

Parameters
$int : int
 
$byteOrder : string
 

formatToUInt8()

public static BitConverter::formatToUInt8 (
int $int
): string

Writes a 8-bit/1-byte unsigned integer.

Parameters
$int : int
 

getMachineByteOrder()

public static BitConverter::getMachineByteOrder (
void
): string

Get the machine byte order.

getSize()

public static BitConverter::getSize (
string $type
): int

Get the size by a specific type.

Parameters
$type : string
 

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)