API Documentation

Gdata/Books/Extension/Viewability.php

Includes Classes 
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
Books
version
$Id: Viewability.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Books_Extension_Viewability

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_Books_Extension_Viewability
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
Books
Properties
$_rootNamespace
$_rootElement
$_value
Methods
__construct
getDOM
takeAttributeFromDOM
getValue
setValue

Description

Describes a viewability

Properties

$_rootElement
jump to class

 $_rootElement = 'viewability'

Details

visibility
protected
default
viewability
final
false
static
false

$_rootNamespace
jump to class

 $_rootNamespace = 'gbs'

Details

visibility
protected
default
gbs
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( string|null $value = null ) :

Constructor for Zend_Gdata_Books_Extension_Viewability which Describes a viewability

Arguments
$value
stringnull
A programmatic value representing the book's viewability mode.
Details
visibility
public
final
false
static
false

getDOM
jump to class

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.

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

getValue
jump to class

getValue( ) : string

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

Output
string
The value
Details
visibility
public
final
false
static
false

setValue
jump to class

setValue( string $value ) : Zend_Gdata_Books_Extension_Viewability

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

Arguments
$value
string
programmatic value that describes the viewability of a volume in Googl eBook Search
Output
Zend_Gdata_Books_Extension_Viewability
Provides a fluent interface
Details
visibility
public
final
false
static
false

takeAttributeFromDOM
jump to class

takeAttributeFromDOM( DOMNode $attribute ) :

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

Arguments
$attribute
DOMNode
The DOMNode attribute to be handled.
Details
visibility
protected
final
false
static
false
Documentation was generated by DocBlox.