README

Generate unique urls for blogs, ecommerce and platforms without prefix. Laravel

Installation
Usage
Contributing

Goals:

When create or update a model to generate a unique url based on urlStrategy() function inside each model
Possibility to have different urls for the different languages (not only a prefix in the beginning)
If the url exists to create a new url with suffix _1, _2, etc.
If we update the model to create a redirect from the old to the new url
If there is a multiple redirects to redirect only to the last one
Possibility to have an url depending on relations (category-name/product-name)

Installation

You can install the package via composer:

composer require vlados/laravel-unique-urls

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravel-unique-urls-migrations"
php artisan migrate

Usage

Configuration

You can publish the config file with:

php artisan vendor:publish --tag="laravel-unique-urls-config"

There will create unique-urls.php with:

return [
    // Locale => $language
    'languages' => [
        'bg_BG' => 'bg',
        'en_US' => 'en',
        'de_DE' => 'de',
    ],
    'redirect_http_code' => 301,
];

Prepare your model

In your Model add these methods:

class MyModel extends Model
{
    use Vlados\LaravelUniqueUrls\HasUniqueUrls;

    public function urlStrategy($language,$locale): string
    {
        return Str::slug($this->getAttribute('name'),"-",$locale);
    }
    
    public function urlHandler(): array
    {
        return [
            // The controller used to handle the request
            'controller' => CategoryController::class,
            // The method
            'method' => 'view',
            // additional arguments sent to this method
            'arguments' => [],
        ];
    }

The method for handling the request:

public function view(Request $request, $arguments = [])
{
    dd($arguments);
}

Routes

And last, add this line at the end of your routes/web.php

Route::get('{urlObj}', [\Vlados\LaravelUniqueUrls\LaravelUniqueUrlsController::class, 'handleRequest'])->where('urlObj', '.*');

Batch import

If for example you have category tree and you need to import all the data before creating the urls, you can disable the automatic generation of the url on model creation To disable automatically generating the urls on create or update overwrite the method isAutoGenerateUrls in the model:

public function isAutoGenerateUrls(): bool
{
    return false;
}

and call generateUrl() later like this:

YourModel::all()->each(function (YourModel $model) {
    $model->generateUrl();
});

or if you want to disable it on the go, use

$model = new TestModel();
$model->disableGeneratingUrlsOnCreate();
$model->name = "Test";
$model->save();

Livewire

To use Livewire full-page component to handle the request, first set in urlHandler() function in your model:

public function urlHandler(): array
{
    return [
        // The Livewire controller
        'controller' => CategoryController::class,
        // The method should be empty
        'method' => '',
        // additional arguments sent to the mount() function
        'arguments' => [],
    ];
}

Example livewire component:

class LivewireComponentExample extends Component
{
    private Url $urlModel;
    private array $url_arguments;

    public function mount(Url $urlObj, $arguments = [])
    {
        $this->urlModel = $urlObj;
        $this->url_arguments = $arguments;
    }

    public function render()
    {
        return view('livewire.view-category');
    }
}

API

Commands

urls:generate

This command generates unique URLs for the specified model or all models in the application that implement the HasUniqueUrls trait.

Usage:

php artisan urls:generate [--model=ModelName] [--fresh] [--only-missing]

urls:doctor

This command checks if all models in the application have implemented the HasUniqueUrls trait and the required functions correctly.

Usage:

php artisan urls:doctor [--model=ModelName]

Checks

Check if all the methods are implemented with the right parameters
Check if the urlHandler is returning the correct controller and method
Check if urlStrategy is generating unique urls for all the languages

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Semantic Commit Messages

See how a minor change to your commit message style can make you a better programmer. Format: <type>(<scope>): <subject>

<scope> is optional

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

feat: (new feature for the user, not a new feature for build script)
fix: (bug fix for the user, not a fix to a build script)
docs: (changes to the documentation)
style: (formatting, missing semi colons, etc; no production code change)
refactor: (refactoring production code, eg. renaming a variable)
test: (adding missing tests, refactoring tests; no production code change)
chore: (updating grunt tasks etc; no production code change)

References:

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

vlados / laravel-unique-urls

Maintainers

Details

README

Goals:

Installation

Usage

Configuration

Prepare your model

Routes

Batch import

Livewire

API

Commands

urls:generate

Usage:

urls:doctor

Usage:

Checks

Testing

Changelog

Contributing

Semantic Commit Messages

Security Vulnerabilities

Credits

License