Download the PHP package roadiz/user-bundle without Composer

Roadiz User bundle

Public user management bundle for Roadiz v2

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

Configuration

• Copy API Platform resource configuration files to your Roadiz project api_resource folder:
  • ./config/api_resources/user.yaml
  • ./config/api_resources/me.yaml

• Edit your ./config/packages/framework.yaml file with:

• Edit your ./config/packages/cache.yaml file with:

• Edit your ./config/packages/security.yaml file with:

• Edit your ./.env file with:

• Update your CORS configuration with additional headers Www-Authenticate and x-g-recaptcha-response:

Passwordless user creation and authentication

You can switch your public users to PasswordlessUser and set up a login link authentication process along with user creation process.

First you need to configure a public login link route:

Then you need to configure your security.yaml file to use login_link authentication process in your API firewall. You must use all_users provider to be able to use Roadiz User provider during the login_link authentication process.

Public login link creation

Then you'll need a public route to request a login-link. In your project create a new App\Controller\SecurityController and add a new route /api/users/login_link:

Register your controller:

Override login link URL

Roadiz User Bundle provides a custom Symfony\Component\Security\Http\LoginLink\LoginLinkHandlerInterface service to generate a login-link with a different base-uri, all you need is to register RZ\Roadiz\UserBundle\Security\FrontendLoginLinkHandler service in your project with its mandatory arguments:

Now for each $frontendLoginLinkRequestRoutes login_link will be generated using $frontendLoginCheckRoute base URL

Public users roles

• ROLE_PUBLIC_USER: Default role for public users
• ROLE_PASSWORDLESS_USER: Role for public users authenticated with a login link
• ROLE_EMAIL_VALIDATED: Role for public users added since they validated their email address, through a validation token or a login link

Maintenance commands

• bin/console users:purge-validation-tokens: Delete all expired user validation tokens
• bin/console users:inactive -d 60 -r ROLE_PUBLIC_USER -m ROLE_EMAIL_VALIDATED -v: Delete all inactive public users that did not logged-in for 60 days. Notice that this command example only displays users that do not have ROLE_EMAIL_VALIDATED role.

Contributing

Report issues and send Pull Requests in the main Roadiz repository