Gdata/MediaMimeStream.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- Gdata
- Version
- $Id$
\Zend_Gdata_MediaMimeStream
Package: Zend_Gdata\Gdata
A streaming Media MIME class that allows for buffered read operations.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
string $_boundaryString = nullA valid MIME boundary.
Default value
nullDetails- Type
- string
integer $_currentPart = 0The current part being read from.
Default value
0Details- Type
- integer
resource $_fileHandle = nullA handle to the file that is part of the message.
Default value
nullDetails- Type
- resource
array $_parts = nullAn array of all the parts to be sent. Array members are either a
MimeFile or a MimeBodyString object.
Default value
nullDetails- Type
- array
integer $_totalSize = 0The size of the MIME message.
Default value
0Details- Type
- integer
Methods
__construct(string $xmlString = null, string $filePath = null, string $fileContentType = null) : voidCreate a new MimeMediaStream object.
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $xmlString | string | The string corresponding to the XML section of the message, typically an atom entry or feed. |
| $filePath | string | The path to the file that constitutes the binary part of the message. |
| $fileContentType | string | The valid internet media type of the file. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_IOException | If the file cannot be read or does not exist. Also if mbstring.func_overload has been set > 1. |
closeFileHandle() : voidClose the internal file that we are streaming to the socket.
getContentType() : stringReturn a Content-type header that includes the current boundary string.
Returns
| Type | Description |
|---|---|
| string | A valid HTTP Content-Type header. |
getTotalSize() : integerReturn the total size of the mime message.
Returns
| Type | Description |
|---|---|
| integer | Total size of the message to be sent. |
read( $bytesRequested) : stringRead a specific chunk of the the MIME multipart message.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $bytesRequested |
| Type | Description |
|---|---|
| string | A corresponding piece of the message. This could be binary or regular text. |
wrapEntry( $entry, $fileMimeType) : voidSandwiches the entry body into a MIME message
Parameters
| Name | Type | Description |
|---|---|---|
| $entry | ||
| $fileMimeType |