/jpgraph/docs/classref/AntiSpam.html
HTML | 96 lines | 69 code | 16 blank | 11 comment | 0 complexity | 47703e0c78c66aa6392d2c81377b5679 MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML><HEAD><style type="text/css"> 2 <!-- 3 A:link {font-family: helvetica, arial, geneva, sans-serif; font-size: small; text-decoration: none; color: #000000} 4 A:visited {font-family: helvetica, arial, geneva, sans-serif; font-size: small; text-decoration: none; color: #000000} 5 A:hover {font-family: helvetica, arial, geneva, sans-serif; font-size: small; text-decoration: underline; color: #FF0000} 6 A.no:link {font-family:inherit; font-size: inhreit;text-decoration: none; color: #000000} 7 A.no:visited {font-family:inherit; font-size: inherit;text-decoration: none; color: #000000} 8 A.no:hover {font-family:inherit; font-size: inherit;text-decoration: none; color: #000000} 9 th {font-family: helvetica, arial; color : black; font-size:90%; background : #b7c8b7; border-right:black solid 1pt; border-bottom:black solid 1pt;} 10 td {font-family: helvetica, arial; color : black; font-size:90%; background : white; border-right:black solid 1pt; border-bottom:black solid 1pt;} 11 12 //--> 13 </style></HEAD><hr><div style="padding-left:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;background-color:#deaa87;font-family:courier new;font-size:16pt;">Class <a class="no" name="_C_ANTISPAM"><b>AntiSpam</b></a></div> 14<i>(Defined in: jpgraph_antispam.php : 546)</i><br> <br><table cellspaceing=0 cellpadding=4 style="border:solid #303030 1px;"><tr><td align="center" style="background:lightgray;" > <a href="AntiSpam.html" style="font-family:arial;font-weight:bold;color:darkblue;">AntiSpam</a> </td></tr><tr><td valign=top> <a href="AntiSpam.html#_ANTISPAM_RAND">Rand()</a> <br> 15 <a href="AntiSpam.html#_ANTISPAM_SET">Set()</a> <br> 16 <a href="AntiSpam.html#_ANTISPAM_STROKE">Stroke()</a> <br> 17 <a href="AntiSpam.html#_ANTISPAM___CONSTRUCT">__construct()</a> <br> 18</td></tr></table> <p><div style="font-weight:bold;font-family:arial;font-size:100%;">Class usage and Overview</div>This module is used to create AntiSpam challenges that can be used to prevent automatic signup by robots on WEB-pages. <p> 19<hr><span style="font-family:arial;font-size:120%;font-weight:bold;">Class Methods</span><hr><p> 20<p> <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_ANTISPAM_RAND"><span style="color:#555555;">AntiSpam ::</span><br><b>Rand</b>($aLen)</a></div> 21 22<span style='font-family:arial;font-size:95%;'><i>Generate a random spam challenge string</i></span><p> 23 24<table cellspacing=0 style='border:black solid 1pt;' width=100%> 25<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr> 26<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000"> 27<span style="color: #0000BB">$aLen</span> 28</span> 29 30</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'> </td><td>Sets the length of the generated string</td></tr> 31</table> 32 33<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Instead of specifying the string manually that should be used as a challenge the string can be automatically generated. This is done witha call to the Rand() method. <br> 34 35<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000"> 36<span style="color: #0000BB">$antispam </span><span style="color: #007700">= new </span><span style="color: #0000BB">AntiSpam</span><span style="color: #007700">(); 37<br /></span><span style="color: #0000BB">$rval </span><span style="color: #007700">= </span><span style="color: #0000BB">$antispam</span><span style="color: #007700">-></span><span style="color: #0000BB">Rand</span><span style="color: #007700">(); 38<br />... 39<br /></span><span style="color: #0000BB"></span> 40</span> 41</b></div><br> 42<p> 43<p> <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_ANTISPAM_SET"><span style="color:#555555;">AntiSpam ::</span><br><b>Set</b>($aData)</a></div> 44 45<span style='font-family:arial;font-size:95%;'><i>Set the spam challenge string</i></span><p> 46 47<table cellspacing=0 style='border:black solid 1pt;' width=100%> 48<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr> 49<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000"> 50<span style="color: #0000BB">$aData</span> 51</span> 52 53</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'> </td><td>Spam challenge</td></tr> 54</table> 55 56<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>This is an alternative way of specifying the AntiSpam string. This can also be specified in the initial creation of the ANtiSpam object ro be automatically generated with a call to the Rand() method <br> 57 <div style="font-weight:bold;font-family:arial;font-size:90%;">See also:</div><ul><li><a href="AntiSpam.html#_ANTISPAM_RAND">AntiSpam::Rand()</a></ul> 58<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000"> 59<span style="color: #0000BB">$antispam </span><span style="color: #007700">= new </span><span style="color: #0000BB">AntiSpam</span><span style="color: #007700">(); 60<br />... 61<br /></span><span style="color: #0000BB">$antispam</span><span style="color: #007700">-></span><span style="color: #0000BB">Set</span><span style="color: #007700">(</span><span style="color: #0000BB">$mySpamVal</span><span style="color: #007700">);</span><span style="color: #0000BB"></span> 62</span> 63</b></div><br> 64<p> 65<p> <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_ANTISPAM_STROKE"><span style="color:#555555;">AntiSpam ::</span><br><b>Stroke</b>()</a></div> 66 67<span style='font-family:arial;font-size:95%;'><i>Send the antispam image back to the browser</i></span><p> 68<br> 69 70<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>This sends the antispam image back to the browser or to an optional file named as the first and only argument. <br> 71 <div style="font-weight:bold;font-family:arial;font-size:90%;">See also:</div><ul><li><a href="AntiSpam.html#_ANTISPAM___CONSTRUCT">AntiSpam::__construct()</a><li><a href="AntiSpam.html#_ANTISPAM_RAND">AntiSpam::Rand()</a></ul> 72<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000"> 73<span style="color: #0000BB">$antispam </span><span style="color: #007700">= new </span><span style="color: #0000BB">AntiSpam</span><span style="color: #007700">(); 74<br /></span><span style="color: #0000BB">$rval </span><span style="color: #007700">= </span><span style="color: #0000BB">$antispam</span><span style="color: #007700">-></span><span style="color: #0000BB">Rand</span><span style="color: #007700">(); 75<br />... 76<br /></span><span style="color: #0000BB">$antispam</span><span style="color: #007700">-></span><span style="color: #0000BB">Stroke</span><span style="color: #007700">()</span><span style="color: #0000BB"></span> 77</span> 78</b></div><br> 79<p> 80<p> <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_ANTISPAM___CONSTRUCT"><span style="color:#555555;">AntiSpam ::</span><br><b>__construct</b>($aData)</a></div> 81 82<span style='font-family:arial;font-size:95%;'><i>Create a new ANtiSpam challenge image</i></span><p> 83 84<table cellspacing=0 style='border:black solid 1pt;' width=100%> 85<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr> 86<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000"> 87<span style="color: #0000BB">$aData</span> 88</span> 89 90</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000"> 91<span style="color: #0000BB"></span><span style="color: #DD0000">''</span><span style="color: #0000BB"></span> 92</span> 93</td><td>Data to be displayed</td></tr> 94</table> 95 96<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>This method creates a new instance of the AntiSpam challenge. When the anti-spam imga eis created it is possible to directly use a supplied data string that should be displayed. 97 98The data can also be added afterwards with a call to Set() <br> 99 <div style="font-weight:bold;font-family:arial;font-size:90%;">See also:</div><ul><li><a href="AntiSpam.html#_ANTISPAM_SET">AntiSpam::Set()</a><li><a href="AntiSpam.html#_ANTISPAM_RAND">AntiSpam::Rand()</a></ul> 100<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000"> 101<span style="color: #0000BB">$spam </span><span style="color: #007700">= new </span><span style="color: #0000BB">AntiSpam</span><span style="color: #007700">();</span><span style="color: #0000BB"></span> 102</span> 103</b></div><br> 104<p> <hr> <p></html>