OpenCrypt - Help and Support - Frequently Asked Questions and Documentation DB

Edit Article: PHP Login Interface Tutorial and Guidance (version 1.6)

Title:

This documentation is updated with each new version of the software, please check you are viewing the correct documentation for your installation of OpenCrypt by going to: <a href="http://www.opencrypt.com/faq.php?c=25" class="genmed"><b>http://www.opencrypt.com/faq.php?c=25</b></a><p> The PHP login interface enables you to integrate user login with the content of your web site and use an HTML login interface embedded in your web pages rather than using the traditional pop-up login prompt. The system offers full anti-hack protection as with the usual pop-up login method, and also includes support for the 'OpenCrypt Points System'. <p> The PHP login interface offers seamless integration between your public and secure content, allowing new content areas in an HTML document to open when a user logs in, and because the interface is written in PHP, you have unlimited control over your content and the structure of your web site. Within minutes you can create sophisticated content structures, for example opening additional content in the web site for each additional month or day a user is registered, this is ideal for e-book's and online courses. <p> Note, the 'PHP Login Interface' is used instead of the standard pop-up prompt, it does not work with the pop-up login prompt as a method of providing an HTML login form! <p> <b>Configuration</b><br> Setting up the PHP login interface does require some knowledge of PHP, if you have some experience with PHP you should not have any trouble. If you are a novice computer user you may find this complicated, please feel free to contact us with your questions, however please keep in mind that our technical support team is not here to teach your to program PHP and can only offer basic guidance and advice. <p> login.php is located in the 'php' directory which you will find in your OpenCrypt 'Path to HTTPDocs' directory. login.php is the main PHP application, login_config.php is the configuration file, login_html.php is used to display the login prompt, four template files are also included for use with login.php; php-login.tmpl, php-failed-login.tmpl, php-logout.tmpl and php-logged-in.tmpl. <p> OpenCrypt version 1.5 and above do not require that you configure the 'PHP Login Interface' like previous versions, the system should be automatically configured. The configuration is updated whenever you adjust your 'Central Configuration', 'Register and Manage', 'Styles and Colours', 'Anti-Hack', 'OpenCrypt Robot' or 'E-Commerce Integration' configuration using the OpenCrypt administration panel. <p> <b>Basic Usage</b><br> To create a login interface, simply create a PHP file for your member's area content, this can simply be an HTML file which you have renamed as a '.php' file. <p> Place the following text in the PHP file at the very top of the file: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> <?PHP<br> require "login.php";<br> ?> </span></font></td></tr></table></center> <p> It is critical that this is at the top of the file, their must be no HTML, text or blank lines above this text. <p> This code will load the PHP login interface and associated functions including the shopping cart. <p> Note, in the require statements you may wish to use a full/absolute server path. To do this, look in your 'Central Configuration' and take the 'Path to HTTPDocs', then simply add '/php/' to the end of the path. e.g. /path/to/httpdocs/oc/php/ and place this before the file name in the require statement. For example: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> <?PHP<br> require "/path/to/httpdocs/oc/php/login.php";<br> ?> </span></font></td></tr></table></center> <p> As explained earlier, login.php does not display the login prompt, to do this we use login_html.php. Simply include the following code anywhere in the PHP document (after the login.php code): <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> <?PHP<br> require "login_html.php";<br> ?> </span></font></td></tr></table></center> <p> If you now load your PHP document on the web server, you will see a login prompt in the HTML/PHP document. You will see you can login, logout and so fourth, but at this stage it does not unlock any secure content. We do this using conditional statements based around the '$login_successful' variable. If a user is logged in, '$login_successful' will equal '1', if they have failed to login it will equal '0'. <p> An example of a basic query follows: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> <?PHP<br> if ("$login_successful" == "1") {<br> print <<<END<br> logged in<br> END;<br> } else {<br> print <<<END<br> not logged in<br> END;<br> }<br> ?> </span></font></td></tr></table></center> <p> This query is within it's own PHP area in the document, and would need the 'require "login_html.php";' code to be elsewhere in the PHP document, you can include the statement with the require line. <p> For example: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> <?PHP<br> require "login_html.php";<br> <br> if ("$login_successful" == "1") {<br> print <<<END<br> logged in<br> END;<br> } else {<br> print <<<END<br> not logged in<br> END;<br> }<br> ?> </span></font></td></tr></table></center> <p> The above two examples show a 'logged in' message when the user is logged in, and a 'not logged in' message when they are not. <p> These conditional statements form the basis for the login interface and these are what must be used to setup the secure and public content. You may place as many of these statements in a document as you wish, though you should only 'require' login.php and login_html.php once in each document. <p> Example of PHP document: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> <?PHP<br> require "login.php";<br> ?><br> <html><br> <head><title>Document</title></head><br> <body bgcolor="#ffffff" text="#000080" link="#800000"><br> <center><table width=650 cellpadding=5 cellspacing=0 border=0><br> <tr><td bgcolor="#000080"><font face="Arial" size="3" color="#eeeeee"><b>An Example PHP Login Interface</b></font></td></tr><br> <tr><td valign=top><font face="Arial">Introduction Text<p><br> Here is an example, below you will see a login prompt.<P><br> <p> <?PHP<br> require "login_html.php";<br> ?><br> <p><hr><p><p> <?PHP<br> if ("$login_successful" == "1") {<br> print <<<END<br> <font color="#ff0000">You have now logged in and opened the secure content in this document.</font><br> END;<br> } else {<br> print <<<END<br> Here is some content for non registered users.<br> END;<br> }<br> ?><br> <p><hr><p><p> <?PHP<br> if ("$login_successful" == "1") {<br> print <<<END<br> <font color="#ff0000">Second secure content area<br> END;<br> } else {<br> print <<<END<br> Here is some more content for non registered users.<br> END;<br> }<br> ?><p> <p></td></tr></table></center></body></html> </td></tr></table></center> <p> This example includes two areas of secure content which will open when logged in. <P> <b>Data Import</b><br> The following user data tags may be used in any .tmpl file. <p> <center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> %self% - Location of self, e.g. The file being called via the browser.<br> %url_cgi% - URL to directory containing OpenCrypt.<br> %username% - Logged in username.<br> %email% - User's email address.<br> %fname% - User's first name.<br> %lname%- User's last name.<br> %sub_id% - User's subscription id.<br> %sub_name% - User's subscription name.<br> %language% - User's language.<br> %date_opened% - User's date of account opening.<br> %date_expire%- User's data of account expiration.<br> %points% - User's points count.<br> %session% - Session id, used for PHP login and User Account Manager login. </span></font></td></tr></table></center> <p> The following user data may be displayed in any secure content (values will be blank if not logged in), document must be PHP and must 'require' login.php. <p> <center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> $envself - Location of self, e.g. The file being called via the browser.<br> $url_cgi - URL to directory containing OpenCrypt.<br> $dbusername - Logged in username.<br> $dbemail - User's email address.<br> $dbfname - User's first name.<br> $dblname - User's last name.<br> $dbsub_id - User's subscription id.<br> $dbsub_name - User's subscription name.<br> $dblanguage - User's language.<br> $dbvcode - User's validation code (if account not active).<br> $dbstage - User's account stage (if account not active, or being renewed).<br> $dbactive - User's account status.<br> $dbdate_opened - User's date of account opening.<br> $dbdate_expire - User's date of account expiration.<br> $dbpoints - User's points count.<br> $session - Session id, used for PHP login and User Account Manager login.<br> $envip - User's IP address.<br> $envref - User's referrer.<br> $envbrow - User's web browser. </span></font></td></tr></table></center> <p> A handy tip, users can move between the PHP login interface and any User Account Manager function thanks to the sessions system. Simply use the following link in your PHP documents: <p> <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> $url_cgi/manage.cgi?s=$session&a=home </span></font></td></tr></table></center> <p> Or in the templates files: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> %url_cgi%/manage.cgi?s=%session%&a=home </span></font></td></tr></table></center> <p> You can replace 'home' with other functions such as 'modify' or 'renew', to link directly to update account details or renew the account. <p> <b>Points System</b><br> To deduct points from an account, use the following code: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> $points = charge_points("10");<br> if ("$points" == "0") {<br> print "error";<br> } else {<br> print "ok";<br> } </span></font></td></tr></table></center> <p> This example will charge the logged in user, 10 points. If they do not have enough points, 'error' is displayed, otherwise 'ok' is displayed. <p> <b>Logging System</b><br> login.php will automatically log all accesses to the frontend statistics database, this includes the location of the file being loaded. If for some reason you wish to add additional logging, use the following code: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> frontend_log("action"); </span></font></td></tr></table></center> <p> Replace 'action' with the action id you wish to log. An example that is already is use in the software is: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> frontend_log("php_logged_in($envself)"); </span></font></td></tr></table></center> <p> <b>Shopping Basket</b><br> login.php will automatically detect and display a summary of the users shopping basket/cart, to display the cart summary, simply use the following code: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> print "$shopping_basket"; </span></font></td></tr></table></center> <p> Or, if for example you wish to place a table around the shopping basket summary, simply use the following code: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> if ("$shopping_basket") { <br> print <<<END<br> <form action="basket.php" method="get"><br> <table cellpadding="8" cellspacing="0" border="0"><br> <tr><td nowrap><br> <font face="Verdana" size="1"><br> $shopping_basket<br> </font><br> </td></tr></table><br> </form><br> END;<br> } </span></font></td></tr></table></center> <p> <b>'Add to Cart' Buttons</b><br> To create an 'Add to Cart' button, simply use the 'buybutton' function. Firstly we create a 'lookup_string' which specifies the details of the product/item. For example: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> $lookup_string ="exampleID---Example Product NAME---This is an example product description.---5.00---0---0---0---0"; </span></font></td></tr></table></center> <p> Simply replace, 'exampleID' with a product ID, this is used to identify the product within the system so it important you use different IDs for each product. Try to keep them short and simple. Then add your 'Product Name' and a 'Description' replacing the text in the example but making sure to leave the groups of three hypens intact. These are used as seperators/delimiters. Replace '5.00' with the price of the product/item. Ignore the following four zeros, these are reserved for future use when the system supports tax, shipping and recurring payments. <p> Then to display the 'Add to Cart' button, simply use the following line: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> buybutton($lookup_string); </span></font></td></tr></table></center> <p> For example: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> <?PHP<br> $lookup_string ="exampleID---Example Product NAME---This is an example product description.---5.00---0---0---0---0";<br> buybutton($lookup_string);<br> ?> </span></font></td></tr></table></center> <p> Note, the $lookup_string line should be on one line without any line returns. The example has line returns so it fits in the pop-up faq used on our web site... <p> If you want to display a quantity input box next to the 'Add to Cart' button, set the variable $show_quantity to '1' before loading the buybutton function. You can also return the output from the buybutton function to a string rather than having the function print the button by setting the variable $return_button to '1', this enables you to include the button in your HTML with less complicated source code. <p> For example: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> <?PHP<br> $show_quantity = "1";<br> $return_button = "1";<br> $lookup_string ="exampleID---Example Product NAME---This is an example product description.---5.00---0---0---0---0";<br> $button = buybutton($lookup_string);<br> print $button;<br> ?> </span></font></td></tr></table></center> <p> <b>Detect If Product Has Been Purchased</b><br> OpenCrypt version 1.7 includes a function for detecting if the logged in user has purchased a product before. This is used as follows: <p><center><table width=400 cellpadding=10 cellspacing=0 border=0 bgcolor="#eeeeee"><tr><td><font face="Verdana, Arial" size="2"><span class="gensmall"> require "$path_php/purchases.php";<br> $product_qty = lookup_purchases("product-ID"); </span></font></td></tr></table></center> <p> <b>Want to learn more about PHP?</b><br> If you are interested in learning more about PHP we would recommend the following resources: <div class="license_overview"><ul> <li><a href="http://www.w3schools.com/PHP/default.asp" target="new" class="genmed"><b>W3Schools PHP Tutorial</b></a> - http://www.w3schools.com/PHP/default.asp <li><a href="http://www.tizag.com/phpT/" target="new" class="genmed"><b>Tizag PHP Tutorial</b></a> - http://www.tizag.com/phpT/ </ul></div> <br> We would also recommend the following book: <div class="license_overview"><ul> <li><a href="http://www.dmcinsights.com/phpmysql3/" target="new" class="genmed"><b>PHP 6 and MySQL 5 for Dynamic Web Sites: Visual QuickPro Guide</b></a> - http://www.dmcinsights.com/phpmysql3/ </ul></div>

Notes:

Note, you must be logged in in order to submit revisions.


	Copyright © 1999 - 2008 ionix Limited. All Rights Reserved.	Powered by OpenCrypt