nextcloud / server

lib/private/FullTextSearch/Model/SearchRequestSimpleQuery.php

Indentation +139 added lines, -139 removed lines

@@ -45,144 +45,144 @@
 final class SearchRequestSimpleQuery implements ISearchRequestSimpleQuery, JsonSerializable {
 
 
-	/** @var int */
-	private $type = 0;
-
-	/** @var string */
-	private $field = '';
-
-	/** @var array */
-	private $values = [];
-
-
-	/**
-	 * SearchRequestQuery constructor.
-	 *
-	 * @param $type
-	 * @param $field
-	 *
-	 * @since 17.0.0
-	 */
-	public function __construct(string $field, int $type) {
-		$this->field = $field;
-		$this->type = $type;
-	}
-
-
-	/**
-	 * Get the compare type of the query
-	 *
-	 * @return int
-	 * @since 17.0.0
-	 */
-	public function getType(): int {
-		return $this->type;
-	}
-
-
-	/**
-	 * Get the field to apply query
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getField(): string {
-		return $this->field;
-	}
-
-	/**
-	 * Set the field to apply query
-	 *
-	 * @param string $field
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function setField(string $field): ISearchRequestSimpleQuery {
-		$this->field = $field;
-
-		return $this;
-	}
-
-
-	/**
-	 * Get the value to compare (string)
-	 *
-	 * @return array
-	 * @since 17.0.0
-	 */
-	public function getValues(): array {
-		return $this->values;
-	}
-
-
-	/**
-	 * Add value to compare (string)
-	 *
-	 * @param string $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValue(string $value): ISearchRequestSimpleQuery {
-		$this->values[] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Add value to compare (int)
-	 *
-	 * @param int $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValueInt(int $value): ISearchRequestSimpleQuery {
-		$this->values[] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Add value to compare (array)
-	 *
-	 * @param array $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValueArray(array $value): ISearchRequestSimpleQuery {
-		$this->values[] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Add value to compare (bool)
-	 *
-	 * @param bool $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValueBool(bool $value): ISearchRequestSimpleQuery {
-		$this->values[] = $value;
-
-		return $this;
-	}
-
-
-	/**
-	 * @return array|mixed
-	 * @since 17.0.0
-	 */
-	public function jsonSerialize() {
-		return [
-			'type'   => $this->getType(),
-			'field'  => $this->getField(),
-			'values' => $this->getValues()
-		];
-	}
+    /** @var int */
+    private $type = 0;
+
+    /** @var string */
+    private $field = '';
+
+    /** @var array */
+    private $values = [];
+
+
+    /**
+     * SearchRequestQuery constructor.
+     *
+     * @param $type
+     * @param $field
+     *
+     * @since 17.0.0
+     */
+    public function __construct(string $field, int $type) {
+        $this->field = $field;
+        $this->type = $type;
+    }
+
+
+    /**
+     * Get the compare type of the query
+     *
+     * @return int
+     * @since 17.0.0
+     */
+    public function getType(): int {
+        return $this->type;
+    }
+
+
+    /**
+     * Get the field to apply query
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getField(): string {
+        return $this->field;
+    }
+
+    /**
+     * Set the field to apply query
+     *
+     * @param string $field
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function setField(string $field): ISearchRequestSimpleQuery {
+        $this->field = $field;
+
+        return $this;
+    }
+
+
+    /**
+     * Get the value to compare (string)
+     *
+     * @return array
+     * @since 17.0.0
+     */
+    public function getValues(): array {
+        return $this->values;
+    }
+
+
+    /**
+     * Add value to compare (string)
+     *
+     * @param string $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValue(string $value): ISearchRequestSimpleQuery {
+        $this->values[] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Add value to compare (int)
+     *
+     * @param int $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValueInt(int $value): ISearchRequestSimpleQuery {
+        $this->values[] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Add value to compare (array)
+     *
+     * @param array $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValueArray(array $value): ISearchRequestSimpleQuery {
+        $this->values[] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Add value to compare (bool)
+     *
+     * @param bool $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValueBool(bool $value): ISearchRequestSimpleQuery {
+        $this->values[] = $value;
+
+        return $this;
+    }
+
+
+    /**
+     * @return array|mixed
+     * @since 17.0.0
+     */
+    public function jsonSerialize() {
+        return [
+            'type'   => $this->getType(),
+            'field'  => $this->getField(),
+            'values' => $this->getValues()
+        ];
+    }
 
 }

