Kunstmaan / KunstmaanBundlesCMS

src/Kunstmaan/FormBundle/Helper/FormMailerInterface.php

<?php

namespace Kunstmaan\FormBundle\Helper;

use Kunstmaan\FormBundle\Entity\FormSubmission;

/**
 * An interface for the mailers who want to send mails after submitting a form.
 */
interface FormMailerInterface
{
    /**
     * @param FormSubmission $submission The submission
     * @param string         $from       The from address
     * @param string         $to         The to address(es) seperated by \n
     * @param string         $subject    The subject
     */
    public function sendContactMail(FormSubmission $submission, $from, $to, $subject);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}