API Documentation

Zend/Gdata/MimeBodyString.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_Gdata  
Subpackage
Gdata  
Version
$Id: MimeBodyString.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_MimeBodyString

Package: Zend\Gdata\Gdata

A wrapper for strings for buffered reading.

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

Properties

Propertyprotectedinteger  $_bytesRead= '0'

The size of the MIME message.

Default value0Details
Type
integer
Propertyprotectedstring  $_sourceString= ''''

The source string.

Default value''Details
Type
string

Methods

methodpublic__construct( string $sourceString ) : void

Create a new MimeBodyString object.

Parameters
Name Type Description
$sourceString string

The string we are wrapping.

methodpublicgetSize( ) : int

The length of the string.

Returns
Type Description
int The length of the string contained in the object.
methodpublicread( integer $bytesRequested ) : string

Read the next chunk of the string.

Parameters
Name Type Description
$bytesRequested integer

The size of the chunk that is to be read.

Returns
Type Description
string A corresponding piece of the string.
Documentation was generated by DocBlox 0.15.1.