add limit and offset

This commit is contained in:
Robin Appelman 2017-03-10 15:53:28 +01:00
commit 0924fa90e0
8 changed files with 132 additions and 2 deletions

View file

@ -25,6 +25,7 @@ use Sabre\Xml\Element;
use Sabre\Xml\Reader;
use Sabre\Xml\Service;
use SearchDAV\XML\BasicSearch;
use SearchDAV\XML\Limit;
use SearchDAV\XML\Literal;
use SearchDAV\XML\Operator;
use SearchDAV\XML\Order;
@ -34,7 +35,8 @@ class QueryParser extends Service {
public $namespaceMap = [
'DAV:' => 'd',
'http://sabredav.org/ns' => 's',
'http://www.w3.org/2001/XMLSchema' => 'xs'
'http://www.w3.org/2001/XMLSchema' => 'xs',
SearchPlugin::SEARCHDAV_NS => 'sd'
];
public function __construct() {
@ -72,6 +74,7 @@ class QueryParser extends Service {
'{DAV:}contains' => Operator::class,
'{DAV:}not' => Operator::class,
'{DAV:}is-collection' => Operator::class,
'{DAV:}limit' => Limit::class,
];
}
}

View file

@ -45,6 +45,8 @@ use SearchDAV\XML\Scope;
use SearchDAV\XML\SupportedQueryGrammar;
class SearchPlugin extends ServerPlugin {
const SEARCHDAV_NS = 'https://github.com/icewind1991/SearchDAV/ns';
/** @var Server */
private $server;

View file

@ -58,6 +58,12 @@ class BasicSearch implements XmlDeserializable {
* more significant.
*/
public $orderBy;
/**
* @var Limit
*
* The limit and offset for the search query
*/
public $limit;
static function xmlDeserialize(Reader $reader) {
$search = new self();
@ -72,6 +78,7 @@ class BasicSearch implements XmlDeserializable {
$search->from = $elements['{DAV:}from'];
$search->where = isset($elements['{DAV:}where']) ? $elements['{DAV:}where'] : null;
$search->orderBy = isset($elements['{DAV:}orderby']) ? $elements['{DAV:}orderby'] : [];
$search->limit = isset($elements['{DAV:}limit']) ? $elements['{DAV:}limit'] : new Limit();
return $search;
}

59
src/XML/Limit.php Normal file
View file

@ -0,0 +1,59 @@
<?php
/**
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace SearchDAV\XML;
use Sabre\Xml\Reader;
use Sabre\Xml\XmlDeserializable;
use SearchDAV\DAV\SearchPlugin;
/**
* The limit and offset of a search query
*/
class Limit implements XmlDeserializable {
/**
* @var integer
*
* The maximum number of results to be returned
*
* If set to 0 then no limit should be imposed
*/
public $maxResults = 0;
/**
* @var integer
*
* The index of the first result to be returned (offset)
*/
public $firstResult = 0;
static function xmlDeserialize(Reader $reader) {
$limit = new self();
$elements = \Sabre\Xml\Deserializer\keyValue($reader);
$namespace = SearchPlugin::SEARCHDAV_NS;
$limit->maxResults = isset($elements['{DAV:}nresults']) ? $elements['{DAV:}nresults'] : 0;
$firstResult = '{' . $namespace . '}firstresult';
$limit->firstResult = isset($elements[$firstResult]) ? $elements[$firstResult] : 0;
return $limit;
}
}