roukmoute/hashids-bundle

Integrates hashids/hashids in a Symfony project

Tuesday, March 27, 2018
by roukmoute
Repository
1 Watchers
22 Stars
11,617 Installations

PHP
0 Dependents
0 Suggesters
5 Forks
0 Open issues
19 Versions
11 % Grown

The README.md

Packagist Downloads , _(*1)

HashidsBundle

Integrates hashids/hashids in a Symfony project., _(*2)

Installation using composer

These commands requires you to have Composer installed globally.
Open a command console, enter your project directory and execute the following commands to download the latest stable version of this bundle:, _(*3)

Using Symfony Flex

    composer config extra.symfony.allow-contrib true
    composer req roukmoute/hashids-bundle

Using Symfony Framework only

    composer require roukmoute/hashids-bundle

If this has not been done automatically, enable the bundle by adding the following line in the config/bundles.php file of your project:, _(*4)

<?php

return [
    …,
    Roukmoute\HashidsBundle\RoukmouteHashidsBundle::class => ['all' => true],
];

Configuration

The configuration (config/packages/roukmoute_hashids.yaml) looks as follows :, _(*5)

roukmoute_hashids:

    # if set, the hashids will differ from everyone else's
    salt:            ""

    # if set, will generate minimum length for the id
    # 0 — meaning hashes will be the shortest possible length
    min_hash_length: 0

    # if set, will use only characters of alphabet string
    alphabet:        "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"

    # if set to true, it will continue with the next available param converters
    passthrough:     false

    # if set to true, it tries to convert all arguments passed to the controller
    auto_convert:    false

Usage


use Hashids\HashidsInterface;

public function postShow(HashidsInterface $hashids): Response
{
    $hashids->…
}

Next it's the same things of official documentation., _(*6)

Hashids Converter

Converter Name: hashids.converter, _(*7)

The hashids converter attempts to convert any attribute set in the route into an integer parameter., _(*8)

You could use hashid or id:, _(*9)

/**
 * @Route("/users/{hashid}")
 */
public function getAction(int $user)
{
}

or, _(*10)

/**
 * @Route("/users/{id}")
 */
public function getAction(int $user)
{
}

You could have several hashids in the same URL prefixed with _hash_., _(*11)

/**
 * @Route("/users/{_hash_user}/status/{_hash_status}")
 */
public function getAction(int $user, int $status)
{
}

The keys must be the same as in parameters controller:, _(*12)

/**
 *                          _hash_user _hash_status
 *                                 ↕            ↕
 * public function getAction(int $user, int $status)
 */

You will receive a LogicException if a hash could not be decoded correctly., _(*13)

Using auto_convert

auto_convert tries to convert all arguments in controller., _(*14)

roukmoute_hashids:
  auto_convert: true

Base on the example above:, _(*15)

/**
 * @Route("/users/{user}/status/{status}")
 */
public function getAction(int $user, int $status)
{
}

It will not be possible to get an exception of type LogicException from the bundle if it is activated., _(*16)

Using passthrough

passthrough allows to continue with the next available param converters.
So if you would like to retrieve an object instead of an integer, just active passthrough :, _(*17)

roukmoute_hashids:
    passthrough: true

Base on the example above:, _(*18)

/**
 * @Route("/users/{hashid}")
 */
public function getAction(User $user)
{
}

As you can see, the passthrough feature allows to use DoctrineParamConverter or any another ParamConverterInterface you would have created., _(*19)

Twig Extension

Usage

{{ path('users.show', {'hashid': user.id | hashids_encode }) }}
{{ app.request.query.get('hashid') | hashids_decode }}

The Versions

27/03 2018

dev-master

9999999-dev

Integrates hashids/hashids in a Symfony project

symfony-bundle hashids-bundle

Integrates hashids/hashids in a Symfony project

roukmoute/hashids-bundle

The README.md

HashidsBundle

Installation using composer

Using Symfony Flex

Using Symfony Framework only

Configuration

Usage

Hashids Converter

Using auto_convert

Using passthrough

Twig Extension

Usage

The Versions

dev-master

The Requires

The Development Requires

by Mathias STRASSER

v2.0.0

The Requires

The Development Requires

by Mathias STRASSER

v2.0.x-dev

The Requires

The Development Requires

by Mathias STRASSER

v1.5.1

The Requires

The Development Requires

by Mathias STRASSER

v1.5.0

The Requires

The Development Requires

by Mathias STRASSER

v1.4.5

The Requires

The Development Requires

by Mathias STRASSER

v1.4.4

The Requires

The Development Requires

by Mathias STRASSER

v1.4.3

The Requires

The Development Requires

by Mathias STRASSER

v1.4.2

The Requires

The Development Requires

by Mathias STRASSER

v1.4.1

The Requires

by Mathias STRASSER

v1.4.0

The Requires

by Mathias STRASSER

v1.3.3

The Requires

by Mathias STRASSER

v1.3.2

The Requires

by Mathias STRASSER

v1.3.1

The Requires

by Mathias STRASSER

v1.3

The Requires

by Mathias STRASSER

v1.2.1

The Requires

by Mathias STRASSER

v1.2

The Requires

by Mathias STRASSER

v1.1

The Requires

by Mathias STRASSER

v1.0