vdlp/oc-hashids-plugin

Allows developers to use secure hashed ID's in October CMS powered websites.

2.2.0 2022-11-28 09:05 UTC

Requires

• php: ^8.0.2
• composer/installers: ^1.0 || ^2.0
• hashids/hashids: ^4.1
• october/rain: >=2.0

GPL-2.0-only

• Van der Let & Partners

README

Vdlp.Hashids

Allows developers to use secure hashed ID's.

Fetches RSS/Atom feeds to put on your website. It can be automated using a cronjob or triggered manually.

It converts numbers like 347 into strings like "yr8", or array of numbers like [27, 986] into "3kTMd".

You can also decode those ids back. This is useful in bundling several parameters into one or simply using them as short UIDs.

Requirements

• PHP 8.0.2 or higher
• October CMS 2.x or higher

Installation

composer require vdlp/oc-hashids-plugin

Configuration

To configure this plugin execute the following command:

php artisan vendor:publish --provider="Vdlp\Hashids\ServiceProvider" --tag="config"

This will create a config/hashids.php file in your app where you can modify the configuration.

Example

Here you can see an example of how to use this plugin. Out of the box, the default configuration used is main.

// You can use this class with Dependency Injection
use Vdlp\Hashids\Classes\HashidsManager;

/** @var HashidsManager $hashids */
$hashidsManager = resolve(HashidsManager::class);

// Encodes the integer 1 to a hashid using the default configuration
$hashidsManager->encode(1);
$hashidsManager->instance()->encode(1);

// Encodes the integer 1 to a hashid using a different configuration
$hashidsManager->instance('different-configuration')->encode(1);

Questions? Need help?

If you have any question about how to use this plugin, please don't hesitate to contact us at [e-mail]. We're happy to help you. You can also visit the support forum and drop your questions/issues there.