API Documentation

Pdf/FileParserDataSource/String.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  
subpackage
FileParser  
version
$Id: String.php 23775 2011-03-01 17:25:24Z ralph $  

\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 {@link __construct()}, {@link __destruct()}, {@link readBytes()}, and {@link readAllBytes()}. Subclasses should also override {@link moveToOffset()} and {@link __toString()} as appropriate.

Extends from
\Zend_Pdf_FileParserDataSource
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  
subpackage
FileParser  

Properties

Propertyprotectedstring  $_string= ''

The string to parse.

Details
Type
string

Methods

methodpublic__construct( string $string ) : void

Object constructor.

Verifies that the string is not empty.

Parameters
Name Type Description
$string string String to parse.
Throws
Exception Description
\Zend_Pdf_Exception
methodpublic__destruct( ) : void

Object destructor.

May also perform cleanup tasks such as deleting temporary files.

methodpublic__toString( ) : string

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

Returns
Type Description
string
methodpublicgetOffset( ) : integer

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

Inherited from: \Zend_Pdf_FileParserDataSource::getOffset()
Returns
Type Description
integer
methodpublicgetSize( ) : integer

Returns the total size in bytes of the data source.

Inherited from: \Zend_Pdf_FileParserDataSource::getSize()
Returns
Type Description
integer
methodpublicmoveToOffset( integer $offset ) : void

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

Parameters
Name Type Description
$offset integer Destination byte offset.
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicreadAllBytes( ) : string

Returns the entire string.

Preserves the current read position.

Returns
Type Description
string
methodpublicreadBytes( integer $byteCount ) : string

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.

Parameters
Name Type Description
$byteCount integer Number of bytes to read.
Returns
Type Description
string
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicskipBytes( integer $byteCount ) : void

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

Parameters
Name Type Description
$byteCount integer Number of bytes to skip.
Throws
Exception Description
\Zend_Pdf_Exception
Documentation was generated by DocBlox 0.13.3.