inspiredminds/contao-member-invites

This Contao extension allows members of your site to send and review invites.

2.0.0 2023-06-18 08:34 UTC

Requires

• php: ^7.4 || ^8.0
• codefog/contao-haste: ^5.0
• contao/core-bundle: ^4.9 || ^5.0
• ramsey/uuid: ^3.0 || ^4.0
• symfony/polyfill-php80: ^1.26
• terminal42/notification_center: ^1.5

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16 || ^3.0

LGPL-3.0-or-later

• Fritz Michael Gschwantner

README

Contao Member Invites

This Contao extension allows members of your site to send and review invites.

Usage

The following steps need to be done to use this extension:

1. Create notifications for invites, invite requests and new registrations.
2. Create a page where members can send invites to other people.
3. Create a page where recipients of invites can accept the invite and register.
4. Create a Registration for invited people to register.
5. Create a Member invite form module for sending invites.
6. Create a Member invite accept module for accepting invites.

Notifications

There are two notification types provided by this extension:

Member invite

This notification will be selected in the Member invite form module and is sent when an invite is created by a member in the front end. The following simple tokens are available within the notification:

• ##member_*##: any information about the member sending the invite.
• ##invite_*##: any information about the invite (i.e. the recipient). This includes ##invite_firstname##, ##invite_lastname##, ##invite_email## and ##invite_message## by default.
• ##invite_link##: this will be replaced with the unique invite link, where the recpient can accept the invite and register.

The notification could look like this for example:

Request another invitation

This notification will be selected in the Member invite accept module and is sent when an invite has expired and the recpient requests another invitation in the front end. The following simple tokens are available within the notification:

• ##member_*##: Any information about the member that originally sent the invite.
• ##invite_*##: Any information about the invite (i.e. the recipient). This includes ##invite_firstname##, ##invite_lastname##, ##invite_email## and ##invite_message## by default.
• ##resend_link##: This will be replaced with the URL to the page containing the Member invite form module, where the sender can send the invite again.

The notification could look like this for example:

Member registration

This notification is not part of this extension, but this extension provides an additional token that can be used for the notification that is sent when a new member registers on the site:

• ##backend_link##: This provides a link to the edit view of the newly registered member in the backend. This can be used for notifications about new registrations to the site's administrator.

Modules

Member invite form

This module will display a form where a member can send an invitation via email to another person to register on the current website. The module takes three settings:

• Notification: The Member invite notification mentioned above.
• Invite expiration: Determines how long an invite link should stay valid.
• Redirect page: This is the page where the recipient of the invite will be sent to. It should include a Member invite accept module (see below).

Member invite accept

This module will either display the selected registration form or a button where the recipient can request another invitation link, if the invite has expired. The module takes three settings:

• Notification: The Request another invitation notification mentioned above.
• Registration module: The registration module to be used for valid invite links.
• Redirect page: This is the page where the sender of the invite will be sent to if a recipient of an invite requests another invitation, in case the invite expired. It should include a Member invite module (see above).

If the invite link is valid, the registration module will be shown, with the information of the invite pre-filled in the respective form elements:

If the invite link expired, a button to request another invitation will be shown instead:

If the invite link is otherwise invalid, a message will be shown:

Member invite table

This module will display all the invites sent by the currently logged in member. It will include a link to send an invite again. The link will either point to the current page or the redirect page.

Member invite overview

This module will dispaly all the invites in the system in the front end.

Attributions

Development of this extension was funded by the austrian society for artificial intelligence (ASAI) with the Austrian Federal Ministry for Climate Action, Environment, Energy, Mobility, Innovation and Technology (BMK) as the public funding body.