Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icanhazstring/expressive-hashids-middleware
PSR-15/PSR-7 compliant middleware using ivanakimov/hashids.php
https://github.com/icanhazstring/expressive-hashids-middleware
hashids middleware psr-15 psr-7
Last synced: 19 days ago
JSON representation
PSR-15/PSR-7 compliant middleware using ivanakimov/hashids.php
- Host: GitHub
- URL: https://github.com/icanhazstring/expressive-hashids-middleware
- Owner: icanhazstring
- License: mit
- Created: 2018-05-22T19:01:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-05-23T11:46:01.000Z (over 6 years ago)
- Last Synced: 2024-10-11T01:06:33.698Z (about 1 month ago)
- Topics: hashids, middleware, psr-15, psr-7
- Language: PHP
- Size: 16.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# icanhazstring/expressive-hashids-middleware
PSR-15/PSR-7 compliant middleware using ivanakimov/hashids.php
[](https://travis-ci.org/icanhazstring/expressive-hashids-middleware) [](https://codeclimate.com/github/icanhazstring/expressive-hashids-middleware) [](https://codeclimate.com/github/icanhazstring/expressive-hashids-middleware/coverage)
## Install
You can install the *expressive-hashids-middleware* library with composer:
```bash
$ composer require icanhazstring/expressive-hashids-middleware
```
## Workflow
The main purpose of the middleware is to obfuscate internal IDs from the outside world.
That said, you don't have to change your internal id handling (like autoincrement in your db) to
use this middleware.
Any incoming request in the form of `/api/resource/{id}` will be decoded using this middleware.
So for example (default configuration):
`/api/user/ABC` (where `ABC` is the encoded value) will produce request attributes like this:
```php
$attributes = $request->getAttributes();
/*
[
'id' => 'ABC',
'__hashids_identifier' => 1
]
*/
```
> The middleware **won't override** attributes!
> You can use the `HashidsMiddleware::ATTRIBUTE` constant to easy access this attribute.
## Usage
### Using expressive
Include the `HashidsConfigProvider` inside your `config/config.php`:
```php
$aggregator = new ConfigAggregator([
...
\icanhazstring\Hashids\HashidsConfigProvider::class,
...
]);
```
Make sure the `HashidsConfigProvider` is included before your autoload files!
### Custom configuration
If you want to change parameters of `Hashids`, simply provide the
`HashidsConfigProvider::CONFIG_KEY` inside your autoload configuration and change the values to your desire.
```php
return [
\icanhazstring\Hashids\HashidsConfigProvider::CONFIG_KEY => [
'salt' => '',
'minHashLength' => 0,
'alphabet' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',
'resource_identifiert' => 'id'
]
];
```
### Using the strategy
If you want, you can use the hydration/extraction strategy provided to decode/encode data
from and into your objects.
To use the strategy, simply use the provided delegator `HashidsHydratorDelegatorFactory` and append
it as delegator for your hydrator.
```php
class ConfigProvider
{
public function __invoke(): array
{
return [
'hydrators' => [
'delegators' => [
ArraySerializable::class => [
\icanhazstring\Hashids\Hydrator\HashidsHydratorDelegatorFactory:class
]
]
],
];
}
}
```