API Documentation

Zend/Pdf/FileParserDataSource/String.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Pdf  
Subpackage
FileParser  
Version
$Id: String.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_FileParserDataSource_String

Package: Zend\Pdf\FileParser

Concrete subclass of {@link Zend_Pdf_FileParserDataSource} that provides an interface to binary strings.

Parent(s)
\Zend_Pdf_FileParserDataSource
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_string= ''''

The string to parse.

Default value''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.

methodpublic__destruct( ) : void

Object destructor.

methodpublic__toString( ) : string

Returns a string containing the parsed string's length.

Returns
Type Description
string
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
Documentation was generated by DocBlox 0.15.1.