Feature #1 : Permissions

This commit is contained in:
Daeng Deni Mardaeni 2024-08-08 21:35:30 +07:00
parent 1157ea79b9
commit 88b9a0aae3
10 changed files with 635 additions and 35 deletions

View File

@ -0,0 +1,47 @@
<?php
namespace Modules\Usermanagement\Exports;
use Maatwebsite\Excel\Concerns\FromCollection;
use Maatwebsite\Excel\Concerns\WithColumnFormatting;
use Maatwebsite\Excel\Concerns\WithHeadings;
use Maatwebsite\Excel\Concerns\WithMapping;
use Modules\Usermanagement\Models\PermissionGroup;
class PermissionExport implements WithColumnFormatting, WithHeadings, FromCollection, withMapping
{
public function collection(){
$permission = PermissionGroup::all();
return $permission->map(function ($permission) {
$permission->roles = $permission->roles($permission);
return $permission;
});
}
public function map($row): array{
$role = $row->roles->pluck('name')->toArray();
return [
$row->id,
$row->name,
$row->roles == null? '' : implode(', ', $role),
$row->created_at
];
}
public function headings(): array{
return [
'ID',
'Permission',
'Roles',
'Created At'
];
}
public function columnFormats(): array{
return [
'A' => \PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_NUMBER,
'C' => \PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_DATETIME
];
}
}

View File

