How is the contact form implemented?

dmitrii_fediuk · January 27, 2018, 5:26pm

1. Magento/Contact/view/frontend/templates/form.phtml

magento/magento2/blob/2.2.2/app/code/Magento/Contact/view/frontend/templates/form.phtml#L10-L53


<form class="form contact"
  action="<?= $block->escapeUrl($block->getFormAction()) ?>"
  id="contact-form"
  method="post"
  data-hasrequired="<?= $block->escapeHtmlAttr(__('* Required Fields')) ?>"
  data-mage-init='{"validation":{}}'>
<fieldset class="fieldset">
    <legend class="legend"><span><?= $block->escapeHtml(__('Write Us')) ?></span></legend><br />
    <div class="field note no-label"><?= $block->escapeHtml(__('Jot us a note and we’ll get back to you as quickly as possible.')) ?></div>
    <div class="field name required">
        <label class="label" for="name"><span><?= $block->escapeHtml(__('Name')) ?></span></label>
        <div class="control">
            <input name="name" id="name" title="<?= $block->escapeHtmlAttr(__('Name')) ?>" value="<?= $block->escapeHtmlAttr($this->helper('Magento\Contact\Helper\Data')->getPostValue('name') ?: $this->helper('Magento\Contact\Helper\Data')->getUserName()) ?>" class="input-text" type="text" data-validate="{required:true}"/>
        </div>
    </div>
    <div class="field email required">
        <label class="label" for="email"><span><?= $block->escapeHtml(__('Email')) ?></span></label>
        <div class="control">
            <input name="email" id="email" title="<?= $block->escapeHtmlAttr(__('Email')) ?>" value="<?= $block->escapeHtmlAttr($this->helper('Magento\Contact\Helper\Data')->getPostValue('email') ?: $this->helper('Magento\Contact\Helper\Data')->getUserEmail()) ?>" class="input-text" type="email" data-validate="{required:true, 'validate-email':true}"/>
        </div>
    </div>
    <div class="field telephone">
        <label class="label" for="telephone"><span><?= $block->escapeHtml(__('Phone Number')) ?></span></label>
        <div class="control">
            <input name="telephone" id="telephone" title="<?= $block->escapeHtmlAttr(__('Phone Number')) ?>" value="<?= $block->escapeHtmlAttr($this->helper('Magento\Contact\Helper\Data')->getPostValue('telephone')) ?>" class="input-text" type="text" />
        </div>
    </div>
    <div class="field comment required">
        <label class="label" for="comment"><span><?= $block->escapeHtml(__('What’s on your mind?')) ?></span></label>
        <div class="control">
            <textarea name="comment" id="comment" title="<?= $block->escapeHtmlAttr(__('What’s on your mind?')) ?>" class="input-text" cols="5" rows="3" data-validate="{required:true}"><?= $block->escapeHtml($this->helper('Magento\Contact\Helper\Data')->getPostValue('comment')) ?></textarea>
        </div>
    </div>
    <?= $block->getChildHtml('form.additional.info') ?>
</fieldset>
<div class="actions-toolbar">
    <div class="primary">
        <input type="hidden" name="hideit" id="hideit" value="" />
        <button type="submit" title="<?= $block->escapeHtmlAttr(__('Submit')) ?>" class="action submit primary">
            <span><?= $block->escapeHtml(__('Submit')) ?></span>
        </button>
    </div>
</div>
</form>

2. Magento\Contact\Block\ContactForm::getFormAction()

github.com

magento/magento2/blob/2.2.2/app/code/Magento/Contact/Block/ContactForm.php#L28-L36


/**
 * Returns action url for contact form
 *
 * @return string
 */
public function getFormAction()
{
    return $this->getUrl('contact/index/post', ['_secure' => true]);
}

3. Magento\Contact\Controller\Index\Post::execute()

github.com

magento/magento2/blob/2.2.2/app/code/Magento/Contact/Controller/Index/Post.php#L63-L90


/**
 * Post user question
 *
 * @return Redirect
 */
public function execute()
{
    if (!$this->isPostRequest()) {
        return $this->resultRedirectFactory->create()->setPath('*/*/');
    }
    try {
        $this->sendEmail($this->validatedParams());
        $this->messageManager->addSuccessMessage(
            __('Thanks for contacting us with your comments and questions. We\'ll respond to you very soon.')
        );
        $this->dataPersistor->clear('contact_us');
    } catch (LocalizedException $e) {
        $this->messageManager->addErrorMessage($e->getMessage());
        $this->dataPersistor->set('contact_us', $this->getRequest()->getParams());
    } catch (\Exception $e) {
        $this->logger->critical($e);
        $this->messageManager->addErrorMessage(
            __('An error occurred while processing your form. Please try again later.')
        );
        $this->dataPersistor->set('contact_us', $this->getRequest()->getParams());
    }
    return $this->resultRedirectFactory->create()->setPath('contact/index');
}

4. Magento\Contact\Controller\Index\Post::sendEmail()

github.com

magento/magento2/blob/2.2.2/app/code/Magento/Contact/Controller/Index/Post.php#L92-L102


/**
 * @param array $post Post data from contact form
 * @return void
 */
private function sendEmail($post)
{
    $this->mail->send(
        $post['email'],
        ['data' => new DataObject($post)]
    );
}

5. Magento\Contact\Model\MailInterface::send()

github.com

magento/magento2/blob/2.2.2/app/code/Magento/Contact/Model/MailInterface.php#L6-L25


namespace Magento\Contact\Model;


/**
* Email from contact form
*
* @api
* @since 100.2.0
*/
interface MailInterface
{
   /**
    * Send email from contact form
    *
    * @param string $replyTo Reply-to email address
    * @param array $variables Email template variables
    * @return void
    * @since 100.2.0
    */
   public function send($replyTo, array $variables);
}

6. app/code/Magento/Contact/etc/di.xml

github.com

magento/magento2/blob/2.2.2/app/code/Magento/Contact/etc/di.xml#L9-L9


<preference for="Magento\Contact\Model\MailInterface" type="Magento\Contact\Model\Mail" />

7. Magento\Contact\Model\Mail::send()

github.com

magento/magento2/blob/2.2.2/app/code/Magento/Contact/Model/Mail.php#L56-L89


/**
 * Send email from contact form
 *
 * @param string $replyTo
 * @param array $variables
 * @return void
 */
public function send($replyTo, array $variables)
{
    /** @see \Magento\Contact\Controller\Index\Post::validatedParams() */
    $replyToName = !empty($variables['data']['name']) ? $variables['data']['name'] : null;


    $this->inlineTranslation->suspend();
    try {
        $transport = $this->transportBuilder
            ->setTemplateIdentifier($this->contactsConfig->emailTemplate())
            ->setTemplateOptions(
                [
                    'area' => Area::AREA_FRONTEND,
                    'store' => $this->storeManager->getStore()->getId()
                ]
            )
            ->setTemplateVars($variables)
            ->setFrom($this->contactsConfig->emailSender())
            ->addTo($this->contactsConfig->emailRecipient())
            ->setReplyTo($replyTo, $replyToName)
            ->getTransport();


        $transport->sendMessage();
    } finally {
        $this->inlineTranslation->resume();
    }
}
}

Details: How does Magento\Framework\Mail\Template\TransportBuilder::getTransport() work?