-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
36 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,43 @@ | ||
# AssociationsDebugger plugin for CakePHP | ||
|
||
## Installation | ||
AssociationsDebugger is a simple plugin that is made for debugging associations. | ||
The point of this plugin is to quickly show different associations of your CakePHP application without you needing to browse through the model files. | ||
|
||
You can install this plugin into your CakePHP application using [composer](https://getcomposer.org). | ||
|
||
The recommended way to install composer packages is: | ||
## Requirements | ||
* CakePHP 3.x | ||
* PHP 7.2 > | ||
|
||
## Installing Using [Composer][composer] | ||
|
||
`cd` to the root of your app folder (where the `composer.json` file is) and run the following command: | ||
|
||
``` | ||
composer require zunnu/AssociationsDebugger | ||
``` | ||
|
||
Then load the plugin by using CakePHP's console: | ||
|
||
``` | ||
composer require your-name-here/AssociationsDebugger | ||
./bin/cake plugin load AssociationsDebugger | ||
``` | ||
|
||
## Usage | ||
You can see the tree by going to | ||
http:https://app-address/associations-debugger | ||
Here you can filter by **association type**. | ||
<img src="https://i.imgur.com/aEqreKN.png" alt="Tree"> | ||
|
||
This same tree can be also viewed in the CakePHP debugKit. | ||
<img src="https://i.imgur.com/NoHfOQp.png" alt="DebugKit tree"> | ||
|
||
Association structure is explained here: | ||
<img src="https://i.imgur.com/fYxikgt.png" alt="Structure"> | ||
|
||
## License | ||
|
||
Licensed under [The MIT License][mit]. | ||
|
||
[cakephp]:http:https://cakephp.org | ||
[composer]:http:https://getcomposer.org | ||
[mit]:http:https://www.opensource.org/licenses/mit-license.php |