ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilWorkflowEngineMailNotification Class Reference

PhpIncludeInspection More...

+ Inheritance diagram for ilWorkflowEngineMailNotification:
+ Collaboration diagram for ilWorkflowEngineMailNotification:

Public Member Functions

 getSubjectText ()
 
 setSubjectText ($subject_text)
 
 getBodyText ()
 
 setBodyText ($body_text)
 
 send ($rcp)
 
- 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_type, $a_parse_recipients=true)
 
 getBlockBorder ()
 Get (ascii) block border. More...
 

Protected Attributes

 $subject_text
 
 $body_text
 
- 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
 
- 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...
 

Detailed Description

PhpIncludeInspection

Author
Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de
Version
$Id$

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

Member Function Documentation

◆ getBodyText()

ilWorkflowEngineMailNotification::getBodyText ( )
Returns
string

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

References $body_text.

◆ getSubjectText()

ilWorkflowEngineMailNotification::getSubjectText ( )

◆ send()

ilWorkflowEngineMailNotification::send (   $rcp)

Definition at line 53 of file class.ilWorkflowEngineMailNotification.php.

References array, ilMailNotification\getMail(), ilMailNotification\initLanguage(), ilMailNotification\initMail(), ilMailNotification\sendMail(), ilMailNotification\setBody(), and ilMailNotification\setSubject().

54  {
55  $this->initLanguage($rcp);
56  $this->initMail();
57 
58  $this->setSubject($this->subject_text);
59  $this->setBody($this->body_text);
60  $this->getMail()->appendInstallationSignature(true);
61 
62  $this->sendMail(array($rcp), array('system'), false);
63  }
initLanguage($a_usr_id)
Init language.
Create styles array
The data for the language used.
sendMail(array $a_rcp, $a_type, $a_parse_recipients=true)
+ Here is the call graph for this function:

◆ setBodyText()

ilWorkflowEngineMailNotification::setBodyText (   $body_text)
Parameters
string$body_text

Definition at line 48 of file class.ilWorkflowEngineMailNotification.php.

References $body_text.

◆ setSubjectText()

ilWorkflowEngineMailNotification::setSubjectText (   $subject_text)
Parameters
string$subject_text

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

References $subject_text.

Field Documentation

◆ $body_text

ilWorkflowEngineMailNotification::$body_text
protected

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

Referenced by getBodyText(), and setBodyText().

◆ $subject_text

ilWorkflowEngineMailNotification::$subject_text
protected

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

Referenced by getSubjectText(), and setSubjectText().


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