https://github.com/cybercog/laravel-optimus
Transform your internal id's to obfuscated integers based on Knuth's integer hash. Laravel wrapper for the Optimus Library by Jens Segers with multiple connections support.
https://github.com/cybercog/laravel-optimus
cog cybercog decrypt encrypt hashids id laravel obfuscate optimus package php public-id
Last synced: 2 months ago
JSON representation
Transform your internal id's to obfuscated integers based on Knuth's integer hash. Laravel wrapper for the Optimus Library by Jens Segers with multiple connections support.
- Host: GitHub
- URL: https://github.com/cybercog/laravel-optimus
- Owner: cybercog
- License: mit
- Created: 2017-01-02T07:31:18.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-25T12:21:10.000Z (7 months ago)
- Last Synced: 2025-07-02T05:19:15.049Z (3 months ago)
- Topics: cog, cybercog, decrypt, encrypt, hashids, id, laravel, obfuscate, optimus, package, php, public-id
- Language: PHP
- Homepage: https://komarev.com/sources/laravel-optimus
- Size: 104 KB
- Stars: 188
- Watchers: 2
- Forks: 14
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Laravel Optimus
## Introduction
Laravel wrapper for the [Optimus Library](https://github.com/jenssegers/optimus) by [Jens Segers](https://github.com/jenssegers) with multiple connections support. Optimus is a small open-source library that generates short, unique, non-sequential ids from numbers. With this library, you can transform your internal id's to obfuscated integers based on Knuth's integer hash. It is similar to Hashids, but will generate integers instead of random strings. It is also super fast.
## Contents
- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Examples](#examples)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Testing](#testing)
- [Security](#security)
- [Contributors](#contributors)
- [Alternatives](#alternatives)
- [License](#license)
- [About CyberCog](#about-cybercog)
## Features
- Configurable multiple Optimus connections support.
- Implicit route model binding.
- Designed to work with Laravel Eloquent models.
- Dependency Injection ready.
- Includes Facade.
- Following PHP Standard Recommendations:
- [PSR-1 (Basic Coding Standard)](http://www.php-fig.org/psr/psr-1/).
- [PSR-2 (Coding Style Guide)](http://www.php-fig.org/psr/psr-2/).
- [PSR-4 (Autoloading Standard)](http://www.php-fig.org/psr/psr-4/).
- Covered with unit tests.
## Installation
First, pull in the package through Composer.
```shell
composer require cybercog/laravel-optimus
```
#### Register Package Manually (optional)
If you disabled package auto-discovery you can register it manually.
Include the service provider within `app/config/app.php`.
```php
'providers' => [
Cog\Laravel\Optimus\Providers\OptimusServiceProvider::class,
],
```
If you want you can use the [facade](http://laravel.com/docs/facades). Add the reference in `config/app.php` to your aliases array.
```php
'aliases' => [
'Optimus' => Cog\Laravel\Optimus\Facades\Optimus::class,
],
```
## Configuration
Laravel Optimus requires connection configuration. To get started, you'll need to publish config file:
```shell
php artisan vendor:publish --provider="Cog\Laravel\Optimus\Providers\OptimusServiceProvider" --tag="config"
```
This will create a `config/optimus.php` file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.
#### Default Connection Name
This option `default` is where you may specify which of the connections below you wish to use as your default connection for all work. Of course, you may use many connections at once using the manager class. The default value for this setting is `main`.
#### Optimus Connections
This option `connections` is where each of the connections are setup for your application. Example configuration has been included, but you may add as many connections as you would like.
#### Optimus numbers generation
To get started you will need 3 keys in main connection;
- `prime`: Large prime number lower than `2147483647`
- `inverse`: The inverse prime so that `(PRIME * INVERSE) & MAXID == 1`
- `random`: A large random integer lower than `2147483647`
Luckily for you, there is console command that can do all of this for you, just run the following command:
```shell
php vendor/bin/optimus spark
```
Copy-paste generated integers to your connection config.
## Usage
#### OptimusManager
This is the class of most interest. It is bound to the ioc container as `optimus` and can be accessed using the `Facades\Optimus` facade. This class implements the ManagerInterface by extending AbstractManager. The interface and abstract class are both part of [Graham Campbell's](https://github.com/GrahamCampbell) [Laravel Manager](https://github.com/GrahamCampbell/Laravel-Manager) package, so you may want to go and checkout the docs for how to use the manager class over at that repository. Note that the connection class returned will always be an instance of `Jenssegers\Optimus\Optimus`.
#### Facades\Optimus
This facade will dynamically pass static method calls to the `optimus` object in the ioc container which by default is the `OptimusManager` class.
#### Providers\OptimusServiceProvider
This class contains no public methods of interest. This class should be added to the providers array in `config/app.php`. This class will setup ioc bindings.
#### Traits\OptimusEncodedRouteKey
This trait can be used in an Eloquent model to enable automatic route model binding. You can then type hint a model in a route closure or a controller and Laravel will try to find it based on the encoded ID.
### Examples
Here you can see an example of just how simple this package is to use. Out of the box, the default adapter is `main`. After you enter your authentication details in the config file, it will just work:
#### Encode ID
```php
Cog\Laravel\Optimus\Facades\Optimus::encode(20); // 1535832388
```
#### Decode ID
```php
Cog\Laravel\Optimus\Facades\Optimus::decode(1535832388); // 20
```
#### Alter Optimus connection
The Optimus manager will behave like it is a `Jenssegers\Optimus\Optimus`. If you want to call specific connections, you can do that with the connection method:
```php
use Cog\Laravel\Optimus\Facades\Optimus;
// Writing this…
Optimus::connection('main')->encode($id);
// …is identical to writing this
Optimus::encode($id);
// and is also identical to writing this.
Optimus::connection()->encode($id);
// This is because the main connection is configured to be the default.
Optimus::getDefaultConnection(); // This will return main.
// We can change the default connection.
Optimus::setDefaultConnection('alternative'); // The default is now alternative.
```
#### Dependency Injection
If you prefer to use dependency injection over facades like me, then you can inject the manager:
```php
use Cog\Laravel\Optimus\OptimusManager;
class Foo
{
protected $optimus;
public function __construct(OptimusManager $optimus)
{
$this->optimus = $optimus;
}
public function bar($id)
{
return $this->optimus->encode($id)
}
}
app()->make('Foo')->bar(20);
```
#### Implicit route model binding
To enable [implicit route model binding](https://laravel.com/docs/5.5/routing#implicit-binding) based on the encoded ID, all you need to do is [configure the prime numbers](#optimus-numbers-generation) and use the `Cog\Laravel\Optimus\Traits\OptimusEncodedRouteKey` trait in your model.
If you don't want to use the default Optimus connection, you can specify a custom connection by adding an `$optimusConnection` property to you model.
```php
use Cog\Laravel\Optimus\Traits\OptimusEncodedRouteKey;
use Illuminate\Database\Eloquent\Model;
class YourModel extends Model
{
use OptimusEncodedRouteKey;
protected $optimusConnection = 'custom'; // optional
}
```
Now you can type hint your model in a route closure or controller and Laravel will use the encoded ID to query the database.
*Note: Implicit route model binding requires Laravel's `Illuminate\Routing\Middleware\SubstituteBindings` middleware, which is part of the `web` middleware group.*
```php
Route::get('url/to/{model}', function (YourModel $model) {
// ...
})->middleware('web');
```
To generate URL's to these routes you can either get the encoded route key:
```php
$encodedId = $model->getRouteKey();
$url = url("url/to/{$encodedId}");
```
Or you can use named routes and pass it the model. Laravel will do the rest.
```php
$url = route('my.named.route', $model);
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Testing
Run the tests with:
```shell
vendor/bin/phpunit
```
## Security
If you discover any security related issues, please email anton@komarev.com instead of using the issue tracker.
## Contributors
| 
Anton Komarev | 
Ivan Vermeyen | 
Christopher Turner | @ahmedbally
Ahmed Bally |
| :---: | :---: | :---: | :---: |
[Laravel Optimus contributors list](../../contributors)
Package was inspired by [Laravel Hashids](https://github.com/vinkla/laravel-hashids) package.
This package is a wrapper for [Optimus Library](https://github.com/jenssegers/optimus).
## Alternatives
- [vinkla/laravel-hashids](https://github.com/vinkla/laravel-hashids)
- [propaganistas/laravel-fakeid](https://github.com/Propaganistas/Laravel-FakeId)
*Feel free to add more alternatives as Pull Request.*
## License
- `Laravel Optimus` package is open-sourced software licensed under the [MIT license](LICENSE) by [Anton Komarev].
## 🌟 Stargazers over time
[](https://yhype.me?utm_source=github&utm_medium=cybercog-laravel-optimus&utm_content=chart-repository-star-cumulative)
## About CyberCog
[CyberCog](https://cybercog.su) is a Social Unity of enthusiasts. Research the best solutions in product & software development is our passion.
- [Follow us on Twitter](https://twitter.com/cybercog)
- [Read our articles on Medium](https://medium.com/cybercog)
[Anton Komarev]: https://komarev.com