Tag Descriptions

BR_Login

DESCRIPTION:

This tag will validate a user login from a given datasource, table, and any two (or three see SessionLoginID) fields in the given table. This tag is to be used in an application template. The tag will block any CFML from being processed by any template that uses that application template that contains the BR_login tag.

Two session variables will be set. The first variable is user defined in the SessionLogin attribute. This session variable will be set to "Yes" if the user is validated.



LICENSE:

Please feel free to use this on your site at no charge. If however this is used on a client site and a charge is assessed to the client, please remit 75% of the fee assessed for the Login script to me. A fair charge would between 3 and 6 hours.

Remit to:
    Lance Shepard
    1990 W Camelback Rd
    Suite 302
    Phoenix, AZ 85015


ATTRIBUTES:

Datasource	(required)	= Datasouce that that contains the table to be checked.
SessionLogin	(required)	= The name of the session variable that you want to be set to "Yes" if the user is validated.
SessionLoginID	(required)	= The name of the field that contains the data that will be contained in the #Session.LoginID# variable.
Tablename	(required)	= The name of the table that contains the UserField, PasswordField, and SessionLoginID fields.
UserField	(required)	= The name of the field that contains the user's name.
PasswordField	(required)	= The name of the field that contains the password.
Webmaster	(optional)	= If an error in the tag ocurres who ya gonna call.
UserNameText	(optional)	= The test that the user will see on the login form that corresponds to the UserName field. This will default to "User Name"
Passwordtext	(optional)	= The test that the user will see on the login form that corresponds to the Password field. This will default to "Password"
UserFormSize	(optional)	= The size of the input object on the login form. the size will default to 10
UserFormMax	(optional)	= The maxLength of the input object on the login form. The maxLegnth will default to 10.
PasswordFormSize	(optional)	= The size of the input object on the login form. the size will default to 10
PasswordFormMax	(optional)	= The maxLength of the input object on the login form. The maxLegnth will default to 10.
BGColor	(optional)	= The background color of the login page, the default is navy(if using hexcolor omit the leading #).
LightColor	(optional)	= The color for the "Please Login" box, default is SlateBlue. (if using hexcolor omit the leading #).
TextColor	(optional)	= The color for the text, default is White. (if using hexcolor omit the leading #).
AdditionalText	(optional)	= Any additional text you want to include for the user. Don't for get to double up the double quotes.
Graphic	(optional)	= Path and filename to graphic to be centered of the login.
IncludedSubRoutine	(optional)	= A comma delimited list of files or tags to be "CFINCLUDE"d. The tags must be in the same directory that is calling this login or in the "Custom Tag" directory.
Mapping	(optional)	= If the is a mapping for you CF server that you are using put it here other wise it is assumed that you are on your own server and the CFINCLUDE does not need any mapping.

NOTES:

The login IS case-sensitive.



USAGE:

Best used in an application file in a director that you want to restrict. See the example.



EXAMPLES:

<CFAPPLICATION NAME="TheseSessions" SESSIONMANAGEMENT="Yes">


<CFPARAM NAME="Session.AmILoggedIn" DEFAULT="No">


<CFIF #Session.AmILoggedIn# EQ "No">


<CF_BR_Login Datasource="#DataSource#"

SessionLogin="AmILoggedIn"
SessionLoginID="UserID"
TableName="UserTable"
UserField="UserName"
UserFormMax="20"
PasswordField="Password"
AdditionalText="If you have forgotten you password

email the <A HREF=""mailto:webmaster@domain.com"">
webmaster</A>"
Graphic = "/images/somepicture.jpg" BGColor="White">


</CFIF>

The result is two variable

#Session.AmILoggedIn# = "Yes"
#Session.LoginID# = "the value in the UserID field of the UserTable





AUTHOR:

Lance Shepard (lance@waypointsystems.com) 7/22/99

BR_LogOut

DESCRIPTION:

This tag will set a session variable to "No" When used in conjunction with BR_Login it gives the abity to login (BR_Login) and logout (BR_Logout) of a directory structure.



ATTRIBUTES:

Datasource	(required)	= Datasouce that that contains the table to be checked.
SessionLogin	(required)	= The name of the session variable that you want to be set to "No" when the user confirms their logout.
ReturnTo	(optional)	= The name of the page you want the user to be CFLOCATIONed to after log out. Default is "/".





NOTES:

Designed to be used with the BR_LoginTag. Set the SessionLogin attribute the same in both tags.



USAGE:





EXAMPLES:

<CF_BR_LogOut


Datasource="#DataSource#"
SessionLogin="AmILoggedIn"
ReturnTo="/cf_tags">





AUTHOR:

Lance Shepard (lance@waypointsystems.com) 07/30/99