Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imanghafoori1/eloquent-relativity
Allows you to decouple your eloquent models from one another.
https://github.com/imanghafoori1/eloquent-relativity
eloquent eloquent-models laravel-package modularity
Last synced: 3 days ago
JSON representation
Allows you to decouple your eloquent models from one another.
- Host: GitHub
- URL: https://github.com/imanghafoori1/eloquent-relativity
- Owner: imanghafoori1
- License: mit
- Created: 2019-05-13T21:10:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-17T12:26:22.000Z (9 months ago)
- Last Synced: 2025-01-11T20:10:49.220Z (10 days ago)
- Topics: eloquent, eloquent-models, laravel-package, modularity
- Language: PHP
- Homepage:
- Size: 82 KB
- Stars: 151
- Watchers: 4
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eloquent Relativity
This allows you to decouple your eloquent models from one another, by defining relations dynamically at run-time.
### - Note that this package is NOT needed in laravel 7.x or above.
Read more:
https://laravel.com/docs/7.x/eloquent-relationships#dynamic-relationships
[](https://travis-ci.org/imanghafoori1/eloquent-relativity)
[](https://scrutinizer-ci.com/g/imanghafoori1/eloquent-relativity/?branch=master)
[](https://scrutinizer-ci.com/g/imanghafoori1/eloquent-relativity/?branch=master)
[](https://packagist.org/packages/imanghafoori/eloquent-relativity)
[](https://github.styleci.io/repos/186496125)
[](https://packagist.org/packages/imanghafoori/eloquent-relativity)
#### Compatibility :
Laravel version 5.5 and above including version 6
#### :arrow_forward: A problem which stops true modularity :
Let's face it, imagine you have a modular blog application.
Then, you want to add a `commenting` feature to it, so that users can comment on your articles.
In a modular structure, you have 2 modules (`user` module and `blog` module) and you will add a new module for `comments`
#### :arrow_forward: let's analyze dependencies and couplings :
Here the `blog` module "knows" and "depends" upon the `user` module.
But the `user` module should not know or care about the `blog` module. The `blog` is a `plug-in` on the top of the `user` module.
Now we want to add a `comment` module, on the top of `user` and `blog` module.
#### :arrow_forward: The Right way :
In a truely modular system when you add the `comments`, you should NOT go and touch the code within the `users` or `blog` module.
(Remember the `open-closed` principle in `SOLID` ?!)
Imagine you are in a team and each member is working on a seperate module.
`Blog` module is not yours. your team mate is responsible for it and is allowed to code on it.
But when you want to start to define the eloquent relations between `Comment` and `User` and `Article` models, you immediately realize that you have to put code on the eloquent models of other modules to define the inverse of the relationships. Crap !
Look How everything is pointing inward.
If you look at the `User` folder you will have absolutely no footprint of Comment or Article.
We have to touch the code of both `Blog` and `User` module when add a new `comment` module.
For example : You have to open `User.php` and define the
```php
public function comments() {
return $this->hasMany(Comment::class);
}
```
and this is a no no, because it makes an arrow from inside to outside.
So what to do ?!
How can `Comment` be introduced to the system without modifying the other modules ?! (@_@)
#### :arrow_forward: Install: (the most painful step)
```
composer require imanghafoori/eloquent-relativity (and take a coffee...)
```
Now the installtion finished, you first have to make your models "relative" !!!
By using the `Imanghafoori\Relativity\DynamicRelations` traits on your eloquent models.
So the `User`, `Article`, `Comment` will have to have this trait one them.
Now comes the sweet part :
within the `CommentsServiceProvider.php`
```php
class CommentsServiceProvider
{
public function register () {
User::has_many('comments', Comment::class); // instead of defining method on the User class.
Article::has_many('comments', Comment::class);
Comment::belongs_to('author', User::class); // inverse of relations
Comment::belongs_to('article', Article::class);
}
}
```
Now you can do these queries :
```php
User::find(1)->comments;
or
User::find(1)->comments()->count();
```
So instead of going to `User` model and define a method there...
```php
public function comments() {
return $this->hasMany(Comment::class);
}
```
You have defined the method remotely from your new module at run-time:
```php
User::has_many('comments', Comment::class);
```
Here is a list of supported relations :
- has_many
- has_one
- belongs_to
- belongs_to_many
- morph_to_many
- morph_many
- morph_one
- morph_to
- morphed_by_many
- has_many_through
They accept the same paramters as the eloquent equivalent counter part. except the first argument should be relation name.
#### :arrow_forward: Extra features :
sometimes you need to call extra methods on the relations.
```php
User::has_many('comments', Comment::class)->orderBy('id', 'asc');
```
All the methods are available to you.
- Enforce eager-loading
On reqular eloquent models you may define the
```php
User extends Model {
protected $with = ['comments'];
}
```
instead you can :
```php
User::forceEagerLoading('comments');
```
remember this should be in the `boot` method of your Service Provider not the `register` method.
### :star: Your Stars Make Us Do More :star:
As always if you found this package useful and you want to encourage us to maintain and work on it, Please press the star button to declare your willing.
### :arrow_forward: More from the author:
### Laravel Terminator
:gem: A minimal yet powerful package to give you opportunity to refactor your controllers.
- https://github.com/imanghafoori1/laravel-terminator
------------------
### Laravel Widgetize
:gem: A minimal yet powerful package to give a better structure and caching opportunity for your laravel apps.
- https://github.com/imanghafoori1/laravel-widgetize
-------------------
### Laravel Master Pass
:gem: A simple package that lets you easily impersonate your users.
- https://github.com/imanghafoori1/laravel-MasterPass
------------------
### Laravel HeyMan
:gem: It allows to write exressive and defensive code which is decoupled from the rest of your app.
- https://github.com/imanghafoori1/laravel-heyman
----------------
### 🍌 Reward me a banana 🍌
so that I will have energy to start the next package for you.
Dodge Coin: DJEZr6GJ4Vx37LGF3zSng711AFZzmJTouN
LiteCoin: ltc1q82gnjkend684c5hvprg95fnja0ktjdfrhcu4c4
BitCoin: bc1q53dys3jkv0h4vhl88yqhqzyujvk35x8wad7uf9
Ripple: rJwrb2v1TR6rAHRWwcYvNZxjDN2bYpYXhZ
Etherium: 0xa4898246820bbC8f677A97C2B73e6DBB9510151e
----------------
Life is like riding a bicycle. To keep your balance you must keep moving.
"Albert Einstein"