README

Form module for Yii 2 WaveCMS.

Please do all install steps first from Yii 2 WaveCMS.

Installation

The preferred way to install this extension is through composer.

Run

composer require --prefer-source "mrstroz/yii2-wavecms-form" "~0.2.1"

or add

"mrstroz/yii2-wavecms-form": "~0.2.1"

to the require section of your composer.json file.

Required

1. Update backend/config/main.php (Yii2 advanced template)

'modules' => [
    // ...
    'wavecms-form' => [
        'class' => 'mrstroz\wavecms\form\Module',
        /*
        * Override classes
        'classMap' => [
            'Form' => 'common\models\Form',
        ]
        */
    ],
],

Form views can be overwritten by backend themes;

1. Add the migrationPath in console/config/main.php and run yii migrate:

// Add migrationPaths to console config:
'controllerMap' => [
    'migrate' => [
        'class' => 'yii\console\controllers\MigrateController',
        'migrationPath' => [
            '@vendor/mrstroz/yii2-wavecms-form/migrations'
        ],
    ],
],

Or run migrates directly

yii migrate/up --migrationPath=@vendor/mrstroz/yii2-wavecms-form/migrations

1. Add reCaptcha component to common/config/main-local.php

'components' => [
    'reCaptcha' => [
        'name' => 'reCaptcha',
        'class' => 'himiklab\yii2\recaptcha\ReCaptcha',
        'siteKey' => 'your siteKey',
        'secret' => 'your secret key',
    ],
    // ...    
]

Usage in frontend

1. Controller

<?php
// ...
use mrstroz\wavecms\form\models\Form;
use mrstroz\wavecms\form\models\FormSettings;
// ...

public function actionIndex()
    {
        $model = new Form();
        $model->scenario = Form::SCENARIO_WEB;
        $formSettings = false;

        if ($model->load(Yii::$app->request->post()) && $model->validate()) {
            $model->save();

            $formSettings = FormSettings::find()->getSettings('contact')->one();
            $formSettings->replaceTags($model);
            $formSettings->replaceExtraTag('tag', 'value');

            if ($formSettings->send_email) {
                Yii::$app->mailer->compose()
                    ->setSubject($formSettings->subject)
                    ->setFrom([$formSettings->from_email => $formSettings->from_name])
                    ->setHtmlBody($formSettings->text)
                    ->setTo(explode(',', $formSettings->recipient))
                    ->send();
            }
            
            if ($formSettings->user_send_email) {
                Yii::$app->mailer->compose()
                    ->setSubject($formSettings->user_subject)
                    ->setFrom([$formSettings->user_from_email => $formSettings->user_from_name])
                    ->setHtmlBody($formSettings->user_text)
                    ->setTo($model->email)
                    ->send();
            }
        }

        return $this->render('index', [
            'model' => $model,
            'formSettings' => $formSettings
        ]);
    }

1. View

<?php
// ...
use himiklab\yii2\recaptcha\ReCaptcha;
use yii\helpers\Html;
use yii\bootstrap\ActiveForm;
use yii\widgets\Pjax;

// ...
    Pjax::begin();
    /** @var \mrstroz\wavecms\form\models\FormSettings $formSettings */
    if ($formSettings) {
        echo $formSettings->thanks_text;
    } else {
        $form = ActiveForm::begin(['options' => ['data-pjax' => true]]);
    
        echo Html::activeHiddenInput($model, 'language', ['value' => Yii::$app->language]);
        echo Html::activeHiddenInput($model, 'type', ['value' => 'contact']);
    
        echo $form->field($model, 'name');
        echo $form->field($model, 'company');
        echo $form->field($model, 'email');
        echo $form->field($model, 'phone');
        echo $form->field($model, 'subject');
        echo $form->field($model, 'text')->textarea();
        echo $form->field($model, 'agree_1')->checkbox();
        echo $form->field($model, 'agree_2')->checkbox();
    
        echo $form->field($model, 'reCaptcha')->label(false)->widget(ReCaptcha::class);
    
    
        echo Html::submitButton('Send message', ['class' => 'btn btn-primary']);
    
        ActiveForm::end();
    }
    Pjax::end();
// ...