README

PHP 随机 KeyGenerator 是一个多功能的 PHP 库，用于生成不同长度的随机密钥。它是创建安全认证令牌、唯一标识符或随机访问密钥的必要工具。

功能

• 多用途：可用于生成认证令牌、唯一标识符或随机访问密钥等各种目的。
• 简单易用：提供简单易用的接口，便于集成到项目中。
• 现代 PHP 兼容性：兼容 PHP 8.1 及更高版本，确保与现代 PHP 环境的兼容性。
• PSR-4 自动加载：遵循 PSR-4 自动加载标准，无缝集成到基于 Composer 的项目中。

直接安装

您可以直接在项目中引入文件

require '/path/to/src/KeyGenerator.php';

通过 Composer 安装

您也可以通过 Composer 安装此包。运行以下命令

composer require ucscode/keygenerator

使用方法

use Ucscode\KeyGenerator\KeyGenerator;

// Create a new instance of the key generator
$keyGenerator = new KeyGenerator();

// Generate a random key of length 10
$key = $keyGenerator->generateKey(10);

实例配置

可选地，您可以配置 KeyGenerator 实例

/**
 * Generate random keys between 'A' and 'Z'
 * 
 * @param string|array
 */
$keyGenerator->setCharacters(range('A', 'Z'));

/** 
 * This will also generate random keys between 'A' and 'Z' 
 * 
 * @param string|array
 */
$keyGenerator->setCharacters('ABCDEFGHIJKLMNOPQRSTUVWXYZ');

/**
 * Add more possible characters to the list of generated keys
 * 
 * @param string|array
 */
$keyGenerator->addCharacters(['#', '@', '%']);

/**
 * Remove one or more possible character from the list
 * 
 * The "@" symbol will not be part of possible value from the characters
 * 
 * @param string|array
 */
$keyGenerator->removeCharacters('@');

/**
 * Apply usage of the system default special characters
 * 
 * By default, if no configuration is made, the key generator will only contain alpha numeric outputs
 * 
 * @param bool
 */
$keyGenerator->applySpecialCharacters(true);

许可证

Ucscode KeyGenerator 是开源软件，采用 MIT 许可证。

支持

如果您在使用此包时遇到任何问题或有任何疑问，请随时在 GitHub 上 提交问题。