diff options
Diffstat (limited to 'lib/public/FullTextSearch/Model/IIndexDocument.php')
| -rw-r--r-- | lib/public/FullTextSearch/Model/IIndexDocument.php | 101 |
1 files changed, 49 insertions, 52 deletions
diff --git a/lib/public/FullTextSearch/Model/IIndexDocument.php b/lib/public/FullTextSearch/Model/IIndexDocument.php index 667d2c15c7f..c7af11d7472 100644 --- a/lib/public/FullTextSearch/Model/IIndexDocument.php +++ b/lib/public/FullTextSearch/Model/IIndexDocument.php @@ -43,8 +43,6 @@ namespace OCP\FullTextSearch\Model; * @package OC\FullTextSearch\Model */ interface IIndexDocument { - - const NOT_ENCODED = 0; const ENCODED_BASE64 = 1; @@ -67,7 +65,7 @@ interface IIndexDocument { * * @return string */ - public function getProviderId(): string; + public function getProviderId(): string; /** @@ -81,7 +79,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setIndex(IIndex $index): IIndexDocument; + public function setIndex(IIndex $index): IIndexDocument; /** * Get the Index. @@ -90,7 +88,7 @@ interface IIndexDocument { * * @return IIndex */ - public function getIndex(): IIndex; + public function getIndex(): IIndex; /** * return if Index is defined. @@ -111,7 +109,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setModifiedTime(int $modifiedTime): IIndexDocument; + public function setModifiedTime(int $modifiedTime): IIndexDocument; /** * Get the modified time of the original document. @@ -120,7 +118,7 @@ interface IIndexDocument { * * @return int */ - public function getModifiedTime(): int; + public function getModifiedTime(): int; /** * Check if the original document of the IIndexDocument is older than $time. @@ -131,7 +129,7 @@ interface IIndexDocument { * * @return bool */ - public function isOlderThan(int $time): bool; + public function isOlderThan(int $time): bool; /** @@ -145,7 +143,7 @@ interface IIndexDocument { * * @return $this */ - public function setAccess(IDocumentAccess $access): IIndexDocument; + public function setAccess(IDocumentAccess $access): IIndexDocument; /** * Get the IDocumentAccess related to the original document. @@ -154,7 +152,7 @@ interface IIndexDocument { * * @return IDocumentAccess */ - public function getAccess(): IDocumentAccess; + public function getAccess(): IDocumentAccess; /** @@ -166,7 +164,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function addTag(string $tag): IIndexDocument; + public function addTag(string $tag): IIndexDocument; /** * Set the list of tags assigned to the original document. @@ -177,7 +175,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setTags(array $tags): IIndexDocument; + public function setTags(array $tags): IIndexDocument; /** * Get the list of tags assigned to the original document. @@ -186,7 +184,7 @@ interface IIndexDocument { * * @return array */ - public function getTags(): array; + public function getTags(): array; /** @@ -198,7 +196,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function addMetaTag(string $tag): IIndexDocument; + public function addMetaTag(string $tag): IIndexDocument; /** * Set the list of meta tags assigned to the original document. @@ -209,7 +207,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setMetaTags(array $tags): IIndexDocument; + public function setMetaTags(array $tags): IIndexDocument; /** * Get the list of meta tags assigned to the original document. @@ -218,7 +216,7 @@ interface IIndexDocument { * * @return array */ - public function getMetaTags(): array; + public function getMetaTags(): array; /** @@ -231,7 +229,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function addSubTag(string $sub, string $tag): IIndexDocument; + public function addSubTag(string $sub, string $tag): IIndexDocument; /** * Set the list of sub tags assigned to the original document. @@ -242,7 +240,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setSubTags(array $tags): IIndexDocument; + public function setSubTags(array $tags): IIndexDocument; /** * Get the list of sub tags assigned to the original document. @@ -255,7 +253,7 @@ interface IIndexDocument { * * @return array */ - public function getSubTags(bool $formatted = false): array; + public function getSubTags(bool $formatted = false): array; /** @@ -267,7 +265,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setSource(string $source): IIndexDocument; + public function setSource(string $source): IIndexDocument; /** * Get the source of the original document. @@ -276,7 +274,7 @@ interface IIndexDocument { * * @return string */ - public function getSource(): string; + public function getSource(): string; /** @@ -288,7 +286,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setTitle(string $title): IIndexDocument; + public function setTitle(string $title): IIndexDocument; /** * Get the title of the original document. @@ -297,7 +295,7 @@ interface IIndexDocument { * * @return string */ - public function getTitle(): string; + public function getTitle(): string; /** @@ -312,7 +310,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setContent(string $content, int $encoded = 0): IIndexDocument; + public function setContent(string $content, int $encoded = 0): IIndexDocument; /** * Get the content of the original document. @@ -321,7 +319,7 @@ interface IIndexDocument { * * @return string */ - public function getContent(): string; + public function getContent(): string; /** * Returns the type of the encoding on the content. @@ -330,7 +328,7 @@ interface IIndexDocument { * * @return int */ - public function isContentEncoded(): int; + public function isContentEncoded(): int; /** * Return the size of the content. @@ -339,7 +337,7 @@ interface IIndexDocument { * * @return int */ - public function getContentSize(): int; + public function getContentSize(): int; /** @@ -349,7 +347,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function initHash(): IIndexDocument; + public function initHash(): IIndexDocument; /** * Set the hash of the original document. @@ -360,7 +358,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setHash(string $hash): IIndexDocument; + public function setHash(string $hash): IIndexDocument; /** * Get the hash of the original document. @@ -369,7 +367,7 @@ interface IIndexDocument { * * @return string */ - public function getHash(): string; + public function getHash(): string; /** @@ -385,7 +383,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function addPart(string $part, string $content): IIndexDocument; + public function addPart(string $part, string $content): IIndexDocument; /** * Set all parts and their content. @@ -396,7 +394,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setParts(array $parts): IIndexDocument; + public function setParts(array $parts): IIndexDocument; /** * Get all parts of the IIndexDocument. @@ -405,7 +403,7 @@ interface IIndexDocument { * * @return array */ - public function getParts(): array; + public function getParts(): array; /** @@ -417,7 +415,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setLink(string $link): IIndexDocument; + public function setLink(string $link): IIndexDocument; /** * Get the link. @@ -426,7 +424,7 @@ interface IIndexDocument { * * @return string */ - public function getLink(): string; + public function getLink(): string; /** @@ -438,7 +436,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setMore(array $more): IIndexDocument; + public function setMore(array $more): IIndexDocument; /** * Get more information. @@ -447,7 +445,7 @@ interface IIndexDocument { * * @return array */ - public function getMore(): array; + public function getMore(): array; /** @@ -461,7 +459,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function addExcerpt(string $source, string $excerpt): IIndexDocument; + public function addExcerpt(string $source, string $excerpt): IIndexDocument; /** * Set all excerpts of the content of the original document. @@ -472,7 +470,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setExcerpts(array $excerpts): IIndexDocument; + public function setExcerpts(array $excerpts): IIndexDocument; /** * Get all excerpts of the content of the original document. @@ -481,7 +479,7 @@ interface IIndexDocument { * * @return array */ - public function getExcerpts(): array; + public function getExcerpts(): array; /** @@ -494,7 +492,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setScore(string $score): IIndexDocument; + public function setScore(string $score): IIndexDocument; /** * Get the score. @@ -503,7 +501,7 @@ interface IIndexDocument { * * @return string */ - public function getScore(): string; + public function getScore(): string; /** @@ -520,7 +518,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setInfo(string $info, string $value): IIndexDocument; + public function setInfo(string $info, string $value): IIndexDocument; /** * Get an information about a document. (string) @@ -532,7 +530,7 @@ interface IIndexDocument { * * @return string */ - public function getInfo(string $info, string $default = ''): string; + public function getInfo(string $info, string $default = ''): string; /** * Set some information about the original document that will be available @@ -548,7 +546,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setInfoArray(string $info, array $value): IIndexDocument; + public function setInfoArray(string $info, array $value): IIndexDocument; /** * Get an information about a document. (array) @@ -560,7 +558,7 @@ interface IIndexDocument { * * @return array */ - public function getInfoArray(string $info, array $default = []): array; + public function getInfoArray(string $info, array $default = []): array; /** * Set some information about the original document that will be available @@ -576,7 +574,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setInfoInt(string $info, int $value): IIndexDocument; + public function setInfoInt(string $info, int $value): IIndexDocument; /** * Get an information about a document. (int) @@ -588,7 +586,7 @@ interface IIndexDocument { * * @return int */ - public function getInfoInt(string $info, int $default = 0): int; + public function getInfoInt(string $info, int $default = 0): int; /** * Set some information about the original document that will be available @@ -604,7 +602,7 @@ interface IIndexDocument { * * @return IIndexDocument */ - public function setInfoBool(string $info, bool $value): IIndexDocument; + public function setInfoBool(string $info, bool $value): IIndexDocument; /** * Get an information about a document. (bool) @@ -616,7 +614,7 @@ interface IIndexDocument { * * @return bool */ - public function getInfoBool(string $info, bool $default = false): bool; + public function getInfoBool(string $info, bool $default = false): bool; /** * Get all info. @@ -625,6 +623,5 @@ interface IIndexDocument { * * @return array */ - public function getInfoAll(): array; - + public function getInfoAll(): array; } |