gambare-web/contact-bundle

This is a contact bundle for Symfony 5

dev-main 2021-01-19 16:24 UTC

Requires

• php: ^7.1.3
• easycorp/easyadmin-bundle: 3.*
• stof/doctrine-extensions-bundle: ^1.5
• symfony/mailer: ^5.1
• vich/uploader-bundle: ^1.10

MIT

• Kaizoku

README

• Contact bundle for Symfony 5 with EasyAdminBundle v3 integration.

Note : This Bundle is intended for personal use. But you are free to use it if you really want to

Installation

Open a command console, enter your project directory and execute:

composer require gambare-web/contact-bundle:dev-main

Configuration

Activate doctrine extention

stof_doctrine_extensions:
    orm:
        default:
            timestampable: true

-TODO- automatize with a recipe

Add Vich uploader config for file attachment

# config/packages/vich_uploader.yaml
vich_uploader:
    mappings:
        message_attachement:
            uri_prefix: /message_file
            upload_destination: '%kernel.project_dir%/public/uploads/contact_message'
            namer: Vich\UploaderBundle\Naming\UniqidNamer

Generate Migration

php bin/console make:migration
php bin/console doctrine:migrations:migrate

Configure Symfony Mailer

https://symfony.com/doc/current/mailer.html

configure MAILER_DSN in your .env.local (or user symfony/google-mailer on dev)

Add Twig namespace in config/packages/twig.yaml if you want to use the predefined twig template

twig:
    paths:
        '%kernel.project_dir%/vendor/gambare-web/contact-bundle/templates': gambare-web

Usage

Copy one exemple from src/Controller/ContactMessageController

You can change the form options about the fields you want to show and have as required using the FormType resolver default

$contact_form = $this->createForm(ContactMessageFormType::class, null, ['name_required' => false, 'file' => true]);

Twig integration

A bootstrap form is provided. You can include it or use it as exemple.

{% include '@gambare-web/_bootstrap_form.html.twig' %}

Email integration

One default html template is included. You can use it, extend it or use your own.

• The base template is : '@gambare-web/email/base_email.html.twig'
• The demo template is : '@gambare-web/email/contact_notif.html.twig'

The following parameters are used in the template.

            $email = (new TemplatedEmail())
                ->htmlTemplate('@gambare-web/email/contact_notif.html.twig')
                ->context(
                    [
                        'name'    => $contact->getName(),
                        'subject' => $contact->getSubject(),
                        'mail'    => $contact->getEmail(),
                        'phone'     => $contact->getPhone(),
                        'message' => $contact->getMessage(),
                        'logo_url' => 'https://.../img.png',
                        'logo_name' => 'W00tKorp',
                    ]
                );

EasyAdminBundle v3 integration

Create a ContactMessageCrudController class that extends ContactMessageDefaultCrudController

ContactMessageDefaultCrudController is extending the AbstractCrudController from EasyAdmin

Add an entry to your DashboardController

    public function configureMenuItems(): iterable
    {
        // [...]
        yield MenuItem::linkToCrud('Message', 'far fa-envelope', ContactMessage::class);
    }