ILIAS\Mail\RecipientSearch\RecipientSearchProvider Class Reference

@phpstan-type AutoCompleteUserRecord array{login?: string, firstname?: string, lastname?: string} @template-implements \Iterator<AutoCompleteUserRecord> More...

Inheritance diagram for ILIAS\Mail\RecipientSearch\RecipientSearchProvider:

Collaboration diagram for ILIAS\Mail\RecipientSearch\RecipientSearchProvider:

Public Member Functions
	__construct (protected string $quoted_term, protected string $term)
	valid ()
	next ()
	__destruct ()

Protected Attributes
ilDBInterface	$db
ilDBStatement	$res = null
array	$data = null
int	$user_id = 0

Detailed Description

@phpstan-type AutoCompleteUserRecord array{login?: string, firstname?: string, lastname?: string} @template-implements \Iterator<AutoCompleteUserRecord>

Definition at line 27 of file RecipientSearchProvider.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Mail\RecipientSearch\RecipientSearchProvider::__construct	(	protected string	$quoted_term,
		protected string	$term
	)

Definition at line 35 of file RecipientSearchProvider.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->user_id = $DIC->user()->getId();
    }

References $DIC.

__destruct()

ILIAS\Mail\RecipientSearch\RecipientSearchProvider::__destruct

(

)

Definition at line 54 of file RecipientSearchProvider.php.

    {
        if ($this->res !== null) {
            $this->db->free($this->res);
            $this->res = null;
        }
    }

Member Function Documentation

next()

ILIAS\Mail\RecipientSearch\RecipientSearchProvider::next

(

)

Definition at line 50 of file RecipientSearchProvider.php.

                          : void
    {
    }

valid()

ILIAS\Mail\RecipientSearch\RecipientSearchProvider::valid

(

)

Reimplemented in ILIAS\Mail\RecipientSearch\SentMailsBasedProvider.

Definition at line 43 of file RecipientSearchProvider.php.

                           : bool
    {
        $this->data = $this->db->fetchAssoc($this->res);
 
        return \is_array($this->data) && !empty($this->data);
    }

Field Documentation

$data

array ILIAS\Mail\RecipientSearch\RecipientSearchProvider::$data = null

protected

Definition at line 32 of file RecipientSearchProvider.php.

$db

ilDBInterface ILIAS\Mail\RecipientSearch\RecipientSearchProvider::$db

protected

Definition at line 29 of file RecipientSearchProvider.php.

$res

ilDBStatement ILIAS\Mail\RecipientSearch\RecipientSearchProvider::$res = null

protected

Definition at line 30 of file RecipientSearchProvider.php.

$user_id

int ILIAS\Mail\RecipientSearch\RecipientSearchProvider::$user_id = 0

protected

Definition at line 33 of file RecipientSearchProvider.php.

---

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

• components/ILIAS/Mail/classes/RecipientSearch/RecipientSearchProvider.php