Zend/Gdata/Books/Extension/Viewability.php

Show:

inherited

Classes
- \Zend_Gdata_Books_Extension_Viewability

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

\Zend_Gdata_Books_Extension_Viewability
jump to top

Package: Zend\Gdata\Books

Describes a viewability

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


                 $_rootElement= ''viewability''

Default value'viewability'Details

Type


                 $_rootNamespace= ''gbs''

Default value'gbs'Details

Type


                 $_value= 'null'

Default valuenullDetails

Type

Methods

__construct(
          string|null $value
              =
              null
          )
        
        :
          void

Constructor for Zend_Gdata_Books_Extension_Viewability which Describes a viewability

Parameters

Name	Type	Description
$value	string\|null	A programmatic value representing the book's viewability mode.

getDOM(
          \DOMDocument $doc
              =
              null,  $majorVersion
              =
              1,  $minorVersion
              =
              null
          )
        
        :
          \DOMElement

Retrieves DOMElement which corresponds to this element and all child properties. This is used to build this object back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistance.

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.

getValue(
          
          )
        
        :
          string

Returns the programmatic value that describes the viewability of a volume in Google Book Search

Returns

Type	Description
string	The value

setValue(
          string $value
          )
        
        :
          \Zend_Gdata_Books_Extension_Viewability

Sets the programmatic value that describes the viewability of a volume in Google Book Search

Parameters

Name	Type	Description
$value	string	programmatic value that describes the viewability of a volume in Googl eBook Search

Returns

Type	Description
\Zend_Gdata_Books_Extension_Viewability	Provides a fluent interface

takeAttributeFromDOM(
          \DOMNode $attribute
          )
        
        :
          void

Extracts XML attributes from the DOM and converts them to the appropriate object members.

Parameters

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

API Documentation

Zend/Gdata/Books/Extension/Viewability.php

\Zend_Gdata_Books_Extension_Viewabilityjump to top

Properties

Methods

\Zend_Gdata_Books_Extension_Viewability
jump to top