Collaboration diagram for ilMailingList:

Public Member Functions
	__construct (ilObjUser $user, private int $mail_id=0)

	insert ()

	update ()

	delete ()

	getAssignedEntries ()

	assignUser (int $usr_id=0)

	deleteEntry (int $a_id=0)

	deassignAllEntries ()

	setId (int $a_mail_id=0)

	getId ()

	setUserId (int $a_user_id=0)

	getUserId ()

	setTitle (string $a_title='')

	getTitle ()

	setDescription (?string $a_description='')

	getDescription ()

	setCreatedate (string $_createdate)

	getCreatedate ()

	setChangedate (?string $a_changedate)

	getChangedate ()

	setMode (int $a_mode)

	getMode ()

	doesExist ()

Data Fields
final const	MODE_ADDRESSBOOK = 1

final const	MODE_TEMPORARY = 2

Private Member Functions
	read ()

Private Attributes
int	$user_id

string	$title = ''

string	$description = ''

string	$createdate

string	$changedate = null

readonly ilDBInterface	$db

int	$mode

bool	$exists = false

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilMailingList::__construct	(	ilObjUser	$user,
		private int	$mail_id = `0`
	)

Definition at line 40 of file class.ilMailingList.php.

References $DIC, ilObject\getId(), read(), and setMode().

     {
         global $DIC;
 
         $this->db = $DIC['ilDB'];
         $this->user_id = $user->getId();
 
         $this->setMode(self::MODE_ADDRESSBOOK);
 
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ assignUser()

ilMailingList::assignUser ( int $usr_id = 0 )

Definition at line 195 of file class.ilMailingList.php.

References getId().

                                                : bool
     {
         $nextId = $this->db->nextId('addressbook_mlist_ass');
         $this->db->manipulateF(
             'INSERT INTO addressbook_mlist_ass (a_id, ml_id, usr_id) VALUES(%s, %s, %s)',
             ['integer', 'integer', 'integer'],
             [$nextId, $this->getId(), $usr_id]
         );
         return true;
     }

Here is the call graph for this function:

◆ deassignAllEntries()

ilMailingList::deassignAllEntries ( )

Definition at line 218 of file class.ilMailingList.php.

References getId().

Referenced by delete().

                                         : bool
     {
         $this->db->manipulateF(
             'DELETE FROM addressbook_mlist_ass WHERE ml_id = %s',
             ['integer'],
             [$this->getId()]
         );
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilMailingList::delete ( )

Definition at line 129 of file class.ilMailingList.php.

References deassignAllEntries(), getId(), and getUserId().

                             : bool
     {
         if ($this->mail_id && $this->user_id) {
             $this->deassignAllEntries();
 
             $this->db->manipulateF(
                 'DELETE FROM addressbook_mlist WHERE ml_id = %s AND user_id = %s',
                 ['integer', 'integer'],
                 [$this->getId(), $this->getUserId()]
             );
             $this->exists = false;
 
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

◆ deleteEntry()

ilMailingList::deleteEntry ( int $a_id = 0 )

Definition at line 207 of file class.ilMailingList.php.

                                               : bool
     {
         $this->db->manipulateF(
             'DELETE FROM addressbook_mlist_ass WHERE a_id = %s',
             ['integer'],
             [$a_id]
         );
         return true;
     }

◆ doesExist()

ilMailingList::doesExist ( )

Definition at line 299 of file class.ilMailingList.php.

References $exists.

                                : bool
     {
         return $this->exists;
     }

◆ getAssignedEntries()

ilMailingList::getAssignedEntries ( )

Returns: array<int, array{a_id: int, usr_id: int}>

Definition at line 174 of file class.ilMailingList.php.

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

                                         : array
     {
         $res = $this->db->queryF(
             'SELECT a_id, usr_data.usr_id FROM addressbook_mlist_ass ' .
             'INNER JOIN usr_data ON usr_data.usr_id = addressbook_mlist_ass.usr_id WHERE ml_id = %s',
             ['integer'],
             [$this->getId()]
         );
 
         $entries = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $entries[(int) $row->a_id] = [
                 'a_id' => (int) $row->a_id,
                 'usr_id' => (int) $row->usr_id
             ];
         }
 
         return $entries;
     }

Here is the call graph for this function:

◆ getChangedate()

ilMailingList::getChangedate ( )

Definition at line 283 of file class.ilMailingList.php.

References $changedate.

Referenced by update().

                                    : ?string
     {
         return $this->changedate;
     }

Here is the caller graph for this function:

◆ getCreatedate()

ilMailingList::getCreatedate ( )

Definition at line 273 of file class.ilMailingList.php.

References $createdate.

Referenced by insert().

                                    : string
     {
         return $this->createdate;
     }

Here is the caller graph for this function:

◆ getDescription()

ilMailingList::getDescription ( )

Definition at line 263 of file class.ilMailingList.php.

References $description.

Referenced by insert(), and update().

                                     : ?string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getId()

ilMailingList::getId ( )

Definition at line 233 of file class.ilMailingList.php.

Referenced by assignUser(), deassignAllEntries(), delete(), getAssignedEntries(), read(), and update().

                            : int
     {
         return $this->mail_id;
     }

Here is the caller graph for this function:

◆ getMode()

ilMailingList::getMode ( )

Definition at line 295 of file class.ilMailingList.php.

References $mode.

Referenced by insert(), and update().

                              : int
     {
         return $this->mode;
     }

Here is the caller graph for this function:

◆ getTitle()

ilMailingList::getTitle ( )

Definition at line 253 of file class.ilMailingList.php.

References $title.

Referenced by insert(), and update().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getUserId()

ilMailingList::getUserId ( )

Definition at line 243 of file class.ilMailingList.php.

References $user_id.

Referenced by delete(), insert(), read(), and update().

                                : int
     {
         return $this->user_id;
     }

Here is the caller graph for this function:

◆ insert()

ilMailingList::insert ( )

Definition at line 52 of file class.ilMailingList.php.

References getCreatedate(), getDescription(), getMode(), getTitle(), getUserId(), and null.

                             : bool
     {
         $nextId = $this->db->nextId('addressbook_mlist');
         $this->db->manipulateF(
             '
                         INSERT INTO addressbook_mlist 
                         (   ml_id,
                                 user_id,
                                 title,
                                 description,
                                 createdate,
                                 changedate,
                                 lmode
                         )
                         VALUES(%s, %s, %s, %s, %s, %s, %s)',
             [
                 'integer',
                 'integer',
                 'text',
                 'text',
                 'timestamp',
                 'timestamp',
                 'integer'
             ],
             [
                 $nextId,
                 $this->getUserId(),
                 $this->getTitle(),
                 $this->getDescription(),
                 $this->getCreatedate(),
                 null,
                 $this->getMode()
             ]
         );
 
         $this->mail_id = $nextId;
         $this->exists = true;
 
         return true;
     }

Here is the call graph for this function:

◆ read()

ilMailingList::read ( )

private

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

References $res, ilDBConstants\FETCHMODE_OBJECT, getId(), getUserId(), setChangedate(), setCreatedate(), setDescription(), setId(), setMode(), setTitle(), and setUserId().

Referenced by __construct().

                            : void
     {
         if ($this->getId() && $this->getUserId()) {
             $res = $this->db->queryF(
                 'SELECT * FROM addressbook_mlist WHERE ml_id = %s AND user_id =%s',
                 ['integer', 'integer'],
                 [$this->getId(), $this->getUserId()]
             );
 
             $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
             if (is_object($row)) {
                 $this->setId((int) $row->ml_id);
                 $this->setUserId((int) $row->user_id);
                 $this->setTitle($row->title);
                 $this->setDescription($row->description);
                 $this->setCreatedate($row->createdate);
                 $this->setChangedate($row->changedate);
                 $this->setMode((int) $row->lmode);
                 $this->exists = true;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setChangedate()

ilMailingList::setChangedate ( ?string $a_changedate )

Definition at line 278 of file class.ilMailingList.php.

Referenced by read().

                                                         : void
     {
         $this->changedate = $a_changedate;
     }

Here is the caller graph for this function:

◆ setCreatedate()

ilMailingList::setCreatedate ( string $_createdate )

Definition at line 268 of file class.ilMailingList.php.

Referenced by read().

                                                       : void
     {
         $this->createdate = $_createdate;
     }

Here is the caller graph for this function:

◆ setDescription()

ilMailingList::setDescription ( ?string $a_description = '' )

Definition at line 258 of file class.ilMailingList.php.

Referenced by read().

                                                                : void
     {
         $this->description = $a_description;
     }

Here is the caller graph for this function:

◆ setId()

ilMailingList::setId ( int $a_mail_id = 0 )

Definition at line 228 of file class.ilMailingList.php.

Referenced by read().

                                              : void
     {
         $this->mail_id = $a_mail_id;
     }

Here is the caller graph for this function:

◆ setMode()

ilMailingList::setMode ( int $a_mode )

Definition at line 288 of file class.ilMailingList.php.

Referenced by __construct(), and read().

                                         : void
     {
         if (in_array($a_mode, [self::MODE_ADDRESSBOOK, self::MODE_TEMPORARY], true)) {
             $this->mode = $a_mode;
         }
     }

Here is the caller graph for this function:

◆ setTitle()

ilMailingList::setTitle ( string $a_title = '' )

Definition at line 248 of file class.ilMailingList.php.

Referenced by read().

                                                   : void
     {
         $this->title = $a_title;
     }

Here is the caller graph for this function:

◆ setUserId()

ilMailingList::setUserId ( int $a_user_id = 0 )

Definition at line 238 of file class.ilMailingList.php.

Referenced by read().

                                                  : void
     {
         $this->user_id = $a_user_id;
     }

Here is the caller graph for this function:

◆ update()

ilMailingList::update ( )

Definition at line 93 of file class.ilMailingList.php.

References getChangedate(), getDescription(), getId(), getMode(), getTitle(), and getUserId().

                             : bool
     {
         if ($this->mail_id && $this->user_id) {
             $this->db->manipulateF(
                 '
                                 UPDATE addressbook_mlist
                                 SET title = %s,
                                         description = %s,
                                         changedate =  %s,
                                         lmode = %s
                                 WHERE ml_id =  %s
                                 AND user_id =  %s',
                 [
                     'text',
                     'text',
                     'timestamp',
                     'integer',
                     'integer',
                     'integer'
                 ],
                 [
                     $this->getTitle(),
                     $this->getDescription(),
                     $this->getChangedate(),
                     $this->getMode(),
                     $this->getId(),
                     $this->getUserId()
                 ]
             );
 
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

Field Documentation

◆ $changedate

string ilMailingList::$changedate = null

private

Definition at line 34 of file class.ilMailingList.php.

Referenced by getChangedate().

◆ $createdate

string ilMailingList::$createdate

private

Definition at line 33 of file class.ilMailingList.php.

Referenced by getCreatedate().

◆ $db

readonly ilDBInterface ilMailingList::$db

private

Definition at line 35 of file class.ilMailingList.php.

◆ $description

string ilMailingList::$description = ''

private

Definition at line 32 of file class.ilMailingList.php.

Referenced by getDescription().

◆ $exists

bool ilMailingList::$exists = false

private

Definition at line 38 of file class.ilMailingList.php.

Referenced by doesExist().

◆ $mode

int ilMailingList::$mode

private

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

Referenced by getMode().

◆ $title

string ilMailingList::$title = ''

private

Definition at line 31 of file class.ilMailingList.php.

Referenced by getTitle().

◆ $user_id

int ilMailingList::$user_id

private

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

Referenced by getUserId().

◆ MODE_ADDRESSBOOK

final const ilMailingList::MODE_ADDRESSBOOK = 1

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

◆ MODE_TEMPORARY

final const ilMailingList::MODE_TEMPORARY = 2

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

Referenced by ilMailingLists\deleteTemporaryLists(), ILIAS\Contact\MailingLists\MailingListsTable\initRecords(), and ilObjUserFolderGUI\mailObject().

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

components/ILIAS/Contact/classes/class.ilMailingList.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assignUser()

◆ deassignAllEntries()

◆ delete()

◆ deleteEntry()

◆ doesExist()

◆ getAssignedEntries()

◆ getChangedate()

◆ getCreatedate()

◆ getDescription()

◆ getId()

◆ getMode()

◆ getTitle()

◆ getUserId()

◆ insert()

◆ read()

◆ setChangedate()

◆ setCreatedate()

◆ setDescription()

◆ setId()

◆ setMode()

◆ setTitle()

◆ setUserId()

◆ update()

Field Documentation

◆ $changedate

◆ $createdate

◆ $db

◆ $description

◆ $exists

◆ $mode

◆ $title

◆ $user_id

◆ MODE_ADDRESSBOOK

◆ MODE_TEMPORARY