Download the PHP package tatter/users without Composer
On this page you can find all versions of the php package tatter/users. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package users
Short Description User interfaces and provider for CodeIgniter 4
License MIT
Homepage https://github.com/tattersoftware/codeigniter4-users
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 users
Tatter\Users
User interfaces and provider for CodeIgniter 4
Quick Start
- Install with Composer:
> composer require tatter/users - Check the list of supported factories or provide your own
- Access users and their methods through the provided service:
Description
Not an authentication module itself, Tatter\Users brings common interfaces and factory
discovery to simplify user integration into other libraries and projects.
Installation
Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities and always be up-to-date:
> composer require tatter/users
Or, install manually by downloading the source files and adding the directory to
app/Config/Autoload.php.
Configuration
The core of Users are the interfaces for User Entities and User Factories. Your project
can use the built-in classes or provide its own implementation, and any library that uses
Tatter\Users will then be able to work with your user classes. Currently the following
libraries are supported natively and with discovery:
- Myth:Auth
- CodeIgniter Shield (in development)
- Agung Sugiarto's CodeIgniter4 Authentication
Discovery will return the first UserFactory implementation it can locate with
the following priorities:
-
A
UserFactoryimplementation called "UserModel" returned by the framework's model factory. Equivalent to:$users = model('UserModel', ['instanceOf' => UserFactory::class])
- A discovered compatible library from
UserProvider.
Note: If your implementation is not compatible with number one then you may supply it to the provider directly:
\Tatter\Users\UserProvider::addFactory(MyDiscoveryClass::class, MyFactory::class);Usage
Once you have the necessary classes available the easiest way to access them is through the Users Service:
Factories
The User Factory interface defines the following methods:
- findById()
- findByEmail()
- findByUsername()
Entities
The User Entity interface defines the following methods:
- getIdentifier()
- getId()
- getEmail()
- getUsername()
- getName()
- isActive()
There are extended interfaces in the Tatter\Users\Interfaces namespace that provide
additional methods which may be required by some libraries. Check your library's requirements
to make sure you are using all the required interfaces.
Testing
There are convenience test cases in Tatter\Users\Test to enable other libraries to add
and test their own classes. If you are looking to test your user interfaces without committing
to a specific provider then consider adding Tatter\Imposter -
a mock authentication library that is fully compliant with Tatter\Users.
Development
Pull Requests are accepted for additional libraries and adapters. Please include the appropriate tests and provider code if you wish to support discovery. Requests for additional implementations should be opened as a Feature Request Issue and fulfillment will depend on availability and sponsorship (see "Sponsor this project").
