Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
This commit adds information about the "immediate login after registration" procedure and some hints about the (execution) order of Member info and events/filters.
  • Loading branch information
michael-e committed Nov 24, 2017
1 parent 3216572 commit ec3e30b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ Event information will be returned in the XML similar to the following example:

The `$member-id` and `$member-role` parameters will be added to the Page Parameters for you to use in your datasources to get information about the logged in member.

Note: All Member information (`$member-id` and `$member-role` parameters, `member-login-info` pseudo event XML) will be added to the page before any real events are executed. So if you change the Member's status via events resp. filters, the new status will not be reflected in these XML nodes. You may work around this rare issue by performing a redirect in your event, e.g. by specifying a redirect location in the corresponding frontend form — all subsequent pages will show the correct Member information, of course.

7. You can log a Member out using `<a href='?member-action=logout'>Logout</a>`


Expand Down Expand Up @@ -213,6 +215,8 @@ The Members: Update Password filter is useful on Events where the member may upd

The Members: Login filter is useful if a Member's password has been changed by an event. It will log the Member in with the new (posted) password. If you need the password to be optional, use the Members: Update Password filter instead.

This filter can, for example, be used to directly log a Member in after registration. But since any "magically added" Member information in your page XML is actually added before events are executed, it will not reflect the login (i.e. still tell you that the Member is not logged in). In this case you should enforce a new page request by adding a redirect to your event.

## Roles and Permissions

The Members extension comes with a single default Role, Public. This role cannot be deleted, but it can be renamed and modified to suit your requirements. This Role is assumed by any Frontend member who is not authenticated and by default, does not allow users to use any Events. Remember to modify the Public role to open up Events as necessary.
Expand Down

0 comments on commit ec3e30b

Please sign in to comment.