PHPackages                             germania-kg/user-profiles - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. germania-kg/user-profiles

ActiveLibrary[Utility & Helpers](/categories/utility)

germania-kg/user-profiles
=========================

2.3.0(3y ago)0119MITPHP ^7.3|^8.0

Since Dec 15Compare

[ Source](https://github.com/GermaniaKG/UserProfiles)[ Packagist](https://packagist.org/packages/germania-kg/user-profiles)[ RSS](/packages/germania-kg-user-profiles/feed)WikiDiscussions Synced today

READMEChangelogDependencies (7)Versions (19)Used By (0)

Germania KG · UserProfiles
==========================

[](#germania-kg--userprofiles)

[![Packagist](https://camo.githubusercontent.com/2643d230f9cfc94240fd1e22411dbb3b89bc8ae1ee4f46e5e9761fc9f5715b99/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6765726d616e69612d6b672f757365722d70726f66696c65732e7376673f7374796c653d666c6174)](https://packagist.org/packages/germania-kg/user-profiles)[![PHP version](https://camo.githubusercontent.com/42f84d82ab5da25f138c1920654cb4a1a68b354121285af657d6b55d40957796/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6765726d616e69612d6b672f757365722d70726f66696c65732e737667)](https://packagist.org/packages/germania-kg/user-profiles)[![Build Status](https://camo.githubusercontent.com/bb0071644c35e836a95fc8ac768e4e96c2b7b1900e5d39e8f03d1fb010e6a092/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f4765726d616e69614b472f5573657250726f66696c65732e7376673f6c6162656c3d5472617669732532304349)](https://travis-ci.org/GermaniaKG/UserProfiles)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/799ea260c12eb4a2f9d64220c4e79a2e2449edc6748277e2b0f6ecf7a38268f6/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4765726d616e69614b472f5573657250726f66696c65732f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/GermaniaKG/UserProfiles/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/f03f03a4282f3157328cc3ff0e5d286dc8ab523b1c52ed82e701fd6fb143a6ca/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4765726d616e69614b472f5573657250726f66696c65732f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/GermaniaKG/UserProfiles/?branch=master)[![Build Status](https://camo.githubusercontent.com/749323cf53531788c1e8bf39bb339a6567cabba97c32d132e35ccc0c29ae3a21/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4765726d616e69614b472f5573657250726f66696c65732f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/GermaniaKG/UserProfiles/build-status/master)

Installation
------------

[](#installation)

```
$ composer require germania-kg/user-profiles:^2.0
```

**MySQL users** may install the table *users* using `users.sql.txt` in `sql/` directory.

A. Register a new User
----------------------

[](#a-register-a-new-user)

Wraps all necessary tasks in a single Callable.
For a detailed list of all single tasks, see chapters below.

1. Check if login name is available
2. Insert new User
3. Set user's password
4. Set user's API Key

*Please note that* just registration will not mark the new user as *active*. By default, he will be marked as *inactive* as desribed in MySQL table scheme. See section **B. Set users 'active' state** for details.

If the registration fails for some reason, a **RegisterUserException** will be thrown.

```