## API Documentation

# Gdata/MimeBodyString.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_Gdata
subpackage
  Gdata
version
  $Id: MimeBodyString.php 23775 2011-03-01 17:25:24Z ralph $

## \Zend_Gdata_MimeBodyString
jump to top

A wrapper for strings for buffered reading.

category
  Zend
copyright
  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license
  New BSD License
package
  Zend_Gdata
subpackage
  Gdata

### Properties

`integer $_bytesRead= '0'`

The size of the MIME message.

Default value `0` Details

Type
  integer

`string $_sourceString= ''`

The source string.

Details

Type
  string

### Methods

`__construct( string $sourceString ) : void`

Create a new MimeBodyString object.

Parameters

Name | Type | Description
--- | --- | ---
$sourceString | string | The string we are wrapping.

`getSize( ) : int`

The length of the string.

Returns

Type | Description
--- | ---
int | The length of the string contained in the object.

`read( 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.13.3.