Download the PHP package nestboxphp/titmouse without Composer
On this page you can find all versions of the php package nestboxphp/titmouse. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nestboxphp/titmouse
More information about nestboxphp/titmouse
Files in nestboxphp/titmouse
Package titmouse
Short Description User registration and session management with built-in password best-practices.
License AGPL-3.0
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package titmouse
Titmouse
A user management interface that can register, login, and logout users while adhering to standard security practices for password handling.
Usage
Titmouse requries Nestbox to function
Settings
| Setting | Description | Default |
|---|---|---|
| usersTable | Defines the table name in which user data is stored. | users |
| userColumn | Defines the column name which identifies the unique ID for each user. | username |
| nameLength | Defines the max number of characters in a user name. | 64 |
| mailColumn | Defines the column name which stores the user email. | email |
| hashColumn | Defines the column name which stores the hashword of a user. | hashword |
| sessionKey | Defines the $_SESSION key which is used to store and access user data. |
user_data |
Methods
Register User
Registers a user and associates a new hash for logging in.
$userData: an array containing key => value pairs where the key is any given column name in the user table and the value is the data to be stored in that column.$password: the plain-text password the user will use to log in with.
Select User
Selects a user from the users table.
$user: the string value of the user id being selected
Login User
Logs in a user, and will load the user data into the $_SESSION variable. For additional security, it will
automatically rehash a given password if a newer and/or better hashing algorithm has been identified and is available.
$user: string value of the username to be logged in$password: plain-text string value of the user's password$loadToSession: boolean determining if the user data will be loaded into the$_SESSIONvariable using thesessionKeysetting's value
Update User
Updates a user in the users data table with the given data.
$user: string value of the username to be updated in the user table$userData: an array of key => value pairs where the key is the name of the column where the value will be stored
Load User Session
Load an array of data into the $_SESSION variable within the sessionKey key.
$user: array of whatever key => value pairs to be stored in the$_SESSIONvariable under thesessionKeykey
Logout User
Clears out all $_SESSION user data under the sessionKey key while leaving any other remaining $_SESSION data
intact
Verify Email
work in progress
Change Password
Changes the current password of $user to a new hash of $newPassword. Returns true if successful, otherwise false.
$user: string value of the user for which the password is being updated$newPassword: plain-text string value of the new password to be used
