Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sethsandaru/eloquent-docs
Generate phpDoc for your Eloquent Models with ease
https://github.com/sethsandaru/eloquent-docs
eloquent laravel php phpdoc
Last synced: about 2 months ago
JSON representation
Generate phpDoc for your Eloquent Models with ease
- Host: GitHub
- URL: https://github.com/sethsandaru/eloquent-docs
- Owner: sethsandaru
- License: mit
- Created: 2022-08-20T14:52:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-11T18:28:32.000Z (8 months ago)
- Last Synced: 2024-12-09T18:24:04.597Z (about 2 months ago)
- Topics: eloquent, laravel, php, phpdoc
- Language: PHP
- Homepage:
- Size: 90.8 KB
- Stars: 43
- Watchers: 3
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Eloquent phpDoc Generator
[](https://codecov.io/gh/sethsandaru/eloquent-docs)
[](https://packagist.org/packages/sethphat/eloquent-docs)
[](https://packagist.org/packages/sethphat/eloquent-docs)
[![Build and test [MYSQL]](https://github.com/sethsandaru/eloquent-docs/actions/workflows/build_mysql.yaml/badge.svg?branch=main)](https://github.com/sethsandaru/eloquent-docs/actions/workflows/build_mysql.yaml)
[![Build and test [SQLite]](https://github.com/sethsandaru/eloquent-docs/actions/workflows/build_sqlite.yaml/badge.svg?branch=main)](https://github.com/sethsandaru/eloquent-docs/actions/workflows/build_sqlite.yaml)
[![Build and test [PostgreSQL]](https://github.com/sethsandaru/eloquent-docs/actions/workflows/build_postgresql.yaml/badge.svg?branch=main)](https://github.com/sethsandaru/eloquent-docs/actions/workflows/build_postgresql.yaml)
[](https://github.com/sethsandaru/eloquent-docs/actions/workflows/build_laravel.yaml)
Quickly generate the phpDoc for your Eloquent Model. Make your Eloquent super friendly with IDEs (eg PHPStorm).
And maintaining the phpDoc of your models don't have to be a pain in the ass, should be:
- Fun
- Fast
- Reliable
And, welcome to Eloquent phpDoc Generator, which going to help you to achieve the 3 points above 🎉
## What will Eloquent phpDoc Generator will generate?
- Table name
- Table columns (with correct types - including Casting types 😎)
- Model relationships
- Model attributes/accessors
## Available For / Requirements
- **v2.x**: Laravel 11, PHP 8.2+.
- **v1.x**: Laravel 9/10, PHP 8.0, 8.1.
## Install
Install as dev-dependencies is enough, since you are only going to use this command on `local/development` env.
```bash
composer require sethphat/eloquent-docs --dev
```
Laravel auto-discovery will automatically do the magic for you.
## Use the command
```bash
php artisan eloquent:phpdoc "App\Models\User" # view only
php artisan eloquent:phpdoc "App\Models\User" --write # view & write to file
php artisan eloquent:phpdoc "App\Models\User" --short-class # new option - use short class instead of full namespace path
# from v1.2.0
php artisan eloquent:bulk-phpdoc "app/Models/*.php" # bulk generation (force write mode)
```
Result:
```bash
====== Start PHPDOC scope of App\Models\User
/**
* Table: users
*
* === Columns ===
* @property int $id
* @property string $name
* @property string $email
* @property \Carbon\Carbon|null|null $email_verified_at
* @property string $password
* @property string|null $remember_token
* @property \Carbon\Carbon|null $created_at
* @property \Carbon\Carbon|null $updated_at
*
* === Relationships ===
* @property-read \App\Models\Emails[]|\Illuminate\Database\Eloquent\Collection|null $emails
* @property-read \App\Models\UserDetails|null $userDetail
*
* === Accessors/Attributes ===
* @property-read string $full_name
* @property-read string $is_admin
* @property-read string $user_type
* @property-read int $total_salary
* @property-read mixed $levels
* @property-read mixed $first_name
* @property-read mixed $last_name
*/
====== End PHPDOC scope of App\Models\User
Wrote phpDoc scope to //app/Models/User.php
Thank you for using EloquentDocs!
```
## Best practices
- Use `$casts` in your model, in order to help EloquentPhpDoc generate better types for you (array, date, datetime,...)
- For `get*Attribute` accessor, always declare the return type
Note: for Eloquent new `Attribute` class utilize the data via Closure, making it impossible to acquire the return types.
For this case, EloquentDocs will always return `mixed`
## Release logs
- v1.0.0
- First version
- View & Update phpDoc for a single Model at a time
- v1.1.0
- `--short-class`
- Fixed some issues
- v1.1.1
- Fixed issue when generating a table that has `enum` column
- v1.1.2
- Fixed issue when first-time install the library that made Laravel discovery went wrong.
- v1.1.3 & v1.1.4
- Improved the indents
- Supported Laravel 10
- Deprecated Laravel 8
- Deprecated PHP 8.0
- v1.2.0
- New command to bulk generate from a given model path.
- `php artisan eloquent:bulk-phpdoc "app/Models/*.php"`
- Fixed an issue where accessors/attributes being generated as snake_case. Should be camelCase.
- v2.0.0
- Supports Laravel 11 + PHP 8.2/8.3
- DBAL as required dependencies
- Better date/datetime parsing (Carbon & Carbon immutable)
- Better boolean parsing
## Contribute to the library
Feel free to fork this library and sending a PR here.
Note: all the contributions need to follow PSR-12 and cover everything under unit testing.
## LICENSE
MIT License
## Made by
- [Seth Phat](https://github.com/sethsandaru)
- And contributors
## (Sponsered Content) Introducing RenderPDF.io - Render your PDF in seconds
[RenderPDF.io](https://renderpdf.io) is a Render-PDF-as-a-Service that provides developer-friendly APIs
to render your HTML content to modern PDFs file sin seconds 😎.
All you have to do is get your API Key and send RenderPDF.io an API call 🚀, no infrastructure setup, no overhead and
hassle-free integration 🔋.
Get your free API Key today: [Sign Up to RenderPDF.io](https://renderpdf.io)