PHPackages                             qopiku/filament-sqids - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Security](/categories/security)
4. /
5. qopiku/filament-sqids

ActiveLibrary[Security](/categories/security)

qopiku/filament-sqids
=====================

A Laravel Filament package that automatically encodes and decodes model IDs using sqids/sqids for improved security and aesthetics.

0.0.1(8mo ago)2221↓100%1MITPHPPHP ^8.0

Since Aug 18Pushed 8mo agoCompare

[ Source](https://github.com/korfra/filament-sqids)[ Packagist](https://packagist.org/packages/qopiku/filament-sqids)[ Docs](https://github.com/qopiku/filament-sqids)[ RSS](/packages/qopiku-filament-sqids/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (2)Versions (2)Used By (0)

Filament Sqids
==============

[](#filament-sqids)

Filament Sqids is a Laravel package that automatically encodes and decodes model IDs using [sqids/sqids](https://github.com/sqids/sqids-php). By replacing numerical IDs with obfuscated Sqids, this package not only improves the aesthetics of your URLs but also provides an extra layer of security.

Table of Contents
-----------------

[](#table-of-contents)

- [Filament Sqids](#filament-sqids)
    - [Table of Contents](#table-of-contents)
    - [Features](#features)
    - [Installation](#installation)
    - [Configuration](#configuration)
    - [Usage](#usage)
        - [Using the Model Trait](#using-the-model-trait)
        - [Blade Directive](#blade-directive)
        - [Setup the Middleware](#setup-the-middleware)
            - [Via Panels](#via-panels)
            - [Via Specific Resources](#via-specific-resources)
    - [Testing](#testing)
    - [Contributing](#contributing)
    - [Licence](#licence)

Features
--------

[](#features)

- **Automatic Sqids Encoding**: Transform model IDs in your URLs (e.g. `/admin/users/1/edit` becomes `/admin/users/86Rf07xd4z/edit`).
- **Automatic Sqids Decoding**: Middleware decodes Sqids back to real IDs when processing requests.
- **Model Trait (`HasSqids`)**: Easily apply Sqids to any Filament model.
- **Filament Plugin (`SqidsPlugin.php`)**: Seamlessly integrate with Filament, overriding resource routes and actions.
- **Customisable Sqids Config**: Configure custom minimum length and alphabet via `filament-sqids.php`.
- **Blade Directive (`@sqids($model)`)**: Helper directive for generating Sqids in your Blade templates.
- **Artisan Command (`install:sqids`)**: Simplifies setup by publishing configuration files and verifying dependencies.

Installation
------------

[](#installation)

Install the package via Composer:

```
composer require qopiku/filament-sqids
```

If you wish to customise the configuration, run the install command:

```
php artisan install:filament-sqids
```

This command will publish the configuration file (`config/filament-sqids.php`) to your Laravel application.

Configuration
-------------

[](#configuration)

After installation, you can adjust your settings in the `config/filament-sqids.php` file. You may set:

- **min\_length**: The minimum length for the generated Sqids.
- **alphabet**: The alphabet used to generate the Sqids.

Usage
-----

[](#usage)

### Using the Model Trait

[](#using-the-model-trait)

Simply include the `HasSqids` trait in your model to enable Sqids functionality:

```
use Qopiku\FilamentSqids\Traits\HasSqids;

class User extends Authenticatable
{
    use HasSqids;

    // ...
}
```

You can then retrieve the Sqids for a model instance:

```
$user = User::find(1);
echo $user->getSqids();
```

You can query by Sqids for a model:

```
$user = User::findSqids($sqids);
$users = User::whereSqids($sqids)->get();
```

### Blade Directive

[](#blade-directive)

In your Blade templates, generate a Sqids easily with the provided directive:

```
@sqids($user)
```

This will output the encoded ID of the model.

### Setup the Middleware

[](#setup-the-middleware)

Middleware ensures that incoming requests with Sqids are automatically decoded into their corresponding numerical IDs. You can set it up in two ways:

#### Via Panels

[](#via-panels)

To apply the middleware globally to a Filament panel, include it in the panel's middleware stack:

```
use Filament\Panel;
use Filament\PanelProvider;
use Qopiku\FilamentSqids\Middleware\FilamentSqidsMiddleware;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->middleware([
                FilamentSqidsMiddleware::class, // Decodes Sqids for all routes in this panel
                // ...existing code...
            ]);
    }
}
```

#### Via Specific Resources

[](#via-specific-resources)

If you want to apply the middleware to specific resources only, you can define it in the resource's `$routeMiddleware` property:

```
use Filament\Resources\Resource;

class UserResource extends Resource
{
    public static array|string $routeMiddleware = [
        'filament-sqids', // Ensures Sqids are decoded for this resource's routes
    ];
}
```

Testing
-------

[](#testing)

The package includes a suite of tests to cover its key functionality:

- **Feature Tests**: Validate that URLs are correctly rewritten and that routes work as expected.
- **Unit Tests**: Ensure that the `SqidsManager`, middleware, and helper functions behave correctly.

To run the tests, simply execute:

```
vendor/bin/phpunit
```

Contributing
------------

[](#contributing)

Contributions are welcome! Feel free to open issues or submit pull requests if you have suggestions or improvements.

Licence
-------

[](#licence)

This package is open-sourced software licensed under the [MIT licence](LICENSE).

---

Enjoy building secure and aesthetically pleasing URLs with Filament Sqids!

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance58

Moderate activity, may be stable

Popularity18

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity30

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

267d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/31d60fa1ab84cc5a95db6220335228643c7c6b7777d77300421751a829fba331?d=identicon)[sooluh](/maintainers/sooluh)

---

Top Contributors

[![sooluh](https://avatars.githubusercontent.com/u/20874779?v=4)](https://github.com/sooluh "sooluh (7 commits)")

---

Tags

urllaravelsecurityencodingfilamentsqids

### Embed Badge

![Health badge](/badges/qopiku-filament-sqids/health.svg)

```
[![Health](https://phpackages.com/badges/qopiku-filament-sqids/health.svg)](https://phpackages.com/packages/qopiku-filament-sqids)
```

###  Alternatives

[tzsk/otp

A secure, database-free One-Time Password (OTP) generator and verifier for PHP and Laravel.

241641.4k1](/packages/tzsk-otp)[dgtlss/warden

A Laravel package that proactively monitors your dependencies for security vulnerabilities by running automated composer audits and sending notifications via webhooks and email

8745.6k](/packages/dgtlss-warden)[ercsctt/laravel-file-encryption

Secure file encryption and decryption for Laravel applications

642.6k](/packages/ercsctt-laravel-file-encryption)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)