API Documentation

Zend/Gdata/Media/Extension/MediaContent.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
Media  
Version
$Id: MediaContent.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Media_Extension_MediaContent

Package: Zend\Gdata\Media

Represents the media:content element of Media RSS.

Represents media objects. Multiple media objects representing the same content can be represented using a media:group (Zend_Gdata_Media_Extension_MediaGroup) element.

Parent(s)
\Zend_Gdata_Extension < \Zend_Gdata_App_Extension < \Zend_Gdata_App_Base
Children
\Zend_Gdata_YouTube_Extension_MediaContent
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedint  $_bitrate= 'null'

Default valuenullDetails
Type
int
Propertyprotectedint  $_channels= 'null'

Default valuenullDetails
Type
int
Propertyprotectedint  $_duration= 'null'

Default valuenullDetails
Type
int
Propertyprotectedstring  $_expression= 'null'

Default valuenullDetails
Type
string
Propertyprotectedint  $_fileSize= 'null'

Default valuenullDetails
Type
int
Propertyprotectedint  $_framerate= 'null'

Default valuenullDetails
Type
int
Propertyprotectedint  $_height= 'null'

Default valuenullDetails
Type
int
Propertyprotectedstring  $_isDefault= 'null'

Default valuenullDetails
Type
string
Propertyprotectedstring  $_lang= 'null'

Default valuenullDetails
Type
string
Propertyprotectedstring  $_medium= 'null'

Default valuenullDetails
Type
string
Propertyprotected  $_rootElement= ''content''
Default value'content'Details
Type
Propertyprotected  $_rootNamespace= ''media''
Default value'media'Details
Type
Propertyprotectedint  $_samplingrate= 'null'

Default valuenullDetails
Type
int
Propertyprotectedstring  $_type= 'null'

Default valuenullDetails
Type
string
Propertyprotectedstring  $_url= 'null'

Default valuenullDetails
Type
string
Propertyprotectedint  $_width= 'null'

Default valuenullDetails
Type
int

Methods

methodpublic__construct(  $url = null,  $fileSize = null,  $type = null,  $medium = null,  $isDefault = null,  $expression = null,  $bitrate = null,  $framerate = null,  $samplingrate = null,  $channels = null,  $duration = null,  $height = null,  $width = null,  $lang = null ) : void

Creates an individual MediaContent object.

Parameters
Name Type Description
$url
$fileSize
$type
$medium
$isDefault
$expression
$bitrate
$framerate
$samplingrate
$channels
$duration
$height
$width
$lang
methodpublic__toString( ) : string

Returns the URL representing this MediaContent object

Returns
Type Description
string The URL representing this MediaContent object.
methodpublicgetBitrate( ) : int

Returns
Type Description
int
methodpublicgetChannels( ) : int

Returns
Type Description
int
methodpublicgetDOM( \DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null ) : \DOMElement

Retrieves a DOMElement which corresponds to this element and all child properties. This is used to build an entry back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistence.

Parameters
Name Type Description
$doc \DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
Type Description
\DOMElement The DOMElement representing this element and all child properties.
methodpublicgetDuration( ) : int

Returns
Type Description
int
methodpublicgetExpression( ) : string

Returns
Type Description
string
methodpublicgetFileSize( ) : int

Returns
Type Description
int The size of the media in bytes
methodpublicgetFramerate( ) : int

Returns
Type Description
int
methodpublicgetHeight( ) : int

Returns
Type Description
int
methodpublicgetIsDefault( ) : bool

Returns
Type Description
bool
methodpublicgetLang( ) : string

Returns
Type Description
string
methodpublicgetMedium( ) : string

Returns
Type Description
string
methodpublicgetSamplingrate( ) : int

Returns
Type Description
int
methodpublicgetType( ) : string

Returns
Type Description
string
methodpublicgetUrl( ) : string

Returns
Type Description
string The direct URL to the media object
methodpublicgetWidth( ) : int

Returns
Type Description
int
methodpublicsetBitrate(  $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value

int

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetChannels(  $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value

int

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetDuration(  $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value

int

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetExpression(  $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value

string

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetFileSize( int $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value int
Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetFramerate(  $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value

int

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetHeight(  $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value

int

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetIsDefault( bool $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value bool
Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetLang(  $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value

string

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetMedium( string $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetSamplingrate(  $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value

int

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetType( string $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetUrl( string $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value string

The direct URL to the media object

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodpublicsetWidth(  $value ) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
Name Type Description
$value

int

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaContent Provides a fluent interface
methodprotectedtakeAttributeFromDOM( \DOMNode $attribute ) : void

Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and value are stored in an array.

Parameters
Name Type Description
$attribute \DOMNode

The DOMNode attribute needed to be handled

Documentation was generated by DocBlox 0.15.1.