README

About

It does exactly what it says on the tin: Provides a route /Security/register to a basic membership form for users to register with your Silverstripe application. It also provides a profile form, for your users to maintain their profiles.

Requirements

PHP ^8
silverstripe/framework ^5
Does not require silverstripe/cms.

Configuration

An environment variable REGISTRATION_ENABLED should be set in your hosting environment for the registration form to show. You can also choose to hide the form in userland code based on an arbitrary boolean using $handler->setHideCondition(). Just overload this modules' getRegistrationHandler() method in your own Authenticator subclass as follows:

/**
  * @param string $link
  * @return RegistrationHandler
  */
public function getRegistrationHandler(string $link): RegistrationHandler
{
    $handler = parent::getRegistrationHandler($link, $this);

    return $handler->setHideCondition((bool) Environment::getEnv('SOME_VAR'));
}

There's also an optional extension for augmenting Member records with a field, whose value tells userland systems that a user was indeed created via registration.

SilverStripe\Security\Member:
  extensions:
    - Dcentrica\Registration\Extension\MemberRegistrationExtension

By default, newly registered users are automatically logged-in. However, this behaviour can be configured as follows:

Dcentrica\Registration\Security\RegistrationHandler:
  # Prevent Silverstripe from auto-logging-in post registration
  login_after_register: false

You can add an optional "success" message when registration is complete. This is useful to show if you do not want registered users to be automatically logged-in:

Dcentrica\Registration\Security\RegistrationHandler:
  registration_completion_message: 'Well done, you filled in a form. Who's a good boy?'

Caveats

The module does not include any form of profile management (unlike the module this package was forked from).
The module does not include any form of spam protection.

History

Forked from tony13tv/silverstripe-registration to work with Silverstripe 5+ and finish off a few rough edges.

License

This module retains the original module's MIT license "claim" (the original module didn't come with a LICENSE file, nor did it stipulate its licensing in any file headers).

dcentrica / silverstripe-registration

Maintainers

Details