utilitees

Restricted Area Documentation

• Requirements
• Installation
• Control Panel
  • The ‘Manage Areas’ Tab
  • Individual area settings
  • The ‘Manage Members’ Tab
  • Add / edit member
  • Member level permissions

• Template usage

  • Main tag + example
  • Parameters
  • Variables
• Changelog

Requirements

Restricted Area requires ExpressionEngine 1.6.8 or newer and the jQuery for the Control Panel extension installed and enabled. This extension was introduced with ExpressionEngine 1.6.5 and if you carefully followed the update instructions you should have it. If you don’t you can install it like outlined in the aforementioned instructions.
Please enter links to recent jQuery releases. At the time of writing this jQuery 1.3.2 and jQueryUI 1.7.2 are the latest stable versions.

Installation

1. Unzip the file.
2. Upload the folder restricted and the contained files to the modules-folder inside your EE system directory.
3. In your Control Panel navigate to CP Home ›  Modules, find the Restricted Area module and click Install.
4. Now you can click on Restricted Area in the modules list to access the settings.

Control Panel

The module’s control panel is split up in two sections: Area Management and Member Management.

The ‘Manage Areas’ Tab

Here you can create, edit or delete your content areas.

Note: Only ‘Super Admins’ are allowed to create, edit or delete areas.

• To add a new area just fill out the two fields at the bottom of the list and hit Submit.
• To delete an area click the delete-link on the right hand side.
• Click on an area label to edit its access permissions. This will take you to

Individual area settings

Short Name
You have the option to change the short name of the area if you don’t like what you entered on creation.
The short name is used to reference areas in your templates. So if you already used that name in some of your templates make sure to update them as well.

Access type names
This is an optional field to enable even more fine grained access control inside your restricted areas.

Let’s say you want to define three levels of access to an area: limited, intermediate and full. You can do this by entering shortnames for these areas into this field. Only single words consisting of alpha-numeric characters are allowed as shortnames. Multiple names may be separated by commas.

If you enter shortnames into this field they will be added as select lists to group- and member-level access settings, the first word from the list being the default value. So any group or member will be assigned to one of these levels.

Inside the {exp:restricted}-tagpair for that area these shortnames will become available as short conditionals which allows you to return content specific to the access-level.

Note: For users belonging to the ‘Super Admins’ group all acccess type conditionals will evaluate as true, so super admins will see all content regardless of access level.

Group-level access to this area
You can allow whole member groups access to an area by checking the appropriate boxes. This can come in handy for example if you want to quickly allow all your editors access without having to define permissions for every single one of them.

If you have set up access types for this area, there will also be a select list which sets this group’s acccess type.

Please note that group level access takes precedence over member level settings. If a member is part of an allowed group he can access the area even if he has an expired access permissions setup on member level.

Also note that the Superadmin group has access to all areas by default. Banned, Pending and Guests groups have no accces by default.

Member-level access to this area
At the bottom you see a list of all members that are currently setup for acccess to this area. Expired accounts are shown in red for quick identification.

To edit a member’s permissions click on his username.
To add a member use the green button in the top-right corner of the screen.

The ‘Manage Members’ Tab

This screen lists all members for whom individual access permissions are currently defined.

Click on any username to edit his settings.
To add a member use the green button in the top-right corner of the screen.

Add / edit member

The ‘Add / edit member’ button will take you to a search form. Enter some search criteria to find the desired user and click on his usename once you found him.

Member level permissions

On the member edit screen you can grant area access permissions for an individual member by checking the the appropriate boxes.

You can optionally set an expiration date for each area. When the date is reached access will be denied. Leave it blank for indefinite access.

If you have set up access types for this area, there will also be a select list which sets this member’s acccess type.

Template usage

Restricting access to content in your templates is really easy. There is only one tag and one parameter.

Example:

Just put any restricted content inside an {exp:restricted}-tagpair.

Parameters:

This parameter in mandatory and must contain the short name of the designated area.

Variables:

This variable-pair may be used to output some content enclosed in case the user has no access to the area.

If you have created access types for an area, short conditionals will be availlable corresponding to the access type shortnames.

 

Changelog

• Version 0.9.2:
  • added access types
  • limited area management to super admins

• Version 0.9.1:

  • added MSM-awareness
• Version 0.9: Beta release

 

 

Questions / bug reports

For general comments, brickbats & bouquets please use the form over here.

Name:

Email:

URL:

	Remember my personal information
	Notify me of follow-up comments?

Page 3 of 3 pages  <  1 2 3

User Talk