SetaPDF_Core_Reader_File Class for a file reader
File: /SetaPDF v2/Core/Reader/File.php
Class hierarchy
Implements
Summary
Methods
- __construct()
- __destruct()
- __sleep()
- __wakeup()
- _closeFile()
- _openFile()
- _setFilename()
- _setStream()
- addOffset()
- cleanUp()
- copyTo()
- ensure()
- ensureContent()
- getBuffer()
- getByte()
- getFilename()
- getLength()
- getOffset()
- getPos()
- getStream()
- getTotalLength()
- increaseLength()
- readByte()
- readBytes()
- readLine()
- reset()
- setOffset()
Properties
$_stream
The stream resource
$_totalLength
The total length
Methods
__sleep()
__wakeup()
_setStream()
copyTo()
ensure()
Ensures bytes in the buffer with a specific length and location in the file.
Parameters
- $pos : int
- $length : int
See
ensureContent()
Make sure that there is at least one character beyond the current offset in the buffer.
getByte()
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
readByte()
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()
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
reset()
Resets the buffer to a specific position and reread the buffer with the given length.
If the $pos is negative the start buffer position will be the $pos'th position from the end of the file.
If the $pos is negative and the absolute value is bigger then the totalLength of the file $pos will set to zero.
Parameters
- $pos : int|null
Start position of the new buffer
- $length : int
Length of the new buffer. Mustn't be negative