Docs For Class Zend_Gdata_YouTube_Extension

Description

Represents the yt:state element used by the YouTube data API

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Gdata/YouTube/Extension/State.php (line 38)

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_Extension
      |
      --Zend_Gdata_Extension
         |
         --Zend_Gdata_YouTube_Extension_State

Variable Summary

mixed $_helpUrl

mixed $_name

mixed $_reasonCode

mixed $_rootElement

mixed $_rootNamespace

Method Summary

Zend_Gdata_YouTube_Extension_State __construct ([ $explanation = null], [ $name = null], [ $reasonCode = null], [ $helpUrl = null], string $explanation(optional), string $name(optional), string $reasonCode(optional), string $helpUrl(optional))

DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])

int getHelpUrl ()

int getName ()

int getReasonCode ()

Zend_Gdata_YouTube_Extension_State setHelpUrl (int $value)

Zend_Gdata_YouTube_Extension_State setName (int $value)

Zend_Gdata_YouTube_Extension_State setReasonCode (int $value)

void takeAttributeFromDOM (DOMNode $attribute)

string __toString ()

Variables

mixed $_helpUrl = null (line 45)

access: protected

mixed $_name = null (line 43)

access: protected

mixed $_reasonCode = null (line 44)

access: protected

mixed $_rootElement = 'state' (line 42)

access: protected

Redefinition of:

Zend_Gdata_App_Base::$_rootElement

mixed $_rootNamespace = 'yt' (line 41)

access: protected

Redefinition of:

Zend_Gdata_Extension::$_rootNamespace

Inherited Variables

Inherited from Zend_Gdata_App_Base

Zend_Gdata_App_Base::$_extensionAttributes
Zend_Gdata_App_Base::$_extensionElements
Zend_Gdata_App_Base::$_namespaceLookupCache
Zend_Gdata_App_Base::$_namespaces
Zend_Gdata_App_Base::$_rootNamespaceURI
Zend_Gdata_App_Base::$_text

Methods

Constructor __construct (line 55)

Constructs a new Zend_Gdata_YouTube_Extension_State object.

access: public

Zend_Gdata_YouTube_Extension_State __construct ([ $explanation = null], [ $name = null], [ $reasonCode = null], [ $helpUrl = null], string $explanation(optional), string $name(optional), string $reasonCode(optional), string $helpUrl(optional))

string $explanation(optional): The explanation of this state
string $name(optional): The name value
string $reasonCode(optional): The reasonCode value
string $helpUrl(optional): The helpUrl value
$explanation
$name
$reasonCode
$helpUrl

Redefinition of:

Zend_Gdata_Extension::__construct()

getDOM (line 76)

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.

return: The DOMElement representing this element and all child properties.
access: public

DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])

DOMDocument $doc: The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion

Redefinition of:

Zend_Gdata_App_Base::getDOM(): 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.

getHelpUrl (line 165)

Get the value for this element's helpUrl attribute.

return: The value associated with this attribute.
access: public

int getHelpUrl ()

getName (line 121)

Get the value for this element's name attribute.

return: The value associated with this attribute.
access: public

int getName ()

getReasonCode (line 143)

Get the value for this element's reasonCode attribute.

return: The value associated with this attribute.
access: public

int getReasonCode ()

setHelpUrl (line 176)

Set the value for this element's helpUrl attribute.

return: The element being modified.
access: public

Zend_Gdata_YouTube_Extension_State setHelpUrl (int $value)

int $value: The desired value for this attribute.

setName (line 132)

Set the value for this element's name attribute.

return: The element being modified.
access: public

Zend_Gdata_YouTube_Extension_State setName (int $value)

int $value: The desired value for this attribute.

setReasonCode (line 154)

Set the value for this element's reasonCode attribute.

return: The element being modified.
access: public

Zend_Gdata_YouTube_Extension_State setReasonCode (int $value)

int $value: The desired value for this attribute.

takeAttributeFromDOM (line 99)

Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and valueare stored in an array.

TODO: Convert attributes to proper types

access: protected

void takeAttributeFromDOM (DOMNode $attribute)

DOMNode $attribute: The DOMNode attribute needed to be handled

Redefinition of:

Zend_Gdata_App_Base::takeAttributeFromDOM(): 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.

__toString (line 188)

Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

access: public

string __toString ()

Redefinition of:

Zend_Gdata_App_Base::__toString(): Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

Inherited Methods

Inherited From Zend_Gdata_Extension

Zend_Gdata_Extension::__construct()

Inherited From Zend_Gdata_App_Base

Zend_Gdata_App_Base::__construct()
Zend_Gdata_App_Base::encode()
Zend_Gdata_App_Base::flushNamespaceLookupCache()
Zend_Gdata_App_Base::getDOM()
Zend_Gdata_App_Base::getExtensionAttributes()
Zend_Gdata_App_Base::getExtensionElements()
Zend_Gdata_App_Base::getText()
Zend_Gdata_App_Base::getXML()
Zend_Gdata_App_Base::lookupNamespace()
Zend_Gdata_App_Base::registerAllNamespaces()
Zend_Gdata_App_Base::registerNamespace()
Zend_Gdata_App_Base::saveXML()
Zend_Gdata_App_Base::setExtensionAttributes()
Zend_Gdata_App_Base::setExtensionElements()
Zend_Gdata_App_Base::setText()
Zend_Gdata_App_Base::takeAttributeFromDOM()
Zend_Gdata_App_Base::takeChildFromDOM()
Zend_Gdata_App_Base::transferFromDOM()
Zend_Gdata_App_Base::transferFromXML()
Zend_Gdata_App_Base::__get()
Zend_Gdata_App_Base::__isset()
Zend_Gdata_App_Base::__set()
Zend_Gdata_App_Base::__toString()
Zend_Gdata_App_Base::__unset()