@ -3,67 +3,323 @@
namespace Modules\Usermanagement\Http\Controllers;
use App\Http\Controllers\Controller;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Maatwebsite\Excel\Facades\Excel;
use Modules\Usermanagement\Exports\PermissionExport;
use Modules\Usermanagement\Http\Requests\PermissionRequest;
use Modules\Usermanagement\Models\Permission;
use Modules\Usermanagement\Models\PermissionGroup;
/**
* Class PermissionsController
*
* This controller is responsible for managing user permissions within the application.
*
* @package Modules\Usermanagement\Http\Controllers
*/
class PermissionsController extends Controller
{
/**
* @var \Illuminate\Contracts\Auth\Authenticatable|null
*/
public $user;
/**
* Display a listing of the resource.
*
* @return \Illuminate\Contracts\View\View
* @return \Illuminate\Contracts\View\Factory
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function index()
{
return view('usermanagement::index');
// Check if the authenticated user has the required permission to view permissions
if (is_null($this->user) || !$this->user->can('permissions.view')) {
//abort(403, 'Sorry! You are not allowed to view permissions.');
}
// Return the view for displaying the permissions
return view('usermanagement::permissions.index');
}
/**
* Store a newly created resource in storage.
*
* @param \Illuminate\Http\Request $request
*
* @return \Illuminate\Http\RedirectResponse
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function store(PermissionRequest $request)
{
// Check if the authenticated user has the required permission to store permissions
if (is_null($this->user) || !$this->user->can('permissions.store')) {
//abort(403, 'Sorry! You are not allowed to store permissions.');
}
$validate = $request->validated();
if($validate){
try{
$group = PermissionGroup::create($validate);
$group_name = strtolower($validate['name']);
$data = [
$group_name . '.create',
$group_name . '.view',
$group_name . '.update',
$group_name . '.delete',
$group_name . '.authorize',
$group_name . '.report'
];
foreach ($data as $permission) {
Permission::create(['name' => $permission,'guard_name' => 'web', 'group_id' => $group->id]);
}
return redirect()->route('users.permissions.index')->with('success', 'Permission created successfully.');
} catch (\Exception $e){
return redirect()->route('users.permissions.index')->with('error', 'Failed to create permission: '.$e->getMessage());
}
}
// Redirect back to the permissions index with a success message
return redirect()->route('users.permissions.index')->with('success', 'Permission created successfully.');
}
/**
* Show the form for creating a new resource.
*
* This function is responsible for displaying the form to create a new resource.
* It returns the view for creating a new resource, which is located at 'usermanagement::create'.
*
* @return \Illuminate\Contracts\View\View|\Illuminate\Contracts\View\Factory
* @return \Illuminate\Contracts\View\View
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function create()
{
return view('usermanagement::create');
// Check if the authenticated user has the required permission to create permissions
if (is_null($this->user) || !$this->user->can('permissions.create')) {
//abort(403, 'Sorry! You are not allowed to create permissions.');
}
public function store(Request $request)
: RedirectResponse
{
//
// Return the view for creating a new role
return view('usermanagement::permissions.create');
}
public function show($id)
{
return view('usermanagement::show');
public function show($id){
// Check if the authenticated user has the required permission to view permissions
if (is_null($this->user) ||!$this->user->can('permissions.view')) {
//abort(403, 'Sorry! You are not allowed to view permissions.');
}
// Return the view for editing the role
return view('usermanagement::permissions.create');
}
/**
* Show the form for editing the specified resource.
*
* @param int $id
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function edit($id)
{
return view('usermanagement::edit');
// Check if the authenticated user has the required permission to edit permissions
if (is_null($this->user) || !$this->user->can('permissions.edit')) {
//abort(403, 'Sorry! You are not allowed to edit permissions.');
}
$permission = PermissionGroup::find($id);
// Return the view for editing the role
return view('usermanagement::permissions.create', compact('permission'));
}
public function update(Request $request, $id)
: RedirectResponse
/**
* Update the specified role in storage.
*
* @param \Modules\Usermanagement\Http\Requests\PermissionRequest $request The request object containing the role data.
* @param int $id The unique identifier of the role to be updated.
*
* @return \Illuminate\Http\RedirectResponse Redirects back to the permissions index with a success message upon successful update.
*
* @throws \Illuminate\Auth\Access\AuthorizationException If the authenticated user does not have the required permission to update permissions.
*/
public function update(PermissionRequest $request, $id)
{
//
// Check if the authenticated user has the required permission to update permissions
if (is_null($this->user) || !$this->user->can('permissions.update')) {
//abort(403, 'Sorry! You are not allowed to update permissions.');
}
$validated = $request->validated();
if ($validated) {
try {
// Process Data
$group = PermissionGroup::find($id);
$group->name = $request->name;
if ($group->save()) {
$group_name = strtolower($request->name);
$permissions = Permission::where('permission_group_id', $group->id)->get();
$data = [
$group_name . '.create',
$group_name . '.read',
$group_name . '.update',
$group_name . '.delete',
$group_name . '.authorize',
$group_name . '.report'
];
$i = 0;
foreach ($permissions as $permission) {
$permission->name = $data[$i];
$permission->save();
$i++;
}
}
return redirect()->route('users.permissions.index')->with('success', 'Permission updated successfully.');
} catch (\Exception $e) {
return redirect()->route('users.permissions.index')->with('error', 'Failed to update permission: '.$e->getMessage());
}
}
}
/**
* Remove the specified resource from storage.
*
* @param int $id
*
* @return \Illuminate\Http\RedirectResponse
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function destroy($id)
{
//
// Check if the authenticated user has the required permission to delete permissions
if (is_null($this->user) || !$this->user->can('permissions.delete')) {
//abort(403, 'Sorry! You are not allowed to delete permissions.');
}
$permission = PermissionGroup::find($id);
if (!is_null($permission)) {
if ($permission->delete()) {
Permission::where('permission_group_id', $id)->delete();
}
}
// Redirect back to the permissions index with a success message
echo json_encode(['message' => 'Permission deleted successfully.', 'success' => true]);
}
/**
* Restore a deleted role.
*
* @param int $id
*
* @return \Illuminate\Http\RedirectResponse
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function restore($id)
{
// Check if the authenticated user has the required permission to restore permissions
if (is_null($this->user) || !$this->user->can('permissions.restore')) {
abort(403, 'Sorry! You are not allowed to restore permissions.');
}
// Fetch the specified role from the database
$permission = PermissionGroup::withTrashed()->find($id);
if(!is_null($permission)) {
// Check if the permission is already restored
if ($permission->trashed()) {
// Process Data
$permission->restore();
Permission::withTrashed()->where('permission_group_id', $id)->restore();
}
}
// Redirect back to the permissions index with a success message
return redirect()->route('users.permissions.index')->with('success', 'Permission restored successfully.');
}
/**
* Process support datatables ajax request.
*
* @param \Illuminate\Http\Request $request
*
* @return \Illuminate\Http\JsonResponse
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function dataForDatatables(Request $request)
{
if (is_null($this->user) || !$this->user->can('permissions.view')) {
//abort(403, 'Sorry! You are not allowed to view users.');
}
// Retrieve data from the database
$query = PermissionGroup::query();
// Apply search filter if provided
if ($request->has('search') && !empty($request->get('search'))) {
$search = $request->get('search');
$query->where(function ($q) use ($search) {
$q->where('name', 'LIKE', "%$search%");
});
}
// Apply sorting if provided
if ($request->has('sortOrder') && !empty($request->get('sortOrder'))) {
$order = $request->get('sortOrder');
$column = $request->get('sortField');
$query->orderBy($column, $order);
}
// Get the total count of records
$totalRecords = $query->count();
// Apply pagination if provided
if ($request->has('start') && $request->has('length')) {
$start = $request->get('start');
$length = $request->get('length');
$query->skip($start)->take($length);
}
// Get the filtered count of records
$filteredRecords = $query->count();
// Get the data for the current page
$permissions = $query->get();
$permissions = $permissions->map(function ($permission) {
$permission->roles = $permission->roles($permission);
return $permission;
});
// Calculate the page count
$pageCount = ceil($totalRecords);
// Calculate the current page number
$currentPage = 0 + 1;
// Return the response data as a JSON object
return response()->json([
'draw' => $request->get('draw'),
'recordsTotal' => $totalRecords,
'recordsFiltered' => $filteredRecords,
'pageCount' => $pageCount,
'page' => $currentPage,
'totalCount' => $totalRecords,
'data' => $permissions,
]);
}
public function export()
{
return Excel::download(new PermissionExport, 'permissions.xlsx');
}
}

View File

@ -190,7 +190,7 @@
$role->delete();
// Redirect back to the roles index with a success message
echo json_encode(['message' => 'User deleted successfully.', 'success' => true]);
echo json_encode(['message' => 'Role deleted successfully.', 'success' => true]);
}
/**

View File

@ -0,0 +1,46 @@
<?php
namespace Modules\Usermanagement\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Str;
class PermissionRequest extends FormRequest
{
public function authorize()
{
return true;
}
/**
* Returns an array of validation rules for the registration form.
*
* @return array The validation rules.
*/
public function rules()
: array
{
$rules = [
'slug' => 'required|string|max:255',
];
if ($this->method() === 'PUT') {
$rules['name'] = 'required|string|max:255|unique:permission_groups,name,' . $this->id;
} else {
$rules['name'] = 'required|string|max:255|unique:permission_groups';
}
return $rules;
}
public function prepareForValidation()
{
$this->merge([
'slug' => Str::slug($this->input('name')),
]);
}
}

