Collaboration diagram for ilMailingList:

Public Member Functions
	__construct (ilObjUser $user, $id=0)

	insert ()

	update ()

	delete ()

	getAssignedEntries ()

	assignUser ($usr_id=0)

	deleteEntry ($a_id=0)

	deassignAllEntries ()

	setId ($a_mail_id=0)

	getId ()

	setUserId ($a_user_id=0)

	getUserId ()

	setTitle ($a_title='')

	getTitle ()

	setDescription ($a_description='')

	getDescription ()

	setCreatedate ($_createdate)

	getCreatedate ()

	setChangedate ($a_changedate)

	getChangedate ()

	setMode ($a_mode)

	getMode ()

Data Fields
const	MODE_ADDRESSBOOK = 1

const	MODE_TEMPORARY = 2

Private Member Functions
	read ()

Private Attributes
	$mail_id = 0

	$user_id = 0

	$title = ''

	$description = ''

	$createdate = null

	$changedate = null

	$user

	$db

Detailed Description

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilMailingList::__construct	(	ilObjUser	$user,
			$id = `0`
	)

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

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

References $DIC, $user, read(), setMode(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ assignUser()

ilMailingList::assignUser ( $usr_id = 0 )

Parameters

int $usr_id

Returns: bool

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

        {
                $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)',
                        array('integer', 'integer', 'integer'),
                        array($nextId, $this->getId(), $usr_id)
                );
                return true;
        }

References getId().

Here is the call graph for this function:

◆ deassignAllEntries()

ilMailingList::deassignAllEntries ( )

Returns: bool

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

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

References getId().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilMailingList::delete ( )

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

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

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

Here is the call graph for this function:

◆ deleteEntry()

ilMailingList::deleteEntry ( $a_id = 0 )

Parameters

int $a_id

Returns: bool

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

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

◆ getAssignedEntries()

ilMailingList::getAssignedEntries ( )

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

        {
                $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',
                        array('integer'),
                        array($this->getId())
                );
 
                $entries = array();
                $counter = 0;
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                {
                        $entries[$row->a_id] = array(
                                'a_id'   => $row->a_id,
                                'usr_id' => $row->usr_id
                        );
                        ++$counter;
                }
                
                return $entries;
        }

References $counter, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and getId().

Here is the call graph for this function:

◆ getChangedate()

ilMailingList::getChangedate ( )

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

        {
                return $this->changedate;
        }

References $changedate.

Referenced by update().

Here is the caller graph for this function:

◆ getCreatedate()

ilMailingList::getCreatedate ( )

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

        {
                return $this->createdate;
        }

References $createdate.

Referenced by insert().

Here is the caller graph for this function:

◆ getDescription()

ilMailingList::getDescription ( )

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

        {
                return $this->description;
        }

References $description.

Referenced by insert(), and update().

Here is the caller graph for this function:

◆ getId()

ilMailingList::getId ( )

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

        {
                return $this->mail_id;
        }

References $mail_id.

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

Here is the caller graph for this function:

◆ getMode()

ilMailingList::getMode ( )

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

        {
                return $this->mode;
        }

Referenced by insert(), and update().

Here is the caller graph for this function:

◆ getTitle()

ilMailingList::getTitle ( )

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

        {
                return $this->title;
        }

References $title.

Referenced by ilMailingListsMembersTableGUI\__construct(), insert(), and update().

Here is the caller graph for this function:

◆ getUserId()

ilMailingList::getUserId ( )

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

        {
                return $this->user_id;
        }

References $user_id.

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

Here is the caller graph for this function:

◆ insert()

ilMailingList::insert ( )

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

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

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

Here is the call graph for this function:

◆ read()

ilMailingList::read ( )

private

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

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

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setChangedate()

ilMailingList::setChangedate ( $a_changedate )

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

        {
                $this->changedate = $a_changedate;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setCreatedate()

ilMailingList::setCreatedate ( $_createdate )

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

        {
                $this->createdate = $_createdate;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setDescription()

ilMailingList::setDescription ( $a_description = '' )

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

        {
                $this->description = $a_description;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setId()

ilMailingList::setId ( $a_mail_id = 0 )

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

        {
                $this->mail_id = $a_mail_id;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setMode()

ilMailingList::setMode ( $a_mode )

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

        {
                $a_mode = (int)$a_mode;
                if(in_array($a_mode, array(self::MODE_ADDRESSBOOK, self::MODE_TEMPORARY)))
                {
                        $this->mode = (int)$a_mode;
                }
        }

Referenced by __construct(), and read().

Here is the caller graph for this function:

◆ setTitle()

ilMailingList::setTitle ( $a_title = '' )

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

        {
                $this->title = $a_title;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setUserId()

ilMailingList::setUserId ( $a_user_id = 0 )

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

        {
                $this->user_id = $a_user_id;
        }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilMailingList::update ( )

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $changedate

ilMailingList::$changedate = null

private

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

Referenced by getChangedate().

◆ $createdate

ilMailingList::$createdate = null

private

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

Referenced by getCreatedate().

◆ $db

ilMailingList::$db

private

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

◆ $description

ilMailingList::$description = ''

private

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

Referenced by getDescription().

◆ $mail_id

ilMailingList::$mail_id = 0

private

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

Referenced by getId().

◆ $title

ilMailingList::$title = ''

private

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

Referenced by getTitle().

◆ $user

ilMailingList::$user

private

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

Referenced by __construct().

◆ $user_id

ilMailingList::$user_id = 0

private

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

Referenced by getUserId().

◆ MODE_ADDRESSBOOK

const ilMailingList::MODE_ADDRESSBOOK = 1

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

◆ MODE_TEMPORARY

const ilMailingList::MODE_TEMPORARY = 2

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

Referenced by ilMailingLists\deleteTemporaryLists(), ilObjUserFolderGUI\mailObject(), and ilMailingListsGUI\showMailingLists().

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

Services/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()

◆ getAssignedEntries()

◆ getChangedate()

◆ getCreatedate()

◆ getDescription()

◆ getId()

◆ getMode()

◆ getTitle()

◆ getUserId()

◆ insert()

◆ read()

◆ setChangedate()

◆ setCreatedate()

◆ setDescription()

◆ setId()

◆ setMode()

◆ setTitle()

◆ setUserId()

◆ update()

Field Documentation

◆ $changedate

◆ $createdate

◆ $db

◆ $description

◆ $mail_id

◆ $title

◆ $user

◆ $user_id

◆ MODE_ADDRESSBOOK

◆ MODE_TEMPORARY