<?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;
	}
}