ilMailAutoCompleteRecipientResult Class Reference

Class ilMailAutoCompleteRecipientResult. More...

Collaboration diagram for ilMailAutoCompleteRecipientResult:

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

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

Protected Member Functions
	initMode ($mode)

Protected Attributes
	$allow_smtp = null
	$user_id = null
	$handled_recipients = array()
	$mode = self::MODE_STOP_ON_MAX_ENTRIES
	$max_entries = null

Detailed Description

Class ilMailAutoCompleteRecipientResult.

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

Constructor & Destructor Documentation

__construct()

ilMailAutoCompleteRecipientResult::__construct

(

$mode

)

Parameters

int

$mode

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

    {
        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->result['items'] = array();
        $this->result['hasMoreResults'] = false;
 
        $this->initMode($mode);
    }

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

Here is the call graph for this function:

Member Function Documentation

addResult()

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

Parameters

string	$login
string	$firstname
string	$lastname

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

    {
        if (!isset($this->handled_recipients[$login])) {
            $recipient = array();
            $recipient['value'] = $login;
 
            $label = $login;
            if ($firstname && $lastname) {
                $label .= " [" . $firstname . ", " . $lastname . "]";
            }
            $recipient['label'] = $label;
 
            $this->result['items'][] = $recipient;
            $this->handled_recipients[$login] = 1;
        }
    }

References $login.

getItems()

ilMailAutoCompleteRecipientResult::getItems

(

)

Returns

array

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

    {
        return $this->result;
    }

References $result.

initMode()

ilMailAutoCompleteRecipientResult::initMode (   $mode )

protected

Parameters

int

$mode

Exceptions

InvalidArgumentException

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

    {
        if (!in_array($mode, array(self::MODE_FETCH_ALL, self::MODE_STOP_ON_MAX_ENTRIES))) {
            throw new InvalidArgumentException("Wrong mode passed!");
        }
        $this->mode = $mode;
    }

References $mode.

Referenced by __construct().

Here is the caller graph for this function:

isResultAddable()

ilMailAutoCompleteRecipientResult::isResultAddable

(

)

Returns

bool

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

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

numItems()

ilMailAutoCompleteRecipientResult::numItems

(

)

Returns

int

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

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

Field Documentation

$allow_smtp

ilMailAutoCompleteRecipientResult::$allow_smtp = null

protected

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

$handled_recipients

ilMailAutoCompleteRecipientResult::$handled_recipients = array()

protected

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

$max_entries

ilMailAutoCompleteRecipientResult::$max_entries = null

protected

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

$mode

ilMailAutoCompleteRecipientResult::$mode = self::MODE_STOP_ON_MAX_ENTRIES

protected

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

Referenced by __construct(), and initMode().

$result

ilMailAutoCompleteRecipientResult::$result = array()

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

Referenced by getItems().

$user_id

ilMailAutoCompleteRecipientResult::$user_id = null

protected

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

MAX_RESULT_ENTRIES

const ilMailAutoCompleteRecipientResult::MAX_RESULT_ENTRIES = 1000

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

MODE_FETCH_ALL

const ilMailAutoCompleteRecipientResult::MODE_FETCH_ALL = 2

Definition at line 12 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 11 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