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.
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).

string
$_rootElement= 'group'
group
Details
__construct(
$element
=
null
)
:
void
Creates an individual MediaGroup object.
Name | Type | Description |
---|---|---|
$element |

__get(
string $name
)
:
void
Magic getter to allow access like $entry->foo to call $entry->getFoo() Alternatively, if no getFoo() is defined, but a $_foo protected variable is defined, this is returned.
Inherited from: \Zend_Gdata_App_Base::__get()TODO Remove ability to bypass getFoo() methods??
Name | Type | Description |
---|---|---|
$name | string | The variable name sought |

encode(
)
:
string
Alias for saveXML()
Inherited from: \Zend_Gdata_App_Base::encode()Can be overridden by children to provide more complex representations of entries.
Type | Description |
---|---|
string | Encoded string content |

flushNamespaceLookupCache(
)
:
void
Flush namespace lookup cache.
Inherited from: \Zend_Gdata_App_Base::flushNamespaceLookupCache()Empties the namespace lookup cache. Call this function if you have added data to the namespace lookup table that contradicts values that may have been cached during a previous call to lookupNamespace().

getCategory(
)
:
array
Type | Description |
---|---|
array |

getContent(
)
:
array
Type | Description |
---|---|
array |

getCopyright(
)
:
\Zend_Gdata_Media_Extension_MediaCopyright
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaCopyright |

getCredit(
)
:
array
Type | Description |
---|---|
array |

getDOM(
\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.
Name | Type | Description |
---|---|---|
$doc | \DOMDocument | The DOMDocument used to construct DOMElements |
$majorVersion | ||
$minorVersion |
Type | Description |
---|---|
\DOMElement | The DOMElement representing this element and all child properties. |

getDescription(
)
:
\Zend_Gdata_Media_Extension_MediaDescription
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaDescription |

getDuration(
)
:
\Zend_Gdata_YouTube_Extension_Duration
Returns the duration value of this element
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_Duration |

getExtensionAttributes(
)
:
array
Returns an array of all extension attributes not transformed into data model properties during parsing of the XML. Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string);
Inherited from: \Zend_Gdata_App_Base::getExtensionAttributes()Type | Description |
---|---|
array | All extension attributes |

getExtensionElements(
)
:
array
Returns an array of all elements not matched to data model classes during the parsing of the XML
Inherited from: \Zend_Gdata_App_Base::getExtensionElements()Type | Description |
---|---|
array | All elements not matched to data model classes during parsing |

getHash(
)
:
array
Type | Description |
---|---|
array |

getKeywords(
)
:
\Zend_Gdata_Media_Extension_MediaKeywords
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaKeywords |

getMediaCredit(
)
:
\Zend_Gdata_YouTube_Extension_MediaCredit
Returns the media:credit value of this element
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_MediaCredit |

getMediaRating(
)
:
\Zend_Gdata_YouTube_Extension_MediaRating
Returns the rating value of this element
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_MediaRating |

getMediaText(
)
:
array
Type | Description |
---|---|
array |

getPlayer(
)
:
array
Type | Description |
---|---|
array |

getPrivate(
)
:
\Zend_Gdata_YouTube_Extension_Private
Returns the private value of this element
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_Private |

getRating(
)
:
array
Type | Description |
---|---|
array |

getRestriction(
)
:
array
Type | Description |
---|---|
array |

getText(
$trim
=
true
)
:
string
Returns the child text node of this element This represents any raw text contained within the XML element
Inherited from: \Zend_Gdata_App_Base::getText()Name | Type | Description |
---|---|---|
$trim |
Type | Description |
---|---|
string | Child text node |

getThumbnail(
)
:
array
Type | Description |
---|---|
array |

getTitle(
)
:
\Zend_Gdata_Media_Extension_MediaTitle
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaTitle |

getUploaded(
)
:
\Zend_Gdata_YouTube_Extension_Uploaded
Returns the yt:uploaded element
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_Uploaded |

getVideoId(
)
:
\Zend_Gdata_YouTube_Extension_VideoId
Returns the videoid value of this element
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_VideoId |