View File

@ -28,7 +28,7 @@
if ($this->method() === 'PUT') {
$rules['name'] = 'required|string|max:255|unique:roles,name,' . $this->id;
} else {
$rules['name'] = 'required|string|max:255';
$rules['name'] = 'required|string|max:255|unique:roles,name';
}
return $rules;

View File

@ -46,6 +46,8 @@
$permission = Permission::where('permission_group_id', $group->id)->first();
$data = [];
if ($permission) {
$roles = Role::all();
foreach ($roles as $role) {
@ -53,6 +55,9 @@
array_push($data, $role);
}
}
} else {
$data = Role::all();
}
return $data;
}

View File

@ -0,0 +1,48 @@
@extends('layouts.main')
@section('breadcrumbs')
{{ Breadcrumbs::render(request()->route()->getName()) }}
@endsection
@section('content')
<div class="w-full grid gap-5 lg:gap-7.5 mx-auto">
@if(isset($permission->id))
<form action="{{ route('users.permissions.update', $permission->id) }}" method="POST">
<input type="hidden" name="id" value="{{ $permission->id }}">
@method('PUT')
@else
<form method="POST" action="{{ route('users.permissions.store') }}">
@endif
@csrf
<div class="card pb-2.5">
<div class="card-header" id="basic_settings">
<h3 class="card-title">
{{ isset($permission->id) ? 'Edit' : 'Add' }} Permission
</h3>
<div class="flex items-center gap-2">
<a href="{{ route('users.permissions.index') }}" class="btn btn-xs btn-info">Back</a>
</div>
</div>
<div class="card-body grid gap-5">
<div class="flex items-baseline flex-wrap lg:flex-nowrap gap-2.5">
<label class="form-label max-w-56">
Name
</label>
<div class="flex flex-wrap items-baseline w-full">
<input class="input @error('name') border-danger @enderror" type="text" name="name" value="{{ $permission->name ?? '' }}">
@error('name')
<em class="alert text-danger text-sm">{{ $message }}</em>
@enderror
</div>
</div>
<div class="flex justify-end">
<button type="submit" class="btn btn-primary">
Save
</button>
</div>
</div>
</div>
</form>
</div>
@endsection

