Gdata/MediaMimeStream.php

Show: PublicProtectedPrivateinherited
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: MediaMimeStream.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_MediaMimeStream

Package: Zend\Gdata\Gdata
A streaming Media MIME class that allows for buffered read operations.
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_boundaryString = null
A valid MIME boundary.
Default valuenullDetails
Type
string
>VPropertyprotectedinteger $_currentPart = 0
The current part being read from.
Default value0Details
Type
integer
>VPropertyprotectedresource $_fileHandle = null
A handle to the file that is part of the message.
Default valuenullDetails
Type
resource
>VPropertyprotectedarray $_parts = null
An array of all the parts to be sent.

Array members are either a MimeFile or a MimeBodyString object.

Default valuenullDetails
Type
array
>VPropertyprotectedinteger $_totalSize = 0
The size of the MIME message.
Default value0Details
Type
integer

Methods

methodpublic__construct(string $xmlString = null, string $filePath = null, string $fileContentType = null) : void

Create a new MimeMediaStream object.

Parameters
NameTypeDescription
$xmlStringstring

The string corresponding to the XML section of the message, typically an atom entry or feed.

$filePathstring

The path to the file that constitutes the binary part of the message.

$fileContentTypestring

The valid internet media type of the file.

Throws
ExceptionDescription
\Zend_Gdata_App_IOExceptionIf the file cannot be read or does not exist. Also if mbstring.func_overload has been set > 1.
methodpubliccloseFileHandle() : void

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

methodpublicgetContentType() : string

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

Returns
TypeDescription
stringA valid HTTP Content-Type header.
methodpublicgetTotalSize() : integer

Return the total size of the mime message.

Returns
TypeDescription
integerTotal size of the message to be sent.
methodpublicread( $bytesRequested) : string

Read a specific chunk of the the MIME multipart message.

Parameters
NameTypeDescription
$bytesRequested
Returns
TypeDescription
stringA corresponding piece of the message. This could be binary or regular text.
methodprivatewrapEntry( $entry,  $fileMimeType) : void

Sandwiches the entry body into a MIME message

Parameters
NameTypeDescription
$entry
$fileMimeType
Documentation was generated by phpDocumentor 2.0.0a12.