Zend_Pdf_FileParserDataSource_File Class Reference

Inheritance diagram for Zend_Pdf_FileParserDataSource_File:

Public Member Functions
	__construct ($filePath)
	__destruct ()
	readBytes ($byteCount)
	readAllBytes ()
	__toString ()
	moveToOffset ($offset)
Public Member Functions inherited from Zend_Pdf_FileParserDataSource
	__destruct ()
	readBytes ($byteCount)
	readAllBytes ()
	__toString ()
	getOffset ()
	getSize ()
	moveToOffset ($offset)
	skipBytes ($byteCount)

Protected Attributes
	$_filePath = ''
	$_fileResource = null
Protected Attributes inherited from Zend_Pdf_FileParserDataSource
	$_size = 0
	$_offset = 0

Detailed Description

Definition at line 40 of file File.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$filePath

)

Object constructor.

Validates the path to the file, ensures that it is readable, then opens it for reading.

Throws an exception if the file is missing or cannot be opened.

Parameters

string

$filePath

Fully-qualified path to the file.

Exceptions

Zend_Pdf_Exception

Definition at line 75 of file File.php.

    {
        if (! (is_file($filePath) || is_link($filePath))) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Invalid file path: $filePath",
                                         Zend_Pdf_Exception::BAD_FILE_PATH);
        }
        if (! is_readable($filePath)) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("File is not readable: $filePath",
                                         Zend_Pdf_Exception::NOT_READABLE);
        }
        if (($this->_size = @filesize($filePath)) === false) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Error while obtaining file size: $filePath",
                                         Zend_Pdf_Exception::CANT_GET_FILE_SIZE);
        }
        if (($this->_fileResource = @fopen($filePath, 'rb')) === false) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Cannot open file for reading: $filePath",
                                         Zend_Pdf_Exception::CANT_OPEN_FILE);
        }
        $this->_filePath = $filePath;
    }

__destruct()

__destruct

(

)

Object destructor.

Closes the file if it had been successfully opened.

Definition at line 105 of file File.php.

    {
        if (is_resource($this->_fileResource)) {
            @fclose($this->_fileResource);
        }
    }

Member Function Documentation

__toString()

__toString

(

)

Returns the full filesystem path of the file.

Returns

string

Definition at line 162 of file File.php.

    {
        return $this->_filePath;
    }

moveToOffset()

moveToOffset

(

$offset

)

Seeks the file read position to the specified byte offset.

Throws an exception if the file pointer cannot be moved or if it is moved beyond EOF (end of file).

Parameters

integer

$offset

Destination byte offset.

Exceptions

Zend_Pdf_Exception

Definition at line 179 of file File.php.

    {
        if ($this->_offset == $offset) {
            return;    // Not moving; do nothing.
        }
        parent::moveToOffset($offset);
        $result = @fseek($this->_fileResource, $offset, SEEK_SET);
        if ($result !== 0) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Error while setting new file position',
                                         Zend_Pdf_Exception::CANT_SET_FILE_POSITION);
        }
        if (feof($this->_fileResource)) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Moved beyond the end of the file',
                                         Zend_Pdf_Exception::MOVE_BEYOND_END_OF_FILE);
        }
    }

readAllBytes()

readAllBytes

(

)

Returns the entire contents of the file as a string.

Preserves the current file seek position.

Returns

string

Definition at line 149 of file File.php.

    {
        return file_get_contents($this->_filePath);
    }

readBytes()

readBytes

(

$byteCount

)

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

Advances the read position by the number of bytes read.

Throws an exception if an error was encountered while reading the file or if there is insufficient data to completely fulfill the request.

Parameters

integer

$byteCount

Number of bytes to read.

Returns

string

Exceptions

Zend_Pdf_Exception

Definition at line 125 of file File.php.

    {
        $bytes = @fread($this->_fileResource, $byteCount);
        if ($bytes === false) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Unexpected error while reading file',
                                         Zend_Pdf_Exception::ERROR_DURING_READ);
        }
        if (strlen($bytes) != $byteCount) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Insufficient data to read $byteCount bytes",
                                         Zend_Pdf_Exception::INSUFFICIENT_DATA);
        }
        $this->_offset += $byteCount;
        return $bytes;
    }

Field Documentation

$_filePath

$_filePath = ''

protected

Definition at line 49 of file File.php.

$_fileResource

$_fileResource = null

protected

Definition at line 55 of file File.php.

---

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

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