Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Gdata_YouTube_Extension_State Class Reference

Public Member Functions

 __construct ($explanation=null, $name=null, $reasonCode=null, $helpUrl=null)
 Constructs a new Zend_Gdata_YouTube_Extension_State object.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves a DOMElement which corresponds to this element and all child properties.
 
 getName ()
 Get the value for this element's name attribute.
 
 setName ($value)
 Set the value for this element's name attribute.
 
 getReasonCode ()
 Get the value for this element's reasonCode attribute.
 
 setReasonCode ($value)
 Set the value for this element's reasonCode attribute.
 
 getHelpUrl ()
 Get the value for this element's helpUrl attribute.
 
 setHelpUrl ($value)
 Set the value for this element's helpUrl attribute.
 
 __toString ()
 Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0.
 
- Public Member Functions inherited from Zend_Gdata_Extension
 __construct ()
 

Protected Member Functions

 takeAttributeFromDOM ($attribute)
 Given a DOMNode representing an attribute, tries to map the data into instance members.
 

Protected Attributes

 $_rootNamespace = 'yt'
 
 $_rootElement = 'state'
 
 $_name = null
 
 $_reasonCode = null
 
 $_helpUrl = null
 
- Protected Attributes inherited from Zend_Gdata_Extension
 $_rootNamespace = 'gd'
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Gdata_App_Base
static flushNamespaceLookupCache ()
 Flush namespace lookup cache.
 
- Static Protected Attributes inherited from Zend_Gdata_App_Base
static $_namespaceLookupCache = array()
 

Constructor & Destructor Documentation

__construct (   $explanation = null,
  $name = null,
  $reasonCode = null,
  $helpUrl = null 
)

Constructs a new Zend_Gdata_YouTube_Extension_State object.

Parameters
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

Member Function Documentation

__toString ( )

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

Returns
string
getDOM (   $doc = null,
  $majorVersion = 1,
  $minorVersion = null 
)

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
DOMDocument$docThe DOMDocument used to construct DOMElements
Returns
DOMElement The DOMElement representing this element and all child properties.
getHelpUrl ( )

Get the value for this element's helpUrl attribute.

Returns
int The value associated with this attribute.
getName ( )

Get the value for this element's name attribute.

Returns
int The value associated with this attribute.
getReasonCode ( )

Get the value for this element's reasonCode attribute.

Returns
int The value associated with this attribute.
setHelpUrl (   $value)

Set the value for this element's helpUrl attribute.

Parameters
int$valueThe desired value for this attribute.
Returns
Zend_Gdata_YouTube_Extension_State The element being modified.
setName (   $value)

Set the value for this element's name attribute.

Parameters
int$valueThe desired value for this attribute.
Returns
Zend_Gdata_YouTube_Extension_State The element being modified.
setReasonCode (   $value)

Set the value for this element's reasonCode attribute.

Parameters
int$valueThe desired value for this attribute.
Returns
Zend_Gdata_YouTube_Extension_State The element being modified.
takeAttributeFromDOM (   $attribute)
protected

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

Parameters
DOMNode$attributeThe DOMNode attribute needed to be handled

Member Data Documentation

$_helpUrl = null
protected
$_name = null
protected
$_reasonCode = null
protected
$_rootElement = 'state'
protected
$_rootNamespace = 'yt'
protected