sqids php

sqids php

Sqids ( pronuncia-se "squids" ) é uma pequena biblioteca que permite gerar IDs exclusivos a partir de números . É bom para encurtamento de links, geração de ID rápida e segura para URL e decodificação em números para pesquisas mais rápidas no banco de dados.

Características:

• Codifique vários números - gere IDs curtos de um ou vários números não negativos
• Decodificação rápida - decodifique facilmente IDs de volta em números
• IDs exclusivos - gere IDs exclusivos embaralhando o alfabeto uma vez
• Preenchimento de ID - fornece comprimento mínimo para tornar os IDs mais uniformes
• URL seguro – IDs gerados automaticamente não contêm palavrões comuns
• Saída aleatória – A entrada sequencial fornece IDs não consecutivos
• Muitas implementações – Suporte para mais de 40 linguagens de programação

? Casos de uso

Bom para:

• Gerando IDs para URLs públicos (por exemplo: encurtamento de link)
• Geração de IDs para sistemas internos (por exemplo: rastreamento de eventos)
• Decodificação para pesquisas mais rápidas no banco de dados (por exemplo: por chaves primárias)

Não é bom para:

• Dados confidenciais (esta não é uma biblioteca de criptografia)
• IDs de usuário (podem ser decodificados revelando a contagem de usuários)

Começando

Exija este pacote, com o Composer, no diretório raiz do seu projeto.

composer require sqids/sqids

Então você pode importar a classe para sua aplicação:

 use Sqids  Sqids ;
$ sqids = new Sqids ();

Importante

Sqids requerem a extensão bcmath ou gmp para funcionar.

?‍ Exemplos

Codificação e decodificação simples:

 $ sqids = new Sqids ();
$ id = $ sqids -> encode ([ 1 , 2 , 3 ]); // "86Rf07"
$ numbers = $ sqids -> decode ( $ id ); // [1, 2, 3] 

Observação

? Devido ao design do algoritmo, vários IDs podem ser decodificados novamente na mesma sequência de números . Se for importante para o seu design que os IDs sejam canônicos, você deverá recodificar manualmente os números decodificados e verificar se o ID gerado corresponde.

Imponha um comprimento mínimo para IDs:

 $ sqids = new Sqids (minLength: 10 );
$ id = $ sqids -> encode ([ 1 , 2 , 3 ]); // "86Rf07xd4z"
$ numbers = $ sqids -> decode ( $ id ); // [1, 2, 3]

Randomize IDs fornecendo um alfabeto personalizado:

 $ sqids = new Sqids (alphabet: ' FxnXM1kBN6cuhsAvjW3Co7l2RePyY8DwaU04Tzt9fHQrqSVKdpimLGIJOgb5ZE ' );
$ id = $ sqids -> encode ([ 1 , 2 , 3 ]); // "B4aajs"
$ numbers = $ sqids -> decode ( $ id ); // [1, 2, 3]

Evite que palavras específicas apareçam em qualquer lugar nos IDs gerados automaticamente:

 $ sqids = new Sqids (blocklist: [ ' 86Rf07 ' ]);
$ id = $ sqids -> encode ([ 1 , 2 , 3 ]); // "se8ojk"
$ numbers = $ sqids -> decode ( $ id ); // [1, 2, 3] 

Licença

MIT