README

Русская документация расположена ниже в данном документе.

The component that makes it easy to create and handle a variety of forms for your website.

Introduction

We all know about the amount of routine work that needs to be do every time when we need to create and edit a particular form on the page. This may be the profile edit page, set a new password for the user, similar forms in admin, or just some kind of new application in a support.

All of these forms are united by common characteristics: they are quite simple and very similar to each other in terms of implementation: to create a method in the controller, to create view-template, organize the validation, shove the data into some kind of model.. Pain, trivial round, boredom. How many times it should be done on a large project? In the initial stages of the problem is often "solved" scaffolding, but this is only a small billet, which was subsequently still need to change and modify. That's why I wrote this library, greatly reduced the amount of resources required to create and maintain such simple forms.

With all of this, I wanted to create the most minimalistic and simple tool that would have carried only a small supporting role, did not limit the developer and it filled up several layers of abstraction. And it seems I have managed to achieve this: at the moment, all the component installation is reduced to a single connection JS-library (Prettyforms.js), service provider and trait to your main controller. Then you can begin to create their own forms based on the same old kind of controllers, which will now have a few extra powerful methods that facilitate you to develop and support forms.

At this point in the component to implement the following:

Data validation on the client and on the server side without any change from the current page
The ability to edit the connection in models such as "many-to-many"
The possibility, when necessary, easily connect their field types
Support from a box of two CSS-frameworks: Twitter Bootstrap and Foundation
Support for "breadcrumbs" that appear on the entry form, on the basis of component Laravel Breadcrumbs
Support soft removal, complete removal and restoration
In addition to standard input and Selects, component supports the following types of fields:
- Input field telephone with the ability to set his mask
- CKEditor
- Group checkboxes, each of which represents a connection to any model in the database
- Ability to create a Select, which will search for value through Ajax (based on "select2" library)
All necessary for non-standard components INPUT JS-default loaded via CDN, but it can be easily disabled via konfiguratsionnny component file

Application sample

You can download and explore the real working example of the application on the following link: https://github.com/believer-ufa/prettyforms-laravel5-app

Almost all the features described above are present in the sample application: validation, editing relations "many-to-many" ajax search, seft delete and recovery, loading the editor and other JS files from CDN, breadcrumbs, and etc.

This example of a working application can also be used as a basis for your own applications: just install it yourself and start a new project on the basis of what is contained in the examples.

#PrettyForms для Laravel 5

Компонент, который позволяет легко создавать и обрабатывать различные формы для вашего сайта.

Введение

В последнее время я долго работал над своей небольшой библиотекой PrettyForms, предназначенной для генерации и обработки форм. Все мы знаем о том объёме рутинной работы, который необходимо каждый раз проделывать тогда, когда нам необходимо создать и обработать определённую форму на странице сайта. Это может быть страница редактирования профиля, установки нового пароля для пользователя, однотипные формы в админке или просто какая-то новая заявка в саппорт.

Все эти формы объединяются общими свойствами: они довольно простые и очень сильно похожи друг на друга с точки зрения реализации: создать метод в контроллере, создать view-шаблон, организовать валидацию данных, пихнуть эти данные в какую-то модель.. Боль, рутина, скукота. Сколько раз это надо проделать на большом проекте? На начальных стадиях проблему часто "решают" скаффолдингом, но ведь это только маленькая заготовка, которую впоследствии всё равно надо будет изменять и дорабатывать. Вот поэтому я и написал эту библиотеку, сильно сокращающую то количество ресурсов, которое необходимо для создания и поддержки подобных простых форм.

При всём этом, я стремился создать как можно более минималистичный и простой инструмент, который бы нёс лишь небольшую вспомогательную роль, не ограничивал разработчика и не заваливал его несколькими слоями абстракций. И кажется, у меня удалось этого добиться: на данный момент, вся установка компонента сводится к подключению одной JS-библиотеки (Prettyforms.js), сервис-провайдера и трейта к вашему родительскому контроллеру. После этого вы можете начать создавать свои формы на основе тех же самых старых добрых контроллеров, которые теперь получат несколько дополнительных мощных методов, облегчающих вам разработку и поддержку форм.

На данный момент в компоненте реализовано следующее:

Валидация данных на клиентской и на на серверной сторонах без какого-либо перехода с текущей страницы
Возможность редактировать связи у моделей типа "многие-ко-многим"
Возможность, при необходимости, легко подключать свои типы полей
Поддержка из коробки трёх CSS-фреймворков: Twitter Bootstrap, Foundation и Kube
Поддержка "хлебных крошек", отображающихся над формой ввода, на основе компонента Laravel Breadcrumbs
Поддержка мягкого удаления, полного удаления и восстановления объектов
Помимо стандартных инпутов и селектов, поддерживаются следующие виды полей:
- Поле ввода номера телефона с возможностью задать его маску
- Редактор CKEditor
- Группа чекбоксов, каждый из которых представляет из себя связь с какой-то моделью в БД
- Возможность создать Select, который будет искать значения через Ajax (на основе плагина "select2")
Все необходимые для нестандартных инпутов JS-компоненты по-умолчанию загружаются через CDN, но это можно легко отключить через конфигурационнный файл компонента

Пример приложения

Вы можете скачать и изучить пример реального работающего приложения по следующей ссылке: https://github.com/believer-ufa/prettyforms-laravel5-app

Практически все фичи, описанные выше, присутствуют в рабочем виде в приложении-примере: валидация, редактирование связей "многие-ко-многим", аяксовый поиск, мягкое удаление и восстановление, загрузка редактора и прочих JS-компонетов по CDN, хлебные крошки, и так далее.

Данный пример рабочего приложения можно также использовать как основу для своего собственного приложения: просто установите его себе и начните работу над новым проектом на основе того, что содержится в примерах.

believer-ufa / prettyforms-laravel

Maintainers

Details