<?php
// (c) Copyright 2002-2015 by authors of the Tiki Wiki CMS Groupware Project
// 
// All Rights Reserved. See copyright.txt for details and a complete list of authors.
// Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
// $Id: Order.php 53803 2015-02-06 00:42:50Z jyhem $

class Search_Query_Order
{
	const FIELD_SCORE = 'score';
	const FIELD_MODIFICATION = 'modification_date';

	const MODE_NUMERIC = 'numeric';
	const MODE_TEXT = 'text';

	const ORDER_ASC = 'asc';
	const ORDER_DESC = 'desc';

	private $field;
	private $mode;
	private $order;

	function __construct($field, $mode, $order)
	{
		$this->field = $field;
		$this->mode = $mode;
		$this->order = $order;
	}

	function getField()
	{
		return $this->field;
	}

	function getOrder()
	{
		return $this->order;
	}

	function getMode()
	{
		return $this->mode;
	}

	public static function getDefault()
	{
		return self::searchResult();
	}

	public static function searchResult()
	{
		return new self(self::FIELD_SCORE, self::MODE_NUMERIC, self::ORDER_DESC);
	}

	public static function recentChanges()
	{
		return new self(self::FIELD_MODIFICATION, self::MODE_NUMERIC, self::ORDER_DESC);
	}

	public static function parse($orderString)
	{
		if (empty($orderString)) {
			return self::getDefault();
		} elseif (preg_match('/^(.+)_(asc|desc)$/', $orderString, $parts)) {
			return new self($parts[1], self::MODE_TEXT, $parts[2]);
		} elseif (preg_match('/^(.+)_n(asc|desc)$/', $orderString, $parts)) {
			return new self($parts[1], self::MODE_NUMERIC, $parts[2]);
		} else {
			return new self($orderString, self::MODE_TEXT, self::ORDER_ASC);
		}
	}
}

