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_MaxFile Class for a file reader respecting the maximum allowed open file handles/descriptors.

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

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_buffer

protected string SetaPDF_Core_Reader_AbstractReader::$_buffer = ''

The current buffer

$_filename

protected string SetaPDF_Core_Reader_File::$_filename = ''

The filename

$_handler

protected SetaPDF_Core_Reader_MaxFileHandler SetaPDF_Core_Reader_MaxFile::$_handler

The handler instance

$_length

protected int SetaPDF_Core_Reader_AbstractReader::$_length = 0

The length of the buffer

$_offset

protected int SetaPDF_Core_Reader_AbstractReader::$_offset = 0

The offset to the current position

$_pos

public int SetaPDF_Core_Reader_AbstractReader::$_pos = 0

The current file position

$_sleepPosition

protected integer SetaPDF_Core_Reader_MaxFile::$_sleepPosition = 0

The position of the point before sleep() was called

$_sleeping

protected boolean SetaPDF_Core_Reader_MaxFile::$_sleeping = true

Defines if the reader is sleeping

$_stream

protected resource SetaPDF_Core_Reader_Stream::$_stream

The stream resource

$_totalLength

protected int SetaPDF_Core_Reader_AbstractReader::$_totalLength

The total length


Methods

__construct()

public SetaPDF_Core_Reader_MaxFile::__construct (
string $filename [, SetaPDF_Core_Reader_MaxFileHandler|null $handler = null ]
)

The constructor.

Parameters
$filename : string
 
$handler : SetaPDF_Core_Reader_MaxFileHandler|null

The handler to which this instance should be bound and notify when opening closing file handles.

Exceptions

Throws SetaPDF_Core_Reader_Exception

__destruct()

public SetaPDF_Core_Reader_Stream::__destruct (
void
): void

The destruct method.

See

__sleep()

public SetaPDF_Core_Reader_MaxFile::__sleep (
void
): array

Implementation of the __sleep() method.

Exceptions

Throws BadMethodCallException

__wakeup()

public SetaPDF_Core_Reader_File::__wakeup (
void
): void

Wakeup method.

Exceptions

Throws SetaPDF_Core_Reader_Exception

See

_closeFile()

protected SetaPDF_Core_Reader_MaxFile::_closeFile (
void
): void

Closes the file handle.

_openFile()

protected SetaPDF_Core_Reader_MaxFile::_openFile (
string $filename
): resource

Opens the file.

Parameters
$filename : string
 

_setFilename()

protected SetaPDF_Core_Reader_File::_setFilename (
string $filename
): void

Set the filename.

Parameters
$filename : string
 
Exceptions

Throws SetaPDF_Core_Reader_Exception

_setStream()

protected SetaPDF_Core_Reader_Stream::_setStream (
resource $stream
): void

Set the stream.

Parameters
$stream : resource
 
Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Reader_Exception

addOffset()

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

Add an offset to the current offset.

Parameters
$offset : integer
 
Exceptions

Throws SetaPDF_Core_Reader_Exception

cleanUp()

public SetaPDF_Core_Reader_MaxFile::cleanUp (
void
): void

Release memory/cylced references.

copyTo()

public SetaPDF_Core_Reader_MaxFile::copyTo (): void

Copies the complete content to a writer instance.

Parameters
$writer : SetaPDF_Core_WriteInterface
 
Exceptions

Throws SetaPDF_Core_Reader_Exception

ensure()

public SetaPDF_Core_Reader_AbstractReader::ensure (
int $pos, int $length
): void

Ensures bytes in the buffer with a specific length and location in the file.

Parameters
$pos : int
 
$length : int
 
See

ensureContent()

public SetaPDF_Core_Reader_AbstractReader::ensureContent (
void
): boolean

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
 

getFilename()

public SetaPDF_Core_Reader_File::getFilename (
void
): string

Returns the filename.

getHandler()

public SetaPDF_Core_Reader_MaxFile::getHandler (
[ boolean $check = true ]
): SetaPDF_Core_Reader_MaxFileHandler

Returns the handler instance.

Parameters
$check : boolean
 

getLength()

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

Returns the byte length of the buffer.

Parameters
$atOffset : boolean
 

getOffset()

public SetaPDF_Core_Reader_AbstractReader::getOffset (
void
): integer

Returns the current offset of the current position.

getPos()

public SetaPDF_Core_Reader_AbstractReader::getPos (
void
): int

Get the current position of the pointer.

getStream()

public SetaPDF_Core_Reader_Stream::getStream (
void
): resource

Returns the stream.

getTotalLength()

public SetaPDF_Core_Reader_MaxFile::getTotalLength (
void
): int

Gets the total available length.

Exceptions

Throws SetaPDF_Core_Reader_Exception

increaseLength()

public SetaPDF_Core_Reader_MaxFile::increaseLength (
[ int $minLength = 100 ]
): boolean

Forcefully read more data into the buffer.

Parameters
$minLength : int
 
Exceptions

Throws SetaPDF_Core_Reader_Exception

isSleeping()

public SetaPDF_Core_Reader_MaxFile::isSleeping (
void
): boolean

Checks if the reader is sleeping.

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|boolean

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|false

Read a line from the current position.

Parameters
$length : integer
 
Exceptions

Throws SetaPDF_Core_Reader_Exception

reset()

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

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

Exceptions

Throws SetaPDF_Core_Reader_Exception

setHandler()

public SetaPDF_Core_Reader_MaxFile::setHandler (
[ SetaPDF_Core_Reader_MaxFileHandler|null $handler = null ]
): void

Set a handler.

Parameters
$handler : SetaPDF_Core_Reader_MaxFileHandler|null
 

setOffset()

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

Set the offset position.

Parameters
$offset : int
 
Exceptions

Throws SetaPDF_Core_Reader_Exception

sleep()

public SetaPDF_Core_Reader_MaxFile::sleep (
void
): void

Set the reader into sleep-state.

In this implementation the file handles will be closed to avoid reaching the limit of open file handles.

See

wakeUp()

public SetaPDF_Core_Reader_MaxFile::wakeUp (
void
): boolean

Wake up the reader if it is in sleep-state.

Re-open the file handle.

Exceptions

Throws SetaPDF_Core_Reader_Exception

See

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