class ContactFormManager extends EmailManager (View source)

Class ContactFormManager

Properties

protected string|null $subject from EmailManager
protected string|null $emailTitle from EmailManager
protected string $successMessage from EmailManager
protected string $failMessage from EmailManager
protected TranslatorInterface $translator from EmailManager
protected Twig_Environment $templating from EmailManager
protected Swift_Mailer $mailer from EmailManager
protected string|null $emailTemplate from EmailManager
protected string|null $emailPlainTextTemplate from EmailManager
protected string $emailStylesheet from EmailManager
protected Request $request from EmailManager
protected array $assignation from EmailManager
protected Swift_Message $message from EmailManager
protected null|Settings $settingsBag from EmailManager
protected array|null $uploadedFiles
protected string $redirectUrl
protected FormBuilder $formBuilder
protected Form $form
protected array $allowedMimeTypes
protected int $maxFileSize

Methods

__construct(Request $request, FormFactoryInterface $formFactory, TranslatorInterface $translator, Twig_Environment $templating, Swift_Mailer $mailer, Settings $settingsBag)

ContactFormManager constructor.

string
renderHtmlEmailBody()

No description

string
renderHtmlEmailBodyWithCss()

No description

string
renderPlainTextEmailBody()

No description

appendWebsiteIcon()

Added mainColor and headerImageSrc assignation to display email header.

Swift_Message
createMessage()

No description

int
send()

Send contact form data by email.

null|string
getSubject()

No description

setSubject(null|string $subject)

No description

null|string
getEmailTitle()

No description

setEmailTitle(null|string $emailTitle)

No description

null|array|string
getReceiver()

No description

null|string
getReceiverEmail()

Return only one email as string.

setReceiver(string|array $receiver)

Sets the value of receiver.

null|string
getSender()

Message virtual sender email.

null|string
getSenderEmail()

Return only one email as string.

setSender(string|array $sender)

Sets the value of sender.

string
getSuccessMessage()

No description

setSuccessMessage(string $successMessage)

No description

string
getFailMessage()

No description

setFailMessage(string $failMessage)

No description

TranslatorInterface
getTranslator()

No description

setTranslator(TranslatorInterface $translator)

No description

Twig_Environment
getTemplating()

No description

setTemplating(Twig_Environment $templating)

No description

Swift_Mailer
getMailer()

No description

setMailer(Swift_Mailer $mailer)

No description

string|null
getEmailTemplate()

No description

setEmailTemplate(string|null $emailTemplate = null)

No description

string|null
getEmailPlainTextTemplate()

No description

setEmailPlainTextTemplate(string|null $emailPlainTextTemplate = null)

No description

string|null
getEmailStylesheet()

No description

setEmailStylesheet(string|null $emailStylesheet = null)

No description

Request
getRequest()

No description

setRequest(Request $request)

No description

null|string
getOrigin()

Origin is the real From enveloppe.

setOrigin(string $origin)

No description

array
getAssignation()

No description

setAssignation(array $assignation)

No description

FormBuilderInterface
getFormBuilder()

No description

Form
getForm()

No description

withDefaultFields()

Adds a email, name and message fields with their constraints.

withGoogleRecaptcha()

Add a Google recaptcha to your contact form.

Response|null
handle()

Handle custom form validation and send it as an email.

handleFiles()

No description

handleFormData(Form $form)

No description

array
flattenFormData(array $formData, array $fields)

No description

string
getRedirectUrl()

Gets the value of redirectUrl.

setRedirectUrl(string $redirectUrl)

Sets the value of redirectUrl.

int
getMaxFileSize()

Gets the value of maxFileSize.

setMaxFileSize(int $maxFileSize)

Sets the value of maxFileSize.

array
getAllowedMimeTypes()

Gets the value of allowedMimeTypes.

setAllowedMimeTypes(array $allowedMimeTypes)

Sets the value of allowedMimeTypes.

Details

__construct(Request $request, FormFactoryInterface $formFactory, TranslatorInterface $translator, Twig_Environment $templating, Swift_Mailer $mailer, Settings $settingsBag)

ContactFormManager constructor.

DO NOT DIRECTLY USE THIS CONSTRUCTOR USE 'contactFormManager' Factory Service

Parameters

Request $request
FormFactoryInterface $formFactory
TranslatorInterface $translator
Twig_Environment $templating
Swift_Mailer $mailer
Settings $settingsBag

string renderHtmlEmailBody()

Return Value

string

string renderHtmlEmailBodyWithCss()

Return Value

string

string renderPlainTextEmailBody()

Return Value

string

EmailManager appendWebsiteIcon()

Added mainColor and headerImageSrc assignation to display email header.

Return Value

EmailManager

Swift_Message createMessage()

Return Value

Swift_Message

int send()

Send contact form data by email.

