Download the PHP package makeitfly/cleantalk-symfony without Composer
On this page you can find all versions of the php package makeitfly/cleantalk-symfony. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download makeitfly/cleantalk-symfony
More information about makeitfly/cleantalk-symfony
Files in makeitfly/cleantalk-symfony
Package cleantalk-symfony
Short Description Cleantalk anti-spam integration for Symfony
License MIT
Informations about the package cleantalk-symfony
Cleantalk Symfony bundle
Unofficial Cleantalk anti-spam integration for Symfony. Currently only provides the most basic anti-spam protection, as per the docs of the php-antispam package.
Installation
Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.
By default your Symfony application automatically performs a cache:clear
after
a composer require
. We haven't submitted a Flex recipe (yet), so this will
error out because of missing configuration. For now, ideally create the config
file before you require the bundle, as per the
configuration section.
Applications that use Symfony Flex
Open a command console, enter your project directory and execute:
Applications that don't use Symfony Flex
Step 1: Download the Bundle
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the config/bundles.php
file of your project:
Configuration
All you need is the auth key, which you can find in your CleanTalk dashboard.
It is recommended to create a development configuration that disables the validation for your development environment.
Usage
Add the CleanTalkType
as a field to your form. It automatically defines a
constraint that will be validated when you call $form->isValid()
.
Example usage:
Passing form data
The CleanTalk API checks if a message is spam based on the submitted form values. The sender email is the only required field, but it is recommended to pass as much data as you have for better spam detection.
When you configure these fields as a string, the library will use these to fetch
the data from the form data. This requires the symfony/property-access
to be
installed.
Alternatively you can use a callback function to return a custom value yourself.
Roadmap
Following points are nice-to-haves:
- Cleantalk returns why a submission is refused. This could be logged.