k-phoen / kphoencontactbundle

Yet another contact bundle

KPhoenContactBundle

Yet another contact bundle.

Installation

Composer

Add kphoen/contact-bundle to your required field. Then install/update your dependencies.

app/AppKernel.php

Register the KPhoenContactBundle:

# app/AppKernel.php
public function registerBundles()
{
    $bundles = array(
        // ...
        new KPhoen\ContactBundle\KPhoenContactBundle(),
    );
}

Configuration

config.yml

The following options are available in the app/config/config.yml file:

k_phoen_contact:
    redirect_url:       homepage  # the url to redirect the user to once the
                                  # mail is sent
    sender:             { address: '[email protected]' }
    receiver:           { address: '[email protected]' }

Routing

Import the routes:

kphoen_contact:
    resource: "@KPhoenContactBundle/Resources/config/routing.yml"

Usage

Routes

The previous configuration imports a route named contact in your application, which correspond to a simple contact form.

Templates

You will probably need to customize the view used by the bundle. To do that, we will override the templates exposed by the contact bundle.

In app/Resources/KPhoenContactBundle/views/Contact/contact.html.twig:

{% extends 'AcmeDemoBundle::layout.html.twig' %}

{% block title %}Contact{% endblock %}

{% block body %}
<h2>Contact</h2>

{% include "KPhoenContactBundle:Contact:form.html.twig" with {'form': form} %}
{% endblock %}

Events

Two events are emitted during the submission of the event form:

• contact.pre_send: emitted just before the mail is sent ;
• contact.post_send: emitted just after.

Contributing

See the CONTRIBUTING file.

kphoencontactbundle's Issues

PHP coding conventions missing.

When they are defined, they'll go in CONTRIBUTING.md.

symfony 2.3 support

Several methods were deprecated starting symfony 2.1 and are going to be removed as of 2.3.

I've noticed some of them still being part of the code of this bundle and this concerns me.

We are building a fresh application which is going to use the symfony cmf, which would be based on symfony 2.3.

Would it be possible to start a tag compatible with the upcoming 2.3 release?

deprecated config/code

The "_method" requirement of route "contact_send" in file ".../kphoen/contact-bundle/Resources/config/routing.yml" is deprecated since version 2.2 and will be removed in 3.0. Use the "methods" option instead

KPhoen\ContactBundle\Form\Type\MessageType: The FormTypeInterface::getName() method is deprecated since version 2.8 and will be removed in 3.0. Remove it from your classes. Use getBlockPrefix() if you want to customize the template block prefix. This method will be added to the FormTypeInterface with Symfony 3.0

Add CI for each supported Symfony version.

Or minimal version at least. See #29.

Twig and HTML coding conventions missing.

When they'll be defined, they'll go in CONTRIBUTING.md.

Unrecognized options "sender, receiver" under "k_phoen_contact"

When I run the project I got this error :

Unrecognized options "sender, receiver" under "k_phoen_contact"

knowing that I can't understrand if I need to create the redirect_url or not as mentioned below in config file:
k_phoen_contact: redirect_url: homepage # the url to redirect the user to once the # mail is sent sender: { address: '[email protected]' } receiver: { address: '[email protected]' }

Code coverage informations missing

Would be great to know if more tests are needed.

Contribution guidelines missing.

Maybe in a wiki, or in a README file if it's short enough.

FrameworkExtraBundle limited to v3.0

The only use appears to be a @Template annotation on one controller action. Allowing "^3.0|^4.0|^5.0" should be safe, and longer-term, using the render() results directly as a return would allow the removal of the FrameworkExtraBundle entirely.

Yamllint default config.

The yamllint default configuration should be overriden to make the code more readable.