Return Value

int

Exceptions

RuntimeException

null|string getSubject()

Return Value

null|string

EmailManager setSubject(null|string $subject)

Parameters

null|string $subject

Return Value

EmailManager

null|string getEmailTitle()

Return Value

null|string

EmailManager setEmailTitle(null|string $emailTitle)

Parameters

null|string $emailTitle

Return Value

EmailManager

null|array|string getReceiver()

Return Value

null|array|string

null|string getReceiverEmail()

Return only one email as string.

Return Value

null|string

EmailManager setReceiver(string|array $receiver)

Sets the value of receiver.

Parameters

string|array $receiver the receiver

Return Value

EmailManager

Exceptions

Exception

null|string getSender()

Message virtual sender email.

This email will be used as ReplyTo: and ReturnPath:

Return Value

null|string

null|string getSenderEmail()

Return only one email as string.

Return Value

null|string

EmailManager setSender(string|array $sender)

Sets the value of sender.

Parameters

string|array $sender the sender

Return Value

EmailManager

Exceptions

Exception

string getSuccessMessage()

Return Value

string

EmailManager setSuccessMessage(string $successMessage)

Parameters

string $successMessage

Return Value

EmailManager

string getFailMessage()

Return Value

string

EmailManager setFailMessage(string $failMessage)

Parameters

string $failMessage

Return Value

EmailManager

TranslatorInterface getTranslator()

Return Value

TranslatorInterface

EmailManager setTranslator(TranslatorInterface $translator)

Parameters

TranslatorInterface $translator

Return Value

EmailManager

Twig_Environment getTemplating()

Return Value

Twig_Environment

EmailManager setTemplating(Twig_Environment $templating)

Parameters

Twig_Environment $templating

Return Value

EmailManager

Swift_Mailer getMailer()

Return Value

Swift_Mailer

EmailManager setMailer(Swift_Mailer $mailer)

Parameters

Swift_Mailer $mailer

Return Value

EmailManager

string|null getEmailTemplate()

Return Value

string|null

EmailManager setEmailTemplate(string|null $emailTemplate = null)

Parameters

string|null $emailTemplate

Return Value

EmailManager

string|null getEmailPlainTextTemplate()

Return Value

string|null

EmailManager setEmailPlainTextTemplate(string|null $emailPlainTextTemplate = null)

Parameters

string|null $emailPlainTextTemplate

Return Value

EmailManager

string|null getEmailStylesheet()

Return Value

string|null

EmailManager setEmailStylesheet(string|null $emailStylesheet = null)

Parameters

string|null $emailStylesheet

Return Value

EmailManager

Request getRequest()

Return Value

Request

EmailManager setRequest(Request $request)

Parameters

Request $request

Return Value

EmailManager

null|string getOrigin()

Origin is the real From enveloppe.

This must be an email address with a know domain name to be validated on your SMTP server.

Return Value

null|string

EmailManager setOrigin(string $origin)

Parameters

string $origin

Return Value

EmailManager

array getAssignation()

Return Value

array

EmailManager setAssignation(array $assignation)

Parameters

array $assignation

Return Value

EmailManager

FormBuilderInterface getFormBuilder()

Return Value

FormBuilderInterface

Form getForm()

Return Value

Form

ContactFormManager withDefaultFields()

Adds a email, name and message fields with their constraints.

Return Value

ContactFormManager $this

ContactFormManager withGoogleRecaptcha()

Add a Google recaptcha to your contact form.

Make sure you’ve added recaptcha form template and filled recaptcha_public_key and recaptcha_private_key settings.

{% block recaptcha_widget -%}

{%- endblock recaptcha_widget %}

Return Value

ContactFormManager $this

Response|null handle()

Handle custom form validation and send it as an email.

Return Value

Response|null

protected handleFiles()

protected handleFormData(Form $form)

Parameters

Form $form

protected array flattenFormData(array $formData, array $fields)

Parameters

array $formData
array $fields

Return Value

array

string getRedirectUrl()

Gets the value of redirectUrl.

Return Value

string

ContactFormManager setRedirectUrl(string $redirectUrl)

Sets the value of redirectUrl.

Parameters

string $redirectUrl the redirect url

Return Value

ContactFormManager

int getMaxFileSize()

Gets the value of maxFileSize.

Return Value

int

ContactFormManager setMaxFileSize(int $maxFileSize)

Sets the value of maxFileSize.

Parameters

int $maxFileSize the max file size

Return Value

ContactFormManager

array getAllowedMimeTypes()

Gets the value of allowedMimeTypes.

Return Value

array

ContactFormManager setAllowedMimeTypes(array $allowedMimeTypes)

Sets the value of allowedMimeTypes.

Parameters

array $allowedMimeTypes the allowed mime types

Return Value

ContactFormManager