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

Public Member Functions

 __construct ($average=null, $min=null, $max=null, $numRaters=null, $value=null)
 Constructs a new Zend_Gdata_Extension_Rating object.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves a DOMElement which corresponds to this element and all child properties.
 
 getMin ()
 Get the value for this element's min attribute.
 
 setMin ($value)
 Set the value for this element's min attribute.
 
 getNumRaters ()
 Get the value for this element's numRaters attribute.
 
 setNumRaters ($value)
 Set the value for this element's numRaters attribute.
 
 getAverage ()
 Get the value for this element's average attribute.
 
 setAverage ($value)
 Set the value for this element's average attribute.
 
 getMax ()
 Get the value for this element's max attribute.
 
 setMax ($value)
 Set the value for this element's max attribute.
 
 getValue ()
 Get the value for this element's value attribute.
 
 setValue ($value)
 Set the value for this element's value attribute.
 
- 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

 $_rootElement = 'rating'
 
 $_min = null
 
 $_max = null
 
 $_numRaters = null
 
 $_average = null
 
 $_value = 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 (   $average = null,
  $min = null,
  $max = null,
  $numRaters = null,
  $value = null 
)

Constructs a new Zend_Gdata_Extension_Rating object.

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

Member Function Documentation

getAverage ( )

Get the value for this element's average attribute.

Returns
integer The requested attribute.
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.
getMax ( )

Get the value for this element's max attribute.

Returns
integer The requested attribute.
getMin ( )

Get the value for this element's min attribute.

Returns
integer The requested attribute.
getNumRaters ( )

Get the value for this element's numRaters attribute.

Returns
integer The requested attribute.
getValue ( )

Get the value for this element's value attribute.

Returns
integer The requested attribute.
setAverage (   $value)

Set the value for this element's average attribute.

Parameters
bool$valueThe desired value for this attribute.
Returns
Zend_Gdata_Extension_Rating The element being modified.
setMax (   $value)

Set the value for this element's max attribute.

Parameters
bool$valueThe desired value for this attribute.
Returns
Zend_Gdata_Extension_Rating The element being modified.
setMin (   $value)

Set the value for this element's min attribute.

Parameters
bool$valueThe desired value for this attribute.
Returns
Zend_Gdata_Extension_Rating The element being modified.
setNumRaters (   $value)

Set the value for this element's numRaters attribute.

Parameters
bool$valueThe desired value for this attribute.
Returns
Zend_Gdata_Extension_Rating The element being modified.
setValue (   $value)

Set the value for this element's value attribute.

Parameters
bool$valueThe desired value for this attribute.
Returns
Zend_Gdata_Extension_Rating 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 value are stored in an array.

Parameters
DOMNode$attributeThe DOMNode attribute needed to be handled

Member Data Documentation

$_average = null
protected
$_max = null
protected
$_min = null
protected
$_numRaters = null
protected
$_rootElement = 'rating'
protected
$_value = null
protected