lib/public/FullTextSearch/Model/ISearchRequest.php

Indentation +289 added lines, -289 removed lines

@@ -52,295 +52,295 @@
 interface ISearchRequest {
 
 
-	/**
-	 * Get the maximum number of results to be returns by the Search Platform.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	public function getSize(): int;
-
-
-	/**
-	 * Get the current page.
-	 * Used by pagination.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	public function getPage(): int;
-
-
-	/**
-	 * Get the author of the request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getAuthor(): string;
-
-	/**
-	 * Get the searched string.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getSearch(): string;
-
-
-	/**
-	 * Get the value of an option (as string).
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param string $default
-	 *
-	 * @return string
-	 */
-	public function getOption(string $option, string $default = ''): string;
-
-	/**
-	 * Get the value of an option (as array).
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param array $default
-	 *
-	 * @return array
-	 */
-	public function getOptionArray(string $option, array $default = []): array;
-
-
-	/**
-	 * Limit the search to a part of the document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $part
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addPart(string $part): ISearchRequest;
-
-	/**
-	 * Limit the search to an array of parts of the document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $parts
-	 *
-	 * @return ISearchRequest
-	 */
-	public function setParts(array $parts): ISearchRequest;
-
-	/**
-	 * Get the parts the search is limited to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getParts(): array;
-
-
-	/**
-	 * Limit the search to a specific meta tag.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $tag
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addMetaTag(string $tag): ISearchRequest;
-
-	/**
-	 * Get the meta tags the search is limited to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getMetaTags(): array;
-
-	/**
-	 * Limit the search to an array of meta tags.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return ISearchRequest
-	 */
-	public function setMetaTags(array $tags): IsearchRequest;
-
-
-	/**
-	 * Limit the search to a specific sub tag.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $source
-	 * @param string $tag
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addSubTag(string $source, string $tag): ISearchRequest;
-
-	/**
-	 * Get the sub tags the search is limited to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param bool $formatted
-	 *
-	 * @return array
-	 */
-	public function getSubTags(bool $formatted): array;
-
-	/**
-	 * Limit the search to an array of sub tags.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return ISearchRequest
-	 */
-	public function setSubTags(array $tags): ISearchRequest;
-
-
-	/**
-	 * Limit the search to a specific field of the mapping, using a full string.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $field
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addLimitField(string $field): ISearchRequest;
-
-	/**
-	 * Get the fields the search is limited to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getLimitFields(): array;
-
-
-	/**
-	 * Limit the search to a specific field of the mapping, using a wildcard on
-	 * the search string.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $field
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addWildcardField(string $field): ISearchRequest;
-
-	/**
-	 * Get the limit to field of the mapping.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getWildcardFields(): array;
-
-
-	/**
-	 * Filter the results, based on a group of field, using regex
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $filters
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addRegexFilters(array $filters): ISearchRequest;
-
-	/**
-	 * Get the regex filters the search is limit to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getRegexFilters(): array;
-
-
-	/**
-	 * Filter the results, based on a group of field, using wildcard
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $filter
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addWildcardFilter(array $filter): ISearchRequest;
-
-	/**
-	 * Get the wildcard filters the search is limit to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getWildcardFilters(): array;
-
-
-	/**
-	 * Add an extra field to the search.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $field
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addField(string $field): ISearchRequest;
-
-	/**
-	 * Get the list of extra field to search into.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getFields(): array;
-
-
-
-	/**
-	 * Add a MUST search on an extra field
-	 *
-	 * @param ISearchRequestSimpleQuery $query
-	 *
-	 * @return ISearchRequest
-	 * @since 17.0.0
-	 */
-	public function addSimpleQuery(ISearchRequestSimpleQuery $query): ISearchRequest;
-
-
-	/**
-	 * Get the list of queries on extra field.
-	 *
-	 * @return ISearchRequestSimpleQuery[]
-	 * @since 17.0.0
-	 */
-	public function getSimpleQueries(): array;
+    /**
+     * Get the maximum number of results to be returns by the Search Platform.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    public function getSize(): int;
+
+
+    /**
+     * Get the current page.
+     * Used by pagination.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    public function getPage(): int;
+
+
+    /**
+     * Get the author of the request.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getAuthor(): string;
+
+    /**
+     * Get the searched string.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getSearch(): string;
+
+
+    /**
+     * Get the value of an option (as string).
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param string $default
+     *
+     * @return string
+     */
+    public function getOption(string $option, string $default = ''): string;
+
+    /**
+     * Get the value of an option (as array).
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param array $default
+     *
+     * @return array
+     */
+    public function getOptionArray(string $option, array $default = []): array;
+
+
+    /**
+     * Limit the search to a part of the document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $part
+     *
+     * @return ISearchRequest
+     */
+    public function addPart(string $part): ISearchRequest;
+
+    /**
+     * Limit the search to an array of parts of the document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $parts
+     *
+     * @return ISearchRequest
+     */
+    public function setParts(array $parts): ISearchRequest;
+
+    /**
+     * Get the parts the search is limited to.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getParts(): array;
+
+
+    /**
+     * Limit the search to a specific meta tag.
+     *
+     * @since 15.0.0
+     *
+     * @param string $tag
+     *
+     * @return ISearchRequest
+     */
+    public function addMetaTag(string $tag): ISearchRequest;
+
+    /**
+     * Get the meta tags the search is limited to.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getMetaTags(): array;
+
+    /**
+     * Limit the search to an array of meta tags.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return ISearchRequest
+     */
+    public function setMetaTags(array $tags): IsearchRequest;
+
+
+    /**
+     * Limit the search to a specific sub tag.
+     *
+     * @since 15.0.0
+     *
+     * @param string $source
+     * @param string $tag
+     *
+     * @return ISearchRequest
+     */
+    public function addSubTag(string $source, string $tag): ISearchRequest;
+
+    /**
+     * Get the sub tags the search is limited to.
+     *
+     * @since 15.0.0
+     *
+     * @param bool $formatted
+     *
+     * @return array
+     */
+    public function getSubTags(bool $formatted): array;
+
+    /**
+     * Limit the search to an array of sub tags.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return ISearchRequest
+     */
+    public function setSubTags(array $tags): ISearchRequest;
+
+
+    /**
+     * Limit the search to a specific field of the mapping, using a full string.
+     *
+     * @since 15.0.0
+     *
+     * @param string $field
+     *
+     * @return ISearchRequest
+     */
+    public function addLimitField(string $field): ISearchRequest;
+
+    /**
+     * Get the fields the search is limited to.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getLimitFields(): array;
+
+
+    /**
+     * Limit the search to a specific field of the mapping, using a wildcard on
+     * the search string.
+     *
+     * @since 15.0.0
+     *
+     * @param string $field
+     *
+     * @return ISearchRequest
+     */
+    public function addWildcardField(string $field): ISearchRequest;
+
+    /**
+     * Get the limit to field of the mapping.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getWildcardFields(): array;
+
+
+    /**
+     * Filter the results, based on a group of field, using regex
+     *
+     * @since 15.0.0
+     *
+     * @param array $filters
+     *
+     * @return ISearchRequest
+     */
+    public function addRegexFilters(array $filters): ISearchRequest;
+
+    /**
+     * Get the regex filters the search is limit to.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getRegexFilters(): array;
+
+
+    /**
+     * Filter the results, based on a group of field, using wildcard
+     *
+     * @since 15.0.0
+     *
+     * @param array $filter
+     *
+     * @return ISearchRequest
+     */
+    public function addWildcardFilter(array $filter): ISearchRequest;
+
+    /**
+     * Get the wildcard filters the search is limit to.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getWildcardFilters(): array;
+
+
+    /**
+     * Add an extra field to the search.
+     *
+     * @since 15.0.0
+     *
+     * @param string $field
+     *
+     * @return ISearchRequest
+     */
+    public function addField(string $field): ISearchRequest;
+
+    /**
+     * Get the list of extra field to search into.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getFields(): array;
+
+
+
+    /**
+     * Add a MUST search on an extra field
+     *
+     * @param ISearchRequestSimpleQuery $query
+     *
+     * @return ISearchRequest
+     * @since 17.0.0
+     */
+    public function addSimpleQuery(ISearchRequestSimpleQuery $query): ISearchRequest;
+
+
+    /**
+     * Get the list of queries on extra field.
+     *
+     * @return ISearchRequestSimpleQuery[]
+     * @since 17.0.0
+     */
+    public function getSimpleQueries(): array;
 
 }
 

