ilTestManScoringParticipantNotification Class Reference

Inheritance diagram for ilTestManScoringParticipantNotification:

Collaboration diagram for ilTestManScoringParticipantNotification:

Public Member Functions
	__construct ($userId, $testRefId)
	send ()
Public Member Functions inherited from ilMailNotification
	__construct ($a_is_personal_workspace=false)
	Constructor. More...
	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 ($a_rcp)
	set mail recipients More...
	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)
	Set ref id. More...
	getRefId ()
	get reference id More...
	getObjId ()
	get object id More...
	setObjId ($a_obj_id)
	set obj id More...
	getObjType ()
	Get object type. More...
	setAdditionalInformation ($a_info)
	Additional information for creating notification mails. More...
	getAdditionalInformation ()
	Get additional information for generating notification mails. More...
	sendMail ($a_rcp, $a_type, $a_parse_recipients=true)
	Send Mail. More...
	getBlockBorder ()
	Get (ascii) block border. More...

Private Member Functions
	buildSubject ()
	buildBody ()
	setRecipient ($userId)
	getRecipient ()
	convertFeedbackForMail ($feedback)

Private Attributes
	$userId = null
	$questionGuiList = null
	$notificationData = null

Additional Inherited Members
Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60
Protected Member Functions inherited from ilMailNotification
	setSubject ($a_subject)
	Set mail subject. More...
	getSubject ()
	Get mail subject. More...
	setBody ($a_body)
	Set mail body. More...
	appendBody ($a_body)
	Append body text. More...
	getBody ()
	Get body. More...
	initLanguage ($a_usr_id)
	Init language. More...
	initLanguageByIso2Code ($a_code='')
	Init language by ISO2 code. More...
	setLanguage ($a_language)
	A language. More...
	getLanguage ()
	get language object More...
	getLanguageText ($a_keyword)
	Replace new lines. More...
	getObjectTitle ($a_shorten=false)
	Get object title. More...
	initMail ()
	Init mail. More...
	getMail ()
	Get mail object. More...
	createPermanentLink ($a_params=array(), $a_append='')
	Create a permanent link for an object. More...
	userToString ($a_usr_id)
	Utility function. More...
	isRefIdAccessible ($a_user_id, $a_ref_id, $a_permission="read")
	Check if ref id is accessible for user. More...
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

Detailed Description

Definition at line 7 of file class.ilTestManScoringParticipantNotification.php.

Constructor & Destructor Documentation

__construct()

ilTestManScoringParticipantNotification::__construct	(		$userId,
			$testRefId
	)

Definition at line 13 of file class.ilTestManScoringParticipantNotification.php.

        {
                parent::__construct();
 
                $this->setRecipient($userId);
                $this->setRefId($testRefId);
                
                $this->initLanguage( $this->getRecipient() );
                $this->getLanguage()->loadLanguageModule('assessment');
 
                $this->initMail()->enableSoap(false);
        }

References $userId, ilMailNotification\getLanguage(), getRecipient(), ilMailNotification\initLanguage(), ilMailNotification\initMail(), setRecipient(), and ilMailNotification\setRefId().

Here is the call graph for this function:

Member Function Documentation

buildBody()

ilTestManScoringParticipantNotification::buildBody ( )

private

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

        {
                //      Salutation
                
                $this->setBody(
                                ilMail::getSalutation( $this->getRecipient(), $this->getLanguage() )
                );
                $this->appendBody("\n\n");
 
                //      Message (What has happened?)
 
                $this->appendBody( $this->getLanguageText('tst_notify_manscoring_done_body_msg_topic') );
                $this->appendBody("\n\n");
                
                $info = $this->getAdditionalInformation();
                
                $this->appendBody( $this->getLanguageText('obj_tst').': '.$info['test_title'] );
                $this->appendBody("\n");
                $this->appendBody( $this->getLanguageText('pass').': '.$info['test_pass'] );
                $this->appendBody("\n\n");
                
                foreach($info['questions_gui_list'] as $questionId => $questionGui)
                {
                        $points = $info['questions_scoring_data'][$questionId]['points'];
                        $feedback = $info['questions_scoring_data'][$questionId]['feedback'];
                        
                        $feedback = $this->convertFeedbackForMail($feedback);
                        
                        $this->appendBody( $this->getLanguageText('tst_question').': '.$questionGui->object->getTitle() );
                        $this->appendBody("\n");
                        $this->appendBody( $this->getLanguageText('tst_reached_points').': '.$points );
                        $this->appendBody("\n");
                        $this->appendBody( $this->getLanguageText('set_manual_feedback').":\n".$feedback );
                        $this->appendBody("\n\n");
                }
 
                //      Task (What do I have to do?
                
                /* NOTHING TODO FOR PARTICIPANT */
                
                //      Explanation (Why do I receive the following message?)
                
                $this->appendBody("\n");
                $this->appendBody($this->getLanguageText('tst_notify_manscoring_done_body_msg_reason'));
                                
                //      Signature
                
                $this->getMail()->appendInstallationSignature(true);
        }

References ilMailNotification\appendBody(), convertFeedbackForMail(), ilMailNotification\getAdditionalInformation(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), getRecipient(), ilMail\getSalutation(), and ilMailNotification\setBody().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

buildSubject()

ilTestManScoringParticipantNotification::buildSubject ( )

private

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

        {
                $info = $this->getAdditionalInformation();
                
                $this->setSubject( sprintf($this->getLanguageText('tst_notify_manscoring_done_body_msg_subject'), $info['test_title']) );
        }

References ilMailNotification\getAdditionalInformation(), ilMailNotification\getLanguageText(), and ilMailNotification\setSubject().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

convertFeedbackForMail()

ilTestManScoringParticipantNotification::convertFeedbackForMail (   $feedback )

private

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

        {
                if( strip_tags($feedback) != $feedback )
                {
                        $feedback = preg_replace('/<br(.*\/)>/m', "\n", $feedback);
                        $feedback = strip_tags($feedback);
                }
                
                return $feedback;
        }

Referenced by buildBody().

Here is the caller graph for this function:

getRecipient()

ilTestManScoringParticipantNotification::getRecipient ( )

private

Definition at line 99 of file class.ilTestManScoringParticipantNotification.php.

        {
                return current( $this->getRecipients() );
        }

References ilMailNotification\getRecipients().

Referenced by __construct(), and buildBody().

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ilTestManScoringParticipantNotification::send

(

)

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

        {
                $this->buildSubject();
                
                $this->buildBody();
 
                $this->sendMail(
                                $this->getRecipients(), array('system')
                );
        }

References buildBody(), buildSubject(), ilMailNotification\getRecipients(), and ilMailNotification\sendMail().

Here is the call graph for this function:

setRecipient()

ilTestManScoringParticipantNotification::setRecipient (   $userId )

private

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

        {
                $this->setRecipients( array($userId) );
        }

References $userId, and ilMailNotification\setRecipients().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$notificationData

ilTestManScoringParticipantNotification::$notificationData = null

private

Definition at line 11 of file class.ilTestManScoringParticipantNotification.php.

$questionGuiList

ilTestManScoringParticipantNotification::$questionGuiList = null

private

Definition at line 10 of file class.ilTestManScoringParticipantNotification.php.

$userId

ilTestManScoringParticipantNotification::$userId = null

private

Definition at line 9 of file class.ilTestManScoringParticipantNotification.php.

Referenced by __construct(), and setRecipient().

---

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

• Modules/Test/classes/notifications/class.ilTestManScoringParticipantNotification.php