You are here

Home » API reference » Role Expire 7

README.txt in Role Expire 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 2.x 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).

 * 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://drupal.org/documentation/install/modules-themes/modules-7
   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/7/setting-up-cron/configuring-cron-jobs-using-the-cron-command

 * 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.

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.  * Actual role expiration occurs at cron time. Cron automatically removes

  31.    expired roles from affected users.

  32. 

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

  34.    section of this README file).

  35. 

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

  37. 

  38. INSTALLATION

  39. ------------

  40. 

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

  42.    https://drupal.org/documentation/install/modules-themes/modules-7

  43.    for further information.

  44. 

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

  46.    properly configure Cron job on your server:

  47. 

  48.    https://www.drupal.org/docs/7/setting-up-cron/configuring-cron-jobs-using-the-cron-command

  49. 

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

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

  52. 

  53. CONFIGURATION

  54. -------------

  55. 

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

  57.    » Role Expire:

  58. 

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