blob: 44ab3ccaddf81fe4aa670fdfcfa3157e2de9dce3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Gdata API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="../css/template.css" type="text/css"></link><script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../js/jquery.tools.min.js"></script><script type="text/javascript" src="../js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../js/template.js"></script></head><body><div id="content"><h1 class="file">Gdata/MediaMimeStream.php</h1><div id="file-nav-box"><div id="file-nav-options">
Show:
<img src="../images/icons/visibility_public.png" alt="Public" id="show-public"></img><img src="../images/icons/visibility_protected.png" alt="Protected" id="show-protected"></img><img src="../images/icons/visibility_private.png" alt="Private" id="show-private"></img><span class="attribute" id="show-inherited">inherited</span></div><div id="file-nav-container"><ul id="file-nav"><li><a href="#classes"><img src="../images/icons/class.png" alt="Class" height="14"></img>
Classes
</a><ul><li><a href="#\Zend_Gdata_MediaMimeStream">\Zend_Gdata_MediaMimeStream</a></li></ul></li></ul><div style="clear: left;"></div></div><div id="file-nav-tab">
Table of Contents
</div></div><a name="top" class="anchor"></a><div id="file-description"><div class="short-description">Zend Framework</div><div class="long-description"><p>LICENSE</p>
<p>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.</p></div></div><dl class="file-info"><dt>Category</dt><dd>Zend
</dd><dt>Copyright</dt><dd>Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
</dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
</dd><dt>Package</dt><dd>Zend_Gdata
</dd><dt>Subpackage</dt><dd>Gdata
</dd><dt>Version</dt><dd>$Id: MediaMimeStream.php 24593 2012-01-05 20:35:02Z matthew $
</dd></dl><a name="classes" class="anchor"></a><a id="\Zend_Gdata_MediaMimeStream" class="anchor"></a><h2 class="class">\Zend_Gdata_MediaMimeStream<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>Zend\Gdata\Gdata</small><div class="short-description">A streaming Media MIME class that allows for buffered read operations.</div><div class="long-description"></div><dl class="class-info"><dt>Category</dt><dd>Zend
</dd><dt>Copyright</dt><dd>Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
</dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
</dd></dl><h3>Properties</h3><div><a id="\Zend_Gdata_MediaMimeStream::$_boundaryString" class="anchor"></a><div class="property protected"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>string <span class="highlight">$_boundaryString</span> = null</code><div class="description"><div class="short-description">A valid MIME boundary.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_MediaMimeStream::$_currentPart" class="anchor"></a><div class="property protected"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>integer <span class="highlight">$_currentPart</span> = 0</code><div class="description"><div class="short-description">The current part being read from.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>0</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>integer</dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_MediaMimeStream::$_fileHandle" class="anchor"></a><div class="property protected"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>resource <span class="highlight">$_fileHandle</span> = null</code><div class="description"><div class="short-description">A handle to the file that is part of the message.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>resource</dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_MediaMimeStream::$_parts" class="anchor"></a><div class="property protected"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>array <span class="highlight">$_parts</span> = null</code><div class="description"><div class="short-description">An array of all the parts to be sent.</div></div><div class="code-tabs"><div class="long-description"><p>Array members are either a
MimeFile or a MimeBodyString object.</p></div><strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>array</dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_MediaMimeStream::$_totalSize" class="anchor"></a><div class="property protected"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>integer <span class="highlight">$_totalSize</span> = 0</code><div class="description"><div class="short-description">The size of the MIME message.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>0</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>integer</dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\Zend_Gdata_MediaMimeStream::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">(string $xmlString = null, string $filePath = null, string $fileContentType = null)</span> : void</code><div class="description"><p class="short_description">Create a new MimeMediaStream object.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$xmlString</th><td>string</td><td><em><p>The string corresponding to the XML section
of the message, typically an atom entry or feed.</p></em></td></tr><tr><th>$filePath</th><td>string</td><td><em><p>The path to the file that constitutes the binary
part of the message.</p></em></td></tr><tr><th>$fileContentType</th><td>string</td><td><em><p>The valid internet media type of the file.</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.IOException.html#\Zend_Gdata_App_IOException">\Zend_Gdata_App_IOException</a></td><td><em>If the file cannot be read or does
not exist. Also if mbstring.func_overload has been set > 1.</em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_MediaMimeStream::closeFileHandle()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">closeFileHandle</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description">Close the internal file that we are streaming to the socket.</p></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\Zend_Gdata_MediaMimeStream::getContentType()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getContentType</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Return a Content-type header that includes the current boundary string.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>A valid HTTP Content-Type header.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_MediaMimeStream::getTotalSize()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getTotalSize</span><span class="nb-faded-text">()</span> : integer</code><div class="description"><p class="short_description">Return the total size of the mime message.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>integer</td><td>Total size of the message to be sent.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_MediaMimeStream::read()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">read</span><span class="nb-faded-text">( $bytesRequested)</span> : string</code><div class="description"><p class="short_description">Read a specific chunk of the the MIME multipart message.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$bytesRequested</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>A corresponding piece of the message. This could be
binary or regular text.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_MediaMimeStream::wrapEntry()" class="anchor"></a><div class="method private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">wrapEntry</span><span class="nb-faded-text">( $entry, $fileMimeType)</span> : void</code><div class="description"><p class="short_description">Sandwiches the entry body into a MIME message</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$entry</th><td></td><td><em></em></td></tr><tr><th>$fileMimeType</th><td></td><td><em></em></td></tr></table></div><div class="clear"></div></div></div></div></div><small class="footer">
Documentation was generated by
<a href="http://phpdoc.org">phpDocumentor
2.0.0a12</a>.
</small></body></html>
|
