VolumeQuery.php
3.01 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<?php
/**
* 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
* @package Zend_Gdata
* @subpackage Books
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: VolumeQuery.php 23775 2011-03-01 17:25:24Z ralph $
*/
/**
* Zend_Gdata_Books
*/
require_once('Zend/Gdata/Books.php');
/**
* Zend_Gdata_Query
*/
require_once('Zend/Gdata/Query.php');
/**
* Assists in constructing queries for Books volumes
*
* @category Zend
* @package Zend_Gdata
* @subpackage Books
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Gdata_Books_VolumeQuery extends Zend_Gdata_Query
{
/**
* Create Gdata_Books_VolumeQuery object
*
* @param string|null $url If non-null, pre-initializes the instance to
* use a given URL.
*/
public function __construct($url = null)
{
parent::__construct($url);
}
/**
* Sets the minimum level of viewability of volumes to return in the search results
*
* @param string|null $value The minimum viewability - 'full' or 'partial'
* @return Zend_Gdata_Books_VolumeQuery Provides a fluent interface
*/
public function setMinViewability($value = null)
{
switch ($value) {
case 'full_view':
$this->_params['min-viewability'] = 'full';
break;
case 'partial_view':
$this->_params['min-viewability'] = 'partial';
break;
case null:
unset($this->_params['min-viewability']);
break;
}
return $this;
}
/**
* Minimum viewability of volumes to include in search results
*
* @return string|null min-viewability
*/
public function getMinViewability()
{
if (array_key_exists('min-viewability', $this->_params)) {
return $this->_params['min-viewability'];
} else {
return null;
}
}
/**
* Returns the generated full query URL
*
* @return string The URL
*/
public function getQueryUrl()
{
if (isset($this->_url)) {
$url = $this->_url;
} else {
$url = Zend_Gdata_Books::VOLUME_FEED_URI;
}
if ($this->getCategory() !== null) {
$url .= '/-/' . $this->getCategory();
}
$url = $url . $this->getQueryString();
return $url;
}
}