https://github.com/novius/laravel-nova-order-nestedset-field
Laravel Nova field that make your resources orderable
https://github.com/novius/laravel-nova-order-nestedset-field
laravel laravel-nova nova tree
Last synced: about 1 month ago
JSON representation
Laravel Nova field that make your resources orderable
- Host: GitHub
- URL: https://github.com/novius/laravel-nova-order-nestedset-field
- Owner: novius
- Created: 2019-07-25T06:23:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-13T14:18:09.000Z (7 months ago)
- Last Synced: 2025-03-29T22:07:01.464Z (6 months ago)
- Topics: laravel, laravel-nova, nova, tree
- Language: PHP
- Size: 43.9 KB
- Stars: 24
- Watchers: 6
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nova Order Field nestedset
[](https://travis-ci.org/novius/laravel-nova-order-nestedset-field)
[](https://packagist.org/packages/novius/laravel-nova-order-nestedset-field)
[](https://github.com/novius/laravel-nova-order-nestedset-field#licence)
A field that make your resources orderable using [the laravel nestedset package](https://github.com/lazychaser/laravel-nestedset).
## Requirements
* PHP >= 8.1
* Laravel Nova >= 4.0
> **NOTE**: These instructions are for Laravel Nova 4.0. If you are using prior version, please
> see the [previous version's docs](https://github.com/novius/laravel-nova-order-nestedset-field/tree/3.x).
## Installation
```sh
composer require novius/laravel-nova-order-nestedset-field
```
### Configuration
Some options that you can override are available.
```sh
php artisan vendor:publish --provider="Novius\LaravelNovaOrderNestedsetField\OrderNestedsetFieldServiceProvider" --tag="config"
```
## Usage
**Step 1**
Use Kalnoy\Nestedset `NodeTrait` and Novius\LaravelNovaOrderNestedsetField `Orderable` trait on your model.
Example :
```php
use Kalnoy\Nestedset\NodeTrait;
use Novius\LaravelNovaOrderNestedsetField\Traits\Orderable;
class Foo extends Model {
use NodeTrait;
use Orderable;
public function getLftName()
{
return 'left';
}
public function getRgtName()
{
return 'right';
}
public function getParentIdName()
{
return 'parent';
}
}
```
**Step 2**
Add the field to your resource and specify order for your resources.
```php
use Novius\LaravelNovaOrderNestedsetField\OrderNestedsetField;
class FooResource extends Resource
{
public function fields(Request $request)
{
return [
OrderNestedsetField::make('Order'),
];
}
/**
* @param \Illuminate\Database\Eloquent\Builder $query
* @param array $orderings
* @return \Illuminate\Database\Eloquent\Builder
*/
protected static function applyOrderings($query, array $orderings)
{
return $query->orderBy('left', 'asc');
}
}
```
**Scoping**
Imagine you have `Menu` model and `MenuItems`. There is a one-to-many relationship
set up between these models. `MenuItem` has `menu_id` attribute for joining models
together. `MenuItem` incorporates nested sets. It is obvious that you would want to
process each tree separately based on `menu_id` attribute. In order to do so, you
need to specify this attribute as scope attribute:
```php
protected function getScopeAttributes()
{
return ['menu_id'];
}
```
[Retrieve more information about usage on official doc](https://github.com/lazychaser/laravel-nestedset#scoping).
## Performances
You can enable cache to avoid performance issues in case of large tree.
**By default cache is disabled.**
To use cache you have to enabled it in config file with :
```php
return [
...
'cache_enabled' => true,
];
```
**You have to clear cache on every tree updates with an observer on your Model (or directly in boot method).**
```php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Kalnoy\Nestedset\NodeTrait;
use Novius\LaravelNovaOrderNestedsetField\Traits\Orderable;
class Foo extends Model
{
use NodeTrait;
use Orderable;
public static function boot()
{
parent::boot();
if (config('nova-order-nestedset-field.cache_enabled', false)) {
static::created(function (Theme $model) {
$model->clearOrderableCache();
});
static::updated(function (Theme $model) {
$model->clearOrderableCache();
});
static::deleted(function (Theme $model) {
$model->clearOrderableCache();
});
}
}
}
```
## Override default languages files
Run:
```sh
php artisan vendor:publish --provider="Novius\LaravelNovaOrderNestedsetField\OrderNestedsetFieldServiceProvider" --tag="lang"
```
## Lint
Run php-cs with:
```sh
composer run-script lint
```
## Contributing
Contributions are welcome!
Leave an issue on Github, or create a Pull Request.
## Licence
This package is under [GNU Affero General Public License v3](http://www.gnu.org/licenses/agpl-3.0.html) or (at your option) any later version.