Gdata/Books/Extension/Viewability.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Books  
Version
$Id$  

\Zend_Gdata_Books_Extension_Viewability

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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_rootElement = 'viewability'
Default value'viewability'Details
Type
n/a
>VPropertyprotected$_rootNamespace = 'gbs'
Default value'gbs'Details
Type
n/a
>VPropertyprotected$_value = null
Default valuenullDetails
Type
n/a

Methods

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

Constructor for Zend_Gdata_Books_Extension_Viewability which Describes a viewability

Parameters
NameTypeDescription
$valuestring | null

A programmatic value representing the book's

   viewability mode.
methodpublicgetDOM(\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
NameTypeDescription
$doc\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElementThe DOMElement representing this element and all child properties.
methodpublicgetValue() : string

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

Returns
TypeDescription
stringThe value
methodpublicsetValue(string $value) : \Zend_Gdata_Books_Extension_Viewability

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

Parameters
NameTypeDescription
$valuestring

programmatic value that describes the viewability of a volume in Googl eBook Search

Returns
TypeDescription
\Zend_Gdata_Books_Extension_ViewabilityProvides a fluent interface
methodprotectedtakeAttributeFromDOM(\DOMNode $attribute) : void

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

Parameters
NameTypeDescription
$attribute\DOMNode

The DOMNode attribute to be handled.

Documentation was generated by phpDocumentor 2.2.0 .