lib/public/FullTextSearch/Model/ISearchRequestSimpleQuery.php

Indentation +86 added lines, -86 removed lines

@@ -46,92 +46,92 @@
 interface ISearchRequestSimpleQuery {
 
 
-	const COMPARE_TYPE_TEXT = 1;
-	const COMPARE_TYPE_KEYWORD = 2;
-	const COMPARE_TYPE_INT_EQ = 3;
-	const COMPARE_TYPE_INT_GTE = 4;
-	const COMPARE_TYPE_INT_GT = 5;
-	const COMPARE_TYPE_INT_LTE = 6;
-	const COMPARE_TYPE_INT_LT = 7;
-	const COMPARE_TYPE_BOOL = 8;
-	const COMPARE_TYPE_ARRAY = 9;
-
-
-	/**
-	 * Get the compare type of the query
-	 *
-	 * @return int
-	 * @since 17.0.0
-	 */
-	public function getType(): int;
-
-
-	/**
-	 * Get the field to apply query
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getField(): string;
-
-	/**
-	 * Set the field to apply query
-	 *
-	 * @param string $field
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function setField(string $field): ISearchRequestSimpleQuery;
-
-
-	/**
-	 * Get the all values to compare
-	 *
-	 * @return array
-	 * @since 17.0.0
-	 */
-	public function getValues(): array;
-
-	/**
-	 * Add value to compare (string)
-	 *
-	 * @param string $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValue(string $value): ISearchRequestSimpleQuery;
-
-	/**
-	 * Add value to compare (int)
-	 *
-	 * @param int $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValueInt(int $value): ISearchRequestSimpleQuery;
-
-	/**
-	 * Add value to compare (array)
-	 *
-	 * @param array $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValueArray(array $value): ISearchRequestSimpleQuery;
-
-	/**
-	 * Add value to compare (bool)
-	 *
-	 * @param bool $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValueBool(bool $value): ISearchRequestSimpleQuery;
+    const COMPARE_TYPE_TEXT = 1;
+    const COMPARE_TYPE_KEYWORD = 2;
+    const COMPARE_TYPE_INT_EQ = 3;
+    const COMPARE_TYPE_INT_GTE = 4;
+    const COMPARE_TYPE_INT_GT = 5;
+    const COMPARE_TYPE_INT_LTE = 6;
+    const COMPARE_TYPE_INT_LT = 7;
+    const COMPARE_TYPE_BOOL = 8;
+    const COMPARE_TYPE_ARRAY = 9;
+
+
+    /**
+     * Get the compare type of the query
+     *
+     * @return int
+     * @since 17.0.0
+     */
+    public function getType(): int;
+
+
+    /**
+     * Get the field to apply query
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getField(): string;
+
+    /**
+     * Set the field to apply query
+     *
+     * @param string $field
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function setField(string $field): ISearchRequestSimpleQuery;
+
+
+    /**
+     * Get the all values to compare
+     *
+     * @return array
+     * @since 17.0.0
+     */
+    public function getValues(): array;
+
+    /**
+     * Add value to compare (string)
+     *
+     * @param string $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValue(string $value): ISearchRequestSimpleQuery;
+
+    /**
+     * Add value to compare (int)
+     *
+     * @param int $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValueInt(int $value): ISearchRequestSimpleQuery;
+
+    /**
+     * Add value to compare (array)
+     *
+     * @param array $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValueArray(array $value): ISearchRequestSimpleQuery;
+
+    /**
+     * Add value to compare (bool)
+     *
+     * @param bool $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValueBool(bool $value): ISearchRequestSimpleQuery;
 
 }