Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decodelabs/disciple
Take control of your users in PHP
https://github.com/decodelabs/disciple
php user user-management
Last synced: 1 day ago
JSON representation
Take control of your users in PHP
- Host: GitHub
- URL: https://github.com/decodelabs/disciple
- Owner: decodelabs
- License: mit
- Created: 2021-04-20T10:19:45.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-04T21:02:38.000Z (4 months ago)
- Last Synced: 2024-12-08T03:19:34.246Z (about 1 month ago)
- Topics: php, user, user-management
- Language: PHP
- Homepage:
- Size: 63.5 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Disciple
[](https://packagist.org/packages/decodelabs/disciple)
[](https://packagist.org/packages/decodelabs/disciple)
[](https://packagist.org/packages/decodelabs/disciple)
[](https://github.com/decodelabs/disciple/actions/workflows/integrate.yml)
[](https://github.com/phpstan/phpstan)
[](https://packagist.org/packages/decodelabs/disciple)
### Take control of your users
Disciple offers a set of simple interfaces that allows third party code to define reliable entry points to user state and data.
_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._
---
## Installation
Install via Composer:
```bash
composer require decodelabs/disciple
```
## Usage
### Importing
Disciple uses [Veneer](https://github.com/decodelabs/veneer) to provide a unified frontage under DecodeLabs\Disciple.
You can access all the primary functionality via this static frontage without compromising testing and dependency injection.
### Implementation
An implementation of Disciple revolves around an Adapter - this acts as the primary mediator between the Disciple Veneer frontage and your system's user management infrastructure.
```php
namespace DecodeLabs\Disciple;
interface Adapter
{
public function isLoggedIn(): bool;
public function getIdentity(): ?string;
public function getProfile(): Profile;
public function isA(string ...$signifiers): bool;
}
```
Your adapter should be registered during your app's bootstrap process:
```php
use DecodeLabs\Disciple;
use My\App\DiscipleAdapter;
Disciple::setAdapter(new DiscipleAdapter(
$myUserManager
));
```
Then at any future point, queries can be made against the current user:
```php
use DecodeLabs\Disciple;
if(Disciple::isLoggedIn()) {
echo 'Yay, you\'re logged in';
} else {
echo 'Boo, nobody loves me';
}
```
### Profile
A registered Adapter should be able to provide an instance of a Profile, representing core data about the current user, such as name, email address, locale, etc.
```php
namespace DecodeLabs\Disciple;
interface Profile
{
public function getId(): ?string;
public function getEmail(): ?string;
public function getFullName(): ?string;
public function getFirstName(): ?string;
public function getSurname(): ?string;
public function getNickName(): ?string;
public function getRegistrationDate(): ?DateTime;
public function getLastLoginDate(): ?DateTime;
public function getLanguage(): ?string;
public function getCountry(): ?string;
public function getTimeZone(): ?string;
public function getSignifiers(): array;
}
```
The Veneer frontage can interface directly with this profile information, allowing quick access of user data:
```php
use DecodeLabs\Disciple;
if(Disciple::isLoggedIn()) {
echo 'Hello '.Disciple::getFullName();
} else {
echo 'You should probably log in first';
}
```
### Client
An Adapter should also be able to provide a Client object which can report details of how a user is interfacing with the system.
Currently, that entails the following, but with more to follow in future versions:
```php
namespace DecodeLabs\Disciple;
interface Client
{
public function getProtocol(): string;
public function getIpString(): string;
public function getAgent(): ?string;
}
```
### Signifiers
The Disciple interfaces define the concept of signifiers - string keys that users can be categorised and identified by.
It is the responsibility of the Adapter implementation to define _how_ signifiers are stored and distributed, however the definition of this interface allows for a powerful, quick access mechanism for high level structures in your application.
```php
if(Disciple::isA('admin')) {
echo 'You can see the fun stuff';
} else {
echo 'You should go home now';
}
```
## Licensing
Disciple is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.