graham-campbell / contact
Contact Is A Contact Form Backend For Laravel 5
Requires
- php: >=5.5.0
- graham-campbell/binput: ~3.0
- graham-campbell/core: ~2.0
- graham-campbell/throttle: ~3.0
- illuminate/contracts: 5.0.*
- illuminate/mail: 5.0.*
- illuminate/routing: 5.0.*
- illuminate/support: 5.0.*
- illuminate/validation: 5.0.*
- illuminate/view: 5.0.*
Requires (Dev)
This package is not auto-updated.
Last update: 2022-02-01 12:45:33 UTC
README
Laravel Contact was created by, and is maintained by Graham Campbell, and provides a contact form backend for Laravel 5. It utilises a few of my packages including Laravel Throttle and Laravel Binput. Feel free to check out the releases, license, and contribution guidelines.
Installation
PHP 5.5+ or HHVM 3.6+, and Composer are required.
To get the latest version of Laravel Contact, simply add the following line to the require block of your composer.json
file:
"graham-campbell/contact": "~1.0"
You'll then need to run composer install
or composer update
to download it and have the autoloader updated.
You will need to register a few service providers before you attempt to load the Laravel Contact service provider. Open up config/app.php
and add the following to the providers
key.
'GrahamCampbell\Security\SecurityServiceProvider'
'GrahamCampbell\Binput\BinputServiceProvider'
'GrahamCampbell\Throttle\ThrottleServiceProvider'
Once Laravel Contact is installed, you need to register the service provider. Open up config/app.php
and add the following to the providers
key.
'GrahamCampbell\Contact\ContactServiceProvider'
Configuration
Laravel Contact supports optional configuration.
To get started, you'll need to publish all vendor assets:
$ php artisan vendor:publish
This will create a config/contact.php
file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.
There are a few config options:
Path To The Form
This option ('path'
) defines the path to the contact form. This is the page where your contact form should be. The default value for this setting is 'pages/contact'
.
Contact Form Email
This option ('email'
) defines the email address to send contact form messages to. It can be a single address, or an array of email addresses. The default value for this setting is 'admin@example.com'
.
Email Layout
This option ('layout'
) defines the layout to extend when building email views. The default value for this setting is 'layouts.email'
.
Additional Configuration
You will need to add a 'name'
key to your app config to set the application name.
Usage
Laravel Contact is designed to work with Bootstrap CMS. In order for it to work in any Laravel application, you must ensure that you know how to use my Laravel Core package as configuration and knowledge of the app:install
and app:update
commands is required.
Laravel Contact provides you with the backend functionality (and email views) to create a comment form. You will need to write your own contact form front end with this plugin, although an example contact form is included ('contact.form'
). Laravel Contact will register the route contact.post
which will accept POST
requests to the path contact
.
License
Laravel Contact is licensed under The MIT License (MIT).