API Documentation

Zend/Gdata/Extension/Rating.php

Show:

inherited

Classes
- \Zend_Gdata_Extension_Rating

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

\Zend_Gdata_Extension_Rating
jump to top

Package: Zend\Gdata\Gdata

Implements the gd:rating element

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


                 $_average= 'null'

Default valuenullDetails

Type


                 $_max= 'null'

Default valuenullDetails

Type


                 $_min= 'null'

Default valuenullDetails

Type


                 $_numRaters= 'null'

Default valuenullDetails

Type


                 $_rootElement= ''rating''

Default value'rating'Details

Type


                 $_value= 'null'

Default valuenullDetails

Type

Methods

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

Constructs a new Zend_Gdata_Extension_Rating object.

Parameters

Name	Type	Description
$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.

getAverage(
          
          )
        
        :
          integer

Get the value for this element's average attribute.

Returns

Type	Description
integer	The requested attribute.

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.

getMax(
          
          )
        
        :
          integer

Get the value for this element's max attribute.

Returns

Type	Description
integer	The requested attribute.

getMin(
          
          )
        
        :
          integer

Get the value for this element's min attribute.

Returns

Type	Description
integer	The requested attribute.

getNumRaters(
          
          )
        
        :
          integer

Get the value for this element's numRaters attribute.

Returns

Type	Description
integer	The requested attribute.

getValue(
          
          )
        
        :
          integer

Get the value for this element's value attribute.

Returns

Type	Description
integer	The requested attribute.

setAverage(
          bool $value
          )
        
        :
          \Zend_Gdata_Extension_Rating

Set the value for this element's average attribute.

Parameters

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

Returns

Type	Description
\Zend_Gdata_Extension_Rating	The element being modified.

setMax(
          bool $value
          )
        
        :
          \Zend_Gdata_Extension_Rating

Set the value for this element's max attribute.

Parameters

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

Returns

Type	Description
\Zend_Gdata_Extension_Rating	The element being modified.

setMin(
          bool $value
          )
        
        :
          \Zend_Gdata_Extension_Rating

Set the value for this element's min attribute.

Parameters

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

Returns

Type	Description
\Zend_Gdata_Extension_Rating	The element being modified.

setNumRaters(
          bool $value
          )
        
        :
          \Zend_Gdata_Extension_Rating

Set the value for this element's numRaters attribute.

Parameters

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

Returns

Type	Description
\Zend_Gdata_Extension_Rating	The element being modified.

setValue(
          bool $value
          )
        
        :
          \Zend_Gdata_Extension_Rating

Set the value for this element's value attribute.

Parameters

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

Returns

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

Parameters

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