ilMailingLists Class Reference

Collaboration diagram for ilMailingLists:

Public Member Functions
	__construct (ilObjUser $a_user)
	ilMailingLists constructor. More...
	get ($id=0)
	getSelected ($a_ids=array())
	getAll ()
	mailingListExists ($a_list_name)
	setCurrentMailingList ($id=0)
	getCurrentMailingList ()
	deleteTemporaryLists ()

Private Attributes
	$db
	$user
	$ml = null

Detailed Description

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilMailingLists::__construct

(

ilObjUser

$a_user

)

ilMailingLists constructor.

Parameters

ilObjUser

$a_user

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

    {
        global $DIC;
 
        $this->db   = $DIC['ilDB'];
        $this->user = $a_user;
    }

References $DIC, and user().

Here is the call graph for this function:

Member Function Documentation

deleteTemporaryLists()

ilMailingLists::deleteTemporaryLists

(

)

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

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

References getAll(), and ilMailingList\MODE_TEMPORARY.

Here is the call graph for this function:

get()

ilMailingLists::get

(

$id = 0

)

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

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

References $id, and user().

Here is the call graph for this function:

getAll()

ilMailingLists::getAll

(

)

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

    {
        $res = $this->db->queryf(
            '
                        SELECT * FROM addressbook_mlist
                        WHERE user_id = %s',
            array('integer'),
            array($this->user->getId())
        );
        
        $entries = array();
        
        $counter = 0;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $tmpObj = new ilMailingList($this->user, 0);
            $tmpObj->setId($row->ml_id);
            $tmpObj->setUserId($row->user_id);
            $tmpObj->setTitle($row->title);
            $tmpObj->setDescription($row->description);
            $tmpObj->setCreatedate($row->createdate);
            $tmpObj->setChangedate($row->changedae);
            $tmpObj->setMode($row->lmode);
            
            $entries[$counter] = $tmpObj;
            
            unset($tmpObj);
            
            ++$counter;
        }
        
        return $entries;
    }

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

Referenced by deleteTemporaryLists().

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentMailingList()

ilMailingLists::getCurrentMailingList

(

)

Returns

ilMailingList

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

    {
        return $this->ml;
    }

References $ml.

getSelected()

ilMailingLists::getSelected

(

$a_ids = array()

)

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

    {
        $entries = array();
        
        if (is_array($a_ids) && !empty($a_ids)) {
            $counter = 0;
            while ($id = @array_pop($a_ids)) {
                $entries[$counter] = new ilMailingList($this->user, $id);
                
                ++$counter;
            }
        }
        
        return $entries;
    }

References $counter, $id, and user().

Here is the call graph for this function:

mailingListExists()

ilMailingLists::mailingListExists

(

$a_list_name

)

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

    {
        $ml_id = substr($a_list_name, strrpos($a_list_name, '_') + 1);
 
        if (!is_numeric($ml_id) || $ml_id <= 0) {
            return false;
        } else {
            $this->setCurrentMailingList($ml_id);
        }
        
        return true;
    }

References setCurrentMailingList().

Here is the call graph for this function:

setCurrentMailingList()

ilMailingLists::setCurrentMailingList

(

$id = 0

)

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

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

References $id.

Referenced by mailingListExists().

Here is the caller graph for this function:

Field Documentation

$db

ilMailingLists::$db

private

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

$ml

ilMailingLists::$ml = null

private

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

Referenced by getCurrentMailingList().

$user

ilMailingLists::$user

private

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

---

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

• Services/Contact/classes/class.ilMailingLists.php