View File

@ -0,0 +1,182 @@
@extends('layouts.main')
@section('breadcrumbs')
{{ Breadcrumbs::render('users.permissions') }}
@endsection
@section('content')
<div class="container-fluid">
<div class="grid">
<div class="card card-grid min-w-full" data-datatable="false" data-datatable-page-size="5" data-datatable-state-save="true" id="permissions-table" data-api-url="{{ route('users.permissions.datatables') }}">
<div class="card-header py-5 flex-wrap">
<h3 class="card-title">
List of Permissions
</h3>
<div class="flex flex-wrap gap-2 lg:gap-5">
<div class="flex">
<label class="input input-sm"> <i class="ki-filled ki-magnifier"> </i>
<input placeholder="Search permissions" id="search" type="text" value="">
</label>
</div>
<div class="flex flex-wrap gap-2.5">
<select class="select select-sm w-28">
<option value="1">
Active
</option>
<option value="2">
Disabled
</option>
<option value="2">
Pending
</option>
</select>
<select class="select select-sm w-28">
<option value="desc">
Latest
</option>
<option value="asc">
Oldest
</option>
</select>
<button class="btn btn-sm btn-outline btn-primary">
<i class="ki-filled ki-setting-4"> </i> <Filters></Filters>
</button>
<div class="h-[24px] border border-r-gray-200"> </div>
<a class="btn btn-sm btn-light" href="{{ route('users.permissions.export') }}"> Export to Excel </a>
<a class="btn btn-sm btn-primary" href="{{ route('users.permissions.create') }}"> Add Permission </a>
</div>
</div>
</div>
<div class="card-body">
<div class="scrollable-x-auto">
<table class="table table-auto table-border align-middle text-gray-700 font-medium text-sm" data-datatable-table="true">
<thead>
<tr>
<th class="w-14">
<input class="checkbox checkbox-sm" data-datatable-check="true" type="checkbox"/>
</th>
<th class="min-w-[250px]" data-datatable-column="name">
<span class="sort"> <span class="sort-label"> Permission </span>
<span class="sort-icon"> </span> </span>
</th>
<th class="min-w-[250px]" data-datatable-column="roles">
<span class="sort"> <span class="sort-label"> Roles </span>
<span class="sort-icon"> </span> </span>
</th>
<th class="min-w-[50px] text-center" data-datatable-column="actions">Action</th>
</tr>
</thead>
</table>
</div>
<div class="card-footer justify-center md:justify-between flex-col md:flex-row gap-3 text-gray-600 text-2sm font-medium">
<div class="flex items-center gap-2">
Show
<select class="select select-sm w-16" data-datatable-size="true" name="perpage"> </select> per page
</div>
<div class="flex items-center gap-4">
<span data-datatable-info="true"> </span>
<div class="pagination" data-datatable-pagination="true">
</div>
</div>
</div>
</div>
</div>
</div>
</div>
@endsection
@push('scripts')
<script src="https://cdn.jsdelivr.net/npm/sweetalert2@11"></script>
<script type="text/javascript">
function deleteData(data) {
Swal.fire({
title: 'Are you sure?',
text: "You won't be able to revert this!" + data,
icon: 'warning',
showCancelButton: true,
confirmButtonColor: '#3085d6',
cancelButtonColor: '#d33',
confirmButtonText: 'Yes, delete it!'
}).then((result) => {
if (result.isConfirmed) {
$.ajaxSetup({
headers: {
'X-CSRF-TOKEN': '{{ csrf_token() }}'
}
});
$.ajax(`permissions/${data}`, {
type: 'DELETE'
}).then((response) => {
swal.fire('Deleted!', 'User has been deleted.','success').then(() => {
window.location.reload();
});
}).catch((error) => {
console.error('Error:', error);
Swal.fire('Error!', 'An error occurred while deleting the file.', 'error');
});
}
})
}
</script>
<script type="module">
const element = document.querySelector('#permissions-table');
const searchInput = document.getElementById('search');
const apiUrl = element.getAttribute('data-api-url');
const colors = ['','badge-primary', 'badge-success', 'badge-info', 'badge-danger', 'badge-warning', 'badge-dark'];
const dataTableOptions = {
apiEndpoint: apiUrl,
pageSize: 5,
columns: {
select: {
render: (item, data, context) => {
const checkbox = document.createElement('input');
checkbox.className = 'checkbox checkbox-sm';
checkbox.type = 'checkbox';
checkbox.value = data.id.toString();
checkbox.setAttribute('data-datatable-row-check', 'true');
return checkbox.outerHTML.trim();
},
},
name: {
title: 'Permission',
},
roles: {
title: 'Roles',
render: (item, data) => {
const _render = data.roles.map((role) =>{
const randomColor = colors[Math.floor(Math.random() * colors.length)];
return `<span class="badge ${randomColor} badge-sm">${role.name}</span>`;
});
return _render.join(' ');
}
},
actions: {
title: 'Status',
render: (item, data) => {
return `<div class="flex flex-nowrap justify-center">
<a class="btn btn-sm btn-icon btn-clear btn-info" href="permissions/${data.id}/edit">
<i class="ki-outline ki-notepad-edit"></i>
</a>
<a onclick="deleteData(${data.id})" class="delete btn btn-sm btn-icon btn-clear btn-danger">
<i class="ki-outline ki-trash"></i>
</a>
</div>`;
},
}
},
};
let dataTable = new KTDataTable(element, dataTableOptions);
// Custom search functionality
searchInput.addEventListener('input', function () {
const searchValue = this.value.trim();
dataTable.search(searchValue, true);
});
</script>
@endpush

View File

@ -32,3 +32,19 @@
$trail->parent('users.roles');
$trail->push('Edit Role');
});
Breadcrumbs::for('users.permissions', function (BreadcrumbTrail $trail) {
$trail->parent('users');
$trail->push('Permissions', route('users.permissions.index'));
});
Breadcrumbs::for('users.permissions.create', function (BreadcrumbTrail $trail) {
$trail->parent('users.permissions');
$trail->push('Add Permission', route('users.permissions.create'));
});
Breadcrumbs::for('users.permissions.edit', function (BreadcrumbTrail $trail) {
$trail->parent('users.permissions');
$trail->push('Edit Permission');
});

View File

@ -31,12 +31,12 @@ Route::middleware(['auth'])->group(function () {
});
Route::resource('roles', RolesController::class);
Route::resource('permissions', PermissionsController::class);
Route::name('permissions.')->prefix('permissions')->group(function () {
Route::get('restore/{id}', [PermissionsController::class,'restore'])->name('restore');
Route::get('datatables', [PermissionsController::class, 'dataForDatatables'])->name('datatables');
Route::get('export', [PermissionsController ::class, 'export'])->name('export');
});
Route::resource('permissions', PermissionsController::class);
});
});