## Zend_Gdata_MediaMimeStream

Description

A streaming Media MIME class that allows for buffered read operations.

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

Located in /Gdata/MediaMimeStream.php (line 44)

Variable Summary
string $_boundaryString
integer $_currentPart
resource $_fileHandle
array $_parts
integer $_totalSize
Method Summary
Zend_Gdata_MediaMimeStream __construct ([string $xmlString = null], [string $filePath = null], [string $fileContentType = null])
void closeFileHandle ()
string getContentType ()
integer getTotalSize ()
string read ( $bytesRequested, integer $bufferSize)
Variables
string $_boundaryString = null (line 52)

A valid MIME boundary.

- access: protected

integer $_currentPart = 0 (line 65)

The current part being read from.

- access: protected

resource $_fileHandle = null (line 59)

A handle to the file that is part of the message.

- access: protected

array $_parts = null (line 78)

An array of all the parts to be sent. Array members are either a MimeFile or a MimeBodyString object.

- access: protected

integer $_totalSize = 0 (line 71)

The size of the MIME message.

- access: protected

Methods
Constructor __construct (line 91)

Create a new MimeMediaStream object.

- throws: Zend_Gdata_App_IOException If the file cannot be read or does not exist. Also if mbstring.func_overload has been set > 1.
- access: public

Zend_Gdata_MediaMimeStream __construct ([string $xmlString = null], [string $filePath = null], [string $fileContentType = null])

- string $xmlString: The string corresponding to the XML section of the message, typically an atom entry or feed.
- string $filePath: The path to the file that constitutes the binary part of the message.
- string $fileContentType: The valid internet media type of the file.

closeFileHandle (line 172)

Close the internal file that we are streaming to the socket.

- access: public

void closeFileHandle ()
getContentType (line 184)

Return a Content-type header that includes the current boundary string.

- return: A valid HTTP Content-Type header.
- access: public

string getContentType ()
getTotalSize (line 162)

Return the total size of the mime message.

- return: Total size of the message to be sent.
- access: public

integer getTotalSize ()
read (line 136)

Read a specific chunk of the the MIME multipart message.

- return: A corresponding piece of the message. This could be binary or regular text.
- access: public

string read ( $bytesRequested, integer $bufferSize)

- integer $bufferSize: The size of the chunk that is to be read, must be lower than MAX_BUFFER_SIZE.
- $bytesRequested

Documentation generated on Tue, 26 Oct 2010 20:08:58 +0400 by phpDocumentor 1.4.2