ilSystemNotification Class Reference

Wrapper classes for system notifications. More...

Inheritance diagram for ilSystemNotification:

Collaboration diagram for ilSystemNotification:

Public Member Functions
	setSubjectLangId ($a_lang_id)
	Set subject lang id. More...
	setSubjectDirect ($a_text)
	Set subject text. More...
	setIntroductionLangId ($a_lang_id)
	Set introduction lang id. More...
	setIntroductionDirect ($a_text)
	Set introduction text. More...
	setTaskLangId ($a_lang_id)
	Set task lang id. More...
	setReasonLangId ($a_lang_id)
	Set reason lang id. More...
	setGotoLangId ($a_lang_id)
	Set goto lang id. More...
	setChangedByUserId ($a_id)
	Set changed by user id. More...
	addAdditionalInfo ($a_lang_id, $a_value, $a_multiline=false, $a_lang_direct=false)
	Add additional information. More...
	sendMail (array $a_user_ids, $a_goto_additional=null, $a_permission="read")
	Send notification(s) More...
	compose ($a_user_id, $a_goto_additional=null, $a_permission="read", $a_append_signature_direct=false)
	Compose notification to single recipient. More...
	composeAndGetMessage ($a_user_id, $a_goto_additional=null, $a_permission="read", $a_append_signature_direct=false)
	Compose notification to single recipient. More...
Public Member Functions inherited from ilMailNotification
	__construct ($a_is_personal_workspace=false)
	setType ($a_type)
	Set notification type. More...
	getType ()
	Get notification type. More...
	setSender ($a_usr_id)
	Set sender of mail. More...
	getSender ()
	get sender of mail More...
	setRecipients (array $a_rcp)
	getRecipients ()
	get array of recipients More...
	setAttachments ($a_att)
	Set attachments. More...
	getAttachments ()
	Get attachments. More...
	setLangModules (array $a_modules)
	Set lang modules. More...
	getUserLanguage ($a_usr_id)
	Get user language. More...
	setRefId ($a_id)
	getRefId ()
	getObjId ()
	setObjId ($a_obj_id)
	getObjType ()
	Get object type. More...
	setAdditionalInformation (array $a_info)
	Additional information for creating notification mails. More...
	getAdditionalInformation ()
	sendMail (array $a_rcp, $a_parse_recipients=true)
	getBlockBorder ()
	Get (ascii) block border. More...

Protected Member Functions
	composeAndSendMail ($a_user_id, $a_goto_additional=null, $a_permission="read")
	Send notification to single recipient. More...
Protected Member Functions inherited from ilMailNotification
	setSubject ($a_subject)
	getSubject ()
	setBody ($a_body)
	appendBody ($a_body)
	Append body text. More...
	getBody ()
	initLanguage ($a_usr_id)
	Init language. More...
	initLanguageByIso2Code ($a_code='')
	Init language by ISO2 code. More...
	setLanguage ($a_language)
	getLanguage ()
	getLanguageText ($a_keyword)
	getObjectTitle ($a_shorten=false)
	initMail ()
	getMail ()
	createPermanentLink ($a_params=array(), $a_append='')
	userToString ($a_usr_id)
	isRefIdAccessible ($a_user_id, $a_ref_id, $a_permission="read")
	Check if ref id is accessible for user. More...

Protected Attributes
	$subject_lang_id
	$subject_direct
	$introduction
	$introduction_direct
	$task
	$reason
	$additional
	$goto_caption
	$changed_by
	$all_ref_ids
Protected Attributes inherited from ilMailNotification
	$type = null
	$sender = null
	$mail = null
	$subject = ''
	$body = ''
	$attachments = array()
	$language = null
	$lang_modules = array()
	$recipients = array()
	$ref_id = null
	$obj_id = null
	$obj_type = null
	$additional_info = array()
	$is_in_wsp
	$wsp_tree
	$wsp_access_handler

Additional Inherited Members
Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60

Detailed Description

Wrapper classes for system notifications.

