FLEA_Rbac_UsersManager类参考

继承图，类FLEA_Rbac_UsersManager

所有成员的列表。

公有成员
	FLEA_Rbac_UsersManager ()
	findByUserId ($id, $fields= '*')
	findByUsername ($username, $fields= '*')
	findByEmail ($email, $fields= '*')
	existsUserId ($id)
	existsUsername ($username)
	existsEmail ($email)
	create (&$row)
	validateUser ($username, $password, $returnUserdata=false)
	changePassword ($username, $oldPassword, $newPassword)
	updatePassword ($username, $newPassword)
	updatePasswordById ($userid, $newPassword)
	checkPassword ($cleartext, $cryptograph)
	encodePassword ($cleartext)
	fetchRoles (&$user, $rolenameField= 'rolename')
	update (&$row)
	_beforeUpdateDb (&$row)
	_beforeCreateDb (&$row)
	_encodeRecordPassword (&$row)
公有属性
	$primaryKey = 'user_id'
	$tableName = 'users'
	$usernameField = 'username'
	$emailField = 'email'
	$passwordField = 'password'
	$rolesField = 'roles'
	$encodeMethod = PWD_CRYPT
	$autoValidating = true
	$functionFields

---

详细描述

在文件Rbac/UsersManager.php第44行定义。

---

成员函数文档

FLEA_Rbac_UsersManager::FLEA_Rbac_UsersManager

(

)

构造函数

在文件Rbac/UsersManager.php第118行定义。

FLEA_Rbac_UsersManager::findByUserId	(	$	id,
		$	fields = '*'
	)

返回指定 ID 的用户

参数:

	mixed	$id
	mixed	$fields

返回:

array

在文件Rbac/UsersManager.php第135行定义。

参考 FLEA_Db_TableDataGateway::$fields及FLEA_Db_TableDataGateway::findByField().

FLEA_Rbac_UsersManager::findByUsername	(	$	username,
		$	fields = '*'
	)

返回指定用户名的用户

参数:

	string	$username
	mixed	$fields

返回:

array

在文件Rbac/UsersManager.php第148行定义。

参考 FLEA_Db_TableDataGateway::$fields及FLEA_Db_TableDataGateway::findByField().

FLEA_Rbac_UsersManager::findByEmail	(	$	email,
		$	fields = '*'
	)

返回指定电子邮件的用户

参数:

	string	$email
	mixed	$fields

返回:

array

在文件Rbac/UsersManager.php第161行定义。

参考 FLEA_Db_TableDataGateway::$fields及FLEA_Db_TableDataGateway::findByField().

FLEA_Rbac_UsersManager::existsUserId

(

$

id

)

检查指定的用户ID是否已经存在

参数:

mixed

$id

返回:

boolean

在文件Rbac/UsersManager.php第173行定义。

参考 FLEA_Db_TableDataGateway::findCount().

FLEA_Rbac_UsersManager::existsUsername

(

$

username

)

检查指定的用户名是否已经存在

参数:

string

$username

返回:

boolean

在文件Rbac/UsersManager.php第185行定义。

参考 FLEA_Db_TableDataGateway::findCount().

FLEA_Rbac_UsersManager::existsEmail

(

$

email

)

检查指定的电子邮件地址是否已经存在

参数:

string

$email

返回:

boolean

在文件Rbac/UsersManager.php第197行定义。

参考 FLEA_Db_TableDataGateway::findCount().

FLEA_Rbac_UsersManager::create

(

&$

row

)

创建用户记录，返回新建用户记录的主键值

参数:

array

$row

返回:

mixed

在文件Rbac/UsersManager.php第209行定义。

FLEA_Rbac_UsersManager::validateUser	(	$	username,
		$	password,
		$	returnUserdata = false
	)

验证指定的用户名和密码是否正确，验证成功则更新用户的登录信息

参数:

	string	$username 用户名
	string	$password 密码
	boolean	$returnUserdata 指示验证通过后是否返回用户数据

返回:

boolean|array

public

在文件Rbac/UsersManager.php第230行定义。

参考 FLEA_Db_TableDataGateway::$fields、checkPassword()、FLEA_Db_TableDataGateway::findByField()及update().

FLEA_Rbac_UsersManager::changePassword	(	$	username,
		$	oldPassword,
		$	newPassword
	)

更新指定用户的密码

