PHPackages                             fabio/laravel-simple-bases - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. fabio/laravel-simple-bases

ActiveLibrary[HTTP & Networking](/categories/http)

fabio/laravel-simple-bases
==========================

A set of base classes to help create projects with Laravel

0.8.12(4y ago)102.9k3[1 issues](https://github.com/fabio-pv/laravel-simple-bases/issues)1MITPHPPHP ^7.2 || ^8.0

Since Jul 10Pushed 2y ago1 watchersCompare

[ Source](https://github.com/fabio-pv/laravel-simple-bases)[ Packagist](https://packagist.org/packages/fabio/laravel-simple-bases)[ Docs](https://github.com/fabio-pv/laravel-simple-bases)[ RSS](/packages/fabio-laravel-simple-bases/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (41)Used By (1)

Laravel Simple Bases
====================

[](#laravel-simple-bases)

##### A set of base classes to help create projects with Laravel

[](#a-set-of-base-classes-to-help-create-projects-with-laravel)

 [![](https://camo.githubusercontent.com/9ab5bc8fcb3cb17dcf988fb0e1b0beb1898bf6ae68cd42dbe4d9bbb920a40e70/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f666162696f2d70762f6c61726176656c2d73696d706c652d6261736573)](https://camo.githubusercontent.com/9ab5bc8fcb3cb17dcf988fb0e1b0beb1898bf6ae68cd42dbe4d9bbb920a40e70/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f666162696f2d70762f6c61726176656c2d73696d706c652d6261736573) [![](https://camo.githubusercontent.com/bf158987cacdf7dee24a5f2d78fa36fc4c6a7c54bb31a2102e799288c9e42db3/68747470733a2f2f706f7365722e707567782e6f72672f666162696f2f6c61726176656c2d73696d706c652d62617365732f6c6963656e7365)](https://camo.githubusercontent.com/bf158987cacdf7dee24a5f2d78fa36fc4c6a7c54bb31a2102e799288c9e42db3/68747470733a2f2f706f7365722e707567782e6f72672f666162696f2f6c61726176656c2d73696d706c652d62617365732f6c6963656e7365)

Summary
-------

[](#summary)

💻 [Installation](#installation-arrow_up)
🔒 [Configuration authentication with JWT](#configuration-authentication-with-jwt-arrow_up)
📡 [Creating an endpoint](#creating-an-endpoint-arrow_up)
🔧 [Utilities on request](#utilities-on-request-arrow_up)
 :mag\_right: [Filters](#filters-arrow_up)
 :arrow\_up\_down: [Ordering](#ordering-arrow_up)
 :keycap\_ten: [Pagination](#pagination-arrow_up)
💾 [Intercept uuid for id](#Intercept-uuid-for-id-arrow_up)
📎 [Intercept base64 to file](#Intercept-base64-to-file-arrow_up)
🚫 [Permission](#Permission-arrow_up)
🔴 [Exception](#exception-arrow_up)
📐 [Helpers](#helpers-arrow_up)
 :keycap\_ten: [fractal\_transformer](#fractal_transformer-arrow_up)

About
-----

[](#about)

This package creates an initial base and utilities for your Laravel projects with a focus on REST api.
Containing the following resources:

- Base class for authentication using JWT (package)
- Base class for models, with uuid and additional functions
- Base class for controller, with index, show, store, update, destrory functions implemented and each with interesting features (see detail below)
- Base class for service, in the same way that the controller has implemented functions and features (see detail below)
- Filters through the request using queryString
- Intercept uuid to id automatically
- Simple implementation of image upload via base64 in a simple way in any model
- Artisan commands to facilitate the creation of the structure
- Base class for validation (see details)
- Base class for the handler for Exceptions
- Among other features

Sample repository
-----------------

[](#sample-repository)

[Sample](https://github.com/fabio-pv/laravel-simple-bases-exemple)

Installation [⬆️](#summary)
---------------------------

[](#installation-arrow_up)

`composer require fabio/laravel-simple-bases`

Configuration authentication with JWT [⬆️](#summary)
----------------------------------------------------

[](#configuration-authentication-with-jwt-arrow_up)

This package is dependent on the package [tymondesigns/jwt-auth](https://github.com/tymondesigns/jwt-auth), but don't worry, it has already been installed together. It will only take a few implementations for you to have working token authentication.

### Step 1

[](#step-1)

Then create a controller for authentication you can use the artisan command for this:

```
php artisan make:controller v1/AuthController

```

### Step 2

[](#step-2)

Extend your controller to BaseAuth

```
class AuthController extends BaseAuth
```

### Step 3

[](#step-3)

In your file routes `routes/api.php`, create a login route. Ex.:

```
Route::post('v1/login', 'v1\AuthController@login');
```

### Step 4

[](#step-4)

php artisan vendor:publish --provider="Tymon\\JWTAuth\\Providers\\LaravelServiceProvider"

```
php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"

```

### Step 5

[](#step-5)

Generate secret key

```
php artisan jwt:secret

```

### Step 6

[](#step-6)

In config/auth.php make the changes

```
'defaults' => [
        'guard' => 'api',
        'passwords' => 'users',
    ],

```

```
'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],

        'api' => [
            'driver' => 'jwt',
            'provider' => 'users',
            'hash' => false,
        ],
    ],
```

**Optional but recommended**
Change the path for the User model.

```
'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\Models\v1\User::class,
        ],

        // 'users' => [
        //     'driver' => 'database',
        //     'table' => 'users',
        // ],
    ],
```

### Step 7

[](#step-7)

**Optional**, if using config with cache, execute:

```
php artisan config:cache

```

Creating an endpoint [⬆️](#summary)
-----------------------------------

[](#creating-an-endpoint-arrow_up)

### Step 1

[](#step-1-1)

Create a table for your new endpoint

```
php artisan make:migration create_cars_table

```

### Step 2

[](#step-2-1)

The **fabio-pv:generate-endpoint-class** command will automatically create all necessary dependencies for the endpoint.It will only be necessary to provide a name for the class and the name of the table that the model will reference.

```
 php artisan fabio-pv:generate-endpoint-class Car --table-name=cars

```

This command will create 5 classes in your versioned project in the v1 directory. If you need to change the versioning use the option `--api-version=`.

- Model
- Controller
- Service
- Validation
- Transformer

### Step 3 **Optional**

[](#step-3-optional)

If you want to validate the request body, you must implement its rules in **App/Http/Validations/v1**
This validation works using Laravel [validation](https://laravel.com/docs/7.x/validation) through the base class

```
$this->fieldsCreate = [
        'name' => 'required',
        'license_plate' => 'required',
        'motor_power' => 'required',
];
```

### Step 4

[](#step-4-1)

Create the return object from your endpoint using [laravel-fractal](https://github.com/spatie/laravel-fractal) which was created in App/Http/Transformers/v1

```
public function transform(Car $car)
    {
        return [
            'name' => $car->name,
            'license_plate' => $car->license_plate,
            'motor_power' => $car->motor_power,
        ];
    }
```

### Step 5

[](#step-5-1)

Create your route in routes/api.php

```
Route::resource('v1/car', 'v1\CarController');
```

### Step 6

[](#step-6-1)

Test, if everything goes well you will have an endpoint working with the functions:

- GET with pagination

```
/api/v1/car

```

- GET

```
/api/v1/car/{uuid}

```

- POST

```
/api/v1/car

```

- PATCH

```
/api/v1/car/{uuid}

```

- DELETE

```
/api/v1/car/{uuid}

```

**Ex.:**

```
{
    "data": [
        {
            "uuid": "d96598d0-c527-11ea-b192-517bb6c42efa",
            "name": "Mustang boss 302 68",
            "license_plate": "ter-1234",
            "motor_power": 290
        },
        {
            "uuid": "44d54ed0-c528-11ea-96f6-658ec4d2da56",
            "name": "Camaro ss 68",
            "license_plate": "ter-4321",
            "motor_power": 295
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}
```

Utilities on request [⬆️](#summary)
-----------------------------------

[](#utilities-on-request-arrow_up)

All endpoints that extend `BaseController` have filters ready to be used.
Note:
In the current version the filter only works for the model's main table.

### Filters [⬆️](#summary)

[](#filters-arrow_up)

```
{{url}}/api/v1/car?filters[index_filter][name_column@name_operator]=value
{{url}}/api/v1/car?filters[0][name@equal]=Mustang boss 302 68

```

**index\_filter** = Array index for the filter string
**name\_column** = Name of the column to be applied the filter
**name\_operator** = Operator to be applied to the filter `equal, not_equal, greater_than_or_equal_to, less_than_or_equal_to, like `
**value** = Value for the filter

#### Filter on related tables

[](#filter-on-related-tables)

As of version v0.3.0, the filter also works with the related tables.

**Example:**

- user endpoint response

```
[
{
            "uuid": "64b774c0-c153-11ea-a4e9-01b907f3026a",
            "name": "default",
            "car": {
                "uuid": "c1f87e50-c769-11ea-99ef-356032d7a36b",
                "name": "Honda Civic",
                "license_plate": "ter-1223",
                "motor_power": 140,
                "car_type": {
                    "uuid": "527b20a0-cda3-11ea-8820-6d38fc501b58",
                    "name": "Hatch"
                }
            }
        },
        ...
]
```

Assuming that we only want **user** who have a **car** with **motor\_power** equal to **'140'**. Our queryString will look like this:

```
{{url}}/api/v1/user?filters[0][car.motor_power@equal]=140

```

**Other example**

Assuming we want all **user** who have **car** of **car\_type** equal to **'Sporty'**

```
{{url}}/api/v1/user?filters[0][car.car_type.name@equal]=Sporty

```

**Note**The functioning of the filters depends on the following requirements:

- The name of the properties in transformer must be the same as the database tables. (This is related to usability)
- The relationships in the transformer must follow the same name as the models only separated by '\_'.
    Model

```
public function carType()
```

Transformer

```
'car_type' => fractal_transformer(
                $car->carType,
                CarTypeTransformer::class,
                null
            )
```

### Ordering [⬆️](#summary)

[](#ordering-arrow_up)

```
{{url}}/api/v1/car?order[name_column]=order
{{url}}/api/v1/car?order[name]=asc

```

**name\_column** = Name of the column to be applied the filter
**order** = asc or desc

### Pagination [⬆️](#summary)

[](#pagination-arrow_up)

Default is 10 per page

```
{{url}}/api/v1/car?paginate=value

{{url}}/api/v1/car?paginate=false
{{url}}/api/v1/car?paginate=20

```

**value** = Can receive `false` to disable a page or a number to change an amount per page

Intercept uuid for id [⬆️](#summary)
------------------------------------

[](#intercept-uuid-for-id-arrow_up)

On request where it is necessary to pass the relationship of another table is common to do by uuid but internally we need the id, to facilitate this 'transformation' this package has a config file where this transformation can be configured so that it happens automatically. Continue reading to learn more

### MER for this example

[](#mer-for-this-example)

[![](https://user-images.githubusercontent.com/56044466/87470933-e5b83180-c5f3-11ea-856c-3789587f4df2.png)](https://user-images.githubusercontent.com/56044466/87470933-e5b83180-c5f3-11ea-856c-3789587f4df2.png)

### Step 1

[](#step-1-2)

Publish configuration file

```
php artisan fabio-pv:from-to-data-config

```

### Step 2

[](#step-2-2)

Configure the file `config/from_to_data.php`

```
return [
    'model::class' => [
        'property_param' => [
            'model' => 'Model::class',
            'property' => 'property_database'
        ],
    ]
];
```

How to configure ?

**model::class** = Model that receives the relationship
**property\_param** = Parameter name in request
**Model::class** = Model where the relationship comes from
**property\_database** = Property name in the model

Your `config/from_to_data.php` file should look like this

```
return [
    \App\Models\v1\User::class => [

        'car_uuid' => [
            'model' => \App\Models\v1\Car::class,
            'property' => 'car_id'
        ],

    ]
];
```

### Step 3

[](#step-3-1)

Test, if everything went well using the method post or patch and passing the relationship you should have the relationship in your database automatically

Intercept base64 to file [⬆️](#summary)
---------------------------------------

[](#intercept-base64-to-file-arrow_up)

This package provides an easy way to implement file upload via base64 on any model you want.
Note: Files are saved using Laravel [Storage](https://laravel.com/docs/7.x/filesystem)

### Step 1

[](#step-1-3)

Run the command below to publish the configuration file

```
php artisan fabio-pv:model-with-file-config

```

### Step 2

[](#step-2-3)

Configure the file in `config/model_with_file.php`

```
return [
    'model::class' => [
        'fantasy_property' => 'photo',
        'save_location' => '/photos/property_item',
        'extension' => '.png'
    ],
];
```

**model::class** = Model that will receive file
**fantasy\_property** = Property name with base64 in the request **save\_location** = Directory where the image will be saved () **extension** = File extension

**Example**

```
return [

    \App\Models\v1\Car::class => [
        'fantasy_property' => 'photo',
        'save_location' => '/photos/car',
        'extension' => '.png'
    ],

];
```

### Step 3 Optional

[](#step-3-optional-1)

If your config files are cached don't forget to run:

```
php artisan config:cache

```

### Step 4

[](#step-4-2)

Test.
**Example Request**

```
{
    "name": "Honda Civic",
    "license_plate": "ter-1223",
    "motor_power": 140,
    "photo": "your_base64"
}
```

Note: the property you defined can receive multiple uploads for that, just pass an array

### Step 5 Optional

[](#step-5-optional)

If you want to show the files in the reply just use the model `files` function
**Implementation**
In your transformer add a name for the property and use the `fractal_transformer` helper
Note: The files function is present in all models that extend `ModelAuthenticatableBase` or `ModelBase`

```
public function transform(Car $car)
    {
        return [
            'uuid' => $car->uuid,
            'name' => $car->name,
            'license_plate' => $car->license_plate,
            'motor_power' => $car->motor_power,
            'files' => fractal_transformer(
                $car->files,
                FileTransformer::class,
                null
            )
        ];
    }
```

**Example response**

```
{
            "uuid": "ff8e9ad0-c768-11ea-8a2a-e3c9240324d2",
            "name": "Camaro ss 68",
            "license_plate": "ter-4321",
            "motor_power": 295,
            "files": [
                {
                    "uuid": "ff90fb00-c768-11ea-926f-29877bf386e1",
                    "file": "ff8f2170-c768-11ea-84b6-a1fa0486978b",
                    "extension": ".png",
                    "url": "http://laravel-simple-bases-test/v1/file/photos/car/ff8f2170-c768-11ea-84b6-a1fa0486978b.png"
                }
            ]
        }
```

### Update file

[](#update-file)

To update the file just pass a new parameter with the same name as the property you created with a '\_uuid' at the end and in the original property pass the new file. Example:

```
{
    "photo": "you_base64",
    "photo_uuid": "uuid of the file that will be updated"
}
```

### Delete file

[](#delete-file)

To delete the file, just pass a new parameter with the same name as the property you created with a '\_uuid' at the end and in the original property pass the value null. Example:

```
{
    "photo": "null",
    "photo_uuid": "uuid of the file to be deleted"
}
```

Permission [⬆️](#summary)
-------------------------

[](#permission-arrow_up)

This package provides classes to deal with permissions, basically it checks if the user's role can access a given route or not. Note: In the current version it does not control whether the user is authenticated or not, it will still be necessary to implement middleware

**Configuration**

### Step 1

[](#step-1-4)

Run the command
`php artisan fabio-pv:generate-permission-class nome_da_class`

### Step 2

[](#step-2-4)

Configure the file giving access to the functions according to your system's rule

```
class CarPermission extends BasePermission
{

     protected $permissions = [
        'index' => [],
        'show' => [],
        'store' => [],
        'update' => [],
        'destroy' => [],
    ];

}
```

Example:

```
class CarPermission extends BasePermission
{

     protected $permissions = [
        'index' => [
            UserRole::ADMIN,
            UserRole::COMMON
        ],
        'show' => [
            UserRole::ADMIN,
            UserRole::COMMON
        ],
        'store' => [
            UserRole::ADMIN,
        ],
        'update' => [
            UserRole::ADMIN,
        ],
        'destroy' => [
            UserRole::ADMIN,
        ],
    ];

}
```

**Tip:**To make the code more elegant, define the role as constant in the role model Example:

```
class UserRole extends ModelBase
{
    const ADMIN = 1;
    const COMMON = 2;
```

### Step 3

[](#step-3-2)

Define dependencies on the controller

```
class CarController extends BaseController
{
    public function __construct(
        Car $car,
        CarTransformer $carTransformer,
        CarValidation $carValidation,
        CarPermission $carPermission
    )
    {
        $this->model = $car;
        $this->service = new CarService($this->model);
        $this->transformer = $carTransformer;
        $this->validation = $carValidation;
        $this->permission = $carPermission;
    }
}
```

### Step 4

[](#step-4-3)

Create the relationship in the user model

```
public function userRole()
    {
        return $this->belongsTo('App\Models\v1\UserRole');
    }
```

### Step 5

[](#step-5-2)

test

### Dica

[](#dica)

If your controller has more functions than the 4 `index` `show` `store` `update` `destroy` defaults, you can configure it manually as follows:

```
protected $permissions = [
        'index' => [],
        'show' => [],
        'store' => [],
        'update' => [],
        'destroy' => [],
        'other_function_name' => [],
        'other_function_name2' => [],
    ];
```

In your controller add this call at the beginning of the function:

```
$this->hasPermissonSet();
```

**Change permission logic**By default, the BasePermission class tries to take the user's role as follows:

```
return $user->userRole->id;
```

If you need to change the way to search for the role run the command below:

```
php artisan fabio-pv:generate-permission-handle

```

The command will generate the class

```
class HandlePermission implements HandlePermissionInterface
{
}
```

Implement the functions `handle` and `message`

**Handle**
Here you can change the way to search for the user's role, just don't forget to return role =)

```
 public static function handle($user)
    {
        /**
         * @var User $user
         */
        return $user->userRole->id;
    }
```

**message**Here you can define the message for access denied exception

```
 public static function message(): string
    {
        return 'Your users do not have access to this feature';
    }
```

Exception [⬆️](#summary)
------------------------

[](#exception-arrow_up)

This package has a base class to extend in `app/Exceptions/Handler.php`. This class will make the return of errors more pleasant for those who use the api

**Original**

[![Captura de tela de 2020-07-16 11-36-29](https://user-images.githubusercontent.com/56044466/87684453-a6efbc00-c758-11ea-9c85-c52639dabb9e.png)](https://user-images.githubusercontent.com/56044466/87684453-a6efbc00-c758-11ea-9c85-c52639dabb9e.png)

**With `BaseHandlerException`**

`APP_DEBUG=true`

```
{
    "error": {
        "message": "Resource not found",
        "file": "/var/www/laravel-simple-bases-test/vendor/fabio/laravel-simple-bases/src/Services/BaseService.php",
        "line": 59
    }
}
```

`APP_DEBUG=false`

```
{
    "error": {
        "message": "Resource not found",
    }
}
```

**Usage**
Just replace the `ExceptionHandler` class in `app/Exceptions/Handler.php` with `BaseHandlerException`

Helpers [⬆️](#summary)
----------------------

[](#helpers-arrow_up)

### fractal\_transformer [⬆️](#summary)

[](#fractal_transformer-arrow_up)

Returns an array of an existing transformer.
Created mainly to be used inside another transformer, with it you can standardize your returns from the api

**Description**

```
fractal_transformer(mixed $data, Transformer $transformer, mixed $defaultValue = [])
```

**Example**

```
fractal_transformer($user->car, CarTransformer::class, null)
```

**Transformer implementation**

```
public function transform(User $user)
    {
        return [
            'uuid' => $user->uuid,
            'name' => $user->name,
            'car' => fractal_transformer(
                $user->car,
                CarTransformer::class,
                null
            ),
        ];
    }
```

**Example response**

```
{
    "data": [
        {
            "uuid": "64b774c0-c153-11ea-a4e9-01b907f3026a",
            "name": "default",
            "car": null
        },
        {
            "uuid": "9c3c8960-c763-11ea-8a64-0b7b48fb6453",
            "name": "new user 2",
            "car": {
                "uuid": "d96598d0-c527-11ea-b192-517bb6c42efa",
                "name": "Mustang boss 302 68",
                "license_plate": "ter-1234",
                "motor_power": 290
            }
        }
    ]
}
```

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity27

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 97.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~11 days

Recently: every ~45 days

Total

36

Last Release

1744d ago

PHP version history (3 changes)0.1.0PHP >=7.2.0

0.4.4PHP ^7.2.0

0.8.12PHP ^7.2 || ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/fc4706a30f1051d71b1a206016b34ba6b634c6f23e4f9cbcd6c98f3b5caecb7c?d=identicon)[fabio-pv](/maintainers/fabio-pv)

---

Top Contributors

[![fabio-pv](https://avatars.githubusercontent.com/u/56044466?v=4)](https://github.com/fabio-pv "fabio-pv (264 commits)")[![munizeverton](https://avatars.githubusercontent.com/u/2388903?v=4)](https://github.com/munizeverton "munizeverton (5 commits)")[![Milkado](https://avatars.githubusercontent.com/u/38528102?v=4)](https://github.com/Milkado "Milkado (1 commits)")

---

Tags

apirestfiltersfabio-pv

### Embed Badge

![Health badge](/badges/fabio-laravel-simple-bases/health.svg)

```
[![Health](https://phpackages.com/badges/fabio-laravel-simple-bases/health.svg)](https://phpackages.com/packages/fabio-laravel-simple-bases)
```

###  Alternatives

[francescomalatesta/laravel-api-boilerplate-jwt

An API Boilerplate to create a ready-to-use REST API in seconds.

1.2k7.5k](/packages/francescomalatesta-laravel-api-boilerplate-jwt)[xendit/xendit-php

Xendit PHP SDK

189730.6k6](/packages/xendit-xendit-php)[angelleye/paypal-php-library

PHP wrapper for PayPal APIs

243440.9k](/packages/angelleye-paypal-php-library)[infobip/infobip-api-php-client

PHP library for consuming Infobip's API

921.8M10](/packages/infobip-infobip-api-php-client)[dreamfactory/df-core

DreamFactory(tm) Core Components

1651.7k20](/packages/dreamfactory-df-core)[tastyigniter/ti-ext-api

Manages and generates RESTful APIs using available models in your TastyIgniter app.

2110.2k3](/packages/tastyigniter-ti-ext-api)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)