You are here

Home » API reference » Role Expire 2.x

README.txt in Role Expire 2.x

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * Configuration

INTRODUCTION
------------

Role expire provides expiration to roles attached to users. Some features
available when you enable this module:

 * On the screen where admins create/edit users and assign roles (user/#/edit
   and admin/people/create), those roles can now have expiry dates.

 * A user with sufficient privilege ('administer role expire' or 'administer users')
   can view and edit roles and expiry dates.

 * On the role administration screen (admin/people/permissions/roles/edit), you
   can set a default duration for each role. The expiry duration can be a
   strtotime-compatible string (like "last day of this month").

 * Selecting a role on user_profile_form triggers a textfield (or textfields)
   where admins can enter expiration date/time for the selected role.

 * Defined expiry dates are displayed on the user's profile page, and is
   visible only to owners of the profile or users with proper permissions).

   If you don't want expiry dates to be displayed on user's profile, just
   go to admin/config/people/accounts/display and hide "Role expiration"
   pseudo field.

 * Actual role expiration occurs at cron time. Cron automatically removes
   expired roles from affected users.

 * You can configure a default role when each role expires (see Configuration
   section of this README file).

 * Rules module integration: One event and two actions.

INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. See:
   https://www.drupal.org/documentation/install/modules-themes/modules-8
   for further information.

 * In order to enjoy full potential of role_expire module you need to
   properly configure Cron job on your server:

   https://www.drupal.org/docs/8/cron-automated-tasks

 * IMPORTANT NOTE: Once the module is installed, make sure to configure your
   regional time zone here: admin/config/regional/settings

CONFIGURATION
-------------

 * Configure module's options in Administration » Configuration » People
   » Role Expire:

    - Configure a default role after each role expiration.

    - Disable role expiration for specific roles

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Installation

  6.  * Configuration

  7. 

  8. INTRODUCTION

  9. ------------

  10. 

  11. Role expire provides expiration to roles attached to users. Some features

  12. available when you enable this module:

  13. 

  14.  * On the screen where admins create/edit users and assign roles (user/#/edit

  15.    and admin/people/create), those roles can now have expiry dates.

  16. 

  17.  * A user with sufficient privilege ('administer role expire' or 'administer users')

  18.    can view and edit roles and expiry dates.

  19. 

  20.  * On the role administration screen (admin/people/permissions/roles/edit), you

  21.    can set a default duration for each role. The expiry duration can be a

  22.    strtotime-compatible string (like "last day of this month").

  23. 

  24.  * Selecting a role on user_profile_form triggers a textfield (or textfields)

  25.    where admins can enter expiration date/time for the selected role.

  26. 

  27.  * Defined expiry dates are displayed on the user's profile page, and is

  28.    visible only to owners of the profile or users with proper permissions).

  29. 

  30.    If you don't want expiry dates to be displayed on user's profile, just

  31.    go to admin/config/people/accounts/display and hide "Role expiration"

  32.    pseudo field.

  33. 

  34.  * Actual role expiration occurs at cron time. Cron automatically removes

  35.    expired roles from affected users.

  36. 

  37.  * You can configure a default role when each role expires (see Configuration

  38.    section of this README file).

  39. 

  40.  * Rules module integration: One event and two actions.

  41. 

  42. INSTALLATION

  43. ------------

  44. 

  45.  * Install as you would normally install a contributed Drupal module. See:

  46.    https://www.drupal.org/documentation/install/modules-themes/modules-8

  47.    for further information.

  48. 

  49.  * In order to enjoy full potential of role_expire module you need to

  50.    properly configure Cron job on your server:

  51. 

  52.    https://www.drupal.org/docs/8/cron-automated-tasks

  53. 

  54.  * IMPORTANT NOTE: Once the module is installed, make sure to configure your

  55.    regional time zone here: admin/config/regional/settings

  56. 

  57. CONFIGURATION

  58. -------------

  59. 

  60.  * Configure module's options in Administration » Configuration » People

  61.    » Role Expire:

  62. 

  63.     - Configure a default role after each role expiration.

  64. 

  65.     - Disable role expiration for specific roles