ILIAS\Notifications\ilNotificationUserIterator Class Reference

Inheritance diagram for ILIAS\Notifications\ilNotificationUserIterator:

Collaboration diagram for ILIAS\Notifications\ilNotificationUserIterator:

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

Private Attributes
array	$userids
ilDBStatement	$rset
ilDBInterface	$db
array	$data
string	$module

Detailed Description

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Definition at line 30 of file ilNotificationUserIterator.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 41 of file ilNotificationUserIterator.php.

    {
        global $ilDB;
        $this->db = $ilDB;
        $this->userids = $userids;
        $this->module = $module;
        $this->rewind();
    }

References $ilDB, ILIAS\Notifications\ilNotificationUserIterator\$module, ILIAS\Notifications\ilNotificationUserIterator\$userids, and ILIAS\Notifications\ilNotificationUserIterator\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

(

)

Definition at line 55 of file ilNotificationUserIterator.php.

                             : array
    {
        return $this->data;
    }

References ILIAS\Notifications\ilNotificationUserIterator\$data.

key()

ILIAS\Notifications\ilNotificationUserIterator::key

(

)

Definition at line 60 of file ilNotificationUserIterator.php.

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

next()

ILIAS\Notifications\ilNotificationUserIterator::next

(

)

Definition at line 65 of file ilNotificationUserIterator.php.

                          : void
    {
    }

rewind()

ILIAS\Notifications\ilNotificationUserIterator::rewind

(

)

Definition at line 69 of file ilNotificationUserIterator.php.

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

References $query, and ILIAS\Notifications\ilNotificationSetupHelper\$tbl_userconfig.

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

Here is the caller graph for this function:

valid()

ILIAS\Notifications\ilNotificationUserIterator::valid

(

)

Definition at line 77 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

private

Definition at line 38 of file ilNotificationUserIterator.php.

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

$db

ilDBInterface ILIAS\Notifications\ilNotificationUserIterator::$db

private

Definition at line 37 of file ilNotificationUserIterator.php.

$module

string ILIAS\Notifications\ilNotificationUserIterator::$module

private

Definition at line 39 of file ilNotificationUserIterator.php.

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

$rset

ilDBStatement ILIAS\Notifications\ilNotificationUserIterator::$rset

private

Definition at line 36 of file ilNotificationUserIterator.php.

$userids

array ILIAS\Notifications\ilNotificationUserIterator::$userids

private

Definition at line 35 of file ilNotificationUserIterator.php.

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

---

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

• Services/Notifications/classes/ilNotificationUserIterator.php