Class Zend_Gdata_Extension_Rating

Description
Description | Vars (details) | Methods (details)

Implements the gd:rating element

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

Located in /Gdata/Extension/Rating.php (line 39) 

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_Extension
      |
      --Zend_Gdata_Extension
         |
         --Zend_Gdata_Extension_Rating
Variable Summary
Description | Vars (details) | Methods (details)
mixed $_average
mixed $_max
mixed $_min
mixed $_numRaters
mixed $_rootElement
mixed $_value
Method Summary
Description | Vars (details) | Methods (details)
Zend_Gdata_Extension_Rating __construct ([integer $average = null], [integer $min = null], [integer $max = null], [integer $numRaters = null], [integer $value = null])
integer getAverage ()
DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
integer getMax ()
integer getMin ()
integer getNumRaters ()
integer getValue ()
Zend_Gdata_Extension_Rating setAverage (bool $value)
Zend_Gdata_Extension_Rating setMax (bool $value)
Zend_Gdata_Extension_Rating setMin (bool $value)
Zend_Gdata_Extension_Rating setNumRaters (bool $value)
Zend_Gdata_Extension_Rating setValue (bool $value)
void takeAttributeFromDOM (DOMNode $attribute)
Variables
Description | Vars (details) | Methods (details)
mixed $_average = null (line 46)
  • access: protected
mixed $_max = null (line 44)
  • access: protected
mixed $_min = null (line 43)
  • access: protected
mixed $_numRaters = null (line 45)
  • access: protected
mixed $_rootElement = 'rating' (line 42)
  • access: protected
Redefinition of:
Zend_Gdata_App_Base::$_rootElement
mixed $_value = null (line 47)
  • access: protected

Inherited Variables

Inherited from Zend_Gdata_Extension

Zend_Gdata_Extension::$_rootNamespace

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
Description | Vars (details) Methods (details)
Constructor __construct (line 58)

Constructs a new Zend_Gdata_Extension_Rating object.

  • access: public
Zend_Gdata_Extension_Rating __construct ([integer $average = null], [integer $min = null], [integer $max = null], [integer $numRaters = null], [integer $value = null])
  • integer $average: (optional) Average rating.
  • integer $min: (optional) Minimum rating.
  • integer $max: (optional) Maximum rating.
  • integer $numRaters: (optional) Number of raters.
  • integer $value: (optional) The value of the rating.
Redefinition of:
Zend_Gdata_Extension::__construct()
getAverage (line 179)

Get the value for this element's average attribute.

  • return: The requested attribute.
  • access: public
integer getAverage ()
getDOM (line 79)

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.
getMax (line 201)

Get the value for this element's max attribute.

  • return: The requested attribute.
  • access: public
integer getMax ()
getMin (line 135)

Get the value for this element's min attribute.

  • return: The requested attribute.
  • access: public
integer getMin ()
getNumRaters (line 157)

Get the value for this element's numRaters attribute.

  • return: The requested attribute.
  • access: public
integer getNumRaters ()
getValue (line 223)

Get the value for this element's value attribute.

  • return: The requested attribute.
  • access: public
integer getValue ()
setAverage (line 190)

Set the value for this element's average attribute.

  • return: The element being modified.
  • access: public
Zend_Gdata_Extension_Rating setAverage (bool $value)
  • bool $value: The desired value for this attribute.
setMax (line 212)

Set the value for this element's max attribute.

  • return: The element being modified.
  • access: public
Zend_Gdata_Extension_Rating setMax (bool $value)
  • bool $value: The desired value for this attribute.
setMin (line 146)

Set the value for this element's min attribute.

  • return: The element being modified.
  • access: public
Zend_Gdata_Extension_Rating setMin (bool $value)
  • bool $value: The desired value for this attribute.
setNumRaters (line 168)

Set the value for this element's numRaters attribute.

  • return: The element being modified.
  • access: public
Zend_Gdata_Extension_Rating setNumRaters (bool $value)
  • bool $value: The desired value for this attribute.
setValue (line 234)

Set the value for this element's value attribute.

  • return: The element being modified.
  • access: public
Zend_Gdata_Extension_Rating setValue (bool $value)
  • bool $value: The desired value for this attribute.
takeAttributeFromDOM (line 108)

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.

  • 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.

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()

Documentation generated on Mon, 21 Jun 2010 15:41:15 -0400 by phpDocumentor 1.4.3