feat: Implement Document Module with Dropzone file upload functionality

- Added DocumentController for handling document uploads and management.
- Created Document model with necessary attributes and relationships.
- Implemented DocumentService for business logic related to documents.
- Set up routes for document management in both web and API contexts.
- Developed views for document upload using Dropzone for file handling.
- Included necessary assets and styles for the Document module.
- Created migration for documents table with appropriate fields.
- Added configuration and service provider for the Document module.
This commit is contained in:
2025-08-01 18:00:15 +05:45
parent 64592f5b96
commit efa9231391
39 changed files with 1831 additions and 69 deletions

View File

@@ -0,0 +1,71 @@
<?php
namespace Modules\Document\Http\Controllers;
use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Illuminate\Support\Str;
use Modules\CCMS\Models\Country;
use Modules\CCMS\Models\Service;
use Modules\CCMS\Models\Test;
use Modules\Document\Services\DocumentService;
use Yajra\DataTables\Facades\DataTables;
class DocumentController extends Controller
{
protected $documentService;
public function __construct(DocumentService $documentService)
{
$this->documentService = $documentService;
}
public function index()
{
$title = 'Upload Documents';
$countryOptions = Country::whereNull('parent_id')->pluck('title', 'id')->mapWithKeys(fn($title, $id) => ["Country:$id" => "Country - $title"]);
$serviceOptions = Service::whereNull('parent_id')->pluck('title', 'id')->mapWithKeys(fn($title, $id) => ["Service:$id" => "Service - $title"]);
$testOptions = Test::whereNull('parent_id')->pluck('title', 'id')->mapWithKeys(fn($title, $id) => ["Test:$id" => "Test - $title"]);
$modelOptions = $countryOptions->merge($serviceOptions)->merge($testOptions);
return view('document::document.index', compact('modelOptions', 'title'));
}
public function dropzoneUpload(Request $request)
{
$request->validate([
'model' => 'required|string',
'file' => 'required|array',
'file.*' => 'file|mimes:pdf,doc,docx,jpg,png|max:5120',
'title' => 'nullable|string',
]);
$parts = explode(':', $request->model);
if (count($parts) !== 2) {
return response()->json(['error' => 'Invalid model format.'], 422);
}
[$modelType, $modelId] = $parts;
$modelClass = "App\\Models\\$modelType";
if (!class_exists($modelClass)) {
return response()->json(['error' => 'Invalid model selected.'], 422);
}
$model = $modelClass::findOrFail($modelId);
foreach ($request->file('file') as $uploadedFile) {
$path = $uploadedFile->store('documents');
$model->documents()->create([
'title' => $request->title ?? 'Untitled',
'file_path' => $path,
]);
}
return response()->json(['success' => 'Files uploaded successfully']);
}
}

View File

@@ -0,0 +1,69 @@
<?php
namespace Modules\Document\Models;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphTo;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str;
class Document extends Model
{
use HasFactory;
protected $fillable = ['title', 'file_path'];
public function documentable(): MorphTo
{
return $this->morphTo();
}
public function getUrl()
{
$path = $this->document_path;
return Storage::disk('public')->url($path);
}
public function getSize()
{
$path = $this->document_path;
if (Storage::disk('public')->exists($path)) {
$sizeInBytes = Storage::disk('public')->size($path);
return round($sizeInBytes / 1024, 2) . " KB";
}
return 0;
}
public function getExtension()
{
return pathinfo($this->document_path, PATHINFO_EXTENSION);
}
public function isImageFile()
{
$imageExtensions = ['jpg', 'jpeg', 'png', 'gif', 'bmp', 'svg', 'webp', 'tiff', 'tif', 'ico'];
$extension = pathinfo($this->document_path, PATHINFO_EXTENSION);
return in_array(Str::lower($extension), $imageExtensions);
}
protected function documentPath(): Attribute
{
return Attribute::make(
get: function (mixed $value, array $attributes) {
$collectionName = $attributes['collection_name'];
$path = $attributes['document_path'];
return "{$collectionName}/{$path}";
}
);
}
public function scopeActive($query, int $status = 1)
{
return $query->where('status', $status);
}
}

View File

View File

