mremi/contact-bundle

Implementation of a contact form for Symfony2

Installs: 11 931

Dependents: 2

Suggesters: 0

Stars: 26

Watchers: 5

Forks: 24

Open Issues: 7

Type:symfony-bundle

v1.3.0 2015-10-27 12:23 UTC

README

SensioLabsInsight

Build Status Total Downloads Latest Stable Version Scrutinizer Code Quality Code Coverage

This bundle provides a contact form in Symfony2.

License

This bundle is available under the MIT license.

Prerequisites

This version of the bundle requires Symfony 2.3+.

Translations

If you wish to use default texts provided in this bundle, you have to make sure you have translator enabled in your config.

# app/config/config.yml

framework:
    translator: ~

For more information about translations, check the Symfony documentation.

Installation

Installation is a quick 6 step process:

  1. Download MremiContactBundle using composer
  2. Enable the Bundle
  3. Create your Contact class (optional)
  4. Configure the MremiContactBundle
  5. Import MremiContactBundle routing
  6. Update your database schema (optional)

Step 1: Download MremiContactBundle using composer

Add MremiContactBundle in your composer.json:

{
    "require": {
        "mremi/contact-bundle": "dev-master"
    }
}

Now tell composer to download the bundle by running the command:

$ php composer.phar update mremi/contact-bundle

Composer will install the bundle to your project's vendor/mremi directory.

Step 2: Enable the bundle

Enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Mremi\ContactBundle\MremiContactBundle(),
    );
}

Step 3: Create your Contact class (optional)

The goal of this bundle is not to persist some Contact class to a database, but you can if you want just by setting the store_data parameter to true (default false). So if you don't need to do this, you can jump to the next step.

Your first job, then, is to create the Contact class for your application. This class can look and act however you want: add any properties or methods you find useful. This is your Contact class.

The bundle provides base classes which are already mapped for most fields to make it easier to create your entity. Here is how you use it:

  1. Extend the base Contact class from the Entity folder
  2. Map the id field. It must be protected as it is inherited from the parent class.

Note:

For now, only Doctrine ORM is handled by this bundle (any PR will be appreciated :) ).

<?php
// src/Acme/ContactBundle/Entity/Contact.php

namespace Acme\ContactBundle\Entity;

use Mremi\ContactBundle\Entity\Contact as BaseContact;

class Contact extends BaseContact
{
    /**
     * @var int
     */
    protected $id;
}
<!-- src/Acme/ContactBundle/Resources/config/doctrine/Contact.orm.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
                  http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">

    <entity name="Acme\ContactBundle\Entity\Contact"
            table="contact">

        <id name="id" column="id" type="integer">
            <generator strategy="AUTO" />
        </id>

    </entity>
</doctrine-mapping>

YML Version:

# src/Acme/ContactBundle/Resources/config/doctrine/Contact.orm.yml
Acme\ContactBundle\Entity\Contact:
  type: entity
  table: contact
  id:
    id:
      type: integer
      generator:
        strategy: AUTO

Annotations Version:

<?php
// src/Acme/ContactBundle/Entity/Contact.php

namespace Acme\ContactBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Mremi\ContactBundle\Entity\Contact as BaseContact;

/**
 * @ORM\Entity
 * @ORM\Table(name="contact")
 */
class Contact extends BaseContact
{
    /**
     * @var int
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;
}

Step 4: Configure the MremiContactBundle

The bundle comes with a sensible default configuration, which is listed below. However you have to configure at least a recipient address.

# app/config/config.yml
mremi_contact:
    store_data:            false
    contact_class:         Mremi\ContactBundle\Model\Contact

    form:
        type:              mremi_contact
        name:              contact_form
        validation_groups: [Default]
        subject_provider:  mremi_contact.subject_provider.noop

    email:
        mailer:            mremi_contact.mailer.twig_swift
        from:              []
        to:                [] # Required
        template:          MremiContactBundle:Contact:email.txt.twig

mremi_contact.email.from allows you to set the From address of the message:

# app/config/config.yml
mremi_contact:
    email:
        from:
            - { address: john.doe@example.com, name: "John Doe" }
            - { address: foo.bar@example.com }

mremi_contact.email.to allows you to set the To address of the message:

# app/config/config.yml
mremi_contact:
    email:
        to:
            - { address: webmaster@example.com, name: "Webmaster" }
            - { address: moderator@example.com }

You can also configure your favorite captcha. You have to install it by yourself and configure it here. You can get one from these bundles:

Or even implement your own.

# app/config/config.yml
mremi_contact:
    form:
        captcha_type:      genemu_captcha # or any other (genemu_recaptcha, ewz_recaptcha, ...)

Step 5: Import MremiContactBundle routing

Now that you have activated and configured the bundle, all that is left to do is import the MremiContactBundle routing file.

By importing the routing file you will have ready access the contact form.

In YAML:

# app/config/routing.yml
mremi_contact_form:
    resource: "@MremiContactBundle/Resources/config/routing.xml"

Or if you prefer XML:

<!-- app/config/routing.xml -->
<import resource="@MremiContactBundle/Resources/config/routing.xml"/>

Note:

In order to use the built-in email functionality, you must activate and configure the SwiftmailerBundle.

Step 6: Update your database schema (optional)

If you configured the data storage (step 3), you can now update your database schema.

If you want to first see the create table query:

$ app/console doctrine:schema:update --dump-sql

Then you can run it:

$ app/console doctrine:schema:update --force

You can now access to the contact form at http://example.com/app_dev.php/contact!

Note:

If your are in debug mode (see your front controller), the HTML5 validation can be disabled by adding ?novalidate=1 to the URL.

Customization

Templating

If you want to customize some parts of this bundle (views for instance), read the Symfony documentation.

Events

The contact controller dispatches 3 events during the index action:

  1. ContactEvents::FORM_INITIALIZE occurs when the form is initialized
  2. ContactEvents::FORM_SUCCESS occurs when the form is submitted successfully
  3. ContactEvents::FORM_COMPLETED occurs after saving the contact in the contact form process

Each one allows you to customize the default workflow provided by this bundle.

Contribution

Any question or feedback? Open an issue and I will try to reply quickly.

A feature is missing here? Feel free to create a pull request to solve it!

I hope this has been useful and has helped you. If so, share it and recommend it! :)

@mremitsme