Docs For Class Zend_Pdf_FileParserDataSource_String

## Class Zend_Pdf_FileParserDataSource_String

Description

Concrete subclass of Zend_Pdf_FileParserDataSource that provides an interface to binary strings.

- license: New BSD License
- copyright: Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Pdf/FileParserDataSource/String.php (line 34)

    Zend_Pdf_FileParserDataSource
       |
       --Zend_Pdf_FileParserDataSource_String

Variable Summary
string $_string
Method Summary
Zend_Pdf_FileParserDataSource_String __construct (string $string)
void __destruct ()
string readAllBytes ()
string readBytes (integer $byteCount)
string __toString ()
Variables
string $_string = '' (line 43)

The string to parse.

- access: protected

#### Inherited Variables

Inherited from Zend_Pdf_FileParserDataSource

> Zend_Pdf_FileParserDataSource::$_offset
> Zend_Pdf_FileParserDataSource::$_size

Methods
Constructor __construct (line 59)

Object constructor.

Verifies that the string is not empty.

- access: public

Zend_Pdf_FileParserDataSource_String __construct (string $string)

- string $string: String to parse.

Redefinition of:

Zend_Pdf_FileParserDataSource::__construct()
  Object constructor. Opens the data source for parsing.

Destructor __destruct (line 72)

Object destructor.

- access: public

void __destruct ()

Redefinition of:

Zend_Pdf_FileParserDataSource::__destruct()
  Object destructor. Closes the data source.

readAllBytes (line 108)

Returns the entire string.

Preserves the current read position.

- access: public

string readAllBytes ()

Redefinition of:

Zend_Pdf_FileParserDataSource::readAllBytes()
  Returns the entire contents of the data source as a string.

readBytes (line 90)

Returns 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.

- access: public
- throws: Zend_Pdf_Exception

string readBytes (integer $byteCount)

- integer $byteCount: Number of bytes to read.

Redefinition of:

Zend_Pdf_FileParserDataSource::readBytes()
  Returns the specified number of raw bytes from the data source at the byte offset of the current read position.

__toString (line 121)

Returns a string containing the parsed string's length.

- access: public

string __toString ()

Redefinition of:

Zend_Pdf_FileParserDataSource::__toString()
  Returns a description of the object for debugging purposes.

#### Inherited Methods

Inherited From Zend_Pdf_FileParserDataSource

> Zend_Pdf_FileParserDataSource::__construct()
> Zend_Pdf_FileParserDataSource::getOffset()
> Zend_Pdf_FileParserDataSource::getSize()
> Zend_Pdf_FileParserDataSource::moveToOffset()
> Zend_Pdf_FileParserDataSource::readAllBytes()
> Zend_Pdf_FileParserDataSource::readBytes()
> Zend_Pdf_FileParserDataSource::skipBytes()
> Zend_Pdf_FileParserDataSource::__destruct()
> Zend_Pdf_FileParserDataSource::__toString()

Documentation generated on Sun, 29 Oct 2006 21:27:33 -0600 by phpDocumentor 1.3.0RC6