https://github.com/tinyappsde/tinyusermanager
Easy-to-use PHP-library for user management
https://github.com/tinyappsde/tinyusermanager
Last synced: 5 months ago
JSON representation
Easy-to-use PHP-library for user management
- Host: GitHub
- URL: https://github.com/tinyappsde/tinyusermanager
- Owner: tinyappsde
- Created: 2019-12-18T20:53:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-12-16T12:40:29.000Z (over 4 years ago)
- Last Synced: 2024-04-18T13:23:51.207Z (about 2 years ago)
- Language: PHP
- Size: 33.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TinyUserManager [Work in Progress]
Easy-to-use PHP-library for user management
## Setup
1. Install with composer: `composer require tinyapps/tinyusermanager`
2. Setup database connection
For example you can create a db-config.php:
```php
'127.0.0.1',
'db' => 'your_db',
'user' => 'db_user',
'password' => 'db_password'
];
```
And use the config file for establishing the connection:
```php
$dbConfig = require __DIR__ . '/path-to/db-config.php';
TinyUserManager\Helpers\Database::conn(
$dbConfig['host'],
$dbConfig['db'],
$dbConfig['user'],
$dbConfig['password'],
'utf8mb4'
);
```
3. Setup the db tables using `TinyUserManager\Setup::createTables();`
4. (Optionally) customize the user table by adding additional fields/columns
## Code Examples
Please note, that `Database::conn()` must be called in every script before the usage of the TinyUserManager features that require a database connection. When using sessions, it is also required to have a php session started (`session_start()`).
A documentation will be added soon.
### Login
```php
$session = new TinyUserManager\Session();
if ($session->login('john.doe@example.com', 'opensesame')) {
// login succeded
} else {
// wrong credentials
}
```
### Check if a user is signed in
```php
if ($session->loggedIn()) {
// user is logged in
$user = $session->getUser();
}
```
### Registration
The code snippet below includes a custom field "phone" that has been added to the users table before.
```php
if ($user = TinyUserManager\UserManager::createUser('john.doe@example.com', 'opensesame', ['phone' => '+49 123 45678'])) {
// User has been created
}
```
### Send the confirmation email
```php
$emailConfig = new TinyUserManager\EmailConfig('no-reply@example.com', 'Example');
TinyUserManager\ConfirmationHandler::sendConfirmationEmail($user, $emailConfig, 'Please confirm your registration', '
');
```
Optionally, if you want to use smtp, you can customize the `$emailConfig`:
```php
$emailConfig->useSmtp();
$emailConfig->setHost('mail.example.com');
$emailConfig->setUsername('no-reply@example.com');
$emailConfig->setPassword('your_email_password');
$emailConfig->setPort(465);
$emailConfig->setSmtpSecure('ssl');
```
To activate an account from the activation email:
```php
$user = TinyUserManager\UserManager::getUser($userId);
if (TinyUserManager\ConfirmationHandler::confirmUser($user, $token)) {
// confirmed
}
```
### Update user details
```php
$user->setField('phone', '+49 123 456789');
TinyUserManager\UserManager::updateUser($user);
```
### Password reset
Send the password reset confirmation email:
```php
TinyUserManager\PasswordResetHandler::sendConfirmationEmail(
$user,
$emailConfig,
$emailSubject,
'Reset password',
);
```
Confirm a password reset token:
```php
$user = TinyUserManager\UserManager::getUser($userId);
if (TinyUserManager\PasswordResetHandler::confirmPasswordForgotToken($user, $token)) {
// valid
}
```
Set a new password (confirm the token again before!)
```php
TinyUserManager\PasswordResetHandler::setNewPassword($user, $newPassword);
```