Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The AMI_iCaptcha interface

• Introduction

Capctha class interface.

• Interface synopsis

AMI_iCaptcha {
/* Constants */
// Digits charset
const AMI_iCaptcha::CHARSET_DIGITS =  0x01;
// Letters charset
const AMI_iCaptcha::CHARSET_LETTERS =  0x02;
/* Methods */
// Constructor.
public __construct ( string $module, string $sid, [ int $digits = 4 ], [ string $charset = self::CHARSET_DIGITS ] ) returns AMI_iCaptcha;
// Returns Image Generator 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 in db.
public saveImageString ( ) returns void;
}
Tags:
since 5.12.0

• Interface Constants

CHARSET_DIGITS

Digits charset

CHARSET_LETTERS

Letters charset

• Interface Methods

// Constructor.
public __construct ( string $module, string $sid, [ int $digits = 4 ], [ string $charset = self::CHARSET_DIGITS ] ) returns AMI_iCaptcha;
  • string $module
    Module name manipulating captha
  • string $sid
    Session Id
  • int $digits
    Symbols number
  • string $charset
    Available constants: self::CHARSET_DIGITS, self::CHARSET_LETTERS, self::CHARSET_LETTERS|self::CHARSET_DIGITS
// Returns Image Generator 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 in db.
public saveImageString ( ) returns void;