Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n7olkachev/laravel-computed-properties
Make your accessors smarter
https://github.com/n7olkachev/laravel-computed-properties
eloquent laravel
Last synced: 4 days ago
JSON representation
Make your accessors smarter
- Host: GitHub
- URL: https://github.com/n7olkachev/laravel-computed-properties
- Owner: n7olkachev
- Created: 2017-08-22T13:54:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-02T07:36:51.000Z (over 6 years ago)
- Last Synced: 2024-12-25T00:06:50.493Z (11 days ago)
- Topics: eloquent, laravel
- Language: PHP
- Homepage:
- Size: 13.7 KB
- Stars: 192
- Watchers: 6
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# Computed properties for Eloquent
[](https://scrutinizer-ci.com/g/n7olkachev/laravel-computed-properties/)
[](https://packagist.org/packages/n7olkachev/laravel-computed-properties)
[](https://packagist.org/packages/n7olkachev/laravel-computed-properties)
[](https://travis-ci.org/n7olkachev/laravel-computed-properties)
**Laravel 5.4+**
Based on this tweet: https://twitter.com/reinink/status/899713609722449920
Some examples for better understanding of this power:
```php
class Order extends Model
{
use ComputedProperties;
public function products()
{
return $this->hasMany(OrderProduct::class);
}
public function computedSum($order)
{
return OrderProduct::select(new Expression('sum(price * count)'))
->where('order_id', $order->id);
}
}
```
Now, we can get order sum with `$order->sum`. Yep, we can get this functionality with `getSumAttribute` but wait! The real power of this package is that we can use this method inside our queries:
```php
$orders = Order::withComputed('sum')->get()
```
We eager loaded `sum` attribute without `N+1` problem.
But there is more! You can add `having` or `orderBy` clauses to such queries for filtering and sorting!
```php
Order::withComputed('sum')->orderBy('sum', 'desc')->get()
```
## Installation
You can install the package via composer:
``` bash
composer require n7olkachev/laravel-computed-properties
```
Next, add ComputedProperties trait to your models:
```php
use ComputedProperties;
```
That's all!
## More examples
```php
class Page extends Model
{
use ComputedProperties;
public $timestamps = false;
protected $casts = [
'last_view' => 'datetime',
'first_view' => 'datetime',
];
public function computedLastView($page)
{
return PageView::select(new Expression('max(viewed_at)'))
->where('page_id', $page->id);
}
public function computedFirstView($page)
{
return PageView::select(new Expression('min(viewed_at)'))
->where('page_id', $page->id);
}
}
```
We can find `Page` by its first view:
```php
$page = Page::withComputed('first_view')
->having('first_view', Carbon::create(2017, 8, 16, 0, 0, 0))
->first();
```
Or by both `first_view` and `last_view`
```php
$page = Page::withComputed(['first_view', 'last_view'])
->having('first_view', Carbon::create(2017, 8, 16, 0, 0, 0))
->having('last_view', Carbon::create(2017, 8, 21, 0, 0, 0))
->first();
```
We can order pages by theirs `last_view`
```php
$pages = Page::withComputed('last_view')
->orderBy('last_view', 'desc')
->get()
```
## Testing
``` bash
$ composer test
```
## Credits
- [Jonathan Reinink](https://github.com/reinink) (idea)
- [Nikita Tolkachev](https://github.com/n7olkachev)
## Sponsored by
https://websecret.by/
Web agency based in Minsk, Belarus
## License
The MIT License (MIT)