getXML(
)
:
string
Alias for saveXML() returns XML content for this element and all children
Inherited from: \Zend_Gdata_App_Base::getXML()Type | Description |
---|---|
string | XML content |

lookupNamespace(
string $prefix, integer $majorVersion
=
1, integer $minorVersion
=
null
)
:
string
Get the full version of a namespace prefix
Inherited from: \Zend_Gdata_App_Base::lookupNamespace()Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.
Name | Type | Description |
---|---|---|
$prefix | string | The namespace prefix to lookup. |
$majorVersion | integer | The major protocol version in effect. Defaults to '1'. |
$minorVersion | integer | The minor protocol version in effect. Defaults to null (use latest). |
Type | Description |
---|---|
string |

registerAllNamespaces(
array $namespaceArray
)
:
void
Add an array of namespaces to the registered list.
Inherited from: \Zend_Gdata_App_Base::registerAllNamespaces()Takes an array in the format of: namespace prefix, namespace URI, major protocol version, minor protocol version and adds them with calls to ->registerNamespace()
Name | Type | Description |
---|---|---|
$namespaceArray | array | An array of namespaces. |

registerNamespace(
string $prefix, string $namespaceUri, integer $majorVersion
=
1, integer $minorVersion
=
0
)
:
void
Add a namespace and prefix to the registered list
Inherited from: \Zend_Gdata_App_Base::registerNamespace()Takes a prefix and a full namespace URI and adds them to the list of registered namespaces for use by $this->lookupNamespace().
WARNING: Currently, registering a namespace will NOT invalidate any memoized data stored in $_namespaceLookupCache. Under normal use, this behavior is acceptable. If you are adding contradictory data to the namespace lookup table, you must call flushNamespaceLookupCache().
Name | Type | Description |
---|---|---|
$prefix | string | The namespace prefix |
$namespaceUri | string | The full namespace URI |
$majorVersion | integer | The major protocol version in effect. Defaults to '1'. |
$minorVersion | integer | The minor protocol version in effect. Defaults to null (use latest). |

saveXML(
)
:
string
Converts this element and all children into XML text using getDOM()
Inherited from: \Zend_Gdata_App_Base::saveXML()Type | Description |
---|---|
string | XML content |

