README

cryptUser 是一套 PHP 类文件，用于创建和管理用户账户。用户对象包括使用 OpenSSL 加密用户内容的能力。

安装

将类文件夹复制到您的 PHP 应用程序目录中。

如果您的应用程序使用 MySQL 数据源，则需要创建数据库和数据库用户。

如果您的应用程序使用 JSON 数据源，则需要创建存储 JSON 文件的目录，并确保您的应用程序具有读写权限。

开发

使用 cryptUser 进行开发只需要在您的应用程序中使用 CryptDataSource 和 CryptUser 实例。将 CryptDataSource 实例（无论是 JSON 还是 MySQL）传递给新的 CryptUser 实例，然后在您的 PHP 应用程序中执行各种用户函数。

CryptDataSource

CryptDataSource 是一个接口类，用于在数据源定义中指定所需的功能。因此，您必须根据接口创建完成类的实例才能使用数据源。

API 包含两个数据源实现，CryptJSONSource 和 CryptMySQLSource。这些类都提供了接口所需的功能之外的功能。例如，CryptJSONSource 提供了一些自定义函数，可以由您的应用程序用于读取和写入自己的 JSON 格式文件。CryptMySQLSource 提供了生成创建数据库中用户表的所需 SQL 的函数。有关详细信息，请参阅 API 文档。

CryptUser

CryptUser 类提供了用户管理和访问用户加密功能的功能。

示例

源代码树中包含一个 Examples 目录，其中您可以找到一些简单的示例脚本和应用程序，它们使用 JSON 和 MySQL 数据源。

这些示例将演示如何使用 API 创建自己的用户管理页面，以及如何在您的应用程序中实现加密功能。

文档

源代码树中包含一个 Documentation 目录，其中包含使用 APIGen 从源代码生成的 HTML 文档。

API 文档可以在此查看：http://bnielsen1965.github.io/cryptUser/。

测试

Tests 目录包含 phpunit 测试文件。将此目录复制到您的 PHP 应用程序目录中，然后运行 phpunit Tests/。

在 Examples/ 目录中也有 JSON 或 MySQL 数据源的示例实现。JSON 示例需要目录具有适当的写入权限，以便能够写入基于 JSON 的数据文件。使用 MySQL 示例时，必须提供数据库，并在示例 index.php 文件中设置适当的连接设置。

分支策略

master

master 分支包含稳定发布版本。

full

full 分支包含稳定发布版本以及所有文档和示例。

develop

develop 分支包含开发中的不稳定代码。

bsn / cryptuser

维护者

详细信息