ilMailingLists Class Reference

Collaboration diagram for ilMailingLists:

Public Member Functions
	__construct (private readonly ilObjUser $user)
	isOwner (int $a_ml_id, int $a_usr_id)
	get (int $id=0)
	getSelected (array $a_ids=[])
	hasAny ()
	getAll ()
	mailingListExists (string $a_list_name)
	setCurrentMailingList (int $id=0)
	getCurrentMailingList ()
	deleteTemporaryLists ()
	deleteLists ()
	deleteAssignments ()

Private Attributes
readonly ilDBInterface	$db
ilMailingList	$ml = null

Detailed Description

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 25 of file class.ilMailingLists.php.

Constructor & Destructor Documentation

__construct()

ilMailingLists::__construct

(

private readonly ilObjUser

$user

)

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

References $DIC.

    {
        global $DIC;

        $this->db = $DIC['ilDB'];
    }

Member Function Documentation

deleteAssignments()

ilMailingLists::deleteAssignments

(

)

Definition at line 161 of file class.ilMailingLists.php.

                                       : void
    {
        $this->db->manipulate(
            'DELETE FROM addressbook_mlist_ass WHERE usr_id = ' . $this->db->quote($this->user->getId(), 'integer')
        );
    }

deleteLists()

ilMailingLists::deleteLists

(

)

Definition at line 147 of file class.ilMailingLists.php.

References ILIAS\Repository\user().

                                 : void
    {
        $this->db->manipulateF(
            'DELETE ass FROM addressbook_mlist_ass ass INNER JOIN addressbook_mlist list ON ass.ml_id = list.ml_id WHERE list.user_id = %s',
            ['integer'],
            [$this->user->getId()]
        );
        $this->db->manipulateF(
            'DELETE FROM addressbook_mlist WHERE user_id = %s',
            ['integer'],
            [$this->user->getId()]
        );
    }

Here is the call graph for this function:

deleteTemporaryLists()

ilMailingLists::deleteTemporaryLists

(

)

Definition at line 138 of file class.ilMailingLists.php.

References getAll(), and ilMailingList\MODE_TEMPORARY.

                                          : void
    {
        foreach ($this->getAll() as $mlist) {
            if ($mlist->getMode() === ilMailingList::MODE_TEMPORARY) {
                $mlist->delete();
            }
        }
    }

Here is the call graph for this function:

get()

ilMailingLists::get

(

int

$id = 0

)

Definition at line 49 of file class.ilMailingLists.php.

References ILIAS\Repository\user().

                                    : ilMailingList
    {
        return new ilMailingList($this->user, $id);
    }

Here is the call graph for this function:

getAll()

ilMailingLists::getAll

(

)

Returns

ilMailingList[]

Definition at line 84 of file class.ilMailingLists.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\user().

Referenced by deleteTemporaryLists().

                            : array
    {
        $res = $this->db->queryF(
            'SELECT * FROM addressbook_mlist WHERE user_id = %s',
            ['integer'],
            [$this->user->getId()]
        );

        $entries = [];

        $counter = 0;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $tmpObj = new ilMailingList($this->user, 0);
            $tmpObj->setId((int) $row->ml_id);
            $tmpObj->setUserId((int) $row->user_id);
            $tmpObj->setTitle($row->title);
            $tmpObj->setDescription($row->description);
            $tmpObj->setCreatedate($row->createdate);
            $tmpObj->setChangedate($row->changedate);
            $tmpObj->setMode((int) $row->lmode);

            $entries[$counter] = $tmpObj;

            unset($tmpObj);

            ++$counter;
        }

        return $entries;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentMailingList()

ilMailingLists::getCurrentMailingList

(

)

Definition at line 133 of file class.ilMailingLists.php.

References $ml.

Referenced by mailingListExists().

                                           : ?ilMailingList
    {
        return $this->ml;
    }

Here is the caller graph for this function:

getSelected()

ilMailingLists::getSelected

(

array

$a_ids = []

)

Parameters

int[]

$a_ids

Returns

ilMailingList[]

Definition at line 58 of file class.ilMailingLists.php.

References ILIAS\Repository\user().

                                                  : array
    {
        $entries = [];

        foreach ($a_ids as $id) {
            $entries[] = new ilMailingList($this->user, $id);
        }

        return $entries;
    }

Here is the call graph for this function:

hasAny()

ilMailingLists::hasAny

(

)

Definition at line 69 of file class.ilMailingLists.php.

References $res, and ILIAS\Repository\user().

                            : bool
    {
        $res = $this->db->queryF(
            'SELECT EXISTS(SELECT 1 FROM addressbook_mlist WHERE user_id = %s) cnt',
            ['integer'],
            [$this->user->getId()]
        );
        $row = $this->db->fetchAssoc($res);

        return (is_array($row) && (int) $row['cnt'] === 1);
    }

Here is the call graph for this function:

isOwner()

ilMailingLists::isOwner	(	int	$a_ml_id,
		int	$a_usr_id
	)

Definition at line 37 of file class.ilMailingLists.php.

References $res, and ILIAS\Repository\int().

                                                        : bool
    {
        $res = $this->db->queryF(
            'SELECT EXISTS(SELECT 1 FROM addressbook_mlist WHERE ml_id = %s AND user_id = %s) cnt',
            ['integer', 'integer'],
            [$a_ml_id, $a_usr_id]
        );
        $row = $this->db->fetchAssoc($res);

        return is_array($row) && (int) $row['cnt'] === 1;
    }

Here is the call graph for this function:

mailingListExists()

ilMailingLists::mailingListExists

(

string

$a_list_name

)

Definition at line 115 of file class.ilMailingLists.php.

References getCurrentMailingList(), ILIAS\Repository\int(), and setCurrentMailingList().

                                                          : bool
    {
        $ml_id = (int) substr($a_list_name, strrpos($a_list_name, '_') + 1);
        if (!is_numeric($ml_id) || $ml_id <= 0) {
            return false;
        }

        $this->setCurrentMailingList($ml_id);

        return $this->getCurrentMailingList()->doesExist();
    }

Here is the call graph for this function:

setCurrentMailingList()

ilMailingLists::setCurrentMailingList

(

int

$id = 0

)

Definition at line 127 of file class.ilMailingLists.php.

References $id.

Referenced by mailingListExists().

                                                      : void
    {
        $this->ml = $this->get($id);
    }

Here is the caller graph for this function:

Field Documentation

$db

readonly ilDBInterface ilMailingLists::$db

private

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

$ml

ilMailingList ilMailingLists::$ml = null

private

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

Referenced by getCurrentMailingList().

---

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

• components/ILIAS/Contact/classes/class.ilMailingLists.php