API Documentation

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

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

Properties

Propertyprotected  $_label= 'null'
Default valuenullDetails
Type
Propertyprotected  $_rootElement= ''category''
Default value'category'Details
Type
Propertyprotected  $_rootNamespace= ''media''
Default value'media'Details
Type
Propertyprotectedstring  $_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
Name Type Description
$text string

Indication of the type and content of the media

$scheme string

URI that identifies the categorization scheme

$label string

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

Returns
Type Description
string Human-readable label to be displayed in applications
methodpublicgetScheme( ) : string

Returns the URI that identifies the categorization scheme Optional.

Returns
Type Description
string URI that identifies the categorization scheme
methodpublicsetLabel( string $value ) : \Zend_Gdata_Media_Extension_MediaCategory

Parameters
Name Type Description
$value string

Human-readable label to be displayed in applications

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaCategory Provides a fluent interface
methodpublicsetScheme( string $value ) : \Zend_Gdata_Media_Extension_MediaCategory

Parameters
Name Type Description
$value string

URI that identifies the categorization scheme

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaCategory 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.