syscover/forms

There is no license information available for the latest version (v2.0.1) of this package.

Forms package

v2.0.1 2016-09-29 15:49 UTC

Requires

• php: >=5.6.4
• google/recaptcha: ~1.1
• syscover/pulsar: ~2.0

Unknown License

• SYSCOVER SL

• Forms
• laravel
• syscover
• pulsar

README

Forms es una aplicación que gestiona formularios, registra cualquier formulario en una base de datos, las características más destacadas de forms son:

• Envío de formularios tanto por ajax como por submit
• Reenvío de formularios a tantos correos como se desee
• Crear estados personalizados
• Asignar estados a cada registro de cada formulario
• Crear comentarios para cada registro
• Mantener informado vía email, de cada cambio de estado o nuevo comentario realzado sobre un registro

Installation

Para instalar este módulo es necesario tener instalado previamente el módulo pulsar, visitar el repositorio de Pulsar en caso de no tenerlo instalado.

1 - After install Laravel framework, insert on file composer.json, inside require object this value

"syscover/forms": "~2.0"

and execute on console:

composer update

2 - Register service provider, on file config/app.php add to providers array

Syscover\Forms\FormsServiceProvider::class,

3 - Execute publish command

php artisan vendor:publish

4 - Execute optimize command load new classes

php artisan optimize

5 - And execute migrations and seed database

php artisan migrate
php artisan db:seed --class="FormsTableSeeder"

6 - Execute command to load all updates

php artisan migrate --path=database/migrations/updates

Activate Package

Access to Pulsar Panel, and go to:

Administration-> Permissions-> Profiles, and set all permissions to your profile by clicking on the open lock.

Go to Administration -> Packages, edit the package installed and activate it.

Implementation

Una vez instalado y activado el package, debemos de crear una cuenta de envío dentro Administración->Cuentas, necesitaremos tanto datos del servidor como usuario y contraseña de la cuenta.

Una vez creada la cuenta de correo nos vamos a la sección Forms->Master tables->Preferences, seleccionamos el estado que tendrá cada registro por defecto, si deamos cambiar o añadir más estados lo podemos realizar desde la sección Forms->Master tables->States, y la cuenta desde la que se enviarán las notificaciones.

Por último deberemos dar de alta un formulario dentro de Forms->Forms, el id del formulario nos servirá para asociar los registros al formulario, indicando el id en la rutina de javascript.

Para realizar la implementación en javascript hay que añadir la siguiente librería en la página donde vayas a implementar tu formulario

<script src="{{ asset('packages/syscover/forms/vendor/jquery.forms/jquery.forms.js') }}"></script>

Después tienes que declarar el plugin de javascript que adaptará tu formulario para que sea enviado y registrado en la base de datos

$('#form').forms({
    id: 1, // Aquí el ID del registro del formulario que has creada en la sección Forms -> Forms
    debug: false,
    ajax: true,
    fields: {
        name: 'name',
        surname: 'surname',
        company: 'company',
        email: 'email',
        subject: 'subject',
        data: ['message','field-1','field-2','field-3', ...] // here you can add fields
    }
}, function(response){

    if(response.success)
    {
        // form submit successful
    }

}).on('forms:submit', function(event){
    // here check your form, if are any error to stop execution use event.preventDefault();

}).on('forms:error', function(event, error) {
    console.log(event);
    console.log(error);
});

Puerdes añadir propiedades a tu formulario mediante atributos data

data-length: Tamaño del campo que tendrá en el panel de control, de 1 a 10
data-label: Título del campo que se le asignará

Configura en tu fichero de variables de entorno las siguientes variables, si usas Google ReCaptcha

GOOGLE_RECAPTCHA_SITE_KEY=your site key
GOOGLE_RECAPTCHA_SECRET_KEY=your secret key

Para usar Google Recapcha debes de añadir la siguiente etiqueta a tu formulario:

<div class="g-recaptcha" data-sitekey="{{ env('GOOGLE_RECAPTCHA_SITE_KEY') }}"></div>

Forms se encargará de la validación, devolviendo el error al evento 'forms:error'

Posibles errores que te puede devolver detro del objeto error:

Error general

{
    success: false,
    code: 0,
    message: "",
    nativeError: Object
}

Error por no haber pulsado el recapcha

{
    success: false,
    code: 1,
    message: "reCaptcha input isn't checked",
    nativeError: null
}