PHP code example of steven-fox / laravel-sqids

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

steven-fox / laravel-sqids example snippets

$idFromDatabase = 7391;

$decodedSqid = \StevenFox\LaravelSqids\Sqids\DecodedSqid::new($idFromDatabase);
$encodedSqid = $decodedSqid->encode(); // instance of EncodedSqid

echo $encodedSqid->id(); // '2h2L'

$decodeAgain = $encodedSqid->decode(); // instance of DecodedSqid

echo $decodeAgain->numbers(); // [7391]
echo $decodeAgain->toInt(); // 7391

$sqidFromRequest = '2h2L';

$encodedSqid = \StevenFox\LaravelSqids\Sqids\EncodedSqid::new($sqidFromRequest);
$decodedSqid = $encodedSqid->decode(); // instance of DecodedSqid

echo $decodedSqid->numbers(); // [7391]
echo $decodedSqid->toInt(); // 7391

\StevenFox\LaravelSqids\Facades\Sqidder::encode([7391]); // '2h2L'
\StevenFox\LaravelSqids\Facades\Sqidder::decode('2h2L'); // [7391]

// /config/sqids.php

return [
    // Specify the default Sqid configuration name.
    'default' => 'primary',

    // Specify one or more Sqid configurations that can be used as needed.
    'sqids' => [
    
        // This Sqid configuration will have a name of 'primary'.
        'primary' => [
            // Randomize IDs by specifying a custom/shuffled alphabet.
            'alphabet' => 'MGZAJbNxVrhm5Sz47URHwXQf1FPgvlc2ptjY9uLEianODyKCosBIkd0q3W6eT8',

            // Enforce a minimum length for the encoded Sqid.
            'minLength' => 0,
        ],
        
        // This Sqid configuration has a name of 'other'.
        'other' => [
            'alphabet' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789',
            'minLength' => 0,
        ],        
        
        // Perhaps this Sqid configuration is used for encoding/decoding User records.
        'user' => [
            'alphabet' => 'kQZlcRHnxL4GY6JW3Ir1weDK8MbOBztmqg7d02jp9UXyNTiSa5FEsvVPhAuofC',
            'minLength' => 0,
        ],
    ],

    // Prevent specific words from appearing anywhere in the encoded Sqids.
    'blocklist' => [
        '0rgasm',
        '1d10t',
        '1d1ot',
        ...
    ],
];

use StevenFox\LaravelSqids\Sqids\DecodedSqid;
use StevenFox\LaravelSqids\Sqids\EncodedSqid;

class UserDecodedSqid extends DecodedSqid
{
    public const CONFIG_NAME = 'user';
    public const ENCODED_SQID_CLASS = UserEncodedSqid::class;
}

$sqid = UserDecodedSqid::new($userId)->encode(); // instance of UserEncodedSqid

use StevenFox\LaravelSqids\Facades\Sqidder

// When a specific coder isn't specified,
// the coder for the default configuration will be used.
// The /config/sqids.php file above specifies the configuration
// named 'primary' should be used as the default.
Sqidder::encode([1]); // 'Ko'
Sqidder::encode([1, 2, 3]); // 'xjECV2'

Sqidder::decode('Ko'); // [1]
Sqidder::decode('xjECV2'); // [1, 2, 3]

// Specifying a config by name.
// The configuration *must* exist in the sqids config file.
// A \StevenFox\LaravelSqids\Exceptions\NamedSqidConfigurationNotFoundException will be thrown otherwise.
Sqidder::forConfig('other'); // A concrete SqidsInterface instance for the 'other' configuration.
Sqidder::forConfig('other')->encode([1]); // 'Uk'
Sqidder::forConfig('other')->decode('Uk'); // [1]

Sqidder::forConfig('does-not-exist'); // exception thrown

bash
php artisan vendor:publish --tag="laravel-sqids-config"