Gdata/Media/Extension/MediaContent.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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Media  
Version
$Id$  

\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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedint $_bitrate = null
Default valuenullDetails
Type
int
>VPropertyprotectedint $_channels = null
Default valuenullDetails
Type
int
>VPropertyprotectedint $_duration = null
Default valuenullDetails
Type
int
>VPropertyprotectedstring $_expression = null
Default valuenullDetails
Type
string
>VPropertyprotectedint $_fileSize = null
Default valuenullDetails
Type
int
>VPropertyprotectedint $_framerate = null
Default valuenullDetails
Type
int
>VPropertyprotectedint $_height = null
Default valuenullDetails
Type
int
>VPropertyprotectedstring $_isDefault = null
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_lang = null
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_medium = null
Default valuenullDetails
Type
string
>VPropertyprotected$_rootElement = 'content'
Default value'content'Details
Type
n/a
>VPropertyprotected$_rootNamespace = 'media'
Default value'media'Details
Type
n/a
>VPropertyprotectedint $_samplingrate = null
Default valuenullDetails
Type
int
>VPropertyprotectedstring $_type = null
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_url = null
Default valuenullDetails
Type
string
>VPropertyprotectedint $_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
NameTypeDescription
$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
TypeDescription
stringThe URL representing this MediaContent object.
methodpublicgetBitrate() : int

Returns
TypeDescription
int
methodpublicgetChannels() : int

Returns
TypeDescription
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
NameTypeDescription
$doc\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElementThe DOMElement representing this element and all child properties.
methodpublicgetDuration() : int

Returns
TypeDescription
int
methodpublicgetExpression() : string

Returns
TypeDescription
string
methodpublicgetFileSize() : int

Returns
TypeDescription
intThe size of the media in bytes
methodpublicgetFramerate() : int

Returns
TypeDescription
int
methodpublicgetHeight() : int

Returns
TypeDescription
int
methodpublicgetIsDefault() : bool

Returns
TypeDescription
bool
methodpublicgetLang() : string

Returns
TypeDescription
string
methodpublicgetMedium() : string

Returns
TypeDescription
string
methodpublicgetSamplingrate() : int

Returns
TypeDescription
int
methodpublicgetType() : string

Returns
TypeDescription
string
methodpublicgetUrl() : string

Returns
TypeDescription
stringThe direct URL to the media object
methodpublicgetWidth() : int

Returns
TypeDescription
int
methodpublicsetBitrate( $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetChannels( $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetDuration( $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetExpression( $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetFileSize(int $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetFramerate( $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetHeight( $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetIsDefault(bool $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$valuebool
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetLang( $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetMedium(string $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetSamplingrate( $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetType(string $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetUrl(string $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$valuestring

The direct URL to the media object

Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides a fluent interface
methodpublicsetWidth( $value) : \Zend_Gdata_Media_Extension_MediaContent

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaContentProvides 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
NameTypeDescription
$attribute\DOMNode

The DOMNode attribute needed to be handled

Documentation was generated by phpDocumentor 2.2.0 .