• 홈
• Airship
• Cabin
• Bridge
• Blueprint
• UserAccounts

PHP 클래스 Airship\Cabin\Bridge\Blueprint\UserAccounts

Manage user accounts 파일 보기 프로젝트 열기: paragonie/airship 1 사용 예제들

공개 메소드들

메소드	설명
countPublicUsers ( ) : integer	Get the number of users with a public profile.
createGroup ( array $post = [] ) : boolean	Create a new user group
createRecoveryToken ( integer $userID ) : string
createSessionCanary ( integer $userID ) : string
createUser ( array $post = [] ) : integer	Create a new user account
deleteGroup ( integer $groupId, integer $newParent ) : boolean
deleteRecoveryToken ( string $selector ) : boolean
deleteUser ( integer $userId ) : boolean
editGroup ( integer $groupId, array $post = [] ) : boolean	Edit a group.
editUser ( integer $userId, array $post = [] ) : boolean	Edit a user's account information
editUserCustomFields ( integer $userId, string $customFields = '[]' ) : boolean	Only change the custom fields.
getDirectory ( integer $offset, integer $limit = 20 ) : array	Get the user directory.
getGroup ( integer $groupId ) : array
getGroupChildren ( integer $groupId ) : array	Get all of the group IDs (not the contents) of a group's children
getGroupTree ( integer $parent, string $column = 'children', array $seen = [] ) : array	Get the group tree
getRecoveryData ( string $selector, integer $maxTokenLife ) : array	Get the data necessary to recover an account.
getRecoveryInfo ( string $username ) : array	Get account recovery information
getTwoFactorSecret ( integer $userID ) : string	Get the user's two-factor authentication secret
getUniqueId ( integer $userId ) : string	Get a user's unique ID
getUserAccount ( integer $userId, boolean $includeExtra = false ) : array	Get a user account given a user ID
getUserByUsername ( string $username, boolean $includeExtra = false ) : array	Get a user account, given a username
getUserIDByUsername ( string $username ) : integer
getUserPreferences ( integer $userId ) : array	Get a user's preferences
getUsersGroups ( integer $userId ) : array	Get all the groups that a user belongs to.
invalidateLongTermAuthTokens ( integer $userID ) : boolean	All long-term authentication tokens will be rendered invalid.
isPasswordWeak ( array $post ) : boolean	Is this password too weak?
isUsernameInvalid ( string $username ) : boolean	Is this username invalid? Currently not implemented but might be in the final version.
isUsernameTaken ( string $username ) : boolean	Is the username already taken by another account?
listUsers ( integer $offset, integer $limit, string $sortBy = 'userid', string $dir = 'ASC' ) : array	List users
numUsers ( ) : integer	How many users exist?
resetTwoFactorSecret ( integer $userID ) : boolean	Get the user's two-factor authentication secret
setPassphrase ( HiddenString $passphrase, integer $accountId ) : boolean	Reset a user's passphrase
toggleTwoFactor ( integer $userID, array $post ) : boolean	Save the user's two-factor-authentication preferences
updateAccountInfo ( array $post, array $account ) : mixed	Update the user's account information
updatePreferences ( integer $userId, array $preferences = [] ) : boolean	Store preferences for a user

보호된 메소드들

메소드	설명
deleteGroupCascade ( integer $groupId )	Overloadable in gadgets. Deletes all entries that depend on the group table.
deleteUserCascade ( integer $userId )	Overloadable in gadgets. Deletes all entries that depend on the user table.
generateUniqueId ( ) : string	Generate a unique random public ID for this user, which is distinct from the username they use to log in.

메소드 상세