API Documentation

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

\Zend_Gdata_Media_Extension_MediaGroup

Package: Zend\Gdata\Media

This class represents the media:group element of Media RSS.

It allows the grouping of media:content elements that are different representations of the same content. When it exists, it is a child of an Entry (Atom) or Item (RSS).

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

Properties

Propertyprotectedarray  $_category= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_content= 'array()'

Default valuearray()Details
Type
array
Propertyprotected\Zend_Gdata_Media_Extension_MediaCopyright  $_copyright= 'null'

Default valuenullDetails
Type
\Zend_Gdata_Media_Extension_MediaCopyright
Propertyprotectedarray  $_credit= 'array()'

Default valuearray()Details
Type
array
Propertyprotected\Zend_Gdata_Media_Extension_MediaDescription  $_description= 'null'

Default valuenullDetails
Type
\Zend_Gdata_Media_Extension_MediaDescription
Propertyprotectedarray  $_hash= 'array()'

Default valuearray()Details
Type
array
Propertyprotected\Zend_Gdata_Media_Extension_MediaKeywords  $_keywords= 'null'

Default valuenullDetails
Type
\Zend_Gdata_Media_Extension_MediaKeywords
Propertyprotectedarray  $_mediaText= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_player= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_rating= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_restriction= 'array()'

Default valuearray()Details
Type
array
Propertyprotected  $_rootElement= ''group''
Default value'group'Details
Type
Propertyprotected  $_rootNamespace= ''media''
Default value'media'Details
Type
Propertyprotectedarray  $_thumbnail= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedstring  $_title= 'null'

Default valuenullDetails
Type
string

Methods

methodpublic__construct(  $element = null ) : void

Creates an individual MediaGroup object.

Parameters
Name Type Description
$element
methodpublicgetCategory( ) : array

Returns
Type Description
array
methodpublicgetContent( ) : array

Returns
Type Description
array
methodpublicgetCredit( ) : array

Returns
Type Description
array
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.
methodpublicgetHash( ) : array

Returns
Type Description
array
methodpublicgetMediaText( ) : array

Returns
Type Description
array
methodpublicgetPlayer( ) : array

Returns
Type Description
array
methodpublicgetRating( ) : array

Returns
Type Description
array
methodpublicgetRestriction( ) : array

Returns
Type Description
array
methodpublicgetThumbnail( ) : array

Returns
Type Description
array
methodpublicsetCategory( array $value ) : \Zend_Gdata_Media_Extension_MediaGroup

Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Media_Extension_MediaGroup
methodpublicsetContent( array $value ) : \Zend_Gdata_Media_MediaGroup

Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Media_MediaGroup Provides a fluent interface
methodpublicsetCredit( array $value ) : \Zend_Gdata_Media_Extension_MediaGroup

Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Media_Extension_MediaGroup
methodpublicsetHash( array $value ) : \Zend_Gdata_Media_Extension_MediaGroup

Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Media_Extension_MediaGroup
methodpublicsetKeywords( array $value ) : \Zend_Gdata_Media_Extension_MediaGroup

Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Media_Extension_MediaGroup Provides a fluent interface
methodpublicsetMediaText(  $value ) : \Zend_Gdata_Media_Extension_MediaGroup

Parameters
Name Type Description
$value

array

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaGroup
methodpublicsetPlayer(  $value ) : \Zend_Gdata_Media_Extension_MediaGroup

Parameters
Name Type Description
$value

array

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaGroup
methodpublicsetRating(  $value ) : \Zend_Gdata_Media_Extension_MediaGroup

Parameters
Name Type Description
$value

array

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaGroup
methodpublicsetRestriction(  $value ) : \Zend_Gdata_Media_Extension_MediaGroup

Parameters
Name Type Description
$value

array

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaGroup
methodpublicsetThumbnail(  $value ) : \Zend_Gdata_Media_Extension_MediaGroup

Parameters
Name Type Description
$value

array

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaGroup
methodprotectedtakeChildFromDOM( \DOMNode $child ) : void

Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.

Parameters
Name Type Description
$child \DOMNode

The DOMNode to process

Documentation was generated by DocBlox 0.15.1.