drsoft/route-helper

A Laravel package for managing route parameter defaults.

v1.2.2 2024-12-25 14:16 UTC

Requires

• php: >=8.0
• illuminate/support: ^10.0

MIT

README

This package simplifies the use of default parameters for Laravel routes. It allows you to define default values for route parameters, automatically fill them when generating URLs, and provides helper functions for route generation and redirection.

Features

• Set and retrieve default route parameter values.
• Automatically include default parameters when generating URLs or redirecting to routes.
• Provides helper functions for route handling.

Installation

1. Install the package using Composer:

   composer require drsoft/route-helper

2. Add the service provider to your config/app.php file (if not automatically registered):

   'providers' => [
       Drsoft28\RouteHelper\RouteHelperServiceProvider::class,
   ],

3. Publish the configuration (optional):

   php artisan vendor:publish --provider="Drsoft28\\RouteHelper\\RouteHelperServiceProvider"

Usage

Setting Default Route Parameters

Use the route_defaults helper to set default values for route parameters:

route_defaults()->set('slug', 'default-slug');

Generating Routes with Default Parameters

Use the routeWithDefault function to generate a route URL:

$url = routeWithDefault('vendor.home');

If the parameter slug is not provided, it will use the default value set earlier.

Redirecting to Routes with Default Parameters

Use the to_routeWithDefault function for redirection:

return to_routeWithDefault('vendor.home');

Accessing Default Parameter Values

Retrieve a parameter's default value:

$slug = route_defaults()->get('slug');

Removing Default Parameter Values

Remove a default parameter value:

route_defaults()->remove('slug');

Example Scenario

1. Set a default value for slug:

   route_defaults()->set('slug', 'my-default-slug');

2. Generate a URL without passing the slug parameter:

   $url = routeWithDefault('vendor.home');
   echo $url; // Outputs: /my-default-slug/dashboard

3. Redirect to a route:

   return to_routeWithDefault('vendor.home');

Helpers Included

• route_defaults: Access the RouteParameterDefaults instance.
• routeWithDefault: Generate a route URL with default parameters.
• to_routeWithDefault: Redirect to a route with default parameters.

How It Works

The package binds a singleton instance of RouteParameterDefaults to the service container. This instance manages the default values for route parameters and integrates them seamlessly into Laravel's route generation and redirection mechanisms.

watch in youtube

https://youtu.be/kbAJRNHTK78

License

This package is open-source software licensed under the MIT license.