ILIAS\User\Search\EndpointGUI Class Reference

Collaboration diagram for ILIAS\User\Search\EndpointGUI:

Public Member Functions
	__construct (private readonly FieldConfigurationRepository $field_configuration_repository, private readonly ProfileDataRepository $profile_data_repository, private readonly SettingsDataRepository $settings_data_repository, private readonly \ilObjUser $current_user, private readonly HttpService $http, private readonly Refinery $refinery, private readonly \ilCtrl $ctrl, private readonly DataFactory $data_factory, private readonly EndpointConfigurator $endpoint_configurator)
	acquireBuilderAndToken ()
	getSuggestionsStartAfter ()
	executeCommand ()

Private Member Functions
	buildQueryStringTransformation ()

Private Attributes
const array	NAMESPACE = ['u', 's']
const string	SEARCH_TERM_TOKEN = 't'
const int	SUGGESTIONS_START_AFTER = 3

Detailed Description

Definition at line 32 of file class.EndpointGUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Search\EndpointGUI::__construct	(	private readonly FieldConfigurationRepository	$field_configuration_repository,
		private readonly ProfileDataRepository	$profile_data_repository,
		private readonly SettingsDataRepository	$settings_data_repository,
		private readonly \ilObjUser	$current_user,
		private readonly HttpService	$http,
		private readonly Refinery	$refinery,
		private readonly \ilCtrl	$ctrl,
		private readonly DataFactory	$data_factory,
		private readonly EndpointConfigurator	$endpoint_configurator
	)

Definition at line 38 of file class.EndpointGUI.php.

      {
    }

Member Function Documentation

acquireBuilderAndToken()

ILIAS\User\Search\EndpointGUI::acquireBuilderAndToken

(

)

Returns

array{0: \ILIAS\UI\URLBuilder, 1: \ILIAS\UI\URLBuilderToken}

Definition at line 54 of file class.EndpointGUI.php.

                                            : array
    {
        return (new URLBuilder(
            $this->data_factory->uri(
                ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                    array_merge(
                        $this->endpoint_configurator->getParentClassPath(),
                        [self::class]
                    )
                )
            )
        ))->acquireParameter(self::NAMESPACE, self::SEARCH_TERM_TOKEN);
    }

buildQueryStringTransformation()

ILIAS\User\Search\EndpointGUI::buildQueryStringTransformation ( )

private

Definition at line 126 of file class.EndpointGUI.php.

                                                     : \Closure
    {
        return function ($parameter): AutocompleteQuery {
            return new AutocompleteQuery(
                $this->getSuggestionsStartAfter(),
                $this->refinery->kindlyTo()->string()->transform($parameter)
            );
        };
    }

References ILIAS\User\Search\EndpointGUI\getSuggestionsStartAfter(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

executeCommand()

ILIAS\User\Search\EndpointGUI::executeCommand

(

)

Definition at line 73 of file class.EndpointGUI.php.

                                    : void
    {
        $this->http->saveResponse(
            $this->http->response()->withBody(
                Streams::ofString($this->buildResponse())
            )
        );
        $this->http->sendResponse();
        $this->http->close();
    }

References ILIAS\FileDelivery\http(), and ILIAS\Filesystem\Stream\Streams\ofString().

Here is the call graph for this function:

getSuggestionsStartAfter()

ILIAS\User\Search\EndpointGUI::getSuggestionsStartAfter

(

)

Definition at line 68 of file class.EndpointGUI.php.

                                              : int
    {
        return self::SUGGESTIONS_START_AFTER;
    }

References ILIAS\User\Search\EndpointGUI\SUGGESTIONS_START_AFTER.

Referenced by ILIAS\User\Search\EndpointGUI\buildQueryStringTransformation().

Here is the caller graph for this function:

Field Documentation

NAMESPACE

const array ILIAS\User\Search\EndpointGUI::NAMESPACE = ['u', 's']

private

Definition at line 34 of file class.EndpointGUI.php.

SEARCH_TERM_TOKEN

const string ILIAS\User\Search\EndpointGUI::SEARCH_TERM_TOKEN = 't'

private

Definition at line 35 of file class.EndpointGUI.php.

SUGGESTIONS_START_AFTER

const int ILIAS\User\Search\EndpointGUI::SUGGESTIONS_START_AFTER = 3

private

Definition at line 36 of file class.EndpointGUI.php.

Referenced by ILIAS\User\Search\EndpointGUI\getSuggestionsStartAfter().

---

The documentation for this class was generated from the following file:

• components/ILIAS/User/src/Search/class.EndpointGUI.php