public function testVolumesListPrintType()
{
/** @var Query $query */
$query = new VolumeSearchQuery('Flowers');
/*
* Filter Books
*/
/** @var Response $response */
$response = $this->volume_search->volumesList($query, false, null, null, 0, 10, null, PublicationTypeEnum::BOOKS());
$this->assertEquals(200, $response->getStatusCode());
$json = (string) $response->getBody();
$data = json_decode($json, true);
foreach ($data['items'] as $volume) {
$this->assertEquals($volume['volumeInfo']['printType'], 'BOOK');
}
/*
* Filter Magazines
*/
/** @var Response $response */
$response = $this->volume_search->volumesList($query, false, null, null, 0, 10, null, PublicationTypeEnum::MAGAZINES());
$this->assertEquals(200, $response->getStatusCode());
$json = (string) $response->getBody();
$data = json_decode($json, true);
foreach ($data['items'] as $volume) {
$this->assertEquals($volume['volumeInfo']['printType'], 'MAGAZINE');
}
}
/**
* Performs a book search.
*
* @param QueryInterface $q Full-text Search query object
* @param bool $download Restrict to volumes by download availability.
* @param VolumeFilterEnum $filter Filter search results.
* Acceptable values are:
* "ebooks" - All Google eBooks.
* "free-ebooks" - Google eBook with full volume text viewability.
* "full" - Public can view entire volume text.
* "paid-ebooks" - Google eBook with a price.
* "partial" - Public able to see parts of text.
* @param string $lang_restrict Restrict results to books with this language code. ISO-639-1 code.
* @param int $start_index Index of the first result to return (starts at 0)
* @param int $max_results Maximum number of results to return. Acceptable values are 0 to 40,
* inclusive. Default is 40 (self::MAX_RESULTS).
* @param OrderByEnum $order_by Sort search results.
* Acceptable values are:
* "newest" - Most recently published.
* "relevance" - Relevance to search terms.
* @param PublicationTypeEnum $print_type Restrict to books or magazines.
* Acceptable values are:
* "all" - All volume content types.
* "books" - Just books.
* "magazines" - Just magazines.
* @param ProjectionEnum $projection Restrict information returned to a set of selected fields.
* Acceptable values are:
* "full" - Includes all volume data.
* "lite" - Includes a subset of fields in volumeInfo and accessInfo.
*
* @return Volumes
* @throws ArgumentOutOfBoundsException
* @throws UsageExceededException
*/
public function volumesList(QueryInterface $q, $download = false, VolumeFilterEnum $filter = null, $lang_restrict = null, $start_index = 0, $max_results = self::MAX_RESULTS, OrderByEnum $order_by = null, PublicationTypeEnum $print_type = null, ProjectionEnum $projection = null)
{
$api_method = 'volumes/';
$query = [];
$query['q'] = (string) $q;
// Google Books API only filters based on downloadable epub content.
if (true === $download) {
$query['download'] = 'epub';
}
// Filter types of volumes
if ($filter instanceof VolumeFilterEnum) {
$query['filter'] = $filter->value();
}
// ISO-639-1 specification require language code to be in 2-character presentation
if (strlen($lang_restrict) == 2) {
$query['langRestrict'] = $lang_restrict;
} elseif (null !== $lang_restrict) {
throw new ArgumentOutOfBoundsException('Language restriction has to be in ISO-639-1 standard.');
}
// Number of volume matches to return in a single response
if ($max_results < 0 or $max_results > 40) {
throw new ArgumentOutOfBoundsException('Max results has to be a value between 0 and 40');
} else {
$query['maxResults'] = $max_results;
}
// Ordering of results
if (null === $order_by) {
$query['orderBy'] = OrderByEnum::RELEVANCE()->value();
} else {
$query['orderBy'] = $order_by->value();
}
// Publication / Print type
if (null === $print_type) {
$query['printType'] = PublicationTypeEnum::ALL()->value();
} else {
$query['printType'] = $print_type->value();
}
// Projection
if ($projection) {
$query['projection'] = $projection->value();
}
// Start index (cursor) for results
if ($start_index < 0) {
throw new ArgumentOutOfBoundsException('Start index cannot be a negative number');
} else {
$query['startIndex'] = (int) $start_index;
}
try {
$json = $this->send('get', $api_method, ['query' => $query]);
} catch (ClientException $e) {
$json = json_decode($e->getResponse()->getBody(), true);
// Error handling
if ($e->getResponse()->getStatusCode() == 403) {
foreach ($json['error']['errors'] as $error) {
switch ($error['domain']) {
case 'usageLimits':
throw new UsageExceededException($error['message']);
break;
}
}
}
// Throw the original exception
throw $e;
}
return $json;
}