Zend_Pdf_FileParserDataSource Class Reference

Inheritance diagram for Zend_Pdf_FileParserDataSource:

Public Member Functions
	__destruct ()
	readBytes ($byteCount)
	readAllBytes ()
	__toString ()
	getOffset ()
	getSize ()
	moveToOffset ($offset)
	skipBytes ($byteCount)

Protected Attributes
	$_size = 0
	$_offset = 0

Detailed Description

Definition at line 41 of file FileParserDataSource.php.

Constructor & Destructor Documentation

__destruct()

__destruct ( )

abstract

Object destructor. Closes the data source.

May also perform cleanup tasks such as deleting temporary files.

Member Function Documentation

__toString()

__toString

(

)

Returns a description of the object for debugging purposes.

Subclasses should override this method to provide a more specific description of the actual object being represented.

Returns

string

Definition at line 111 of file FileParserDataSource.php.

    {
        return get_class($this);
    }

getOffset()

getOffset

(

)

Returns the byte offset of the current read position within the data source.

Returns

integer

Definition at line 125 of file FileParserDataSource.php.

    {
        return $this->_offset;
    }

getSize()

getSize

(

)

Returns the total size in bytes of the data source.

Returns

integer

Definition at line 135 of file FileParserDataSource.php.

    {
        return $this->_size;
    }

moveToOffset()

moveToOffset

(

$offset

)

Moves the current read position to the specified byte offset.

Throws an exception you attempt to move before the beginning or beyond the end of the data source.

If a subclass needs to perform additional tasks (such as performing a fseek() on a filesystem source), it should do so after calling this parent method.

Parameters

integer

$offset

Destination byte offset.

Exceptions

Zend_Pdf_Exception

Definition at line 156 of file FileParserDataSource.php.

    {
        if ($this->_offset == $offset) {
            return;    // Not moving; do nothing.
        }
        if ($offset < 0) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Attempt to move before start of data source',
                                         Zend_Pdf_Exception::MOVE_BEFORE_START_OF_FILE);
        }
        if ($offset >= $this->_size) {    // Offsets are zero-based.
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Attempt to move beyond end of data source',
                                         Zend_Pdf_Exception::MOVE_BEYOND_END_OF_FILE);
        }
        $this->_offset = $offset;
    }

readAllBytes()

readAllBytes ( )

abstract

Returns the entire contents of the data source as a string.

This method may be called at any time and so must preserve the byte offset of the read position, both through $this->_offset and whatever other additional pointers (such as the seek position of a file pointer) that might be used.

Returns

string

readBytes()

readBytes (   $byteCount )

abstract

Returns the specified number of raw bytes from the data source at the byte offset of the current read position.

Must advance the read position by the number of bytes read by updating $this->_offset.

Throws an exception if there is insufficient data to completely fulfill the request or if an error occurs.

Parameters

integer

$byteCount

Number of bytes to read.

Returns

string

Exceptions

Zend_Pdf_Exception

skipBytes()

skipBytes

(

$byteCount

)

Shifts the current read position within the data source by the specified number of bytes.

You may move forward (positive numbers) or backward (negative numbers). Throws an exception you attempt to move before the beginning or beyond the end of the data source.

Parameters

integer

$byteCount

Number of bytes to skip.

Exceptions

Zend_Pdf_Exception

Definition at line 185 of file FileParserDataSource.php.

    {
        $this->moveToOffset($this->_offset + $byteCount);
    }

Field Documentation

$_offset

$_offset = 0

protected

Definition at line 56 of file FileParserDataSource.php.

$_size

$_size = 0

protected

Definition at line 50 of file FileParserDataSource.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Pdf/FileParserDataSource.php