From 89f85e46886fed2b806d8d5313fcf65885275089 Mon Sep 17 00:00:00 2001 From: Devansh Date: Fri, 22 Oct 2021 09:02:45 +0530 Subject: [PATCH] Commenting Done --- .../src/Providers/AdminServiceProvider.php | 74 ++++++++++--------- .../Webkul/Admin/src/Routes/auth-routes.php | 3 + .../Admin/src/Routes/catalog-routes.php | 6 +- .../Webkul/Admin/src/Routes/cms-routes.php | 3 + .../Admin/src/Routes/configuration-routes.php | 8 +- .../Admin/src/Routes/customers-routes.php | 3 + .../Admin/src/Routes/marketing-routes.php | 5 +- .../Webkul/Admin/src/Routes/rest-routes.php | 3 + .../Webkul/Admin/src/Routes/sales-routes.php | 8 +- .../Admin/src/Routes/settings-routes.php | 3 + packages/Webkul/Admin/src/Routes/web.php | 2 +- 11 files changed, 72 insertions(+), 46 deletions(-) diff --git a/packages/Webkul/Admin/src/Providers/AdminServiceProvider.php b/packages/Webkul/Admin/src/Providers/AdminServiceProvider.php index e7c852d66..e5c210ec4 100755 --- a/packages/Webkul/Admin/src/Providers/AdminServiceProvider.php +++ b/packages/Webkul/Admin/src/Providers/AdminServiceProvider.php @@ -2,10 +2,10 @@ namespace Webkul\Admin\Providers; -use Webkul\Core\Tree; use Illuminate\Routing\Router; use Illuminate\Support\ServiceProvider; use Webkul\Admin\Http\Middleware\Locale; +use Webkul\Core\Tree; class AdminServiceProvider extends ServiceProvider { @@ -20,14 +20,10 @@ class AdminServiceProvider extends ServiceProvider $this->loadTranslationsFrom(__DIR__ . '/../Resources/lang', 'admin'); - $this->publishes([__DIR__ . '/../Resources/lang' => resource_path('lang/vendor/admin')]); - - $this->publishes([ - __DIR__ . '/../../publishable/assets' => public_path('vendor/webkul/admin/assets'), - ], 'public'); - $this->loadViewsFrom(__DIR__ . '/../Resources/views', 'admin'); + $this->loadPublishers(); + $this->composeView(); $this->registerACL(); @@ -47,6 +43,41 @@ class AdminServiceProvider extends ServiceProvider $this->registerConfig(); } + /** + * Register package config. + * + * @return void + */ + protected function registerConfig() + { + $this->mergeConfigFrom( + dirname(__DIR__) . '/Config/menu.php', + 'menu.admin' + ); + + $this->mergeConfigFrom( + dirname(__DIR__) . '/Config/acl.php', + 'acl' + ); + + $this->mergeConfigFrom( + dirname(__DIR__) . '/Config/system.php', + 'core' + ); + } + + /** + * Load publishers. + * + * @return void + */ + protected function loadPublishers(): void + { + $this->publishes([__DIR__ . '/../Resources/lang' => resource_path('lang/vendor/admin')]); + + $this->publishes([__DIR__ . '/../../publishable/assets' => public_path('vendor/webkul/admin/assets')], 'public'); + } + /** * Bind the data to the views. * @@ -111,11 +142,11 @@ class AdminServiceProvider extends ServiceProvider } /** - * Registers acl to entire application + * Register ACL to entire application. * * @return void */ - public function registerACL() + protected function registerACL() { $this->app->singleton('acl', function () { return $this->createACL(); @@ -127,7 +158,7 @@ class AdminServiceProvider extends ServiceProvider * * @return mixed */ - public function createACL() + protected function createACL() { static $tree; @@ -145,27 +176,4 @@ class AdminServiceProvider extends ServiceProvider return $tree; } - - /** - * Register package config. - * - * @return void - */ - protected function registerConfig() - { - $this->mergeConfigFrom( - dirname(__DIR__) . '/Config/menu.php', - 'menu.admin' - ); - - $this->mergeConfigFrom( - dirname(__DIR__) . '/Config/acl.php', - 'acl' - ); - - $this->mergeConfigFrom( - dirname(__DIR__) . '/Config/system.php', - 'core' - ); - } } diff --git a/packages/Webkul/Admin/src/Routes/auth-routes.php b/packages/Webkul/Admin/src/Routes/auth-routes.php index 9acaadb5a..316bab7b7 100644 --- a/packages/Webkul/Admin/src/Routes/auth-routes.php +++ b/packages/Webkul/Admin/src/Routes/auth-routes.php @@ -6,6 +6,9 @@ use Webkul\User\Http\Controllers\ForgetPasswordController; use Webkul\User\Http\Controllers\ResetPasswordController; use Webkul\User\Http\Controllers\SessionController; +/** + * Auth routes. + */ Route::group(['middleware' => ['web', 'admin_locale'], 'prefix' => config('app.admin_url')], function () { /** * Redirect route. diff --git a/packages/Webkul/Admin/src/Routes/catalog-routes.php b/packages/Webkul/Admin/src/Routes/catalog-routes.php index 5fa6db739..520774f5a 100644 --- a/packages/Webkul/Admin/src/Routes/catalog-routes.php +++ b/packages/Webkul/Admin/src/Routes/catalog-routes.php @@ -6,10 +6,10 @@ use Webkul\Attribute\Http\Controllers\AttributeFamilyController; use Webkul\Category\Http\Controllers\CategoryController; use Webkul\Product\Http\Controllers\ProductController; +/** + * Catalog routes. + */ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => config('app.admin_url')], function () { - /** - * Catalog routes. - */ Route::prefix('catalog')->group(function () { /** * Sync route. diff --git a/packages/Webkul/Admin/src/Routes/cms-routes.php b/packages/Webkul/Admin/src/Routes/cms-routes.php index b7e537e35..7a32927ec 100644 --- a/packages/Webkul/Admin/src/Routes/cms-routes.php +++ b/packages/Webkul/Admin/src/Routes/cms-routes.php @@ -3,6 +3,9 @@ use Illuminate\Support\Facades\Route; use Webkul\CMS\Http\Controllers\Admin\PageController; +/** + * CMS routes. + */ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => config('app.admin_url')], function () { Route::prefix('cms')->group(function () { Route::get('/', [PageController::class, 'index'])->defaults('_config', [ diff --git a/packages/Webkul/Admin/src/Routes/configuration-routes.php b/packages/Webkul/Admin/src/Routes/configuration-routes.php index 9f56c4e26..7c1a6c5a0 100644 --- a/packages/Webkul/Admin/src/Routes/configuration-routes.php +++ b/packages/Webkul/Admin/src/Routes/configuration-routes.php @@ -3,10 +3,10 @@ use Illuminate\Support\Facades\Route; use Webkul\Admin\Http\Controllers\ConfigurationController; +/** + * Configuration routes. + */ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => config('app.admin_url')], function () { - /** - * Configuration routes. - */ Route::get('configuration/{slug?}/{slug2?}', [ConfigurationController::class, 'index'])->defaults('_config', [ 'view' => 'admin::configuration.index', ])->name('admin.configuration.index'); @@ -18,4 +18,4 @@ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => conf Route::get('configuration/{slug?}/{slug2?}/{path}', [ConfigurationController::class, 'download'])->defaults('_config', [ 'redirect' => 'admin.configuration.index', ])->name('admin.configuration.download'); -}); \ No newline at end of file +}); diff --git a/packages/Webkul/Admin/src/Routes/customers-routes.php b/packages/Webkul/Admin/src/Routes/customers-routes.php index 5217a82fa..46e68be3a 100644 --- a/packages/Webkul/Admin/src/Routes/customers-routes.php +++ b/packages/Webkul/Admin/src/Routes/customers-routes.php @@ -6,6 +6,9 @@ use Webkul\Admin\Http\Controllers\Customer\CustomerController; use Webkul\Admin\Http\Controllers\Customer\CustomerGroupController; use Webkul\Product\Http\Controllers\ReviewController; +/** + * Customers routes. + */ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => config('app.admin_url')], function () { /** * Customer management routes. diff --git a/packages/Webkul/Admin/src/Routes/marketing-routes.php b/packages/Webkul/Admin/src/Routes/marketing-routes.php index 231857617..f76e494e5 100644 --- a/packages/Webkul/Admin/src/Routes/marketing-routes.php +++ b/packages/Webkul/Admin/src/Routes/marketing-routes.php @@ -9,6 +9,9 @@ use Webkul\Marketing\Http\Controllers\CampaignController; use Webkul\Marketing\Http\Controllers\EventController; use Webkul\Marketing\Http\Controllers\TemplateController; +/** + * Marketing routes. + */ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => config('app.admin_url')], function () { Route::prefix('promotions')->group(function () { /** @@ -70,7 +73,7 @@ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => conf Route::post('catalog-rules/delete/{id}', [CatalogRuleController::class, 'destroy'])->name('admin.catalog-rules.delete'); /** - * Marketing campaigns routes. + * Campaigns routes. */ Route::get('campaigns', [CampaignController::class, 'index'])->defaults('_config', [ 'view' => 'admin::marketing.email-marketing.campaigns.index', diff --git a/packages/Webkul/Admin/src/Routes/rest-routes.php b/packages/Webkul/Admin/src/Routes/rest-routes.php index ed1311015..ed3c56a51 100644 --- a/packages/Webkul/Admin/src/Routes/rest-routes.php +++ b/packages/Webkul/Admin/src/Routes/rest-routes.php @@ -7,6 +7,9 @@ use Webkul\Admin\Http\Controllers\TinyMCEController; use Webkul\User\Http\Controllers\AccountController; use Webkul\User\Http\Controllers\SessionController; +/** + * Extra routes. + */ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => config('app.admin_url')], function () { /** * Tinymce file upload handler. diff --git a/packages/Webkul/Admin/src/Routes/sales-routes.php b/packages/Webkul/Admin/src/Routes/sales-routes.php index 55f662a20..be861f212 100644 --- a/packages/Webkul/Admin/src/Routes/sales-routes.php +++ b/packages/Webkul/Admin/src/Routes/sales-routes.php @@ -7,10 +7,10 @@ use Webkul\Admin\Http\Controllers\Sales\RefundController; use Webkul\Admin\Http\Controllers\Sales\ShipmentController; use Webkul\Admin\Http\Controllers\Sales\TransactionController; +/** + * Sales routes. + */ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => config('app.admin_url')], function () { - /** - * Sales routes. - */ Route::prefix('sales')->group(function () { /** * Order routes. @@ -72,7 +72,7 @@ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => conf ])->name('admin.sales.shipments.view'); /** - * Redunds routes. + * Refunds routes. */ Route::get('/refunds', [RefundController::class, 'index'])->defaults('_config', [ 'view' => 'admin::sales.refunds.index', diff --git a/packages/Webkul/Admin/src/Routes/settings-routes.php b/packages/Webkul/Admin/src/Routes/settings-routes.php index 258d365c2..cdc1982f9 100644 --- a/packages/Webkul/Admin/src/Routes/settings-routes.php +++ b/packages/Webkul/Admin/src/Routes/settings-routes.php @@ -13,6 +13,9 @@ use Webkul\Tax\Http\Controllers\TaxRateController; use Webkul\User\Http\Controllers\RoleController; use Webkul\User\Http\Controllers\UserController; +/** + * Settings routes. + */ Route::group(['middleware' => ['web', 'admin', 'admin_locale'], 'prefix' => config('app.admin_url')], function () { /** * Role routes. diff --git a/packages/Webkul/Admin/src/Routes/web.php b/packages/Webkul/Admin/src/Routes/web.php index f8045dd22..5b7a27fb2 100644 --- a/packages/Webkul/Admin/src/Routes/web.php +++ b/packages/Webkul/Admin/src/Routes/web.php @@ -16,7 +16,7 @@ require 'sales-routes.php'; require 'catalog-routes.php'; /** - * Customer routes. + * Customers routes. */ require 'customers-routes.php';