add permission, datatable and file services
This commit is contained in:
67
laravel/app/Facades/DataTable/DataTable.php
Normal file
67
laravel/app/Facades/DataTable/DataTable.php
Normal file
@@ -0,0 +1,67 @@
|
||||
<?php
|
||||
|
||||
namespace App\Facades\DataTable;
|
||||
|
||||
use App\Services\DataTable\DataTableInput;
|
||||
use App\Services\DataTable\DataTableService;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
use Illuminate\Http\Request;
|
||||
use App\Services\DataTable\Exceptions\InvalidParameterInterface;
|
||||
|
||||
class DataTable
|
||||
{
|
||||
/**
|
||||
* Extracts data from request, passes to datatable service and prepares data for response.
|
||||
* @param Model|Builder $mixed
|
||||
* @param Request $request
|
||||
* @param array $allowedFilters
|
||||
* @param array $allowedRelations
|
||||
* @param array $allowedSortings
|
||||
* @param array $allowedSelects
|
||||
* @return array
|
||||
* @throws InvalidParameterInterface if input parameters are invalid.
|
||||
*/
|
||||
public function run(
|
||||
Model|Builder $mixed,
|
||||
Request $request,
|
||||
array $allowedFilters = [],
|
||||
array $allowedRelations = [],
|
||||
array $allowedSortings = [],
|
||||
array $allowedSelects = [],
|
||||
array $allowedGroupBy = []
|
||||
): array
|
||||
{
|
||||
|
||||
$filters = json_decode($request->filters);
|
||||
$sorting = json_decode($request->sorting);
|
||||
$rels = $request->rels ?: array();
|
||||
|
||||
$dataTableInput = new DataTableInput(
|
||||
$request->start,
|
||||
$request->size,
|
||||
$filters,
|
||||
$sorting,
|
||||
$rels,
|
||||
$allowedFilters,
|
||||
$allowedSortings,
|
||||
$allowedGroupBy
|
||||
);
|
||||
|
||||
$query = $this->makeQueryFromModel($mixed);
|
||||
|
||||
$dataTableService = (new DataTableService($query, $dataTableInput))
|
||||
->setAllowedFilters($allowedFilters)
|
||||
->setAllowedRelations($allowedRelations)
|
||||
->setAllowedSortings($allowedSortings)
|
||||
->setAllowedSelects($allowedSelects)
|
||||
->setAllowedGroupBy($allowedGroupBy);
|
||||
|
||||
return $dataTableService->getData();
|
||||
}
|
||||
|
||||
protected function makeQueryFromModel(Model|Builder $mixed): Builder
|
||||
{
|
||||
return ($mixed instanceof Model) ? $mixed->query() : $mixed;
|
||||
}
|
||||
}
|
||||
13
laravel/app/Facades/DataTable/DataTableFacade.php
Normal file
13
laravel/app/Facades/DataTable/DataTableFacade.php
Normal file
@@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
namespace App\Facades\DataTable;
|
||||
|
||||
use Illuminate\Support\Facades\Facade;
|
||||
|
||||
class DataTableFacade extends Facade
|
||||
{
|
||||
protected static function getFacadeAccessor()
|
||||
{
|
||||
return 'datatable';
|
||||
}
|
||||
}
|
||||
112
laravel/app/Facades/File/File.php
Normal file
112
laravel/app/Facades/File/File.php
Normal file
@@ -0,0 +1,112 @@
|
||||
<?php
|
||||
|
||||
namespace App\Facades\File;
|
||||
|
||||
use Illuminate\Support\Facades\Storage;
|
||||
use Illuminate\Http\File as HttpFile;
|
||||
use Illuminate\Http\UploadedFile;
|
||||
use Illuminate\Support\Str;
|
||||
|
||||
class File
|
||||
{
|
||||
public function save(HttpFile|UploadedFile $file, string $path, string $name = null, string $disk = 'public'): string
|
||||
{
|
||||
return Storage::disk($disk)->putFileAs(
|
||||
$path,
|
||||
$file,
|
||||
$name ?? Str::uuid() . '.' . $file->extension()
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $filePath
|
||||
* @param bool $url_is_absolute
|
||||
* @param string $disk
|
||||
* @return void
|
||||
* @throws \InvalidArgumentException when filePath is empty.
|
||||
*/
|
||||
public function delete(string $filePath, bool $url_is_absolute = false, string $disk = 'public'): void
|
||||
{
|
||||
if (!$filePath){
|
||||
throw new \InvalidArgumentException('File path is invalid.');
|
||||
}
|
||||
|
||||
if ($url_is_absolute) {
|
||||
$needle = 'storage/';
|
||||
$pos = strpos($filePath, $needle);
|
||||
$filePath = substr($filePath, $pos + strlen($needle));
|
||||
}
|
||||
|
||||
if (Storage::disk($disk)->exists($filePath)) {
|
||||
Storage::disk($disk)->delete($filePath);
|
||||
}
|
||||
}
|
||||
|
||||
public function deleteContent($file_path): bool
|
||||
{
|
||||
if (file_exists($file_path)) {
|
||||
file_put_contents($file_path, '');
|
||||
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
public function tail($file_path, $lines = 100, $buffer = 2048): bool|string
|
||||
{
|
||||
// Open file
|
||||
$file = @fopen($file_path, "rb");
|
||||
if ($file === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Jump to last character
|
||||
fseek($file, -1, SEEK_END);
|
||||
|
||||
// Read it and adjust line number if necessary
|
||||
// (Otherwise the result would be wrong if file doesn't end with a blank line)
|
||||
if (fread($file, 1) != "\n") {
|
||||
$lines -= 1;
|
||||
}
|
||||
|
||||
// Start reading
|
||||
$output = '';
|
||||
$chunk = '';
|
||||
|
||||
// While we would like more
|
||||
while (ftell($file) > 0 && $lines >= 0) {
|
||||
|
||||
// Figure out how far back we should jump
|
||||
$seek = min(ftell($file), $buffer);
|
||||
|
||||
// Do the jump (backwards, relative to where we are)
|
||||
fseek($file, -$seek, SEEK_CUR);
|
||||
|
||||
// Read a chunk and prepend it to our output
|
||||
$output = ($chunk = fread($file, $seek)) . $output;
|
||||
|
||||
// Jump back to where we started reading
|
||||
fseek($file, -mb_strlen($chunk, '8bit'), SEEK_CUR);
|
||||
|
||||
// Decrease our line counter
|
||||
$lines -= substr_count($chunk, "\n");
|
||||
}
|
||||
|
||||
// While we have too many lines
|
||||
// (Because of buffer size we might have read too many)
|
||||
while ($lines++ < 0) {
|
||||
|
||||
// Find first newline and remove all text before that
|
||||
$output = substr($output, strpos($output, "\n") + 1);
|
||||
}
|
||||
|
||||
// Close file and return
|
||||
fclose($file);
|
||||
return trim($output);
|
||||
}
|
||||
|
||||
public function deleteDirectory(string $path, string $disk = 'public'): void
|
||||
{
|
||||
Storage::disk($disk)->deleteDirectory($path);
|
||||
}
|
||||
}
|
||||
13
laravel/app/Facades/File/FileFacade.php
Normal file
13
laravel/app/Facades/File/FileFacade.php
Normal file
@@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
namespace App\Facades\File;
|
||||
|
||||
use Illuminate\Support\Facades\Facade;
|
||||
|
||||
class FileFacade extends Facade
|
||||
{
|
||||
protected static function getFacadeAccessor(): string
|
||||
{
|
||||
return 'file';
|
||||
}
|
||||
}
|
||||
12
laravel/app/Models/Permission.php
Normal file
12
laravel/app/Models/Permission.php
Normal file
@@ -0,0 +1,12 @@
|
||||
<?php
|
||||
|
||||
namespace App\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Spatie\Permission\Models\Permission as SpatiePermission;
|
||||
|
||||
class Permission extends SpatiePermission
|
||||
{
|
||||
use HasFactory;
|
||||
}
|
||||
@@ -6,10 +6,11 @@ namespace App\Models;
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Foundation\Auth\User as Authenticatable;
|
||||
use Illuminate\Notifications\Notifiable;
|
||||
use Spatie\Permission\Traits\HasRoles;
|
||||
|
||||
class User extends Authenticatable
|
||||
{
|
||||
use HasFactory, Notifiable;
|
||||
use HasFactory, Notifiable, HasRoles;
|
||||
|
||||
protected $guarded = [];
|
||||
|
||||
|
||||
27
laravel/app/Providers/DataTableServiceProvider.php
Normal file
27
laravel/app/Providers/DataTableServiceProvider.php
Normal file
@@ -0,0 +1,27 @@
|
||||
<?php
|
||||
|
||||
namespace App\Providers;
|
||||
|
||||
use App\Facades\DataTable\DataTable;
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
|
||||
class DataTableServiceProvider extends ServiceProvider
|
||||
{
|
||||
/**
|
||||
* Register services.
|
||||
*/
|
||||
public function register(): void
|
||||
{
|
||||
$this->app->bind('datatable', function () {
|
||||
return new DataTable();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Bootstrap services.
|
||||
*/
|
||||
public function boot(): void
|
||||
{
|
||||
//
|
||||
}
|
||||
}
|
||||
27
laravel/app/Providers/FileServiceProvider.php
Normal file
27
laravel/app/Providers/FileServiceProvider.php
Normal file
@@ -0,0 +1,27 @@
|
||||
<?php
|
||||
|
||||
namespace App\Providers;
|
||||
|
||||
use App\Facades\File\File;
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
|
||||
class FileServiceProvider extends ServiceProvider
|
||||
{
|
||||
/**
|
||||
* Register services.
|
||||
*/
|
||||
public function register(): void
|
||||
{
|
||||
$this->app->bind('file', function () {
|
||||
return new File();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Bootstrap services.
|
||||
*/
|
||||
public function boot(): void
|
||||
{
|
||||
//
|
||||
}
|
||||
}
|
||||
83
laravel/app/Services/DataTable/DataTableInput.php
Normal file
83
laravel/app/Services/DataTable/DataTableInput.php
Normal file
@@ -0,0 +1,83 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable;
|
||||
|
||||
use App\Services\DataTable\Filter\Filter;
|
||||
use App\Services\DataTable\Sort\Sort;
|
||||
|
||||
class DataTableInput
|
||||
{
|
||||
/**
|
||||
* @param int $start
|
||||
* @param int $size
|
||||
* @param array $filters
|
||||
* @param array $sorting
|
||||
* @param array $rels
|
||||
*/
|
||||
public function __construct(
|
||||
private ?int $start,
|
||||
private ?int $size,
|
||||
private array $filters,
|
||||
private ?array $sorting,
|
||||
private array $rels,
|
||||
private array $allowedFilters,
|
||||
private array $allowedSortings,
|
||||
private ?array $GroupBy,
|
||||
)
|
||||
{
|
||||
}
|
||||
|
||||
public function getStart(): ?int
|
||||
{
|
||||
return $this->start;
|
||||
}
|
||||
|
||||
public function getSize(): ?int
|
||||
{
|
||||
return $this->size;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array returns an array of Filter objects
|
||||
*/
|
||||
public function getFilters(): array
|
||||
{
|
||||
$filters = array();
|
||||
|
||||
foreach ($this->filters as $filter) {
|
||||
$filters[] = new Filter(
|
||||
$filter->id,
|
||||
$filter->value,
|
||||
$filter->fn,
|
||||
$filter->datatype,
|
||||
$this->allowedFilters
|
||||
);
|
||||
}
|
||||
|
||||
return $filters;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function getSorting(): ?array
|
||||
{
|
||||
$sorts = [];
|
||||
if (!empty($this->sorting)){
|
||||
foreach ($this->sorting as $sort) {
|
||||
$sorts[] = new Sort($sort->id, $sort->desc, $this->allowedSortings);
|
||||
}
|
||||
}
|
||||
return $sorts;
|
||||
}
|
||||
|
||||
public function getRelations(): array
|
||||
{
|
||||
return $this->rels;
|
||||
}
|
||||
|
||||
public function getGroupBy(): ?array
|
||||
{
|
||||
return $this->GroupBy;
|
||||
}
|
||||
}
|
||||
128
laravel/app/Services/DataTable/DataTableService.php
Normal file
128
laravel/app/Services/DataTable/DataTableService.php
Normal file
@@ -0,0 +1,128 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable;
|
||||
|
||||
use App\Services\DataTable\Filter\ApplyFilter;
|
||||
use App\Services\DataTable\Sort\ApplySort;
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class DataTableService
|
||||
{
|
||||
|
||||
protected array $allowedFilters;
|
||||
protected array $allowedRelations;
|
||||
protected array $allowedSortings;
|
||||
protected array $allowedSelects;
|
||||
protected array $allowedGroupBy;
|
||||
private int $totalRowCount;
|
||||
|
||||
public function __construct(
|
||||
protected Builder $query,
|
||||
private DataTableInput $dataTableInput
|
||||
)
|
||||
{
|
||||
}
|
||||
|
||||
public function setAllowedFilters(array $allowedFilters): DataTableService
|
||||
{
|
||||
$this->allowedFilters = $allowedFilters;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function setAllowedRelations(array $allowedRelations): DataTableService
|
||||
{
|
||||
$this->allowedRelations = $allowedRelations;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function setAllowedSortings(array $allowedSortings): DataTableService
|
||||
{
|
||||
$this->allowedSortings = $allowedSortings;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function setAllowedSelects(array $allowedSelects): DataTableService
|
||||
{
|
||||
$this->allowedSelects = $allowedSelects;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function setAllowedGroupBy(array $allowedGroupBy): DataTableService
|
||||
{
|
||||
$this->allowedGroupBy = $allowedGroupBy;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle 'getData' operations
|
||||
* @return array
|
||||
*/
|
||||
public function getData(): array
|
||||
{
|
||||
$query = $this->buildQuery();
|
||||
$data = $query->get();
|
||||
|
||||
return array(
|
||||
'data' => $data,
|
||||
'meta' => [
|
||||
'totalRowCount' => $this->totalRowCount
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
protected function buildQuery(): Builder
|
||||
{
|
||||
$query = $this->query;
|
||||
|
||||
foreach ($this->dataTableInput->getFilters() as $filter) {
|
||||
$query = (new ApplyFilter($query, $filter))->apply();
|
||||
}
|
||||
|
||||
$query = $this->applySelect($query, $this->allowedSelects);
|
||||
$query = $this->includeRelationsInQuery($query, $this->allowedRelations);
|
||||
$query = $this->applyGroupBy($query, $this->allowedGroupBy);
|
||||
|
||||
$this->totalRowCount = $query->count();
|
||||
|
||||
if (!is_null($this->dataTableInput->getStart())) {
|
||||
$query->offset($this->dataTableInput->getStart());
|
||||
}
|
||||
|
||||
if(!is_null($this->dataTableInput->getSize())){
|
||||
$query->limit($this->dataTableInput->getSize());
|
||||
}
|
||||
|
||||
$sorting = $this->dataTableInput->getSorting();
|
||||
foreach ($sorting as $sort){
|
||||
$query = (new ApplySort($query, $sort))->apply();
|
||||
}
|
||||
|
||||
return $query;
|
||||
}
|
||||
|
||||
protected function applySelect(Builder $query, array $selectedFields): Builder
|
||||
{
|
||||
if (!empty($selectedFields)) {
|
||||
$query->select($selectedFields);
|
||||
}
|
||||
|
||||
return $query;
|
||||
}
|
||||
|
||||
protected function applyGroupBy(Builder $query, array $groupBy): Builder
|
||||
{
|
||||
return empty($groupBy) ? $query : $query->groupBy($groupBy);
|
||||
}
|
||||
|
||||
protected function includeRelationsInQuery(Builder $query, array $rels): Builder
|
||||
{
|
||||
if (!empty($rels)) {
|
||||
$query->with($rels);
|
||||
}
|
||||
|
||||
return $query;
|
||||
}
|
||||
|
||||
// (later) define mapping of relation names to prevent relation name expose.
|
||||
// (later) define mapping of column names to prevent column name expose.
|
||||
}
|
||||
15
laravel/app/Services/DataTable/Enums/DataType.php
Normal file
15
laravel/app/Services/DataTable/Enums/DataType.php
Normal file
@@ -0,0 +1,15 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Enums;
|
||||
|
||||
enum DataType: string
|
||||
{
|
||||
case NUMERIC = 'numeric';
|
||||
case TEXT = 'text';
|
||||
case DATE = 'date';
|
||||
|
||||
public static function values(): array
|
||||
{
|
||||
return array_column(self::cases(), 'value');
|
||||
}
|
||||
}
|
||||
19
laravel/app/Services/DataTable/Enums/SearchType.php
Normal file
19
laravel/app/Services/DataTable/Enums/SearchType.php
Normal file
@@ -0,0 +1,19 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Enums;
|
||||
|
||||
enum SearchType: string
|
||||
{
|
||||
case CONTAINS = 'contains';
|
||||
case EQUALS = 'equals';
|
||||
case NOT_EQUALS = 'notEquals';
|
||||
case BETWEEN = 'between';
|
||||
case GREATER_THAN = 'greaterThan';
|
||||
case LESS_THAN = 'lessThan';
|
||||
case FUZZY = 'fuzzy';
|
||||
|
||||
public static function values(): array
|
||||
{
|
||||
return array_column(self::cases(), 'value');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Exceptions;
|
||||
|
||||
use Exception;
|
||||
|
||||
class InvalidFilterException extends Exception implements InvalidParameterInterface
|
||||
{
|
||||
protected $fieldName;
|
||||
|
||||
public function __construct($fieldName, $message = "", $code = 400, \Throwable $previous = null)
|
||||
{
|
||||
$this->fieldName = $fieldName;
|
||||
parent::__construct($message, $code, $previous);
|
||||
}
|
||||
|
||||
public function getFieldName()
|
||||
{
|
||||
return $this->fieldName;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Exceptions;
|
||||
|
||||
interface InvalidParameterInterface
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Exceptions;
|
||||
|
||||
use Exception;
|
||||
|
||||
class InvalidRelationException extends Exception implements InvalidParameterInterface
|
||||
{
|
||||
protected $fieldName;
|
||||
|
||||
public function __construct($fieldName, $message = "", $code = 400, \Throwable $previous = null)
|
||||
{
|
||||
$this->fieldName = $fieldName;
|
||||
parent::__construct($message, $code, $previous);
|
||||
}
|
||||
|
||||
public function getFieldName()
|
||||
{
|
||||
return $this->fieldName;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Exceptions;
|
||||
|
||||
use Exception;
|
||||
|
||||
class InvalidSortingException extends Exception implements InvalidParameterInterface
|
||||
{
|
||||
protected $fieldName;
|
||||
|
||||
public function __construct($fieldName, $message = "", $code = 400, \Throwable $previous = null)
|
||||
{
|
||||
$this->fieldName = $fieldName;
|
||||
parent::__construct($message, $code, $previous);
|
||||
}
|
||||
|
||||
public function getFieldName()
|
||||
{
|
||||
return $this->fieldName;
|
||||
}
|
||||
}
|
||||
84
laravel/app/Services/DataTable/Filter/ApplyFilter.php
Normal file
84
laravel/app/Services/DataTable/Filter/ApplyFilter.php
Normal file
@@ -0,0 +1,84 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter;
|
||||
|
||||
use App\Services\DataTable\Enums\SearchType;
|
||||
use App\Services\DataTable\Exceptions\InvalidFilterException;
|
||||
use App\Services\DataTable\Filter\SearchFunctions\FilterBetween;
|
||||
use App\Services\DataTable\Filter\SearchFunctions\FilterContains;
|
||||
use App\Services\DataTable\Filter\SearchFunctions\FilterEquals;
|
||||
use App\Services\DataTable\Filter\SearchFunctions\FilterGreaterThan;
|
||||
use App\Services\DataTable\Filter\SearchFunctions\FilterLessThan;
|
||||
use App\Services\DataTable\Filter\SearchFunctions\FilterNotEquals;
|
||||
use App\Services\DataTable\Filter\SearchFunctions\SearchFilter;
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class ApplyFilter
|
||||
{
|
||||
private SearchFilter $searchFilter;
|
||||
|
||||
/**
|
||||
* @param Builder $query
|
||||
* @param Filter $filter
|
||||
*/
|
||||
public function __construct(
|
||||
private Builder $query,
|
||||
private Filter $filter,
|
||||
)
|
||||
{
|
||||
}
|
||||
|
||||
public function apply(): Builder
|
||||
{
|
||||
$filter = $this->filter;
|
||||
$query = $this->query;
|
||||
|
||||
$searchType = SearchType::from($filter->getFn());
|
||||
switch ($searchType) {
|
||||
case SearchType::CONTAINS:
|
||||
$this->searchFilter = new FilterContains($query, $filter);
|
||||
break;
|
||||
|
||||
case SearchType::EQUALS:
|
||||
$this->searchFilter = new FilterEquals($query, $filter);
|
||||
break;
|
||||
|
||||
case SearchType::NOT_EQUALS:
|
||||
$this->searchFilter = new FilterNotEquals($query, $filter);
|
||||
break;
|
||||
|
||||
case SearchType::BETWEEN:
|
||||
$this->searchFilter = new FilterBetween($query, $filter);
|
||||
break;
|
||||
|
||||
case SearchType::GREATER_THAN:
|
||||
$this->searchFilter = new FilterGreaterThan($query, $filter);
|
||||
break;
|
||||
|
||||
case SearchType::LESS_THAN:
|
||||
$this->searchFilter = new FilterLessThan($query, $filter);
|
||||
break;
|
||||
|
||||
default:
|
||||
$searchFunction = $filter->getFn();
|
||||
throw new InvalidFilterException($searchFunction, "search function `$searchFunction` is invalid.");
|
||||
|
||||
}
|
||||
|
||||
$relation = $this->filter->getRelation();
|
||||
return method_exists($this->query->getModel(), $relation) ? $this->applyFilterToRelation($relation) : $this->searchFilter->apply();
|
||||
}
|
||||
|
||||
protected function applyFilterToRelation(string $relation): Builder
|
||||
{
|
||||
return $this->query->whereHas($relation, function (Builder $query) {
|
||||
$this->filter->removeRelationFromId();
|
||||
$this->applyFilter($query, $this->filter);
|
||||
});
|
||||
}
|
||||
|
||||
private function applyFilter(Builder $query, Filter $filter): Builder
|
||||
{
|
||||
return (new ApplyFilter($query, $filter))->apply();
|
||||
}
|
||||
}
|
||||
73
laravel/app/Services/DataTable/Filter/Filter.php
Normal file
73
laravel/app/Services/DataTable/Filter/Filter.php
Normal file
@@ -0,0 +1,73 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter;
|
||||
|
||||
use App\Services\DataTable\Validators\FilterValidator;
|
||||
|
||||
class Filter
|
||||
{
|
||||
private static FilterValidator $filterValidator;
|
||||
|
||||
/**
|
||||
* @param string $id
|
||||
* @param string|int|array $value
|
||||
* @param string $fn
|
||||
* @param string $datatype
|
||||
* @param array $allowedFilters
|
||||
* @throws \App\Services\DataTable\Exceptions\InvalidFilterException
|
||||
*/
|
||||
public function __construct(
|
||||
private string $id,
|
||||
private string|int|array $value,
|
||||
private string $fn,
|
||||
private string $datatype,
|
||||
private array $allowedFilters
|
||||
)
|
||||
{
|
||||
self::$filterValidator = FilterValidator::getInstance();
|
||||
self::$filterValidator->isValid($this, $this->allowedFilters);
|
||||
}
|
||||
|
||||
public function getId(): string
|
||||
{
|
||||
return $this->id;
|
||||
}
|
||||
|
||||
public function getValue(): array|int|string
|
||||
{
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
public function getFn(): string
|
||||
{
|
||||
return $this->fn;
|
||||
}
|
||||
|
||||
public function getDatatype(): string
|
||||
{
|
||||
return $this->datatype;
|
||||
}
|
||||
|
||||
public function getRelation(): string
|
||||
{
|
||||
$fieldArray = explode('.', $this->id);
|
||||
return count($fieldArray) > 1 ? $fieldArray[0] : '';
|
||||
}
|
||||
|
||||
public function getColumn(): string
|
||||
{
|
||||
$fieldArray = explode('.', $this->id);
|
||||
return array_pop($fieldArray);
|
||||
}
|
||||
|
||||
public function removeRelationFromId(): void
|
||||
{
|
||||
$this->id = $this->getColumn();
|
||||
}
|
||||
|
||||
public function setValue(int|array|string $value): void
|
||||
{
|
||||
$this->value = $value;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter\SearchFunctions;
|
||||
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class FilterBetween extends SearchFilter
|
||||
{
|
||||
|
||||
public function apply(): Builder
|
||||
{
|
||||
$query = $this->query;
|
||||
[$minVal, $maxVal] = $this->filter->getValue();
|
||||
|
||||
if ($minVal) {
|
||||
if ($this->filter->getDatatype() == "date") {
|
||||
$minVal = $minVal . " 00:00:00";
|
||||
}
|
||||
$this->filter->setValue($minVal);
|
||||
$query = (new FilterGreaterThanOrEqual($this->query, $this->filter))->apply();
|
||||
}
|
||||
|
||||
if ($maxVal) {
|
||||
if ($this->filter->getDatatype() == "date") {
|
||||
$maxVal = $maxVal . " 23:59:59";
|
||||
}
|
||||
$this->filter->setValue($maxVal);
|
||||
$query = (new FilterLessThanOrEqual($this->query, $this->filter))->apply();
|
||||
}
|
||||
|
||||
return $query;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter\SearchFunctions;
|
||||
|
||||
use App\Services\DataTable\Enums\DataType;
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class FilterContains extends SearchFilter
|
||||
{
|
||||
|
||||
public function apply(): Builder
|
||||
{
|
||||
$column = $this->filter->getId();
|
||||
$value = '%' . $this->filter->getValue() . '%';
|
||||
|
||||
if ($this->filter->getDatatype() == DataType::TEXT->value) {
|
||||
$query = $this->searchIgnoreCase($column, $value);
|
||||
|
||||
} else {
|
||||
$query = $this->query->where($column, 'LIKE', $value);
|
||||
}
|
||||
|
||||
return $query;
|
||||
}
|
||||
|
||||
private function searchIgnoreCase(string $column, string $value): Builder
|
||||
{
|
||||
$value = strtolower($value);
|
||||
return $this->query->whereRaw("LOWER($column) LIKE ?", [$value]);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter\SearchFunctions;
|
||||
|
||||
use App\Services\DataTable\Enums\DataType;
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class FilterEquals extends SearchFilter
|
||||
{
|
||||
|
||||
public function apply(): Builder
|
||||
{
|
||||
$column = $this->filter->getId();
|
||||
$value = $this->filter->getValue();
|
||||
|
||||
if ($this->filter->getDatatype() == DataType::TEXT->value) {
|
||||
$query = $this->searchIgnoreCase($column, $value);
|
||||
} else {
|
||||
$query = $this->query->where($column, $value);
|
||||
}
|
||||
|
||||
return $query;
|
||||
}
|
||||
|
||||
private function searchIgnoreCase(string $column, string $value): Builder
|
||||
{
|
||||
$value = strtolower($value);
|
||||
return $this->query->whereRaw("LOWER($column) = ?", [$value]);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter\SearchFunctions;
|
||||
|
||||
use App\Services\DataTable\Enums\DataType;
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class FilterGreaterThan extends SearchFilter
|
||||
{
|
||||
|
||||
public function apply(): Builder
|
||||
{
|
||||
$value = ($this->filter->getDatatype() == DataType::NUMERIC) ?
|
||||
(float)$this->filter->getValue() : $this->filter->getValue();
|
||||
|
||||
return $this->query->where($this->filter->getId(), '>', $value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter\SearchFunctions;
|
||||
|
||||
use App\Services\DataTable\Enums\DataType;
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class FilterGreaterThanOrEqual extends SearchFilter
|
||||
{
|
||||
|
||||
public function apply(): Builder
|
||||
{
|
||||
$value = ($this->filter->getDatatype() == DataType::NUMERIC) ?
|
||||
(float)$this->filter->getValue() : $this->filter->getValue();
|
||||
|
||||
return $this->query->where($this->filter->getId(), '>=', $value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter\SearchFunctions;
|
||||
|
||||
use App\Services\DataTable\Enums\DataType;
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class FilterLessThan extends SearchFilter
|
||||
{
|
||||
|
||||
public function apply(): Builder
|
||||
{
|
||||
$value = ($this->filter->getDatatype() == DataType::NUMERIC) ?
|
||||
(float)$this->filter->getValue() : $this->filter->getValue();
|
||||
|
||||
return $this->query->where($this->filter->getId(), '<', $value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter\SearchFunctions;
|
||||
|
||||
use App\Services\DataTable\Enums\DataType;
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class FilterLessThanOrEqual extends SearchFilter
|
||||
{
|
||||
|
||||
public function apply(): Builder
|
||||
{
|
||||
$value = ($this->filter->getDatatype() == DataType::NUMERIC) ?
|
||||
(float)$this->filter->getValue() : $this->filter->getValue();
|
||||
|
||||
return $this->query->where($this->filter->getId(), '<=', $value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter\SearchFunctions;
|
||||
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class FilterNotEquals extends SearchFilter
|
||||
{
|
||||
|
||||
public function apply(): Builder
|
||||
{
|
||||
$column = $this->filter->getId();
|
||||
$value = $this->filter->getValue();
|
||||
|
||||
return $this->query->whereNot($column, $value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Filter\SearchFunctions;
|
||||
|
||||
use App\Services\DataTable\Filter\Filter;
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
abstract class SearchFilter
|
||||
{
|
||||
/**
|
||||
* @param Builder $query
|
||||
* @param Filter $filter
|
||||
*/
|
||||
public function __construct(
|
||||
protected Builder $query,
|
||||
protected Filter $filter,
|
||||
)
|
||||
{
|
||||
}
|
||||
|
||||
abstract public function apply(): Builder;
|
||||
}
|
||||
31
laravel/app/Services/DataTable/Sort/ApplySort.php
Normal file
31
laravel/app/Services/DataTable/Sort/ApplySort.php
Normal file
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Sort;
|
||||
|
||||
use Illuminate\Contracts\Database\Query\Builder;
|
||||
|
||||
class ApplySort
|
||||
{
|
||||
|
||||
/**
|
||||
* @param Builder $query
|
||||
* @param ?Sort $sort
|
||||
*/
|
||||
public function __construct(
|
||||
private Builder $query,
|
||||
private ?Sort $sort,
|
||||
)
|
||||
{
|
||||
}
|
||||
|
||||
public function apply(): Builder
|
||||
{
|
||||
$query = $this->query;
|
||||
|
||||
if (!is_null($this->sort)) {
|
||||
$query->orderBy($this->sort->getId(), $this->sort->getDirection());
|
||||
}
|
||||
|
||||
return $query;
|
||||
}
|
||||
}
|
||||
39
laravel/app/Services/DataTable/Sort/Sort.php
Normal file
39
laravel/app/Services/DataTable/Sort/Sort.php
Normal file
@@ -0,0 +1,39 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Sort;
|
||||
|
||||
use App\Services\DataTable\Validators\SortingValidator;
|
||||
|
||||
class Sort
|
||||
{
|
||||
private static SortingValidator $sortingValidator;
|
||||
|
||||
/**
|
||||
* @param string $id
|
||||
* @param bool $desc
|
||||
* @param array $allowedSortings
|
||||
* @throws \App\Services\DataTable\Exceptions\InvalidSortingException
|
||||
*/
|
||||
public function __construct(
|
||||
private string $id,
|
||||
private bool $desc,
|
||||
private array $allowedSortings,
|
||||
)
|
||||
{
|
||||
self::$sortingValidator = SortingValidator::getInstance();
|
||||
self::$sortingValidator->isValid($this, $this->allowedSortings);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getId(): string
|
||||
{
|
||||
return $this->id;
|
||||
}
|
||||
|
||||
public function getDirection(): string
|
||||
{
|
||||
return $this->desc === true ? 'desc' : 'asc';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Validators;
|
||||
|
||||
use App\Services\DataTable\Enums\SearchType;
|
||||
use App\Services\DataTable\Enums\DataType;
|
||||
use App\Services\DataTable\Exceptions\InvalidFilterException;
|
||||
use App\Services\DataTable\Filter\Filter;
|
||||
|
||||
class FilterValidator
|
||||
{
|
||||
private static $instance;
|
||||
|
||||
private function __construct()
|
||||
{
|
||||
}
|
||||
|
||||
public static function getInstance(): FilterValidator
|
||||
{
|
||||
if (!isset(self::$instance)) {
|
||||
self::$instance = new static();
|
||||
}
|
||||
|
||||
return self::$instance;
|
||||
}
|
||||
|
||||
public function isValid(Filter $filter, array $allowedFilters): bool
|
||||
{
|
||||
if (!$this->isAllowed($filter, $allowedFilters)) {
|
||||
$filterId = $filter->getId();
|
||||
throw new InvalidFilterException($filter->getId(), "filtering field `$filterId` is not allowed.");
|
||||
}
|
||||
|
||||
if (!$this->isValidSearchFunction($filter)) {
|
||||
$searchFunction = $filter->getFn();
|
||||
throw new InvalidFilterException($searchFunction, "search function `$searchFunction` is invalid.");
|
||||
}
|
||||
|
||||
if ($this->isValidDataType($filter) == -1) {
|
||||
throw new InvalidFilterException(null, "datatype property is not set in `filters` array.");
|
||||
}
|
||||
|
||||
if (!$this->isValidDataType($filter)) {
|
||||
$datatype = $filter->getDatatype();
|
||||
throw new InvalidFilterException($datatype, "datatype `$datatype` is invalid.");
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
protected function isAllowed(Filter $filter, array $allowedFilters): bool
|
||||
{
|
||||
return $allowedFilters == ['*'] || in_array($filter->getId(), $allowedFilters);
|
||||
}
|
||||
|
||||
protected function isValidSearchFunction(Filter $filter): bool
|
||||
{
|
||||
$searchFunction = $filter->getFn();
|
||||
return isset($searchFunction) && in_array($searchFunction, SearchType::values());
|
||||
}
|
||||
|
||||
protected function isValidDataType(Filter $filter): int
|
||||
{
|
||||
if (!property_exists($filter, 'datatype'))
|
||||
return -1;
|
||||
|
||||
return $filter->getDatatype() && in_array($filter->getDatatype(), DataType::values()) ? 1 : 0;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Validators;
|
||||
|
||||
use App\Services\DataTable\Exceptions\InvalidRelationException;
|
||||
|
||||
class RelationValidator
|
||||
{
|
||||
public static function validate(?array $rels, array $allowedRelations): bool
|
||||
{
|
||||
foreach ($rels as $relation) {
|
||||
|
||||
if (!self::isAllowed($relation, $allowedRelations)) {
|
||||
throw new InvalidRelationException($relation, "relation `$relation` is not allowed.");
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
public static function isAllowed(string $relation, array $allowedRelations): bool
|
||||
{
|
||||
return !$relation || in_array($relation, $allowedRelations);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
<?php
|
||||
|
||||
namespace App\Services\DataTable\Validators;
|
||||
|
||||
use App\Services\DataTable\Exceptions\InvalidSortingException;
|
||||
use App\Services\DataTable\Sort\Sort;
|
||||
|
||||
class SortingValidator
|
||||
{
|
||||
private static $instance;
|
||||
|
||||
private function __construct()
|
||||
{
|
||||
}
|
||||
|
||||
public static function getInstance(): SortingValidator
|
||||
{
|
||||
if (!isset(self::$instance)) {
|
||||
self::$instance = new static();
|
||||
}
|
||||
|
||||
return self::$instance;
|
||||
}
|
||||
|
||||
public function isValid(Sort $sorting, array $allowedSortings): bool
|
||||
{
|
||||
if (!$this->isAllowed($sorting, $allowedSortings)) {
|
||||
$sortId = $sorting->getId();
|
||||
throw new InvalidSortingException($sortId, "sorting field `$sortId` is not allowed.");
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
protected function isAllowed(Sort $sorting, array $allowedSortings): bool
|
||||
{
|
||||
return $allowedSortings == ['*'] || in_array($sorting->getId(), $allowedSortings);
|
||||
}
|
||||
}
|
||||
@@ -2,4 +2,6 @@
|
||||
|
||||
return [
|
||||
App\Providers\AppServiceProvider::class,
|
||||
App\Providers\DataTableServiceProvider::class,
|
||||
App\Providers\FileServiceProvider::class,
|
||||
];
|
||||
|
||||
@@ -12,7 +12,8 @@
|
||||
"php": "^8.2",
|
||||
"laravel/framework": "^12.0",
|
||||
"laravel/sanctum": "^4.0",
|
||||
"laravel/tinker": "^2.10.1"
|
||||
"laravel/tinker": "^2.10.1",
|
||||
"spatie/laravel-permission": "^6.17"
|
||||
},
|
||||
"require-dev": {
|
||||
"fakerphp/faker": "^1.23",
|
||||
|
||||
85
laravel/composer.lock
generated
85
laravel/composer.lock
generated
@@ -4,7 +4,7 @@
|
||||
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
|
||||
"This file is @generated automatically"
|
||||
],
|
||||
"content-hash": "85c1d2065f70e38b0d6bf66559fb13c5",
|
||||
"content-hash": "c6435e4e604560a7d58c57b5d1bd2d63",
|
||||
"packages": [
|
||||
{
|
||||
"name": "brick/math",
|
||||
@@ -3350,6 +3350,89 @@
|
||||
],
|
||||
"time": "2024-04-27T21:32:50+00:00"
|
||||
},
|
||||
{
|
||||
"name": "spatie/laravel-permission",
|
||||
"version": "6.17.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spatie/laravel-permission.git",
|
||||
"reference": "02ada8f638b643713fa2fb543384738e27346ddb"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/spatie/laravel-permission/zipball/02ada8f638b643713fa2fb543384738e27346ddb",
|
||||
"reference": "02ada8f638b643713fa2fb543384738e27346ddb",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"illuminate/auth": "^8.12|^9.0|^10.0|^11.0|^12.0",
|
||||
"illuminate/container": "^8.12|^9.0|^10.0|^11.0|^12.0",
|
||||
"illuminate/contracts": "^8.12|^9.0|^10.0|^11.0|^12.0",
|
||||
"illuminate/database": "^8.12|^9.0|^10.0|^11.0|^12.0",
|
||||
"php": "^8.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"laravel/passport": "^11.0|^12.0",
|
||||
"laravel/pint": "^1.0",
|
||||
"orchestra/testbench": "^6.23|^7.0|^8.0|^9.0|^10.0",
|
||||
"phpunit/phpunit": "^9.4|^10.1|^11.5"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"laravel": {
|
||||
"providers": [
|
||||
"Spatie\\Permission\\PermissionServiceProvider"
|
||||
]
|
||||
},
|
||||
"branch-alias": {
|
||||
"dev-main": "6.x-dev",
|
||||
"dev-master": "6.x-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"files": [
|
||||
"src/helpers.php"
|
||||
],
|
||||
"psr-4": {
|
||||
"Spatie\\Permission\\": "src"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Freek Van der Herten",
|
||||
"email": "freek@spatie.be",
|
||||
"homepage": "https://spatie.be",
|
||||
"role": "Developer"
|
||||
}
|
||||
],
|
||||
"description": "Permission handling for Laravel 8.0 and up",
|
||||
"homepage": "https://github.com/spatie/laravel-permission",
|
||||
"keywords": [
|
||||
"acl",
|
||||
"laravel",
|
||||
"permission",
|
||||
"permissions",
|
||||
"rbac",
|
||||
"roles",
|
||||
"security",
|
||||
"spatie"
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/spatie/laravel-permission/issues",
|
||||
"source": "https://github.com/spatie/laravel-permission/tree/6.17.0"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://github.com/spatie",
|
||||
"type": "github"
|
||||
}
|
||||
],
|
||||
"time": "2025-04-08T15:06:14+00:00"
|
||||
},
|
||||
{
|
||||
"name": "symfony/clock",
|
||||
"version": "v7.2.0",
|
||||
|
||||
202
laravel/config/permission.php
Normal file
202
laravel/config/permission.php
Normal file
@@ -0,0 +1,202 @@
|
||||
<?php
|
||||
|
||||
return [
|
||||
|
||||
'models' => [
|
||||
|
||||
/*
|
||||
* When using the "HasPermissions" trait from this package, we need to know which
|
||||
* Eloquent model should be used to retrieve your permissions. Of course, it
|
||||
* is often just the "Permission" model but you may use whatever you like.
|
||||
*
|
||||
* The model you want to use as a Permission model needs to implement the
|
||||
* `Spatie\Permission\Contracts\Permission` contract.
|
||||
*/
|
||||
|
||||
'permission' => Spatie\Permission\Models\Permission::class,
|
||||
|
||||
/*
|
||||
* When using the "HasRoles" trait from this package, we need to know which
|
||||
* Eloquent model should be used to retrieve your roles. Of course, it
|
||||
* is often just the "Role" model but you may use whatever you like.
|
||||
*
|
||||
* The model you want to use as a Role model needs to implement the
|
||||
* `Spatie\Permission\Contracts\Role` contract.
|
||||
*/
|
||||
|
||||
'role' => Spatie\Permission\Models\Role::class,
|
||||
|
||||
],
|
||||
|
||||
'table_names' => [
|
||||
|
||||
/*
|
||||
* When using the "HasRoles" trait from this package, we need to know which
|
||||
* table should be used to retrieve your roles. We have chosen a basic
|
||||
* default value but you may easily change it to any table you like.
|
||||
*/
|
||||
|
||||
'roles' => 'roles',
|
||||
|
||||
/*
|
||||
* When using the "HasPermissions" trait from this package, we need to know which
|
||||
* table should be used to retrieve your permissions. We have chosen a basic
|
||||
* default value but you may easily change it to any table you like.
|
||||
*/
|
||||
|
||||
'permissions' => 'permissions',
|
||||
|
||||
/*
|
||||
* When using the "HasPermissions" trait from this package, we need to know which
|
||||
* table should be used to retrieve your models permissions. We have chosen a
|
||||
* basic default value but you may easily change it to any table you like.
|
||||
*/
|
||||
|
||||
'model_has_permissions' => 'model_has_permissions',
|
||||
|
||||
/*
|
||||
* When using the "HasRoles" trait from this package, we need to know which
|
||||
* table should be used to retrieve your models roles. We have chosen a
|
||||
* basic default value but you may easily change it to any table you like.
|
||||
*/
|
||||
|
||||
'model_has_roles' => 'model_has_roles',
|
||||
|
||||
/*
|
||||
* When using the "HasRoles" trait from this package, we need to know which
|
||||
* table should be used to retrieve your roles permissions. We have chosen a
|
||||
* basic default value but you may easily change it to any table you like.
|
||||
*/
|
||||
|
||||
'role_has_permissions' => 'role_has_permissions',
|
||||
],
|
||||
|
||||
'column_names' => [
|
||||
/*
|
||||
* Change this if you want to name the related pivots other than defaults
|
||||
*/
|
||||
'role_pivot_key' => null, // default 'role_id',
|
||||
'permission_pivot_key' => null, // default 'permission_id',
|
||||
|
||||
/*
|
||||
* Change this if you want to name the related model primary key other than
|
||||
* `model_id`.
|
||||
*
|
||||
* For example, this would be nice if your primary keys are all UUIDs. In
|
||||
* that case, name this `model_uuid`.
|
||||
*/
|
||||
|
||||
'model_morph_key' => 'model_id',
|
||||
|
||||
/*
|
||||
* Change this if you want to use the teams feature and your related model's
|
||||
* foreign key is other than `team_id`.
|
||||
*/
|
||||
|
||||
'team_foreign_key' => 'team_id',
|
||||
],
|
||||
|
||||
/*
|
||||
* When set to true, the method for checking permissions will be registered on the gate.
|
||||
* Set this to false if you want to implement custom logic for checking permissions.
|
||||
*/
|
||||
|
||||
'register_permission_check_method' => true,
|
||||
|
||||
/*
|
||||
* When set to true, Laravel\Octane\Events\OperationTerminated event listener will be registered
|
||||
* this will refresh permissions on every TickTerminated, TaskTerminated and RequestTerminated
|
||||
* NOTE: This should not be needed in most cases, but an Octane/Vapor combination benefited from it.
|
||||
*/
|
||||
'register_octane_reset_listener' => false,
|
||||
|
||||
/*
|
||||
* Events will fire when a role or permission is assigned/unassigned:
|
||||
* \Spatie\Permission\Events\RoleAttached
|
||||
* \Spatie\Permission\Events\RoleDetached
|
||||
* \Spatie\Permission\Events\PermissionAttached
|
||||
* \Spatie\Permission\Events\PermissionDetached
|
||||
*
|
||||
* To enable, set to true, and then create listeners to watch these events.
|
||||
*/
|
||||
'events_enabled' => false,
|
||||
|
||||
/*
|
||||
* Teams Feature.
|
||||
* When set to true the package implements teams using the 'team_foreign_key'.
|
||||
* If you want the migrations to register the 'team_foreign_key', you must
|
||||
* set this to true before doing the migration.
|
||||
* If you already did the migration then you must make a new migration to also
|
||||
* add 'team_foreign_key' to 'roles', 'model_has_roles', and 'model_has_permissions'
|
||||
* (view the latest version of this package's migration file)
|
||||
*/
|
||||
|
||||
'teams' => false,
|
||||
|
||||
/*
|
||||
* The class to use to resolve the permissions team id
|
||||
*/
|
||||
'team_resolver' => \Spatie\Permission\DefaultTeamResolver::class,
|
||||
|
||||
/*
|
||||
* Passport Client Credentials Grant
|
||||
* When set to true the package will use Passports Client to check permissions
|
||||
*/
|
||||
|
||||
'use_passport_client_credentials' => false,
|
||||
|
||||
/*
|
||||
* When set to true, the required permission names are added to exception messages.
|
||||
* This could be considered an information leak in some contexts, so the default
|
||||
* setting is false here for optimum safety.
|
||||
*/
|
||||
|
||||
'display_permission_in_exception' => false,
|
||||
|
||||
/*
|
||||
* When set to true, the required role names are added to exception messages.
|
||||
* This could be considered an information leak in some contexts, so the default
|
||||
* setting is false here for optimum safety.
|
||||
*/
|
||||
|
||||
'display_role_in_exception' => false,
|
||||
|
||||
/*
|
||||
* By default wildcard permission lookups are disabled.
|
||||
* See documentation to understand supported syntax.
|
||||
*/
|
||||
|
||||
'enable_wildcard_permission' => false,
|
||||
|
||||
/*
|
||||
* The class to use for interpreting wildcard permissions.
|
||||
* If you need to modify delimiters, override the class and specify its name here.
|
||||
*/
|
||||
// 'permission.wildcard_permission' => Spatie\Permission\WildcardPermission::class,
|
||||
|
||||
/* Cache-specific settings */
|
||||
|
||||
'cache' => [
|
||||
|
||||
/*
|
||||
* By default all permissions are cached for 24 hours to speed up performance.
|
||||
* When permissions or roles are updated the cache is flushed automatically.
|
||||
*/
|
||||
|
||||
'expiration_time' => \DateInterval::createFromDateString('24 hours'),
|
||||
|
||||
/*
|
||||
* The cache key used to store all permissions.
|
||||
*/
|
||||
|
||||
'key' => 'spatie.permission.cache',
|
||||
|
||||
/*
|
||||
* You may optionally indicate a specific cache driver to use for permission and
|
||||
* role caching using any of the `store` drivers listed in the cache.php config
|
||||
* file. Using 'default' here means to use the `default` set in cache.php.
|
||||
*/
|
||||
|
||||
'store' => 'default',
|
||||
],
|
||||
];
|
||||
23
laravel/database/factories/PermissionFactory.php
Normal file
23
laravel/database/factories/PermissionFactory.php
Normal file
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
|
||||
namespace Database\Factories;
|
||||
|
||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||
|
||||
/**
|
||||
* @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Permission>
|
||||
*/
|
||||
class PermissionFactory extends Factory
|
||||
{
|
||||
/**
|
||||
* Define the model's default state.
|
||||
*
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
public function definition(): array
|
||||
{
|
||||
return [
|
||||
//
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,140 @@
|
||||
<?php
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
return new class extends Migration
|
||||
{
|
||||
/**
|
||||
* Run the migrations.
|
||||
*/
|
||||
public function up(): void
|
||||
{
|
||||
$teams = config('permission.teams');
|
||||
$tableNames = config('permission.table_names');
|
||||
$columnNames = config('permission.column_names');
|
||||
$pivotRole = $columnNames['role_pivot_key'] ?? 'role_id';
|
||||
$pivotPermission = $columnNames['permission_pivot_key'] ?? 'permission_id';
|
||||
|
||||
if (empty($tableNames)) {
|
||||
throw new \Exception('Error: config/permission.php not loaded. Run [php artisan config:clear] and try again.');
|
||||
}
|
||||
if ($teams && empty($columnNames['team_foreign_key'] ?? null)) {
|
||||
throw new \Exception('Error: team_foreign_key on config/permission.php not loaded. Run [php artisan config:clear] and try again.');
|
||||
}
|
||||
|
||||
Schema::create($tableNames['permissions'], static function (Blueprint $table) {
|
||||
// $table->engine('InnoDB');
|
||||
$table->bigIncrements('id'); // permission id
|
||||
$table->string('name'); // For MyISAM use string('name', 225); // (or 166 for InnoDB with Redundant/Compact row format)
|
||||
$table->string('guard_name'); // For MyISAM use string('guard_name', 25);
|
||||
$table->timestamps();
|
||||
|
||||
$table->unique(['name', 'guard_name']);
|
||||
});
|
||||
|
||||
Schema::create($tableNames['roles'], static function (Blueprint $table) use ($teams, $columnNames) {
|
||||
// $table->engine('InnoDB');
|
||||
$table->bigIncrements('id'); // role id
|
||||
if ($teams || config('permission.testing')) { // permission.testing is a fix for sqlite testing
|
||||
$table->unsignedBigInteger($columnNames['team_foreign_key'])->nullable();
|
||||
$table->index($columnNames['team_foreign_key'], 'roles_team_foreign_key_index');
|
||||
}
|
||||
$table->string('name'); // For MyISAM use string('name', 225); // (or 166 for InnoDB with Redundant/Compact row format)
|
||||
$table->string('guard_name'); // For MyISAM use string('guard_name', 25);
|
||||
$table->timestamps();
|
||||
if ($teams || config('permission.testing')) {
|
||||
$table->unique([$columnNames['team_foreign_key'], 'name', 'guard_name']);
|
||||
} else {
|
||||
$table->unique(['name', 'guard_name']);
|
||||
}
|
||||
});
|
||||
|
||||
Schema::create($tableNames['model_has_permissions'], static function (Blueprint $table) use ($tableNames, $columnNames, $pivotPermission, $teams) {
|
||||
$table->unsignedBigInteger($pivotPermission);
|
||||
|
||||
$table->string('model_type');
|
||||
$table->unsignedBigInteger($columnNames['model_morph_key']);
|
||||
$table->index([$columnNames['model_morph_key'], 'model_type'], 'model_has_permissions_model_id_model_type_index');
|
||||
|
||||
$table->foreign($pivotPermission)
|
||||
->references('id') // permission id
|
||||
->on($tableNames['permissions'])
|
||||
->onDelete('cascade');
|
||||
if ($teams) {
|
||||
$table->unsignedBigInteger($columnNames['team_foreign_key']);
|
||||
$table->index($columnNames['team_foreign_key'], 'model_has_permissions_team_foreign_key_index');
|
||||
|
||||
$table->primary([$columnNames['team_foreign_key'], $pivotPermission, $columnNames['model_morph_key'], 'model_type'],
|
||||
'model_has_permissions_permission_model_type_primary');
|
||||
} else {
|
||||
$table->primary([$pivotPermission, $columnNames['model_morph_key'], 'model_type'],
|
||||
'model_has_permissions_permission_model_type_primary');
|
||||
}
|
||||
|
||||
});
|
||||
|
||||
Schema::create($tableNames['model_has_roles'], static function (Blueprint $table) use ($tableNames, $columnNames, $pivotRole, $teams) {
|
||||
$table->unsignedBigInteger($pivotRole);
|
||||
|
||||
$table->string('model_type');
|
||||
$table->unsignedBigInteger($columnNames['model_morph_key']);
|
||||
$table->index([$columnNames['model_morph_key'], 'model_type'], 'model_has_roles_model_id_model_type_index');
|
||||
|
||||
$table->foreign($pivotRole)
|
||||
->references('id') // role id
|
||||
->on($tableNames['roles'])
|
||||
->onDelete('cascade');
|
||||
if ($teams) {
|
||||
$table->unsignedBigInteger($columnNames['team_foreign_key']);
|
||||
$table->index($columnNames['team_foreign_key'], 'model_has_roles_team_foreign_key_index');
|
||||
|
||||
$table->primary([$columnNames['team_foreign_key'], $pivotRole, $columnNames['model_morph_key'], 'model_type'],
|
||||
'model_has_roles_role_model_type_primary');
|
||||
} else {
|
||||
$table->primary([$pivotRole, $columnNames['model_morph_key'], 'model_type'],
|
||||
'model_has_roles_role_model_type_primary');
|
||||
}
|
||||
});
|
||||
|
||||
Schema::create($tableNames['role_has_permissions'], static function (Blueprint $table) use ($tableNames, $pivotRole, $pivotPermission) {
|
||||
$table->unsignedBigInteger($pivotPermission);
|
||||
$table->unsignedBigInteger($pivotRole);
|
||||
|
||||
$table->foreign($pivotPermission)
|
||||
->references('id') // permission id
|
||||
->on($tableNames['permissions'])
|
||||
->onDelete('cascade');
|
||||
|
||||
$table->foreign($pivotRole)
|
||||
->references('id') // role id
|
||||
->on($tableNames['roles'])
|
||||
->onDelete('cascade');
|
||||
|
||||
$table->primary([$pivotPermission, $pivotRole], 'role_has_permissions_permission_id_role_id_primary');
|
||||
});
|
||||
|
||||
app('cache')
|
||||
->store(config('permission.cache.store') != 'default' ? config('permission.cache.store') : null)
|
||||
->forget(config('permission.cache.key'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Reverse the migrations.
|
||||
*/
|
||||
public function down(): void
|
||||
{
|
||||
$tableNames = config('permission.table_names');
|
||||
|
||||
if (empty($tableNames)) {
|
||||
throw new \Exception('Error: config/permission.php not found and defaults could not be merged. Please publish the package configuration before proceeding, or drop the tables manually.');
|
||||
}
|
||||
|
||||
Schema::drop($tableNames['role_has_permissions']);
|
||||
Schema::drop($tableNames['model_has_roles']);
|
||||
Schema::drop($tableNames['model_has_permissions']);
|
||||
Schema::drop($tableNames['roles']);
|
||||
Schema::drop($tableNames['permissions']);
|
||||
}
|
||||
};
|
||||
17
laravel/database/seeders/PermissionSeeder.php
Normal file
17
laravel/database/seeders/PermissionSeeder.php
Normal file
@@ -0,0 +1,17 @@
|
||||
<?php
|
||||
|
||||
namespace Database\Seeders;
|
||||
|
||||
use Illuminate\Database\Console\Seeds\WithoutModelEvents;
|
||||
use Illuminate\Database\Seeder;
|
||||
|
||||
class PermissionSeeder extends Seeder
|
||||
{
|
||||
/**
|
||||
* Run the database seeds.
|
||||
*/
|
||||
public function run(): void
|
||||
{
|
||||
//
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user