Zend/Gdata/YouTube/Extension/State.php

Show:

inherited

Classes
- \Zend_Gdata_YouTube_Extension_State

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: YouTube
Version: $Id: State.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_YouTube_Extension_State
jump to top

Package: Zend\Gdata\YouTube

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

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


                 $_helpUrl= 'null'

Default valuenullDetails

Type


                 $_name= 'null'

Default valuenullDetails

Type


                 $_reasonCode= 'null'

Default valuenullDetails

Type


                 $_rootElement= ''state''

Default value'state'Details

Type


                 $_rootNamespace= ''yt''

Default value'yt'Details

Type

Methods

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

Constructs a new Zend_Gdata_YouTube_Extension_State object.

Parameters

Name	Type	Description
$explanation
$name
$reasonCode
$helpUrl

__toString(
          
          )
        
        :
          string

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

Returns

Type	Description
string

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.

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.

getHelpUrl(
          
          )
        
        :
          int

Get the value for this element's helpUrl attribute.

Returns

Type	Description
int	The value associated with this attribute.

getName(
          
          )
        
        :
          int

Get the value for this element's name attribute.

Returns

Type	Description
int	The value associated with this attribute.

getReasonCode(
          
          )
        
        :
          int

Get the value for this element's reasonCode attribute.

Returns

Type	Description
int	The value associated with this attribute.

setHelpUrl(
          int $value
          )
        
        :
          \Zend_Gdata_YouTube_Extension_State

Set the value for this element's helpUrl attribute.

Parameters

Name	Type	Description
$value	int	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_State	The element being modified.

setName(
          int $value
          )
        
        :
          \Zend_Gdata_YouTube_Extension_State

Set the value for this element's name attribute.

Parameters

Name	Type	Description
$value	int	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_State	The element being modified.

setReasonCode(
          int $value
          )
        
        :
          \Zend_Gdata_YouTube_Extension_State

Set the value for this element's reasonCode attribute.

Parameters

Name	Type	Description
$value	int	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_State	The element being modified.

takeAttributeFromDOM(
          \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 valueare stored in an array.

TODO: Convert attributes to proper types

Parameters

Name	Type	Description
$attribute	\DOMNode	The DOMNode attribute needed to be handled

API Documentation

Zend/Gdata/YouTube/Extension/State.php

\Zend_Gdata_YouTube_Extension_Statejump to top

Properties

Methods

\Zend_Gdata_YouTube_Extension_State
jump to top