Gdata/Media/Extension/MediaCategory.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_MediaCategory

Package: Zend_Gdata\Media
Represents the media:category element
Parent(s)
\Zend_Gdata_Extension < \Zend_Gdata_App_Extension < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_label = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_rootElement = 'category'
Default value'category'Details
Type
n/a
>VPropertyprotected$_rootNamespace = 'media'
Default value'media'Details
Type
n/a
>VPropertyprotectedstring $_scheme = null
Default valuenullDetails
Type
string

Methods

methodpublic__construct(string $text = null, string $scheme = null, string $label = null) : void

Creates an individual MediaCategory object.

Parameters
NameTypeDescription
$textstring

Indication of the type and content of the media

$schemestring

URI that identifies the categorization scheme

$labelstring

Human-readable label to be displayed in applications

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.
methodpublicgetLabel() : string

Returns
TypeDescription
stringHuman-readable label to be displayed in applications
methodpublicgetScheme() : string

Returns the URI that identifies the categorization scheme Optional.

Returns
TypeDescription
stringURI that identifies the categorization scheme
methodpublicsetLabel(string $value) : \Zend_Gdata_Media_Extension_MediaCategory

Parameters
NameTypeDescription
$valuestring

Human-readable label to be displayed in applications

Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaCategoryProvides a fluent interface
methodpublicsetScheme(string $value) : \Zend_Gdata_Media_Extension_MediaCategory

Parameters
NameTypeDescription
$valuestring

URI that identifies the categorization scheme

Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaCategoryProvides 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 .