Gdata/YouTube/Extension/State.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: YouTube
version: $Id: State.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_YouTube_Extension_State

Description

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.

Zend_Gdata_YouTube_Extension_State
jump to top

Extends from: Zend_Gdata_Extension
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: YouTube
Properties: $_rootNamespace; $_rootElement; $_name; $_reasonCode; $_helpUrl
Methods: __construct; getDOM; takeAttributeFromDOM; getName; setName; getReasonCode; setReasonCode; getHelpUrl; setHelpUrl; __toString

Description

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

Properties

$_helpUrl
jump to class

$_helpUrl = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_name
jump to class

$_name = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_reasonCode
jump to class

$_reasonCode = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_rootElement
jump to class

$_rootElement = 'state'

Details

visibility: protected
default: state
final: false
static: false

$_rootNamespace
jump to class

$_rootNamespace = 'yt'

Details

visibility: protected
default: yt
final: false
static: false

Methods

__construct
jump to class

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

Constructs a new Zend_Gdata_YouTube_Extension_State object.

Arguments

$explanation
$name
$reasonCode
$helpUrl

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

getDOM
jump to class

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.

Arguments

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

Output

DOMElement: The DOMElement representing this element and all child properties.

Details

visibility: public
final: false
static: false

getHelpUrl
jump to class

getHelpUrl(
          
          )
        
        :
        int

Get the value for this element's helpUrl attribute.

Output

int: The value associated with this attribute.

Details

visibility: public
final: false
static: false

getName
jump to class

getName(
          
          )
        
        :
        int

Get the value for this element's name attribute.

Output

int: The value associated with this attribute.

Details

visibility: public
final: false
static: false

getReasonCode
jump to class

getReasonCode(
          
          )
        
        :
        int

Get the value for this element's reasonCode attribute.

Output

int: The value associated with this attribute.

Details

visibility: public
final: false
static: false

setHelpUrl
jump to class

setHelpUrl(
          int $value
          )
        
        :
        Zend_Gdata_YouTube_Extension_State

Set the value for this element's helpUrl attribute.

Arguments

$value: int
The desired value for this attribute.

Output

Zend_Gdata_YouTube_Extension_State: The element being modified.

Details

visibility: public
final: false
static: false

setName
jump to class

setName(
          int $value
          )
        
        :
        Zend_Gdata_YouTube_Extension_State

Set the value for this element's name attribute.

Arguments

$value: int
The desired value for this attribute.

Output

Zend_Gdata_YouTube_Extension_State: The element being modified.

Details

visibility: public
final: false
static: false

setReasonCode
jump to class

setReasonCode(
          int $value
          )
        
        :
        Zend_Gdata_YouTube_Extension_State

Set the value for this element's reasonCode attribute.

Arguments

$value: int
The desired value for this attribute.

Output

Zend_Gdata_YouTube_Extension_State: The element being modified.

Details

visibility: public
final: false
static: false

takeAttributeFromDOM
jump to class

takeAttributeFromDOM(
          DOMNode $attribute
          )
        
        :

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

Arguments

$attribute: DOMNode
The DOMNode attribute needed to be handled

Details

visibility: protected
final: false
static: false

API Documentation

Gdata/YouTube/Extension/State.php

Description

Zend_Gdata_YouTube_Extension_Statejump to top

Description

Properties

$_helpUrljump to class

Details

$_namejump to class

Details

$_reasonCodejump to class

Details

$_rootElementjump to class

Details

$_rootNamespacejump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

getDOMjump to class

Arguments

Output

Details

getHelpUrljump to class

Output

Details

getNamejump to class

Output

Details

getReasonCodejump to class

Output

Details

setHelpUrljump to class

Arguments

Output

Details

setNamejump to class

Arguments

Output

Details

setReasonCodejump to class

Arguments

Output

Details

takeAttributeFromDOMjump to class

Arguments

Details

Zend_Gdata_YouTube_Extension_State
jump to top

$_helpUrl
jump to class

$_name
jump to class

$_reasonCode
jump to class

$_rootElement
jump to class

$_rootNamespace
jump to class

__construct
jump to class

__toString
jump to class

getDOM
jump to class

getHelpUrl
jump to class

getName
jump to class

getReasonCode
jump to class

setHelpUrl
jump to class

setName
jump to class

setReasonCode
jump to class

takeAttributeFromDOM
jump to class