API Documentation

Pdf/FileParserDataSource/String.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
FileParser
version
$Id: String.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Pdf_FileParserDataSource_String

Description

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.

Zend_Pdf_FileParserDataSource_String

Extends from
Zend_Pdf_FileParserDataSource
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
FileParser
Properties
$_string
Methods
__construct
__destruct
readBytes
readAllBytes
__toString

Description

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

Properties

$_string

string $_string = ''

The string to parse.

Details

$_string
string
visibility
protected
default
final
false
static
false

Methods

__construct

__construct( string $string ) :

Object constructor.

Verifies that the string is not empty.

Arguments
$string
string
String to parse.
Details
visibility
public
final
false
static
false

__destruct

__destruct( ) :

Object destructor.

Details
visibility
public
final
false
static
false

__toString

__toString( ) : string

Returns a string containing the parsed string's length.

Output
string
Details
visibility
public
final
false
static
false

readAllBytes

readAllBytes( ) : string

Returns the entire string.

Preserves the current read position.

Output
string
Details
visibility
public
final
false
static
false

readBytes

readBytes( 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.

Arguments
$byteCount
integer
Number of bytes to read.
Output
string
Details
visibility
public
final
false
static
false
throws
Documentation was generated by DocBlox.