-
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(events): Add typed event for filtering autocompletion sugges… #41218
Merged
nickvergessen
merged 1 commit into
master
from
techdebt/noid/add-autocomplete-filter-event
Nov 2, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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 { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. any string? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As far as I understand yes. same for itemId. Basically whatever API provider and consumer agree up on. |
||
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 { | ||
nickvergessen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
return $this->sorter; | ||
|
||
} | ||
|
||
/** | ||
* @since 28.0.0 | ||
*/ | ||
public function getLimit(): int { | ||
return $this->limit; | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
though no error, a little creepy, this overwriting game