Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Reader
        1. AbstractReader
        2. Binary
        3. Exception
        4. File
        5. FilePath
        6. MaxFile
        7. MaxFileHandler
        8. ReaderInterface
        9. Stream
        10. String

SetaPDF_Core_Reader_Binary Class representing a binary reader

File: /SetaPDF v2/Core/Reader/Binary.php

Class hierarchy

Summary

Methods

Properties

Constants

Constants

BYTE_ORDER_BIG_ENDIAN

public const string SetaPDF_Core_Reader_Binary::BYTE_ORDER_BIG_ENDIAN = 'bigEndian'

Big endian byte order

BYTE_ORDER_LITTLE_ENDIAN

public const string SetaPDF_Core_Reader_Binary::BYTE_ORDER_LITTLE_ENDIAN = 'littleEndian'

Little endian byte order


Properties

$_reader

protected SetaPDF_Core_Reader_ReaderInterface SetaPDF_Core_Reader_Binary::$_reader

The main reader instance


Methods

__construct()

public SetaPDF_Core_Reader_Binary::__construct ()

The constructor.

Parameters
$reader : SetaPDF_Core_Reader_ReaderInterface
 

cleanUp()

public SetaPDF_Core_Reader_Binary::cleanUp (
void
): void

Release resources/cycled references.

getReader()

public SetaPDF_Core_Reader_Binary::getReader (
void
): SetaPDF_Core_Reader_ReaderInterface

Get the reader.

readByte()

public SetaPDF_Core_Reader_Binary::readByte (
[ integer $pos = null ]
): string|boolean

Read a single byte.

Parameters
$pos : integer
 

readBytes()

public SetaPDF_Core_Reader_Binary::readBytes (
integer $length [, integer $pos = null ]
): string|boolean

Read a specific amount of bytes.

Parameters
$length : integer
 
$pos : integer
 

readInt16()

public SetaPDF_Core_Reader_Binary::readInt16 (
[ integer|null $pos = null [, string $byteOrder = SetaPDF_Core_Reader_Binary::BYTE_ORDER_BIG_ENDIAN ]]
): integer

Reads a 16-bit signed integer.

Parameters
$pos : integer|null
 
$byteOrder : string
 

readInt32()

public SetaPDF_Core_Reader_Binary::readInt32 (
[ integer|null $pos = null [, string $byteOrder = SetaPDF_Core_Reader_Binary::BYTE_ORDER_BIG_ENDIAN ]]
): mixed

Reads a 32-bit signed integer.

Parameters
$pos : integer|null
 
$byteOrder : string
 

readInt8()

public SetaPDF_Core_Reader_Binary::readInt8 (
[ integer|null $pos = null ]
): integer

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

Parameters
$pos : integer|null
 

readUInt16()

public SetaPDF_Core_Reader_Binary::readUInt16 (
[ integer|null $pos = null [, string $byteOrder = SetaPDF_Core_Reader_Binary::BYTE_ORDER_BIG_ENDIAN ]]
): integer

Reads a 16-bit unsigned integer.

Parameters
$pos : integer|null
 
$byteOrder : string
 

readUInt32()

public SetaPDF_Core_Reader_Binary::readUInt32 (
[ integer|null $pos = null [, string $byteOrder = SetaPDF_Core_Reader_Binary::BYTE_ORDER_BIG_ENDIAN ]]
): mixed

Reads a 32-bit unsigned integer.

Parameters
$pos : integer|null
 
$byteOrder : string
 

readUInt8()

public SetaPDF_Core_Reader_Binary::readUInt8 (
[ integer|null $pos = null ]
): integer

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

Parameters
$pos : integer|null
 

reset()

public SetaPDF_Core_Reader_Binary::reset (
integer $position, integer $length
): void

Reset the reader to a specific position.

Parameters
$position : integer
 
$length : integer
 

seek()

public SetaPDF_Core_Reader_Binary::seek (
integer $position
): void

Seek to a position.

Parameters
$position : integer
 

skip()

public SetaPDF_Core_Reader_Binary::skip (
integer $length
): void

Skip a specific byte count.

Parameters
$length : integer
 

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