luyadev/luya-module-forms

<?php

namespace luya\forms;

use luya\forms\models\Submission;
use luya\helpers\StringHelper;
use yii\validators\EmailValidator;

/**
 * E-Mail Submission Object
 *
 * @author Basil Suter <git@nadar.io>
 * @since 1.0.0
 */
class SubmissionEmail
{
    /**
     * @var Submission
     */
    public $submission;

    /**
     * Constructor
     *
     * @param Submission $submission
     */
    public function __construct(Submission $submission)
    {
        $this->submission = $submission;
    }

    /**
     * Returns the subject of the email.
     *
     * If subject is not defined, the form title is returned
     *
     * @return string
     */
    public function getSubject()
    {
        return $this->submission->form->subject ? $this->submission->form->subject : $this->submission->form->title;
    }

    /**
     * Returns all recipients
     *
     * @return array
     */
    public function getRecipients()
    {
        $recipients = $this->submission->form->recipients;

        $copyAttribute = $this->submission->form->copy_to_attribute;

        if ($copyAttribute) {
            $copyAttributeValue = $this->submission->getValueByAttribute($copyAttribute);
            $validator = new EmailValidator();
            if (!empty($copyAttributeValue) && $validator->validate($copyAttributeValue)) {
                $recipients[] = $copyAttributeValue;
            }
        }

        return array_unique($recipients);
    }

    /**
     * Returns the full html body with intro, summary and outro.
     *
     * @return string
     * @since 1.2.0
     */
    public function getBodyHtml()
    {
        return $this->getIntro() . $this->getSummaryHtml() . $this->getOutro();
    }

    /**
     * Get the body with intro, summary and outro as text, with stripped tags
     *
     * @return string
     * @since 1.2.0
     */
    public function getBodyText()
    {
        return strip_tags($this->getBodyHtml());
    }

    /**
     * Returns the summary of the form value
     *
     * @return string
     */
    public function getSummaryHtml()
    {
        $html = null;

        foreach ($this->submission->values as $value) {
            $html .= "<p><strong>{$value->label}</strong>: {$value->formattedValue}</p>";
        }

        return $html;
    }

    /**
     * Get the summary text with stripped tags
     *
     * @return string
     * @since 1.2.0
     */
    public function getSummaryText()
    {
        return strip_tags($this->getSummaryHtml());
    }

    /**
     * Returns the intro text for the email
     *
     * @return string
     */
    public function getIntro()
    {
        return StringHelper::template($this->submission->form->email_intro, $this->variablizeValues());
    }

    /**
     * Returns the outro text for the email
     *
     * @return string
     */
    public function getOutro()
    {
        return StringHelper::template($this->submission->form->email_outro, $this->variablizeValues());
    }

    private $_variablizedValues = false;

    /**
     * Get all variables with its value as array
     *
     * @return array
     * @since 1.7.0
     */
    public function variablizeValues()
    {
        if ($this->_variablizedValues === false) {
            $vars = [];
            foreach ($this->submission->values as $value) {
                $vars[$value->attribute] = $value->value;
            }
            $this->_variablizedValues = $vars;
        }

        return $this->_variablizedValues;
    }

    /**
     * Get attribute value
     *
     * @param string $attributeName
     * @param mixed $defaultValue
     * @return mixed
     * @since 1.7.0
     */
    public function getAttributeValue($attributeName, $defaultValue = null)
    {
        $vars = $this->variablizeValues();
        
        return array_key_exists($attributeName, $vars) ? $vars[$attributeName] : $defaultValue;
    }
}