See also

FeatureWiki/Guidelines/System Notification Guideline

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Id

class.ilObjExerciseGUI.php 24003 2010-05-26 14:35:42Z akill

Definition at line 16 of file class.ilSystemNotification.php.

Member Function Documentation

addAdditionalInfo()

ilSystemNotification::addAdditionalInfo	(		$a_lang_id,
			$a_value,
			$a_multiline = false,
			$a_lang_direct = false
	)

Add additional information.

Parameters

string	$a_lang_id
mixed	$a_value
bool	$a_multiline
bool	$a_lang_direct

Definition at line 119 of file class.ilSystemNotification.php.

    {
        $this->additional[$a_lang_id] = array(trim($a_value), (bool) $a_multiline, (bool) $a_lang_direct);
    }

compose()

ilSystemNotification::compose	(		$a_user_id,
			$a_goto_additional = null,
			$a_permission = "read",
			$a_append_signature_direct = false
	)

Compose notification to single recipient.

Parameters

mixed	$a_rcp
string	$a_goto_additional
string	$a_permission
bool	$a_append_signature_direct

Returns

bool

Definition at line 181 of file class.ilSystemNotification.php.

    {
        $this->initLanguage($a_user_id);
        $this->initMail();
 
        if ($this->subject_direct) {
            $this->setSubject($this->subject_direct);
        } else {
            $this->setSubject(
                sprintf($this->getLanguageText($this->subject_lang_id), $this->getObjectTitle(true))
            );
        }
 
        $this->setBody(ilMail::getSalutation($a_user_id, $this->getLanguage()));
        $this->appendBody("\n\n");
 
        if ($this->introduction) {
            $this->appendBody($this->getLanguageText($this->introduction));
            $this->appendBody("\n\n");
        }
 
        if ($this->introduction_direct) {
            $this->appendBody($this->introduction_direct);
            $this->appendBody("\n\n");
        }
 
        if ($this->task) {
            $this->appendBody($this->getLanguageText($this->task));
            $this->appendBody("\n\n");
        }
 
        // details table
        if ($this->getObjId()) {
            $this->appendBody($this->getLanguageText("obj_" . $this->getObjType()) . ": " .
                $this->getObjectTitle() . "\n");
        }
        if (is_array($this->additional)) {
            foreach ($this->additional as $lang_id => $item) {
                $caption = "";
                if ($lang_id) {
                    $caption = (!$item[2])
                        ? $this->getLanguageText($lang_id)
                        : $lang_id;
                }
                if (!$item[1]) {
                    if ($caption) {
                        $caption .= ": ";
                    }
                    $this->appendBody($caption . $item[0] . "\n");
                } else {
                    if ($caption) {
                        $caption .= "\n";
                    }
                    $this->appendBody("\n" . $caption .
                        $this->getBlockBorder() .
                        $item[0] . "\n" .
                        $this->getBlockBorder() . "\n");
                }
            }
        }
        $this->body = trim($this->body);
        $this->appendBody("\n\n");
 
        if ($this->changed_by) {
            $this->appendBody($this->getLanguageText("system_notification_installation_changed_by") . ": " .
                ilUserUtil::getNamePresentation($this->changed_by));
            $this->appendBody("\n\n");
        }
 
        if ($this->getObjId()) {
            // try to find accessible ref_id
            if (!$this->getRefId() && $this->all_ref_ids) {
                $find_ref_id = true;
                foreach ($this->all_ref_ids as $ref_id) {
                    if ($this->isRefIdAccessible($a_user_id, $ref_id, $a_permission)) {
                        $this->ref_id = $ref_id;
                        break;
                    }
                }
            }
            
            // check if initially given ref_id is accessible for current recipient
            if ($this->getRefId() &&
                !$find_ref_id &&
                !$this->isRefIdAccessible($a_user_id, $this->getRefId(), $a_permission)) {
                return false;
            }
            
            $goto = $this->createPermanentLink(array(), $a_goto_additional);
            if ($goto) {
                $this->appendBody($this->getLanguageText($this->goto_caption) . ": " .
                    $goto);
                $this->appendBody("\n\n");
            }
 
            if ($find_ref_id) {
                $this->ref_id = null;
            }
        }
 
        if ($this->reason) {
            $this->appendBody($this->getLanguageText($this->reason));
            $this->appendBody("\n\n");
        }
        
        $this->appendBody(ilMail::_getAutoGeneratedMessageString($this->language));
 
        // signature will append new lines
        $this->body = trim($this->body);
 
        if (!$a_append_signature_direct) {
            $this->getMail()->appendInstallationSignature(true);
        } else {
            $this->appendBody(ilMail::_getInstallationSignature());
        }
        
        return true;
    }

