Popularity
0.6
Growing
Activity
0.0
Stable
1
1
0

Description

Useful lib to use with your rest api to encode/decode internal id values.

Monthly Downloads: 0
Programming language: PHP
License: MIT License
Tags: API     PHP7     REST     Hal     Zend-expressive    
Latest version: v1.0

icanhazstring/expressive-hashids-middleware alternatives and similar libraries

Based on the "API" category

Do you think we are missing an alternative of icanhazstring/expressive-hashids-middleware or a related project?

Add another 'API' Library

README

icanhazstring/expressive-hashids-middleware

PSR-15/PSR-7 compliant middleware using ivanakimov/hashids.php

Build Status Code Climate Test Coverage

Install

You can install the expressive-hashids-middleware library with composer:

$ 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:

$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:

$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.

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.

class ConfigProvider
{
    public function __invoke(): array
    {
        return [
            'hydrators' => [
                'delegators' => [
                    ArraySerializable::class => [
                        \icanhazstring\Hashids\Hydrator\HashidsHydratorDelegatorFactory:class
                    ]
                ]
            ],
        ];
    }
}