Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erdiko/users
User bundle for php (models, authentication, & authorization)
https://github.com/erdiko/users
authentication authorization doctrine erdiko php users
Last synced: 1 day ago
JSON representation
User bundle for php (models, authentication, & authorization)
- Host: GitHub
- URL: https://github.com/erdiko/users
- Owner: Erdiko
- License: mit
- Created: 2016-11-10T08:47:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-24T18:39:20.000Z (about 7 years ago)
- Last Synced: 2024-04-16T21:05:42.399Z (7 months ago)
- Topics: authentication, authorization, doctrine, erdiko, php, users
- Language: PHP
- Homepage: http://erdiko.org/users/
- Size: 251 KB
- Stars: 6
- Watchers: 5
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Users
[](https://packagist.org/packages/erdiko/users)
[](https://circleci.com/gh/Erdiko/users)
[](https://github.com/Erdiko/users/blob/master/LICENSE)
**Erdiko Users**
The `erdiko/users` is a package adding Service Models and AJAX endpoints for user management in a Erdiko application or your custom application. It will allow you to authenticate and authorize your users as well as create a user entity stored in a database.
Erdiko users leverages our [authenticate](https://github.com/Erdiko/authenticate) and [authorization](https://github.com/Erdiko/authorize) packages.
Installation
------------
### Install the package via Composer
Add package using composer
`composer require erdiko/users`
### Create & Install the DB
This package relies upon a number of database tables to store user records. You must create the database & tables before you can use this package.
We highly recomend installing the DB and tables with our install scripts found in the erdiko/user-admin repo (`scripts/install-db.sh`). More information can be found on the erdiko/user-admin README file.
If you would like to install the database manually, please use the `users\sql\dumps\user-admin.sql` to create the database defintion.
### Add the required routes to your Erdiko application
Below are examples of the minimum required routes to interact with the `users` package:
* Login Controller OR UserAuthenticationAjax Controller Route
* The Login Controller exposes self-contained login/logout actions and views, these methods expose an HTML form to allow users to login
* `"/[ROUTE NAME]/:action": "\erdiko\users\controllers\admin\UserAjax"`
* The UserAuthenticationAjax controller provides actions to manage login/logout and password related situations as forgotPass and changePassword. This route is for AJAX login & logout.
* `"/[ROUTE NAME]/:action": "\erdiko\users\controllers\UserAuthenticationAjax"`
* Userajax Controller Route
* Provides actions relative to manage users without privileges, to have it accessible.
* `"/[ROUTE NAME]]/:action": "\erdiko\users\controllers\UserAjax"`
* admin\Userajax Controller Route
* Provides actions relative to manage users as admin level
* `"/ROUTE NAME]/:action": "\erdiko\users\controllers\admin\Userajax"`
##### Example Route Config
Below is an example config containing all the AJAX endpoints exposed by the package:
```
{
"routes": {
"/ajax/users/admin/:action": "\erdiko\users\controllers\admin\UserAjax",
"/ajax/users/:action": "\erdiko\users\controllers\UserAjax",
"/ajax/roles/:action": "\erdiko\users\controllers\RoleAjax",
"/ajax/auth/:action": "\erdiko\users\controllers\UserAuthenticationAjax",
"/users/:action": "\erdiko\users\controllers\Login"
}
}
```
Project Documentation
---------------------
Complete project documentation can be found on our Erdiko documentation site (coming soon).
Special Thanks
--------------
Arroyo Labs - For sponsoring development, [http://arroyolabs.com](http://arroyolabs.com)