Pdf/FileParserDataSource/String.php
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Pdf
- Subpackage
- FileParser
- Version
- $Id: String.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Pdf_FileParserDataSource_String
Concrete subclass of {@link Zend_Pdf_FileParserDataSource} that provides an interface to binary strings.
Concrete subclasses allow for parsing of in-memory, filesystem, and other sources through a common API. These subclasses also take care of error handling and other mundane tasks.
Subclasses must implement at minimum __construct(), __destruct(), readBytes(), and readAllBytes(). Subclasses should also override moveToOffset() and __toString() as appropriate.
- Parent(s)
- \Zend_Pdf_FileParserDataSource
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
integer $_offset = 0Byte offset of the current read position within the data source.
Inherited from: \Zend_Pdf_FileParserDataSource::$$_offset0Details- Type
- integer
- Inherited_from
- \Zend_Pdf_FileParserDataSource::$$_offset
integer $_size = 0Total size in bytes of the data source.
Inherited from: \Zend_Pdf_FileParserDataSource::$$_size0Details- Type
- integer
- Inherited_from
- \Zend_Pdf_FileParserDataSource::$$_size
string $_string = ''The string to parse.
''Details- Type
- string
Methods
__construct(string $string) : voidObject constructor.
Verifies that the string is not empty.
| Name | Type | Description |
|---|---|---|
| $string | string | String to parse. |
__destruct() : voidObject destructor.
Closes the data source.
May also perform cleanup tasks such as deleting temporary files.
__toString() : stringReturns a string containing the parsed string's length.
Subclasses should override this method to provide a more specific description of the actual object being represented.
| Type | Description |
|---|---|
| string |
getOffset() : integerReturns the byte offset of the current read position within the data source.
Inherited from: \Zend_Pdf_FileParserDataSource::getOffset()| Type | Description |
|---|---|
| integer |
getSize() : integerReturns the total size in bytes of the data source.
Inherited from: \Zend_Pdf_FileParserDataSource::getSize()| Type | Description |
|---|---|
| integer |
moveToOffset(integer $offset) : voidMoves the current read position to the specified byte offset.
Inherited from: \Zend_Pdf_FileParserDataSource::moveToOffset()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.
| Name | Type | Description |
|---|---|---|
| $offset | integer | Destination byte offset. |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
readAllBytes() : stringReturns the entire string.
Preserves the current read position.
| Type | Description |
|---|---|
| string |
readBytes(integer $byteCount) : stringReturns the specified number of raw bytes from the string at the byte offset of the current read position.
Advances the read position by the number of bytes read.
Throws an exception if there is insufficient data to completely fulfill the request.
| Name | Type | Description |
|---|---|---|
| $byteCount | integer | Number of bytes to read. |
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
skipBytes(integer $byteCount) : voidShifts the current read position within the data source by the specified number of bytes.
Inherited from: \Zend_Pdf_FileParserDataSource::skipBytes()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.
| Name | Type | Description |
|---|---|---|
| $byteCount | integer | Number of bytes to skip. |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |