### Step 1
Publish configuration file
```
php artisan fabio-pv:from-to-data-config
```
### Step 2
Configure the file ``` config/from_to_data.php ```
```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
```php
return [
\App\Models\v1\User::class => [
'car_uuid' => [
'model' => \App\Models\v1\Car::class,
'property' => 'car_id'
],
]
];
```
### Step 3
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 [:arrow_up:](#summary)
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
Run the command below to publish the configuration file
```
php artisan fabio-pv:model-with-file-config
```
### Step 2
Configure the file in ```config/model_with_file.php```
```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**
```php
return [
\App\Models\v1\Car::class => [
'fantasy_property' => 'photo',
'save_location' => '/photos/car',
'extension' => '.png'
],
];
```
### Step 3 Optional
If your config files are cached don't forget to run:
```
php artisan config:cache
```
### Step 4
Test.
**Example Request**
```json
{
"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
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```
```php
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**
```json
{
"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
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:
```json
{
"photo": "you_base64",
"photo_uuid": "uuid of the file that will be updated"
}
```
### 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:
```json
{
"photo": "null",
"photo_uuid": "uuid of the file to be deleted"
}
```
## Permission [:arrow_up:](#summary)
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 https://laravel.com/docs/7.x/middleware
**Configuration**
### Step 1
Run the command
`php artisan fabio-pv:generate-permission-class nome_da_class`
### Step 2
Configure the file giving access to the functions according to your system's rule
```php
class CarPermission extends BasePermission
{
protected $permissions = [
'index' => [],
'show' => [],
'store' => [],
'update' => [],
'destroy' => [],
];
}
```
Example:
```php
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:
```php
class UserRole extends ModelBase
{
const ADMIN = 1;
const COMMON = 2;
```
### Step 3
Define dependencies on the controller
```php
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
Create the relationship in the user model
```php
public function userRole()
{
return $this->belongsTo('App\Models\v1\UserRole');
}
```
### Step 5
test
### Dica
If your controller has more functions than the 4 `index` `show` `store` `update` `destroy` defaults, you can configure it manually as follows:
```php
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:
```php
$this->hasPermissonSet();
```
**Change permission logic**
By default, the BasePermission class tries to take the user's role as follows:
```php
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
```php
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 =)
```php
public static function handle($user)
{
/**
* @var User $user
*/
return $user->userRole->id;
}
```
**message**
Here you can define the message for access denied exception
```php
public static function message(): string
{
return 'Your users do not have access to this feature';
}
```
## Exception [:arrow_up:](#summary)
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**
**With ```BaseHandlerException```**
```APP_DEBUG=true```
```json
{
"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```
```json
{
"error": {
"message": "Resource not found",
}
}
```
**Usage**
Just replace the ```ExceptionHandler``` class in ```app/Exceptions/Handler.php``` with ```BaseHandlerException```
## Helpers [:arrow_up:](#summary)
### fractal_transformer [:arrow_up:](#summary)
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**
```php
fractal_transformer(mixed $data, Transformer $transformer, mixed $defaultValue = [])
```
**Example**
```php
fractal_transformer($user->car, CarTransformer::class, null)
```
**Transformer implementation**
```php
public function transform(User $user)
{
return [
'uuid' => $user->uuid,
'name' => $user->name,
'car' => fractal_transformer(
$user->car,
CarTransformer::class,
null
),
];
}
```
**Example response**
```json
{
"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
}
}
]
}
```