searchdav/src/XML/BasicSearch.php
2017-02-01 14:56:25 +01:00

72 lines
2.3 KiB
PHP

<?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;
/**
* The object representation of a search query made by the client
*/
class BasicSearch implements XmlDeserializable {
/**
* @var string[]
*
* The list of properties to be selected, specified in clark notation
*/
public $select;
/**
* @var Scope[]
*
* The collections to perform the search in
*/
public $from;
/**
* @var Operator
*
* The search operator, either a comparison ('gt', 'eq', ...) or a boolean operator ('and', 'or', 'not')
*/
public $where;
/**
* @var Order[]
*
* The list of order operations that should be used to order the results.
*
* Each order operations consists of a property to sort on and a sort direction.
* If more then one order operations are specified, the comparisons for ordering should
* be applied in the order that the order operations are defined in with the earlier comparisons being
* more significant.
*/
public $orderBy;
static function xmlDeserialize(Reader $reader) {
$search = new self();
$elements = \Sabre\Xml\Deserializer\keyValue($reader);
$search->select = isset($elements['{DAV:}select']) ? $elements['{DAV:}select'] : null;
$search->from = isset($elements['{DAV:}from']) ? $elements['{DAV:}from'] : null;
$search->where = isset($elements['{DAV:}where']) ? $elements['{DAV:}where'] : null;
$search->orderBy = isset($elements['{DAV:}orderby']) ? $elements['{DAV:}orderby'] : null;
return $search;
}
}