@phpstan-type AutoCompleteUserItem array{label: string, value: string} @phpstan-type AutoCompleteResult array{items: list<AutoCompleteUserItem>, hasMoreResults: bool} More...

Inheritance diagram for ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult:

Collaboration diagram for ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult:

Public Member Functions
	__construct (int $mode)

	markMoreResultsAvailable ()

	addResult (string $identifier, string $firstname, string $lastname)

	getItems ()

	addResult (string $identifier, string $firstname, string $lastname)

	markMoreResultsAvailable ()

Data Fields
final const int	MODE_STOP_ON_MAX_ENTRIES = 1

final const int	MODE_FETCH_ALL = 2

final const int	MAX_RESULT_ENTRIES = 1000

array	$result

Private Member Functions
	initMode (int $mode)

	isResultAddable ()

Private Attributes
array	$handled_recipients = []

int	$mode = self::MODE_STOP_ON_MAX_ENTRIES

int	$max_entries

Detailed Description

@phpstan-type AutoCompleteUserItem array{label: string, value: string} @phpstan-type AutoCompleteResult array{items: list<AutoCompleteUserItem>, hasMoreResults: bool}

Definition at line 29 of file LegacyAutocompleteSearchResult.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::__construct ( int $mode )

Definition at line 45 of file LegacyAutocompleteSearchResult.php.

    {
        $this->max_entries = ilSearchSettings::getInstance()->getAutoCompleteLength();
 
        $this->initMode($mode);
    }

References ilSearchSettings\getInstance(), and ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult\initMode().

Here is the call graph for this function:

Member Function Documentation

◆ addResult()

ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::addResult	(	string	$identifier,
		string	$firstname,
		string	$lastname
	)

Implements ILIAS\Mail\RecipientSearch\SearchResult.

Definition at line 83 of file LegacyAutocompleteSearchResult.php.

                                                                                      : SearchResultStatus
    {
        if (!$this->isResultAddable()) {
            throw new \DomainException('Search result is not addable!');
        }
 
        if ($identifier === '') {
            return SearchResultStatus::IGNORED;
        }
 
        if (!isset($this->handled_recipients[$identifier])) {
            $recipient = [];
            $recipient['value'] = $identifier;
 
            $label = $identifier;
            if ($firstname && $lastname) {
                $label .= ' [' . $firstname . ', ' . $lastname . ']';
            }
            $recipient['label'] = $label;
 
            $this->result['items'][] = $recipient;
            $this->handled_recipients[$identifier] = true;
 
            if (!$this->isResultAddable()) {
                return SearchResultStatus::LIMIT_REACHED;
            }
        }
 
        return SearchResultStatus::DUPLICATE;
    }

References ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult\isResultAddable(), and ILIAS\Mail\RecipientSearch\LIMIT_REACHED.

Here is the call graph for this function:

◆ getItems()

ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::getItems ( )

Returns: AutoCompleteResult

Definition at line 117 of file LegacyAutocompleteSearchResult.php.

                              : array
    {
        return $this->result;
    }

References ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult\$result.

◆ initMode()

ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::initMode ( int $mode )

private

Exceptions

InvalidArgumentException

Definition at line 55 of file LegacyAutocompleteSearchResult.php.

                                        : void
    {
        if (!\in_array($mode, [self::MODE_FETCH_ALL, self::MODE_STOP_ON_MAX_ENTRIES], true)) {
            throw new \InvalidArgumentException('Wrong mode passed!');
        }
        $this->mode = $mode;
    }

References ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult\$mode.

Referenced by ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult\__construct().

Here is the caller graph for this function:

◆ isResultAddable()

ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::isResultAddable ( )

private

Definition at line 63 of file LegacyAutocompleteSearchResult.php.

                                      : bool
    {
        if ($this->mode === self::MODE_STOP_ON_MAX_ENTRIES &&
            $this->max_entries >= 0 && \count($this->result['items']) >= $this->max_entries) {
            return false;
        }
 
        if ($this->mode === self::MODE_FETCH_ALL &&
            \count($this->result['items']) >= self::MAX_RESULT_ENTRIES) {
            return false;
        }
 
        return true;
    }

Referenced by ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult\addResult().

Here is the caller graph for this function:

◆ markMoreResultsAvailable()

ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::markMoreResultsAvailable ( )

Implements ILIAS\Mail\RecipientSearch\SearchResult.

Definition at line 78 of file LegacyAutocompleteSearchResult.php.

                                              : void
    {
        $this->result['hasMoreResults'] = true;
    }

Field Documentation

◆ $handled_recipients

array ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::$handled_recipients = []

private

Definition at line 36 of file LegacyAutocompleteSearchResult.php.

◆ $max_entries

int ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::$max_entries

private

Definition at line 38 of file LegacyAutocompleteSearchResult.php.

◆ $mode

int ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::$mode = self::MODE_STOP_ON_MAX_ENTRIES

private

Definition at line 37 of file LegacyAutocompleteSearchResult.php.

Referenced by ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult\initMode().

◆ $result

array ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::$result

Initial value:

= [
        'items' => [],
        'hasMoreResults' => false
    ]

Definition at line 40 of file LegacyAutocompleteSearchResult.php.

Referenced by ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult\getItems().

◆ MAX_RESULT_ENTRIES

final const int ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::MAX_RESULT_ENTRIES = 1000

Definition at line 33 of file LegacyAutocompleteSearchResult.php.

◆ MODE_FETCH_ALL

final const int ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::MODE_FETCH_ALL = 2

Definition at line 32 of file LegacyAutocompleteSearchResult.php.

◆ MODE_STOP_ON_MAX_ENTRIES

final const int ILIAS\Mail\RecipientSearch\LegacyAutocompleteSearchResult::MODE_STOP_ON_MAX_ENTRIES = 1

Definition at line 31 of file LegacyAutocompleteSearchResult.php.

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

components/ILIAS/Mail/classes/RecipientSearch/LegacyAutocompleteSearchResult.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addResult()

◆ getItems()

◆ initMode()

◆ isResultAddable()

◆ markMoreResultsAvailable()

Field Documentation

◆ $handled_recipients

◆ $max_entries

◆ $mode

◆ $result

◆ MAX_RESULT_ENTRIES

◆ MODE_FETCH_ALL

◆ MODE_STOP_ON_MAX_ENTRIES