README.md
1[](https://waffle.io/friendsofcake/crud)
2[](https://travis-ci.org/FriendsOfCake/crud)
3[](https://coveralls.io/r/FriendsOfCake/crud?branch=master)
4[](https://packagist.org/packages/FriendsOfCake/crud)
5[](https://packagist.org/packages/FriendsOfCake/crud)
6
7# Version notice
8
9This version of Crud is for CakePHP 2.x.
10This fork has been patched for PHP 7.2 compatibilty, specifically for the [ZoneMinder](https://github.com/ZoneMinder/ZoneMinder) project.
11This fork will no longer be necessary once [Pull Reqeust #282](https://github.com/FriendsOfCake/crud/pull/582) has been merged.
12
13# Introduction
14
15Crud was built to be [scaffolding](http://book.cakephp.org/2.0/en/controllers/scaffolding.html) on
16steroids, and allow developers to have enough flexibility to use it for both rapid prototyping and
17production applications, even on the same code base -- saving you time.
18
19* Crud is [very fast to install](http://friendsofcake.com/crud/docs/installation.html), a few minutes tops.
20
21* Crud is very flexible and has tons of [configuration options](http://friendsofcake.com/crud/docs/configuration.html).
22
23* Crud aims to stay out of your way, and if it happens to get in your way, you can change the undesired
24behavior very easily.
25
26* Crud relies heavily on CakePHP events and is possible to override, extend, or disable almost all
27of Crud's functionality either globally or for one specific action.
28
29* Usually, the basic code for controller CRUD actions are very simple and always looks the same. Crud
30will add the actions to your controller so you don't have to reimplement them over and over again.
31
32* Crud does not have the same limitations as CakePHP's own scaffolding, which is "my way or the
33highway." Crud allows you to hook into all stages of a request, only building the controller code
34needed specifically for your business logic, outsourcing all the heavy boilerplating to Crud.
35
36* Less boilerplate code means less code to maintain, and less code to spend time unit testing.
37
38* Crud allows you to use your own views, baked or hand-crafted, in addition to adding the
39code needed to fulfill your application logic, using [events](http://friendsofcake.com/crud/docs/events.html). It is
40by default compatible with CakePHP's baked views.
41
42* Crud also provides built in features for JSON and XML [API](http://friendsofcake.com/crud/docs/listeners/api.html)
43for any action you have enabled through Crud, which eliminates maintaining both a
44HTML frontend and a JSON and/or XML interface for your applications -- saving you tons of time and
45having a leaner code base.
46
47# Bugs
48
49If you happen to stumble upon a bug, please feel free to create a pull request with a fix
50(optionally with a test), and a description of the bug and how it was resolved.
51
52You can also create an issue with a description to raise awareness of the bug.
53
54# Features
55
56If you have a good idea for a Crud feature, please join us on IRC and let's discuss it. Pull
57requests are always more than welcome.
58
59# Support / Questions
60
61You can join us on IRC in the #FriendsOfCake channel for any support or questions.
62
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}