参数:

	string	$username 用户名
	string	$oldPassword 现在使用的密码
	string	$newPassword 新密码

返回:

boolean

public

在文件Rbac/UsersManager.php第300行定义。

参考 checkPassword()及FLEA_Db_TableDataGateway::findByField().

FLEA_Rbac_UsersManager::updatePassword	(	$	username,
		$	newPassword
	)

直接更新密码

参数:

	string	$username
	string	$newPassword

返回:

boolean

在文件Rbac/UsersManager.php第323行定义。

参考 FLEA_Db_TableDataGateway::findByField().

FLEA_Rbac_UsersManager::updatePasswordById	(	$	userid,
		$	newPassword
	)

直接更新密码

参数:

	mixed	$userId
	string	$newPassword

返回:

boolean

在文件Rbac/UsersManager.php第340行定义。

参考 FLEA_Db_TableDataGateway::findByField().

FLEA_Rbac_UsersManager::checkPassword	(	$	cleartext,
		$	cryptograph
	)

检查密码的明文和密文是否符合

参数:

	string	$cleartext 密码的明文
	string	$cryptograph 密文

返回:

boolean

public

在文件Rbac/UsersManager.php第359行定义。

参考自 changePassword()及validateUser().

FLEA_Rbac_UsersManager::encodePassword

(

$

cleartext

)

将密码明文转换为密文

参数:

string

$cleartext 要加密的明文

返回:

string

public

在文件Rbac/UsersManager.php第387行定义。

参考自 _encodeRecordPassword().

FLEA_Rbac_UsersManager::fetchRoles	(	&$	user,
		$	rolenameField = 'rolename'
	)

返回指定用户的角色名数组

参数:

	array	$user
	string	$rolenameField

返回:

array

在文件Rbac/UsersManager.php第414行定义。

FLEA_Rbac_UsersManager::update

(

&$

row

)

更新用户信息时，禁止更新密码字段

参数:

array

$row

返回:

boolean

在文件Rbac/UsersManager.php第437行定义。

参考自 validateUser().

FLEA_Rbac_UsersManager::_beforeUpdateDb

(

&$

row

)

在更新到数据库之前加密密码

重载FLEA_Db_TableDataGateway。

在文件Rbac/UsersManager.php第446行定义。

参考 _encodeRecordPassword().

FLEA_Rbac_UsersManager::_beforeCreateDb

(

&$

row

)

在更新到数据库之前加密密码

重载FLEA_Db_TableDataGateway。

在文件Rbac/UsersManager.php第455行定义。

参考 _encodeRecordPassword().

FLEA_Rbac_UsersManager::_encodeRecordPassword

(

&$

row

)

将记录里面的密码字段值从明文转为加密后的密文

参数:

array

$row

在文件Rbac/UsersManager.php第466行定义。

参考 encodePassword().

参考自 _beforeCreateDb()及_beforeUpdateDb().

---

成员数据文档

FLEA_Rbac_UsersManager::$primaryKey = 'user_id'

重载FLEA_Db_TableDataGateway。

在文件Rbac/UsersManager.php第51行定义。

FLEA_Rbac_UsersManager::$tableName = 'users'

重载FLEA_Db_TableDataGateway。

在文件Rbac/UsersManager.php第58行定义。

FLEA_Rbac_UsersManager::$usernameField = 'username'

在文件Rbac/UsersManager.php第65行定义。

FLEA_Rbac_UsersManager::$emailField = 'email'

在文件Rbac/UsersManager.php第72行定义。

FLEA_Rbac_UsersManager::$passwordField = 'password'

在文件Rbac/UsersManager.php第79行定义。

FLEA_Rbac_UsersManager::$rolesField = 'roles'

在文件Rbac/UsersManager.php第86行定义。

FLEA_Rbac_UsersManager::$encodeMethod = PWD_CRYPT

在文件Rbac/UsersManager.php第93行定义。

FLEA_Rbac_UsersManager::$autoValidating = true

重载FLEA_Db_TableDataGateway。

在文件Rbac/UsersManager.php第100行定义。

FLEA_Rbac_UsersManager::$functionFields

初始化序列：

 array(
        'registerIpField' => null,
        'lastLoginField' => null,
        'lastLoginIpField' => null,
        'loginCountField' => null,
        'isLockedField' => null,
    )

在文件Rbac/UsersManager.php第107行定义。

---

该类的文档由以下文件生成：

• Rbac/UsersManager.php

---