Skip to content

[IMPROVEMENT] User: Improve PHP types in User/Search #11435

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.

Sign up for GitHub

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

Open
mjansenDatabay wants to merge 1 commit into
base: release_11
Choose a base branch
from
Open

[IMPROVEMENT] User: Improve PHP types in User/Search #11435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions components/ILIAS/User/src/Search/AutocompleteItem.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@ interface AutocompleteItem
* The returned tags will then again be filtered by the value in the property
* "searchBy". If you need to show the tag even if you are not allowed to
* divulge the full value of the field the search string was found in, you
* can simply reuse the search term here. See the
* `\ILIAS\User\Search\DefaultAutocompleteItem for an implementation of this.
* can simply reuse the search term here. See the {@see DefaultAutocompleteItem}
* for an implementation of this.
*
* @return array{value: string, display: string, searchBy: string}
*/
public function getTagArray(): array;
}
6 changes: 2 additions & 4 deletions components/ILIAS/User/src/Search/DefaultEndpointConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,10 @@

namespace ILIAS\User\Search;

class DefaultEndpointConfigurator implements EndpointConfigurator
readonly class DefaultEndpointConfigurator implements EndpointConfigurator
{
/**
*
* @param list<string> $parent_class_path see:
* `\ILIAS\User\Search\EndpointConfigurator::getParentClassPath()`
* @param list<string> $parent_class_path like in {@see EndpointConfigurator::getParentClassPath()}
*/
public function __construct(
private array $parent_class_path
Expand Down
6 changes: 3 additions & 3 deletions components/ILIAS/User/src/Search/EndpointConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ interface EndpointConfigurator
{
/**
* @return list<string> MUST return an array containing all class names in
* the path to be prepended to the EndpointGUI in order to build the URL
* with `ilCtrl`
* the path to be prepended to the EndpointGUI to build the URL
* with {@see \ilCtrlInterface}
*/
public function getParentClassPath(): array;

/**
* @return list<\ILIAS\User\Search\AutocompleteItem> Items that should be
* @return list<AutocompleteItem> Items that should be
* added to the list the user can select from.
*/
public function getAdditionalAnswerElements(
Expand Down
Loading