Web Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the package via Composer:

   composer require desarrolla2/web-bundle
   

   Publish the bundle's assets/config (if available):

   php artisan vendor:publish --provider="Desarrolla2\WebBundle\WebBundleServiceProvider"
   

2. First Use Case The package appears to offer "general features for web development." Check the routes/web.php for predefined routes (if any) or inspect the config/web-bundle.php for default configurations. Example:

   // Check if the bundle provides a base controller or middleware
   use Desarrolla2\WebBundle\Http\Controllers\BaseController;
   

3. Where to Look First

   • Service Provider: Desarrolla2\WebBundle\WebBundleServiceProvider (registers routes, bindings, etc.).
   • Config File: config/web-bundle.php (if published).
   • Routes: routes/web.php (look for bundle-specific routes).
   • Controllers/Views: Check vendor/desarrolla2/web-bundle/src/ for core functionality.

Implementation Patterns

Common Workflows

1. Extending Core Features If the bundle provides base controllers (e.g., BaseController), extend them:

   namespace App\Http\Controllers;
   
   use Desarrolla2\WebBundle\Http\Controllers\BaseController;
   
   class CustomController extends BaseController {
       // Override or extend methods
   }
   

2. Customizing Routes Override bundle routes in your routes/web.php:

   // Disable bundle routes (if needed)
   Route::get('/custom-path', [App\Http\Controllers\CustomController::class, 'method']);
   

3. Using Bundle Services If the bundle registers services (e.g., WebHelper), bind them in your AppServiceProvider:

   public function register() {
       $this->app->singleton('webHelper', function ($app) {
           return new \Desarrolla2\WebBundle\Services\WebHelper();
       });
   }
   

4. Blade Directives/Helpers If the bundle provides Blade helpers (e.g., @bundleDirective), add them to AppServiceProvider:

   Blade::directive('bundleDirective', function () {
       return "<?php echo Desarrolla2\WebBundle\Blade::bundleDirective(); ?>";
   });
   

5. Middleware Integration If the bundle includes middleware (e.g., WebMiddleware), register it in app/Http/Kernel.php:

   protected $middleware = [
       // ...
       \Desarrolla2\WebBundle\Http\Middleware\WebMiddleware::class,
   ];
   

Gotchas and Tips

Pitfalls

1. Archived Status The package is archived (no active maintenance). Verify core functionality works with your Laravel version (e.g., test on a staging environment first).

2. Lack of Documentation The README is minimal ("WebsiteBundle" with no details). Assume undocumented features may break or lack clarity. Use php artisan vendor:publish to inspect configs/routes.

3. Namespace Collisions The bundle uses Desarrolla2 namespace. Ensure no conflicts with your app’s namespaces (e.g., avoid naming classes WebBundle).

4. No Dependents Zero dependents suggest untested real-world use. Test thoroughly in isolation.

5. Config Overrides If the bundle publishes configs, always back up your config/ directory before publishing:

   cp -r config/ config.backup
   

Debugging Tips

1. Check Registered Bindings Dump the service container to verify bundle services:

   dd(app()->bindings());
   

2. Route Debugging List all registered routes to spot bundle routes:

   php artisan route:list
   

3. Middleware Debugging If middleware fails, check the Handle method in WebMiddleware or use Laravel’s middleware debugging:

   php artisan route:clear && php artisan config:clear
   

Extension Points

1. Override Controllers Copy bundle controllers to app/Http/Controllers/ and modify them (e.g., BaseController).

2. Customize Views If the bundle uses views (e.g., resources/views/vendor/web-bundle/), override them in your resources/views/ directory.

3. Add New Features Fork the package on GitHub to extend functionality, then use composer require your-fork/web-bundle.

4. Event Listeners If the bundle dispatches events (e.g., WebBundleEvents), listen to them in EventServiceProvider:

   protected $listen = [
       'Desarrolla2\WebBundle\Events\WebBundleEvent' => [
           'App\Listeners\CustomWebBundleListener',
       ],
   ];
   

Performance Notes

• Avoid Overhead: If the bundle adds unnecessary middleware or services, disable them in app/Http/Kernel.php or config/web-bundle.php.
• Caching: Clear caches after publishing configs:

  php artisan config:clear && php artisan view:clear