README

构建状态:

最强大、最简单的库，用于添加可定制的用户管理系统

• 密码以哈希（MD5）形式存储
• 面向对象：每个用户都是一个对象
• 非常简单，只有两个对象：User（单个用户）和UsersManagement（环境）
• 与 mysqltcs 集成
• 使用已建立的数据库连接（mysqltcs 连接）
• ApiKey 支持
• 启用用户支持
• 盐支持（更安全）
• 可扩展

#下载 ##获取/更新 composer 此库需要 composer（在此下载 composer https://getcomposer.org.cn/）

更新 composer

php composer.phar self-update

##下载

通过 composer require 下载（我们建议为此创建一个专用目录）

php composer.phar require thecsea/users-management

或者将库作为依赖项插入到您的 composer 项目中

thecsea/users-management": "1.0.*

在后一种情况下，您必须安装或更新项目

php composer.phar install

或者

php composer.phar update

注意。如果您没有访问服务器终端，您可以在您的电脑上执行安装，然后通过 ftp 上传所有内容

##更新 users-management

您可以更新 users-management（根据在 composer.json 中设置的版本限制）

php composer.phar update

#使用

示例尚未实现，尽管您可以通过查看 tests 了解如何使用此库

##首次使用

您必须导入sql结构 tests/usersManagement.sql

##简单示例

<?php
require_once(__DIR__."/vendor/autoload.php"); //composer autoload
$db = require(__DIR__."/config.php"); //mysql connection data as array
use it\thecsea\mysqltcs\Mysqltcs;
use it\thecsea\users_management\UsersManagement;
use it\thecsea\users_management\User;
$connection = new Mysqltcs($db['host'],  $db['user'], $db['psw'], $db['db']); //myslqtcs connection
$usersManagement = new UsersManagement($connection, $db['tables']['users'], "salt"); //environment
$user = User::newUser($usersManagement, "t", "tt@hhh.it", "gggg"); //new user, already inserted in db
$user2 = User::getUserByLogin($usersManagement, "tt@hhh.it", "gggg"); //LOGIN get user checking password
$users = $usersManagement->getUsers(); //get list of users
print_r($users[0]->getUserInfo()); //print user info (associative matrix) 
?>

注意：config.php是一个包含mysql连接数据的数组文件。

注意：您必须包含composer自动加载才能使用此库

##工作原理此库完全面向对象，因此具有tostring、equals（用户）、clone等方法

###异常此库使用异常来显示错误，每个方法都可以抛出两个异常

• UsersManagementException 在逻辑错误（例如密码错误）时抛出
• Mysqltcsexception 在mysql错误（例如数据库权限问题）时抛出

###方法和文档用户包含其他有用的方法，您可以通过查看phpdoc了解如何使用这些方法

###盐此库支持盐，为了更高的安全性，您可以通过构造函数或setter指定它，或者您可以选择忽略它并使用默认的盐"thecsea"

###额外功能此库包括一些额外功能，如apiKey字符串和每个用户的启用标志，您可以使用这些信息，此类仅提供插入和更新这些信息的方法

注意：此类为每个用户创建一个唯一的apiKey（默认行为）

###数据库访问您显然可以访问数据库，但我们建议不要修改结构。

#测试

此库经过测试，您可以在tests下找到测试，覆盖率：

致谢

• Mysqltcs：连接到mysql数据库的php库

由 thecsea.it 提供