SetaPDF_Core_Reader_String Class for a string reader

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

Class hierarchy

Implements

Summary

Properties

$_buffer

protected string SetaPDF_Core_Reader_String::$_buffer = ''

The current buffer

$_length

The length of the buffer

$_offset

The offset to the current position

$_pos

The current file position

$_string

protected string SetaPDF_Core_Reader_String::$_string = ''

The complete string.

$_totalLength

The total length


Methods

__construct()

public SetaPDF_Core_Reader_String::__construct (
string $string
)

The constructor.

Parameters
$string : string
 

__toString()

public SetaPDF_Core_Reader_String::__toString (
void
): string

Returns the complete string.

addOffset()

public SetaPDF_Core_Reader_AbstractReader::addOffset (
integer $offset
): void

Add an offset to the current offset.

Parameters
$offset : integer
 

cleanUp()

public SetaPDF_Core_Reader_String::cleanUp (
void
): void

Implementation of SetaPDF_Core_Reader_ReaderInterface (empty body for this type of reader).

See

copyTo()

Copies the complete content to the writer.

Parameters
$writer : SetaPDF_Core_WriteInterface
 

ensureContent()

Make sure that there is at least one character beyond the current offset in the buffer.

getBuffer()

public SetaPDF_Core_Reader_AbstractReader::getBuffer (
[ boolean $atOffset = true ]
): string

Returns the current buffer.

Parameters
$atOffset : boolean
 

getByte()

public SetaPDF_Core_Reader_AbstractReader::getByte (
[ integer $pos = null ]
): string|boolean

Gets a byte at a specific position.

If the position is invalid the method will return false.

If non position is set $this->_offset will used.

Parameters
$pos : integer
 

getLength()

public SetaPDF_Core_Reader_AbstractReader::getLength (
[ boolean $atOffset = false ]
): int

Returns the byte length of the buffer.

Parameters
$atOffset : boolean
 

getOffset()

Returns the current offset of the current position.

getPos()

Get the current position of the pointer.

getString()

public SetaPDF_Core_Reader_String::getString (
void
): string

Get the complete string.

getTotalLength()

Gets the total available length.

increaseLength()

public SetaPDF_Core_Reader_String::increaseLength (
[ int $minLength = 50000 ]
): boolean;

Forcefully read more data into the buffer.

Parameters
$minLength : int
 

readByte()

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

Returns a byte at a specific position, returns it and set the offset to the next byte position.

If the position is invalid the method will return false.

If non position is set $this->_offset will used.

Parameters
$pos : integer
 

readBytes()

public SetaPDF_Core_Reader_AbstractReader::readBytes (
integer $length [, integer $pos = null ]
): string

Get a specific byte count from the current or at a specific offset position and set the internal pointer to the next byte.

If the position is invalid the method will return false.

If non position is set $this->_offset will used.

Parameters
$length : integer
 
$pos : integer
 

readLine()

public SetaPDF_Core_Reader_AbstractReader::readLine (
[ integer $length = 1024 ]
): string

Read a line from the current position.

Parameters
$length : integer
 

reset()

public SetaPDF_Core_Reader_String::reset (
[ int|null $pos = 0 [, int $length = 100 ]]
): void

Resets the buffer to a specific position and reread the buffer with the given length.

The behavior of the arguments is the same like "substr" ($pos=$start; $length=$length).

Parameters
$pos : int|null

Start position of the new buffer.

$length : int

Length of the new buffer.

See

setOffset()

public SetaPDF_Core_Reader_AbstractReader::setOffset (
int $offset
): void

Set the offset position.

Parameters
$offset : int
 
Exceptions

Throws SetaPDF_Core_Reader_Exception

setString()

public SetaPDF_Core_Reader_String::setString (
string $string
): void

Set the string.

Parameters
$string : string