-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(events): Add typed event for filtering autocompletion suggestions
Signed-off-by: Joas Schilling <coding@schilljs.com>
- Loading branch information
1 parent
d779092
commit 2b8114d
Showing
5 changed files
with
123 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
lib/public/Collaboration/AutoComplete/AutoCompleteFilterEvent.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> | ||
| * | ||
| * @author Joas Schilling <coding@schilljs.com> | ||
| * | ||
| * @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\Collaboration\AutoComplete; | ||
|
|
||
| use OCP\EventDispatcher\Event; | ||
|
|
||
| /** | ||
| * @since 28.0.0 | ||
| */ | ||
| class AutoCompleteFilterEvent extends Event { | ||
| /** | ||
| * @since 28.0.0 | ||
| */ | ||
| public function __construct( | ||
| protected array $results, | ||
| protected string $search, | ||
| protected ?string $itemType, | ||
| protected ?string $itemId, | ||
| protected ?string $sorter, | ||
| protected array $shareTypes, | ||
| protected int $limit, | ||
| ) { | ||
| parent::__construct(); | ||
| } | ||
|
|
||
| /** | ||
| * @since 28.0.0 | ||
| */ | ||
| public function getResults(): array { | ||
| return $this->results; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $results | ||
| * @since 28.0.0 | ||
| */ | ||
| public function setResults(array $results): void { | ||
| $this->results = $results; | ||
| } | ||
|
|
||
| /** | ||
| * @since 28.0.0 | ||
| */ | ||
| public function getSearchTerm(): string { | ||
| return $this->search; | ||
| } | ||
|
|
||
| /** | ||
| * @return int[] List of `\OCP\Share\IShare::TYPE_*` constants | ||
| * @since 28.0.0 | ||
| */ | ||
| public function getShareTypes(): array { | ||
| return $this->shareTypes; | ||
| } | ||
|
|
||
| /** | ||
| * @since 28.0.0 | ||
| */ | ||
| public function getItemType(): ?string { | ||
| return $this->itemType; | ||
| } | ||
|
|
||
| /** | ||
| * @since 28.0.0 | ||
| */ | ||
| public function getItemId(): ?string { | ||
| return $this->itemId; | ||
| } | ||
|
|
||
| /** | ||
| * @return ?string List of desired sort identifiers, top priority first. When multiple are given they are joined with a pipe: `commenters|share-recipients` | ||
| * @since 28.0.0 | ||
| */ | ||
| public function getSorter(): ?string { | ||
| return $this->sorter; | ||
| } | ||
|
|
||
| /** | ||
| * @since 28.0.0 | ||
| */ | ||
| public function getLimit(): int { | ||
| return $this->limit; | ||
| } | ||
| } |