ilSendMailActivity Class Reference

@noinspection PhpIncludeInspection More...

Inheritance diagram for ilSendMailActivity:

Collaboration diagram for ilSendMailActivity:

Public Member Functions
	__construct (ilNode $a_context)
	Default constructor. More...
	getContext ()
	Returns a reference to the parent node. More...
	setName ($name)
	getName ()
	getMessageName ()
	setMessageName ($message_name)
	getParameters ()
	setParameters ($parameters)
	getOutputs ()
	setOutputs ($outputs)
	decodeMessageText ($message_text)
	processPlaceholders ($message_text)
Public Member Functions inherited from ilActivity
	execute ()
	getContext ()
	This method returns the context of the element. More...
	setName ($name)
	getName ()

Protected Attributes
	$name

Private Attributes
	$context
	$message_name
	$parameters
	$outputs

Detailed Description

@noinspection PhpIncludeInspection

@noinspection PhpIncludeInspection Class ilSendMailActivity

This activity setup and send or read an email.

Author

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

/

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

Constructor & Destructor Documentation

__construct()

ilSendMailActivity::__construct

(

ilNode

$a_context

)

Default constructor.

Parameters

ilNode

$a_context

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

    {
        $this->context = $a_context;
    }

Member Function Documentation

decodeMessageText()

ilSendMailActivity::decodeMessageText

(

$message_text

)

Definition at line 162 of file class.ilSendMailActivity.php.

    {
        return base64_decode($message_text);
    }

getContext()

ilSendMailActivity::getContext

(

)

Returns a reference to the parent node.

Returns

ilNode Reference to the parent node.

Implements ilWorkflowEngineElement.

Definition at line 93 of file class.ilSendMailActivity.php.

    {
        return $this->context;
    }

References $context.

getMessageName()

ilSendMailActivity::getMessageName

(

)

Returns

string

Definition at line 117 of file class.ilSendMailActivity.php.

    {
        return $this->message_name;
    }

References $message_name.

getName()

ilSendMailActivity::getName

(

)

Returns

string

Implements ilWorkflowEngineElement.

Definition at line 109 of file class.ilSendMailActivity.php.

    {
        return $this->name;
    }

References $name.

getOutputs()

ilSendMailActivity::getOutputs

(

)

Returns

array

Definition at line 149 of file class.ilSendMailActivity.php.

    {
        return $this->outputs;
    }

References $outputs.

getParameters()

ilSendMailActivity::getParameters

(

)

Returns

array

Definition at line 133 of file class.ilSendMailActivity.php.

    {
        return $this->parameters;
    }

References $parameters.

processPlaceholders()

ilSendMailActivity::processPlaceholders

(

$message_text

)

Definition at line 167 of file class.ilSendMailActivity.php.

    {
        $matches = array();
        preg_match_all('/\[(.*?)\]/', $message_text, $matches, PREG_PATTERN_ORDER);
 
        foreach ($matches[0] as $match) {
            $placeholder = substr($match, 1, strlen($match)-2);
 
            $handled = false;
            if (strtolower(substr($placeholder, 0, strlen('EVENTLINK'))) == 'eventlink') {
                $handled = true;
                $content = $this->getEventLink($match);
            }
 
            if (!$handled) {
                $content = $this->context->getContext()->getInstanceVarById($placeholder);
            }
 
            if (strlen($content)) {
                $message_text = str_replace($match, $content, $message_text);
            }
        }
        return $message_text;
    }

setMessageName()

ilSendMailActivity::setMessageName

(

$message_name

)

Parameters

string

$message_name

Definition at line 125 of file class.ilSendMailActivity.php.

    {
        $this->message_name = $message_name;
    }

References $message_name.

setName()

ilSendMailActivity::setName

(

$name

)

Parameters

string

$name

Implements ilWorkflowEngineElement.

Definition at line 101 of file class.ilSendMailActivity.php.

    {
        $this->name = $name;
    }

References $name.

setOutputs()

ilSendMailActivity::setOutputs

(

$outputs

)

Parameters

array

$outputs

Definition at line 157 of file class.ilSendMailActivity.php.

    {
        $this->outputs = $outputs;
    }

References $outputs.

setParameters()

ilSendMailActivity::setParameters

(

$parameters

)

Parameters

array

$parameters

Definition at line 141 of file class.ilSendMailActivity.php.

    {
        $this->parameters = $parameters;
    }

References $parameters.

Field Documentation

$context

ilSendMailActivity::$context

private

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

Referenced by getContext().

$message_name

ilSendMailActivity::$message_name

private

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

Referenced by getMessageName(), and setMessageName().

$name

string ilSendMailActivity::$name

protected

Definition at line 28 of file class.ilSendMailActivity.php.

Referenced by getName(), and setName().

$outputs

ilSendMailActivity::$outputs

private

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

Referenced by getOutputs(), and setOutputs().

$parameters

ilSendMailActivity::$parameters

private

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

Referenced by getParameters(), and setParameters().

---

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

• Services/WorkflowEngine/classes/activities/class.ilSendMailActivity.php