References ilMailNotification\$ref_id, ilMail\_getAutoGeneratedMessageString(), ilMail\_getInstallationSignature(), ilMailNotification\appendBody(), ilMailNotification\createPermanentLink(), ilMailNotification\getBlockBorder(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), ilUserUtil\getNamePresentation(), ilMailNotification\getObjectTitle(), ilMailNotification\getObjId(), ilMailNotification\getObjType(), ilMailNotification\getRefId(), ilMail\getSalutation(), ilMailNotification\initLanguage(), ilMailNotification\initMail(), ilMailNotification\isRefIdAccessible(), language(), ilMailNotification\setBody(), and ilMailNotification\setSubject().

Referenced by composeAndGetMessage(), and composeAndSendMail().

Here is the call graph for this function:

Here is the caller graph for this function:

composeAndGetMessage()

ilSystemNotification::composeAndGetMessage	(		$a_user_id,
			$a_goto_additional = null,
			$a_permission = "read",
			$a_append_signature_direct = false
	)

Compose notification to single recipient.

Parameters

mixed	$a_user_id
string	$a_goto_additional
string	$a_permission
bool	$a_append_signature_direct

Returns

string

Definition at line 326 of file class.ilSystemNotification.php.

    {
        if ($this->compose($a_user_id, $a_goto_additional, $a_permission, $a_append_signature_direct)) {
            return $this->body;
        }
    }

References ilMailNotification\$body, and compose().

Here is the call graph for this function:

composeAndSendMail()

ilSystemNotification::composeAndSendMail (   $a_user_id,   $a_goto_additional = null,   $a_permission = "read"  )

protected

Send notification to single recipient.

Parameters

mixed	$a_rcp
string	$a_goto_additional
string	$a_permission

Returns

bool

Definition at line 308 of file class.ilSystemNotification.php.

    {
        if ($this->compose($a_user_id, $a_goto_additional, $a_permission)) {
            parent::sendMail(array($a_user_id), is_numeric($a_user_id));
            return true;
        }
        return false;
    }

References compose().

Referenced by sendMail().

Here is the call graph for this function:

Here is the caller graph for this function:

sendMail()

ilSystemNotification::sendMail	(	array	$a_user_ids,
			$a_goto_additional = null,
			$a_permission = "read"
	)

Send notification(s)

Parameters

array	$a_user_ids
string	$a_goto_additional
string	$a_permission

Returns

array recipient ids

Definition at line 132 of file class.ilSystemNotification.php.

    {
        $this->all_ref_ids = null;
        
        // prepare object related info
        if ($this->getObjId()) {
            if (!$this->getRefId()) {
                // try to find ref_id(s)
                if (!$this->is_in_wsp) {
                    $ref_ids = ilObject::_getAllReferences($this->getObjId());
                    if (sizeof($ref_ids) == 1) {
                        $this->ref_id = array_shift($ref_ids);
                    } else {
                        $this->all_ref_ids = $ref_ids;
                    }
                }
            } elseif ($this->is_in_wsp) { // #11680
                $this->ref_id = $this->wsp_tree->lookupNodeId($this->getObjId());
            }
            
            // default values
            if (!$this->goto_caption) {
                $this->goto_caption = "url";
            }
        }
        
        $recipient_ids = array();
        foreach (array_unique($a_user_ids) as $user_id) {
            // author of change should not get notification
            if ($this->changed_by == $user_id) {
                continue;
            }
            if ($this->composeAndSendMail($user_id, $a_goto_additional, $a_permission)) {
                $recipient_ids[] = $user_id;
            }
        }
        
        return $recipient_ids;
    }

