ILIAS\Notifications\ilNotificationUserIterator Class Reference

Inheritance diagram for ILIAS\Notifications\ilNotificationUserIterator:

Collaboration diagram for ILIAS\Notifications\ilNotificationUserIterator:

Public Member Functions
	__construct (private readonly string $module, private readonly array $userids=[])
	__destruct ()
	current ()
	key ()
	next ()
	rewind ()
	valid ()

Private Attributes
ilDBStatement	$rset
readonly ilDBInterface	$db
array	$data = null

Detailed Description

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e <int, array<string, mixed>>

Definition at line 32 of file ilNotificationUserIterator.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Notifications\ilNotificationUserIterator::__construct	(	private readonly string	$module,
		private readonly array	$userids = []
	)

Parameters

list<int>

$userids

Definition at line 42 of file ilNotificationUserIterator.php.

References $DIC, and ILIAS\Notifications\ilNotificationUserIterator\rewind().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->rewind();
    }

Here is the call graph for this function:

__destruct()

ILIAS\Notifications\ilNotificationUserIterator::__destruct

(

)

Definition at line 50 of file ilNotificationUserIterator.php.

    {
        $this->db->free($this->rset);
    }

Member Function Documentation

current()

ILIAS\Notifications\ilNotificationUserIterator::current

(

)

Returns

array<string, mixed>

Definition at line 58 of file ilNotificationUserIterator.php.

References ILIAS\Notifications\ilNotificationUserIterator\$data.

                             : array
    {
        return $this->data;
    }

key()

ILIAS\Notifications\ilNotificationUserIterator::key

(

)

Definition at line 63 of file ilNotificationUserIterator.php.

                         : int
    {
        return (int) $this->data['usr_id'];
    }

next()

ILIAS\Notifications\ilNotificationUserIterator::next

(

)

Definition at line 68 of file ilNotificationUserIterator.php.

                          : void
    {
    }

rewind()

ILIAS\Notifications\ilNotificationUserIterator::rewind

(

)

Definition at line 72 of file ilNotificationUserIterator.php.

References ILIAS\Notifications\ilNotificationSetupHelper\$tbl_userconfig, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by ILIAS\Notifications\ilNotificationUserIterator\__construct().

                            : void
    {
        $query = 'SELECT usr_id, module, channel FROM ' . ilNotificationSetupHelper::$tbl_userconfig . ' WHERE module = %s AND ' . $this->db->in(
            'usr_id',
            $this->userids,
            false,
            ilDBConstants::T_INTEGER
        );
        $types = [ilDBConstants::T_TEXT];
        $values = [$this->module];
        $this->rset = $this->db->queryF($query, $types, $values);
    }

Here is the caller graph for this function:

valid()

ILIAS\Notifications\ilNotificationUserIterator::valid

(

)

Definition at line 85 of file ilNotificationUserIterator.php.

                           : bool
    {
        $this->data = $this->db->fetchAssoc($this->rset);

        return is_array($this->data);
    }

Field Documentation

$data

array ILIAS\Notifications\ilNotificationUserIterator::$data = null

private

Definition at line 37 of file ilNotificationUserIterator.php.

Referenced by ILIAS\Notifications\ilNotificationUserIterator\current().

$db

readonly ilDBInterface ILIAS\Notifications\ilNotificationUserIterator::$db

private

Definition at line 35 of file ilNotificationUserIterator.php.

$rset

ilDBStatement ILIAS\Notifications\ilNotificationUserIterator::$rset

private

Definition at line 34 of file ilNotificationUserIterator.php.

---

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

• components/ILIAS/Notifications/classes/ilNotificationUserIterator.php