@@ -0,0 +1,135 @@
<?php
namespace Modules\Document\Providers;
use Illuminate\Support\Facades\Blade;
use Illuminate\Support\ServiceProvider;
use Nwidart\Modules\Traits\PathNamespace;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
class DocumentServiceProvider extends ServiceProvider
{
use PathNamespace;
protected string $name = 'Document';
protected string $nameLower = 'document';
/**
* Boot the application events.
*/
public function boot(): void
{
$this->registerCommands();
$this->registerCommandSchedules();
$this->registerTranslations();
$this->registerConfig();
$this->registerViews();
$this->loadMigrationsFrom(module_path($this->name, 'database/migrations'));
}
/**
* Register the service provider.
*/
public function register(): void
{
$this->app->register(EventServiceProvider::class);
$this->app->register(RouteServiceProvider::class);
}
/**
* Register commands in the format of Command::class
*/
protected function registerCommands(): void
{
// $this->commands([]);
}
/**
* Register command Schedules.
*/
protected function registerCommandSchedules(): void
{
// $this->app->booted(function () {
// $schedule = $this->app->make(Schedule::class);
// $schedule->command('inspire')->hourly();
// });
}
/**
* Register translations.
*/
public function registerTranslations(): void
{
$langPath = resource_path('lang/modules/'.$this->nameLower);
if (is_dir($langPath)) {
$this->loadTranslationsFrom($langPath, $this->nameLower);
$this->loadJsonTranslationsFrom($langPath);
} else {
$this->loadTranslationsFrom(module_path($this->name, 'lang'), $this->nameLower);
$this->loadJsonTranslationsFrom(module_path($this->name, 'lang'));
}
}
/**
* Register config.
*/
protected function registerConfig(): void
{
$relativeConfigPath = config('modules.paths.generator.config.path');
$configPath = module_path($this->name, $relativeConfigPath);
if (is_dir($configPath)) {
$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($configPath));
foreach ($iterator as $file) {
if ($file->isFile() && $file->getExtension() === 'php') {
$relativePath = str_replace($configPath . DIRECTORY_SEPARATOR, '', $file->getPathname());
$configKey = $this->nameLower . '.' . str_replace([DIRECTORY_SEPARATOR, '.php'], ['.', ''], $relativePath);
$key = ($relativePath === 'config.php') ? $this->nameLower : $configKey;
$this->publishes([$file->getPathname() => config_path($relativePath)], 'config');
$this->mergeConfigFrom($file->getPathname(), $key);
}
}
}
}
/**
* Register views.
*/
public function registerViews(): void
{
$viewPath = resource_path('views/modules/'.$this->nameLower);
$sourcePath = module_path($this->name, 'resources/views');
$this->publishes([$sourcePath => $viewPath], ['views', $this->nameLower.'-module-views']);
$this->loadViewsFrom(array_merge($this->getPublishableViewPaths(), [$sourcePath]), $this->nameLower);
$componentNamespace = $this->module_namespace($this->name, $this->app_path(config('modules.paths.generator.component-class.path')));
Blade::componentNamespace($componentNamespace, $this->nameLower);
}
/**
* Get the services provided by the provider.
*/
public function provides(): array
{
return [];
}
private function getPublishableViewPaths(): array
{
$paths = [];
foreach (config('view.paths') as $path) {
if (is_dir($path.'/modules/'.$this->nameLower)) {
$paths[] = $path.'/modules/'.$this->nameLower;
}
}
return $paths;
}
}

View File

@@ -0,0 +1,30 @@
<?php
namespace Modules\Document\Providers;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
class EventServiceProvider extends ServiceProvider
{
/**
* The event handler mappings for the application.
*
* @var array<string, array<int, string>>
*/
protected $listen = [];
/**
* Indicates if events should be discovered.
*
* @var bool
*/
protected static $shouldDiscoverEvents = true;
/**
* Configure the proper event listeners for email verification.
*/
protected function configureEmailVerification(): void
{
//
}
}

View File

@@ -0,0 +1,50 @@
<?php
namespace Modules\Document\Providers;
use Illuminate\Support\Facades\Route;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
class RouteServiceProvider extends ServiceProvider
{
protected string $name = 'Document';
/**
* Called before routes are registered.
*
* Register any model bindings or pattern based filters.
*/
public function boot(): void
{
parent::boot();
}
/**
* Define the routes for the application.
*/
public function map(): void
{
$this->mapApiRoutes();
$this->mapWebRoutes();
}
/**
* Define the "web" routes for the application.
*
* These routes all receive session state, CSRF protection, etc.
*/
protected function mapWebRoutes(): void
{
Route::middleware('web')->group(module_path($this->name, '/routes/web.php'));
}
/**
* Define the "api" routes for the application.
*
* These routes are typically stateless.
*/
protected function mapApiRoutes(): void
{
Route::middleware('api')->prefix('api')->name('api.')->group(module_path($this->name, '/routes/api.php'));
}
}

View File

View File

@@ -0,0 +1,49 @@
<?php
namespace Modules\Document\Services;
use Illuminate\Support\Facades\DB;
use Modules\Document\Models\Document;
class DocumentService
{
public function getAllCategories()
{
$query = Document::query();
return $query->get();
}
public function storeDocument(array $documentData): Document
{
return DB::transaction(function () use ($documentData) {
$document = Document::create($documentData);
return $document;
});
}
public function getDocumentById(int $id)
{
return Document::findOrFail($id);
}
public function updateDocument(int $id, array $documentData)
{
$document = $this->getDocumentById($id);
return DB::transaction(function () use ($document, $documentData) {
$document->update($documentData);
return $document;
});
}
public function deleteDocument(int $id)
{
return DB::transaction(function () use ($id) {
$document = $this->getDocumentById($id);
$document->delete();
return true;
});
}
}