ilMailAutoCompleteRecipientResult Class Reference

Class ilMailAutoCompleteRecipientResult. More...

Collaboration diagram for ilMailAutoCompleteRecipientResult:

Public Member Functions
array	__construct (int $mode)
	isResultAddable ()
	addResult (string $login, string $firstname, string $lastname)
	getItems ()
	numItems ()

Data Fields
const	MODE_STOP_ON_MAX_ENTRIES = 1
const	MODE_FETCH_ALL = 2
const	MAX_RESULT_ENTRIES = 1000
array	$result

Protected Member Functions
	initMode (int $mode)

Protected Attributes
bool	$allow_smtp
int	$user_id
array	$handled_recipients = []
int	$mode = self::MODE_STOP_ON_MAX_ENTRIES
int	$max_entries

Detailed Description

Class ilMailAutoCompleteRecipientResult.

Definition at line 24 of file class.ilMailAutoCompleteRecipientResult.php.

Constructor & Destructor Documentation

__construct()

array ilMailAutoCompleteRecipientResult::__construct

(

int

$mode

)

Definition at line 41 of file class.ilMailAutoCompleteRecipientResult.php.

References $DIC, ilSearchSettings\getInstance(), initMode(), and MAIL_SETTINGS_ID.

    {
        global $DIC;

        $this->allow_smtp = $DIC->rbac()->system()->checkAccess('smtp_mail', MAIL_SETTINGS_ID);
        $this->user_id = $DIC->user()->getId();
        $this->max_entries = ilSearchSettings::getInstance()->getAutoCompleteLength();

        $this->initMode($mode);
    }

Here is the call graph for this function:

Member Function Documentation

addResult()

ilMailAutoCompleteRecipientResult::addResult	(	string	$login,
		string	$firstname,
		string	$lastname
	)

Definition at line 82 of file class.ilMailAutoCompleteRecipientResult.php.

                                                                                 : void
    {
        if ($login !== '' && !isset($this->handled_recipients[$login])) {
            $recipient = [];
            $recipient['value'] = $login;

            $label = $login;
            if ($firstname && $lastname) {
                $label .= " [" . $firstname . ", " . $lastname . "]";
            }
            $recipient['label'] = $label;

            $this->result['items'][] = $recipient;
            $this->handled_recipients[$login] = 1;
        }
    }

getItems()

ilMailAutoCompleteRecipientResult::getItems

(

)

Returns

array{hasMoreResults: bool, items: array{value: string, label: string}[]}

Definition at line 102 of file class.ilMailAutoCompleteRecipientResult.php.

References $result.

                              : array
    {
        return $this->result;
    }

initMode()

ilMailAutoCompleteRecipientResult::initMode ( int  $mode )

protected

Exceptions

InvalidArgumentException

Definition at line 55 of file class.ilMailAutoCompleteRecipientResult.php.

References $mode.

Referenced by __construct().

                                          : 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;
    }

Here is the caller graph for this function:

isResultAddable()

ilMailAutoCompleteRecipientResult::isResultAddable

(

)

Definition at line 63 of file class.ilMailAutoCompleteRecipientResult.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;
    }

numItems()

ilMailAutoCompleteRecipientResult::numItems

(

)

Definition at line 107 of file class.ilMailAutoCompleteRecipientResult.php.

                              : int
    {
        return count($this->result['items']);
    }

Field Documentation

$allow_smtp

bool ilMailAutoCompleteRecipientResult::$allow_smtp

protected

Definition at line 29 of file class.ilMailAutoCompleteRecipientResult.php.

$handled_recipients

array ilMailAutoCompleteRecipientResult::$handled_recipients = []

protected

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

$max_entries

int ilMailAutoCompleteRecipientResult::$max_entries

protected

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

$mode

int ilMailAutoCompleteRecipientResult::$mode = self::MODE_STOP_ON_MAX_ENTRIES

protected

Definition at line 33 of file class.ilMailAutoCompleteRecipientResult.php.

Referenced by initMode().

$result

array ilMailAutoCompleteRecipientResult::$result

Initial value:

= [
        'items' => []

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

Referenced by getItems().

$user_id

int ilMailAutoCompleteRecipientResult::$user_id

protected

Definition at line 30 of file class.ilMailAutoCompleteRecipientResult.php.

MAX_RESULT_ENTRIES

const ilMailAutoCompleteRecipientResult::MAX_RESULT_ENTRIES = 1000

Definition at line 28 of file class.ilMailAutoCompleteRecipientResult.php.

MODE_FETCH_ALL

const ilMailAutoCompleteRecipientResult::MODE_FETCH_ALL = 2

Definition at line 27 of file class.ilMailAutoCompleteRecipientResult.php.

Referenced by ilMailForm\getRecipientAsync().

MODE_STOP_ON_MAX_ENTRIES

const ilMailAutoCompleteRecipientResult::MODE_STOP_ON_MAX_ENTRIES = 1

Definition at line 26 of file class.ilMailAutoCompleteRecipientResult.php.

Referenced by ilMailForm\getRecipientAsync().

---

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

• Services/Mail/classes/class.ilMailAutoCompleteRecipientResult.php