API Documentation

Zend/Gdata/MimeFile.php

Show: inherited
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: MimeFile.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_MimeFile

Package: Zend\Gdata\Gdata

A wrapper for strings for buffered reading.

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

Properties

Propertyprotectedresource  $_fileHandle= 'null'

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

Default valuenullDetails
Type
resource

Methods

methodpublic__construct( string $fileHandle ) : void

Create a new MimeFile object.

Parameters
Name Type Description
$fileHandle string

An open file handle to the file being read.

methodpublicread( integer $bytesRequested ) : string

Read the next chunk of the file.

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 message. This could be binary or regular text.
Documentation was generated by DocBlox 0.15.1.