Moodle  2.2.1
http://www.collinsharper.com
Zend_Gdata_Extension_Rating Class Reference
Inheritance diagram for Zend_Gdata_Extension_Rating:
Collaboration diagram for Zend_Gdata_Extension_Rating:

Public Member Functions

 __construct ($average=null, $min=null, $max=null, $numRaters=null, $value=null)
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 getMin ()
 setMin ($value)
 getNumRaters ()
 setNumRaters ($value)
 getAverage ()
 setAverage ($value)
 getMax ()
 setMax ($value)
 getValue ()
 setValue ($value)

Protected Member Functions

 takeAttributeFromDOM ($attribute)

Protected Attributes

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

Detailed Description

Definition at line 39 of file Rating.php.


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.

Definition at line 58 of file Rating.php.

Here is the call graph for this function:


Member Function Documentation

Get the value for this element's average attribute.

Returns:
integer The requested attribute.

Definition at line 179 of file Rating.php.

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.

Reimplemented from Zend_Gdata_App_Base.

Definition at line 79 of file Rating.php.

getMax ( )

Get the value for this element's max attribute.

Returns:
integer The requested attribute.

Definition at line 201 of file Rating.php.

getMin ( )

Get the value for this element's min attribute.

Returns:
integer The requested attribute.

Definition at line 135 of file Rating.php.

Get the value for this element's numRaters attribute.

Returns:
integer The requested attribute.

Definition at line 157 of file Rating.php.

getValue ( )

Get the value for this element's value attribute.

Returns:
integer The requested attribute.

Definition at line 223 of file Rating.php.

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.

Definition at line 190 of file Rating.php.

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.

Definition at line 212 of file Rating.php.

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.

Definition at line 146 of file Rating.php.

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.

Definition at line 168 of file Rating.php.

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.

Definition at line 234 of file Rating.php.

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

Reimplemented from Zend_Gdata_App_Base.

Definition at line 108 of file Rating.php.


Field Documentation

$_average = null [protected]

Definition at line 46 of file Rating.php.

$_max = null [protected]

Definition at line 44 of file Rating.php.

$_min = null [protected]

Definition at line 43 of file Rating.php.

$_numRaters = null [protected]

Definition at line 45 of file Rating.php.

$_rootElement = 'rating' [protected]

Reimplemented from Zend_Gdata_App_Base.

Definition at line 42 of file Rating.php.

$_value = null [protected]

Definition at line 47 of file Rating.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations