SetaPDF_Core_Reader_AbstractReader An abstract reader class

File: /SetaPDF/Core/Reader/AbstractReader.php

Class hierarchy

Summary

Properties

$_buffer

The current buffer

$_length

The length of the buffer

$_offset

The offset to the current position

$_pos

The current file position

$_totalLength

The total length


Methods

addOffset()

public void SetaPDF_Core_Reader_AbstractReader::addOffset ( integer $offset )

Add an offset to the current offset.

Parameters
$offset : integer
 

ensureContent()

public boolean SetaPDF_Core_Reader_AbstractReader::ensureContent ( void )

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

getBuffer()

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

Returns the current buffer.

Parameters
$atOffset : boolean
 

getByte()

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

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 int SetaPDF_Core_Reader_AbstractReader::getLength ( [ boolean $atOffset = false ] )

Returns the byte length of the buffer.

Parameters
$atOffset : boolean
 

getOffset()

public integer SetaPDF_Core_Reader_AbstractReader::getOffset ( void )

Returns the current offset of the current position.

getPos()

public int SetaPDF_Core_Reader_AbstractReader::getPos ( void )

Get the current position of the pointer.

readByte()

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

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 string SetaPDF_Core_Reader_AbstractReader::readBytes ( integer $length [, integer $pos = null ] )

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 string SetaPDF_Core_Reader_AbstractReader::readLine ( [ integer $length = 1024 ] )

Read a line from the current position.

Parameters
$length : integer
 

setOffset()

public void SetaPDF_Core_Reader_AbstractReader::setOffset ( int $offset )

Set the offset position.

Parameters
$offset : int
 
Exceptions

Throws SetaPDF_Core_Reader_Exception