setCategory(
array $value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | array |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setContent(
array $value
)
:
\Zend_Gdata_Media_MediaGroup
Name | Type | Description |
---|---|---|
$value | array |
Type | Description |
---|---|
\Zend_Gdata_Media_MediaGroup | Provides a fluent interface |

setCopyright(
\Zend_Gdata_Media_Extension_MediaCopyright $value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | \Zend_Gdata_Media_Extension_MediaCopyright |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setCredit(
array $value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | array |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setDescription(
\Zend_Gdata_Media_Extension_MediaDescription $value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | \Zend_Gdata_Media_Extension_MediaDescription |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setDuration(
\Zend_Gdata_YouTube_Extension_Duration $value
)
:
\Zend_Gdata_YouTube_Extension_MediaGroup
Sets the duration value of this element
Name | Type | Description |
---|---|---|
$value | \Zend_Gdata_YouTube_Extension_Duration | The duration value |
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_MediaGroup | Provides a fluent interface |

setExtensionAttributes(
array $value
)
:
\Zend_Gdata_App_Base
Sets an array of all extension attributes not transformed into data model properties during parsing of the XML. Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string); This can be used to add arbitrary attributes to any data model element
Inherited from: \Zend_Gdata_App_Base::setExtensionAttributes()Name | Type | Description |
---|---|---|
$value | array | All extension attributes |
Type | Description |
---|---|
\Zend_Gdata_App_Base | Returns an object of the same type as 'this' to provide a fluent interface. |

setExtensionElements(
array $value
)
:
\Zend_Gdata_App_Base
Sets an array of all elements not matched to data model classes during the parsing of the XML. This method can be used to add arbitrary child XML elements to any data model class.
Inherited from: \Zend_Gdata_App_Base::setExtensionElements()Name | Type | Description |
---|---|---|
$value | array | All extension elements |
Type | Description |
---|---|
\Zend_Gdata_App_Base | Returns an object of the same type as 'this' to provide a fluent interface. |

setHash(
array $value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | array |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setKeywords(
array $value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | array |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup | Provides a fluent interface |

setMediaCredit(
\Zend_Gdata_YouTube_Extension_MediaCredit $value
)
:
\Zend_Gdata_YouTube_Extension_MediaGroup
Sets the media:credit value of this element
Name | Type | Description |
---|---|---|
$value | \Zend_Gdata_YouTube_Extension_MediaCredit | The credit element |
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_MediaGroup | Provides a fluent interface |

setMediaRating(
\Zend_Gdata_YouTube_Extension_MediaRating $value
)
:
\Zend_Gdata_YouTube_Extension_MediaGroup
Sets the media:rating value of this element
Name | Type | Description |
---|---|---|
$value | \Zend_Gdata_YouTube_Extension_MediaRating | The rating element |
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_MediaGroup | Provides a fluent interface |

setMediaText(
$value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | array |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setPlayer(
$value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | array |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setPrivate(
\Zend_Gdata_YouTube_Extension_Private $value
)
:
\Zend_Gdata_YouTube_Extension_MediaGroup
Sets the private value of this element
Name | Type | Description |
---|---|---|
$value | \Zend_Gdata_YouTube_Extension_Private | The private value |
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_MediaGroup | Provides a fluent interface |

setRating(
$value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | array |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setRestriction(
$value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | array |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setText(
string $value
)
:
\Zend_Gdata_App_Base
Sets the child text node of this element This represents any raw text contained within the XML element
Inherited from: \Zend_Gdata_App_Base::setText()Name | Type | Description |
---|---|---|
$value | string | Child text node |
Type | Description |
---|---|
\Zend_Gdata_App_Base | Returns an object of the same type as 'this' to provide a fluent interface. |

setThumbnail(
$value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | array |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setTitle(
\Zend_Gdata_Media_Extension_MediaTitle $value
)
:
\Zend_Gdata_Media_Extension_MediaGroup
Name | Type | Description |
---|---|---|
$value | \Zend_Gdata_Media_Extension_MediaTitle |
Type | Description |
---|---|
\Zend_Gdata_Media_Extension_MediaGroup |

setUploaded(
\Zend_Gdata_YouTube_Extension_Uploaded $value
)
:
\Zend_Gdata_YouTube_Extension_MediaGroup
Sets the yt:uploaded element
Name | Type | Description |
---|---|---|
$value | \Zend_Gdata_YouTube_Extension_Uploaded | The uploaded value |
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_MediaGroup | Provides a fluent interface |

setVideoId(
\Zend_Gdata_YouTube_Extension_VideoId $value
)
:
\Zend_Gdata_YouTube_Extension_MediaGroup
Sets the videoid value of this element
Name | Type | Description |
---|---|---|
$value | \Zend_Gdata_YouTube_Extension_VideoId | The video id value |
Type | Description |
---|---|
\Zend_Gdata_YouTube_Extension_MediaGroup | Provides a fluent interface |

takeAttributeFromDOM(
\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.
Inherited from: \Zend_Gdata_App_Base::takeAttributeFromDOM()Name | Type | Description |
---|---|---|
$attribute | \DOMNode | The DOMNode attribute needed to be handled |

takeChildFromDOM(
\DOMNode $child
)
:
void
Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.
Name | Type | Description |
---|---|---|
$child | \DOMNode | The DOMNode to process |

transferFromDOM(
\DOMNode $node
)
:
void
Transfers each child and attribute into member variables.
Inherited from: \Zend_Gdata_App_Base::transferFromDOM()This is called when XML is received over the wire and the data model needs to be built to represent this XML.
Name | Type | Description |
---|---|---|
$node | \DOMNode | The DOMNode that represents this object's data |

transferFromXML(
string $xml
)
:
void
Parses the provided XML text and generates data model classes for each know element by turning the XML text into a DOM tree and calling transferFromDOM($element). The first data model element with the same name as $this->_rootElement is used and the child elements are recursively parsed.
Inherited from: \Zend_Gdata_App_Base::transferFromXML()Name | Type | Description |
---|---|---|
$xml | string | The XML text to parse |