Amiro.CMS API Reference
 Amiro.Ru / Manual

Orphus
Loading search...

The AMI_Captcha class

• Introduction

Capctha class provides capthca manipulation functionality. At this moment not recomended to use. Use only AMI_CaptchaImage.

• Class synopsis

AMI_Captcha implements AMI_iCaptcha {
/* Properties */
// Number of digits
protected int $digits;
// Contains module name manipulating captha.
protected string $modId;
// Image generator object.
protected AMI_iCaptchaImage $oImageGenerator;
// Captcha data stored in db time period.
protected string $period = '-1 hour';
// Session id.
protected string $sessionId;
/* Methods */
// Return coresponding constat (CHARSET_DIGITS, CHARSET_LETTERS, CHARSET_LETTERS|CHARSET_DIGITS ) value to incoming $charset.
public static getConstantCharset ( string $charset ) returns self::CHARSET_DIGITS|self::CHARSET_LETTERS|(self::CHARSET_LETTERS|self::CHARSET_DIGITS);
// Constructor.
public __construct ( string $modId, string $sid, [ int $digits = 4 ], [ string $charset = self::CHARSET_DIGITS ] ) returns AMI_Captcha;
// Returns ImageGenerator object.
public getImageGenerator ( ) returns AMI_iCaptchaImage;
// Loads image string from db.
public loadImageString ( ) returns mixed;
// Removes record from DB.
public removeRecord ( ) returns void;
// Saves image string to DB.
public saveImageString ( ) returns void;
}
Tags:
resource captcha AMI::getResource('captcha')
since 5.12.0

• Class Properies

protected int $digits

Number of digits

protected string $modId

Contains module name manipulating captha.

protected AMI_iCaptchaImage $oImageGenerator

Image generator object.

protected string $period

Captcha data stored in db time period.

protected string $sessionId

Session id.

• Class Methods

// Return coresponding constat (CHARSET_DIGITS, CHARSET_LETTERS, CHARSET_LETTERS|CHARSET_DIGITS ) value to incoming $charset.
public static getConstantCharset ( string $charset ) returns self::CHARSET_DIGITS|self::CHARSET_LETTERS|(self::CHARSET_LETTERS|self::CHARSET_DIGITS);
  • string $charset
    Old charset string
// Constructor.
public __construct ( string $modId, string $sid, [ int $digits = 4 ], [ string $charset = self::CHARSET_DIGITS ] ) returns AMI_Captcha;
  • string $modId
    Module name manipulating captha
  • string $sid
    Session Id
  • int $digits
    Number of digits
  • string $charset
    Available constants: self::CHARSET_DIGITS, self::CHARSET_LETTERS, self::CHARSET_LETTERS|self::CHARSET_DIGITS

Implementation of: AMI_iCaptcha::__construct().

// Returns ImageGenerator object.
public getImageGenerator ( ) returns AMI_iCaptchaImage;

Implementation of: AMI_iCaptcha::getImageGenerator().

// Loads image string from db.
public loadImageString ( ) returns mixed;

Implementation of: AMI_iCaptcha::loadImageString().

// Removes record from DB.
public removeRecord ( ) returns void;

Implementation of: AMI_iCaptcha::removeRecord().

// Saves image string to DB.
public saveImageString ( ) returns void;

Implementation of: AMI_iCaptcha::saveImageString().