References ilObject\_getAllReferences(), composeAndSendMail(), ilMailNotification\getObjId(), and ilMailNotification\getRefId().

Here is the call graph for this function:

setChangedByUserId()

ilSystemNotification::setChangedByUserId

(

$a_id

)

Set changed by user id.

Parameters

int

$a_id

Definition at line 104 of file class.ilSystemNotification.php.

    {
        $this->changed_by = (int) $a_id;
        
        include_once "Services/User/classes/class.ilUserUtil.php";
    }

setGotoLangId()

ilSystemNotification::setGotoLangId

(

$a_lang_id

)

Set goto lang id.

Parameters

string

$a_lang_id

Definition at line 94 of file class.ilSystemNotification.php.

    {
        $this->goto_caption = (string) $a_lang_id;
    }

setIntroductionDirect()

ilSystemNotification::setIntroductionDirect

(

$a_text

)

Set introduction text.

Parameters

string

$a_text

Definition at line 64 of file class.ilSystemNotification.php.

    {
        $this->introduction_direct = trim($a_text);
    }

setIntroductionLangId()

ilSystemNotification::setIntroductionLangId

(

$a_lang_id

)

Set introduction lang id.

Parameters

string

$a_lang_id

Definition at line 54 of file class.ilSystemNotification.php.

    {
        $this->introduction = (string) $a_lang_id;
    }

setReasonLangId()

ilSystemNotification::setReasonLangId

(

$a_lang_id

)

Set reason lang id.

Parameters

string

$a_lang_id

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

    {
        $this->reason = (string) $a_lang_id;
    }

setSubjectDirect()

ilSystemNotification::setSubjectDirect

(

$a_text

)

Set subject text.

Parameters

string

$a_text

Definition at line 44 of file class.ilSystemNotification.php.

    {
        $this->subject_direct = trim($a_text);
    }

setSubjectLangId()

ilSystemNotification::setSubjectLangId

(

$a_lang_id

)

Set subject lang id.

Parameters

string

$a_lang_id

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

    {
        $this->subject_lang_id = (string) $a_lang_id;
    }

setTaskLangId()

ilSystemNotification::setTaskLangId

(

$a_lang_id

)

Set task lang id.

Parameters

string

$a_lang_id

Definition at line 74 of file class.ilSystemNotification.php.

    {
        $this->task = (string) $a_lang_id;
    }

Field Documentation

$additional

ilSystemNotification::$additional

protected

Definition at line 24 of file class.ilSystemNotification.php.

$all_ref_ids

ilSystemNotification::$all_ref_ids

protected

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

$changed_by

ilSystemNotification::$changed_by

protected

Definition at line 26 of file class.ilSystemNotification.php.

$goto_caption

ilSystemNotification::$goto_caption

protected

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

$introduction

ilSystemNotification::$introduction

protected

Definition at line 20 of file class.ilSystemNotification.php.

$introduction_direct

ilSystemNotification::$introduction_direct

protected

Definition at line 21 of file class.ilSystemNotification.php.

$reason

ilSystemNotification::$reason

protected

Definition at line 23 of file class.ilSystemNotification.php.

$subject_direct

ilSystemNotification::$subject_direct

protected

Definition at line 19 of file class.ilSystemNotification.php.

$subject_lang_id

ilSystemNotification::$subject_lang_id

protected

Definition at line 18 of file class.ilSystemNotification.php.

$task

ilSystemNotification::$task

protected

Definition at line 22 of file class.ilSystemNotification.php.

---

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

• Services/Notification/classes/class.ilSystemNotification.php