mirror of
https://github.com/nextcloud/server.git
synced 2025-02-25 17:30:20 +00:00
117 lines
2.6 KiB
PHP
117 lines
2.6 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
|
*
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
|
* @author Maxence Lange <maxence@artificial-owl.com>
|
|
* @author 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 OCP\Files\Search;
|
|
|
|
/**
|
|
* @since 12.0.0
|
|
*
|
|
* @psalm-type ParamSingleValue = \DateTime|int|string|bool
|
|
* @psalm-type ParamValue = ParamSingleValue|list<ParamSingleValue>
|
|
*/
|
|
interface ISearchComparison extends ISearchOperator {
|
|
/**
|
|
* @since 12.0.0
|
|
*/
|
|
public const COMPARE_EQUAL = 'eq';
|
|
|
|
/**
|
|
* @since 12.0.0
|
|
*/
|
|
public const COMPARE_GREATER_THAN = 'gt';
|
|
|
|
/**
|
|
* @since 12.0.0
|
|
*/
|
|
public const COMPARE_GREATER_THAN_EQUAL = 'gte';
|
|
|
|
/**
|
|
* @since 12.0.0
|
|
*/
|
|
public const COMPARE_LESS_THAN = 'lt';
|
|
|
|
/**
|
|
* @since 12.0.0
|
|
*/
|
|
public const COMPARE_LESS_THAN_EQUAL = 'lte';
|
|
|
|
/**
|
|
* @since 12.0.0
|
|
*/
|
|
public const COMPARE_LIKE = 'like';
|
|
|
|
/**
|
|
* @since 23.0.0
|
|
*/
|
|
public const COMPARE_LIKE_CASE_SENSITIVE = 'clike';
|
|
|
|
/**
|
|
* @since 28.0.0
|
|
*/
|
|
public const COMPARE_DEFINED = 'is-defined';
|
|
|
|
/**
|
|
* @since 29.0.0
|
|
*/
|
|
public const COMPARE_IN = 'in';
|
|
|
|
/**
|
|
* @since 23.0.0
|
|
*/
|
|
public const HINT_PATH_EQ_HASH = 'path_eq_hash'; // transform `path = "$path"` into `path_hash = md5("$path")`, on by default
|
|
|
|
/**
|
|
* Get the type of comparison, one of the ISearchComparison::COMPARE_* constants
|
|
*
|
|
* @return string
|
|
* @since 12.0.0
|
|
*/
|
|
public function getType(): string;
|
|
|
|
/**
|
|
* Get the name of the field to compare with
|
|
*
|
|
* i.e. 'size', 'name' or 'mimetype'
|
|
*
|
|
* @return string
|
|
* @since 12.0.0
|
|
*/
|
|
public function getField(): string;
|
|
|
|
/**
|
|
* extra means data are not related to the main files table
|
|
*
|
|
* @return string
|
|
* @since 28.0.0
|
|
*/
|
|
public function getExtra(): string;
|
|
|
|
/**
|
|
* Get the value to compare the field with
|
|
*
|
|
* @return ParamValue
|
|
* @since 12.0.0
|
|
*/
|
|
public function getValue(): string|int|bool|\DateTime|array;
|
|
}
|