Gdata/Extension/Rating.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: Gdata
version: $Id: Rating.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_Extension_Rating

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_Extension_Rating
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: Gdata
Properties: $_rootElement; $_min; $_max; $_numRaters; $_average; $_value
Methods: __construct; getDOM; takeAttributeFromDOM; getMin; setMin; getNumRaters; setNumRaters; getAverage; setAverage; getMax; setMax; getValue; setValue

Description

Implements the gd:rating element

Properties

$_average
jump to class

$_average = 'null'

Details

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

$_max
jump to class

$_max = 'null'

Details

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

$_min
jump to class

$_min = 'null'

Details

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

$_numRaters
jump to class

$_numRaters = 'null'

Details

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

$_rootElement
jump to class

$_rootElement = 'rating'

Details

visibility: protected
default: rating
final: false
static: false

$_value
jump to class

$_value = 'null'

Details

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

Methods

__construct
jump to class

__construct(
          integer $average
              =
              null, integer $min
              =
              null, integer $max
              =
              null, integer $numRaters
              =
              null, integer $value
              =
              null
          )
        
        :

Constructs a new Zend_Gdata_Extension_Rating object.

Arguments

$average: integer
(optional) Average rating.
$min: integer
(optional) Minimum rating.
$max: integer
(optional) Maximum rating.
$numRaters: integer
(optional) Number of raters.
$value: integer
(optional) The value of the rating.

Details

visibility: public
final: false
static: false

getAverage
jump to class

getAverage(
          
          )
        
        :
        integer

Get the value for this element's average attribute.

Output

integer: The requested attribute.

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

getMax
jump to class

getMax(
          
          )
        
        :
        integer

Get the value for this element's max attribute.

Output

integer: The requested attribute.

Details

visibility: public
final: false
static: false

getMin
jump to class

getMin(
          
          )
        
        :
        integer

Get the value for this element's min attribute.

Output

integer: The requested attribute.

Details

visibility: public
final: false
static: false

getNumRaters
jump to class

getNumRaters(
          
          )
        
        :
        integer

Get the value for this element's numRaters attribute.

Output

integer: The requested attribute.

Details

visibility: public
final: false
static: false

getValue
jump to class

getValue(
          
          )
        
        :
        integer

Get the value for this element's value attribute.

Output

integer: The requested attribute.

Details

visibility: public
final: false
static: false

setAverage
jump to class

setAverage(
          bool $value
          )
        
        :
        Zend_Gdata_Extension_Rating

Set the value for this element's average attribute.

Arguments

$value: bool
The desired value for this attribute.

Output

Zend_Gdata_Extension_Rating: The element being modified.

Details

visibility: public
final: false
static: false

setMax
jump to class

setMax(
          bool $value
          )
        
        :
        Zend_Gdata_Extension_Rating

Set the value for this element's max attribute.

Arguments

$value: bool
The desired value for this attribute.

Output

Zend_Gdata_Extension_Rating: The element being modified.

Details

visibility: public
final: false
static: false

setMin
jump to class

setMin(
          bool $value
          )
        
        :
        Zend_Gdata_Extension_Rating

Set the value for this element's min attribute.

Arguments

$value: bool
The desired value for this attribute.

Output

Zend_Gdata_Extension_Rating: The element being modified.

Details

visibility: public
final: false
static: false

setNumRaters
jump to class

setNumRaters(
          bool $value
          )
        
        :
        Zend_Gdata_Extension_Rating

Set the value for this element's numRaters attribute.

Arguments

$value: bool
The desired value for this attribute.

Output

Zend_Gdata_Extension_Rating: The element being modified.

Details

visibility: public
final: false
static: false

setValue
jump to class

setValue(
          bool $value
          )
        
        :
        Zend_Gdata_Extension_Rating

Set the value for this element's value attribute.

Arguments

$value: bool
The desired value for this attribute.

Output

Zend_Gdata_Extension_Rating: 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 value are stored in an array.

Arguments

$attribute: DOMNode
The DOMNode attribute needed to be handled

Details

visibility: protected
final: false
static: false

API Documentation

Gdata/Extension/Rating.php

Description

Zend_Gdata_Extension_Ratingjump to top

Description

Properties

$_averagejump to class

Details

$_maxjump to class

Details

$_minjump to class

Details

$_numRatersjump to class

Details

$_rootElementjump to class

Details

$_valuejump to class

Details

Methods

__constructjump to class

Arguments

Details

getAveragejump to class

Output

Details

getDOMjump to class

Arguments

Output

Details

getMaxjump to class

Output

Details

getMinjump to class

Output

Details

getNumRatersjump to class

Output

Details

getValuejump to class

Output

Details

setAveragejump to class

Arguments

Output

Details

setMaxjump to class

Arguments

Output

Details

setMinjump to class

Arguments

Output

Details

setNumRatersjump to class

Arguments

Output

Details

setValuejump to class

Arguments

Output

Details

takeAttributeFromDOMjump to class

Arguments

Details

Zend_Gdata_Extension_Rating
jump to top

$_average
jump to class

$_max
jump to class

$_min
jump to class

$_numRaters
jump to class

$_rootElement
jump to class

$_value
jump to class

__construct
jump to class

getAverage
jump to class

getDOM
jump to class

getMax
jump to class

getMin
jump to class

getNumRaters
jump to class

getValue
jump to class

setAverage
jump to class

setMax
jump to class

setMin
jump to class

setNumRaters
jump to class

setValue
jump to class

takeAttributeFromDOM
jump to class