|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.FrameworkSupertype
coldbox.system.Plugin
contentbox.plugins.Captcha
public class Captcha
plugin for CF8 built in captcha functionality
Constructor Summary | |
---|---|
init(any controller)
|
Method Summary | |
---|---|
private void |
clearCaptcha()
|
any |
display([numeric length='4'], [string text='[runtime expression]'], [string width='200'], [string height='50'], [string fonts='verdana,arial,times new roman,courier'], [string message='Please enter the correct code shown in the graphic.'])
I display the captcha and an error message, if appropriate |
string |
getCaptchaCode()
|
private any |
getCaptchaStorage()
|
private boolean |
isValidated()
|
private string |
makeRandomString([numeric length='4'])
|
void |
setCaptchaCode(string captchastring)
|
private void |
setValidated(boolean validated)
|
boolean |
validate(string code)
I validate the passed in string against the captcha code |
Methods inherited from class coldbox.system.Plugin |
---|
getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL
|
Methods inherited from class coldbox.system.FrameworkSupertype |
---|
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel
|
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(any controller)
controller
Method Detail |
---|
private void clearCaptcha()
public any display([numeric length='4'], [string text='[runtime expression]'], [string width='200'], [string height='50'], [string fonts='verdana,arial,times new roman,courier'], [string message='Please enter the correct code shown in the graphic.'])
length
text
width
- width of captcha image in pixelsheight
- height of captcha image in pixelsfonts
- fonts to use for characters in captcha imagemessage
- Message to display below captcha if validate method failed.public string getCaptchaCode()
private any getCaptchaStorage()
private boolean isValidated()
private string makeRandomString([numeric length='4'])
length
public void setCaptchaCode(string captchastring)
captchastring
private void setValidated(boolean validated)
validated
public boolean validate(string code)
code
|
ContentBox Core API 1.6.0 | ||||
FRAMES |