Pdf/FileParserDataSource/File.php
Show:
inherited
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Pdf
- Subpackage
- FileParser
- Version
- $Id$
\Zend_Pdf_FileParserDataSource_File
Package: Zend_Pdf\FileParser
Throws
Throws
Returns
Throws
Concrete subclass of {@link Zend_Pdf_FileParserDataSource} that provides an
interface to filesystem objects.
Note that this class cannot be used for other sources that may be supported
by {@link fopen()} (through URL wrappers). It may be used for local
filesystem objects only.
- Parent(s)
- \Zend_Pdf_FileParserDataSource
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
string $_filePath = ''Fully-qualified path to the file.
Default value
''Details- Type
- string
resource $_fileResource = nullFile resource handle .
Default value
nullDetails- Type
- resource
Methods
__construct(string $filePath) : voidObject 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| Name | Type | Description |
|---|---|---|
| $filePath | string | Fully-qualified path to the file. |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
__destruct() : voidObject destructor.
Closes the file if it had been successfully opened.
__toString() : stringReturns the full filesystem path of the file.
Returns
| Type | Description |
|---|---|
| string |
moveToOffset(integer $offset) : voidSeeks 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| Name | Type | Description |
|---|---|---|
| $offset | integer | Destination byte offset. |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
readAllBytes() : stringReturns the entire contents of the file as a string.
Preserves the current file seek position.
Returns| Type | Description |
|---|---|
| string |
readBytes(integer $byteCount) : stringReturns 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| Name | Type | Description |
|---|---|---|
| $byteCount | integer | Number of bytes to read. |
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |