Class RECaptcha

Description

Két féle üzemmódot felváltva használó Captcha.

  1. Random karakterek felismerése
  2. Egyszerű matematikai művelet megoldása.
Ezen kívül két féle módon jeleníthető meg. Egy részt kép típusú fájlban
  1. <?php
  2. /* 
  3.  * Példa Captcha létrehozására kép típusú php fájlban
  4.  */
  5. require_once'../RECaptcha.class.php';
  6. //kép létrehozás
  7. $captcha new RECaptcha(array(
  8.         'fonttype' => '../fonts/arial.ttf'//Ez az alapértelmezett is
  9.         'fontsize' => '10',
  10.         'bgcolor' => '170,255,200',
  11.         'bgintensity' => 2,
  12.         'fgintensity' => 3,
  13.         'height' => '50',
  14.         'width' => '100',
  15.         'spacerange' => array(1,2)
  16.         ));
  17. $captcha->flush();
  18.  
  19. ?>
Más részt html kódba ágyazva, a kép forrását base64 kódolással az img tag src tulajdonságába helyezve
  1. <?php
  2. /*
  3.  * Példa Captcha létrehozására html kódba ágyazva
  4.  */
  5. require_once'../RECaptcha.class.php';
  6. //kép létrehozás
  7. $captcha new RECaptcha(array(
  8.         'fonttype' => '../fonts/arial.ttf'//Ez az alapértelmezett is
  9.         'fontsize' => 10,
  10.         'bgcolor' => '170,255,200',
  11.         'bgintensity' => 2,
  12.         'fgintensity' => 3,
  13.         'height' => '50',
  14.         'width' => '100',
  15.         'spacerange' => array(1,2),
  16.         'params' => array(
  17.             'style'=>'width: 300px;'
  18.             )
  19.         ));
  20. print $captcha;
  21.  
  22. ?>

  • author: Takács Ákos (Rimelek), programmer [at] rimelek [dot] hu
  • version: 1.0
  • copyright: Copyright (C) 2010, Takács Ákos

Located in /RECaptcha.class.php (line 38)


	
			
Variable Summary
 string $bgcolor
 int $fontsize
 string $fonttype
 int $height
 array $params
 string $session_name
 array $spacerange
 string $text
 string $type
 int $width
 int $_bgcolor
Method Summary
 RECaptcha __construct ([array $options = array()])
 string codeGenerator (int $fontsize)
 void flush ([bool $bool = false])
 void randomBg (int $intensity)
 void setBackground (mixed $bgcolor, [int $greenc = null], [int $bluec = null])
 void setProperties ( &$options, array $options)
 string __toString ()
Variables
string $bgcolor = '255,255,255' (line 66)

Háttérszín RGB összetevői: R,G,B formátumban

  • access: protected
int $bgintensity = 10 (line 87)

Háttérzavarás intenzitásának beállítása

  • access: protected
int $fgintensity = 5 (line 94)

A karakterek előttizavaró jelek intenzitása

  • access: protected
int $fontsize = 17 (line 101)

Betűméret

  • access: protected
string $fonttype = 'fonts/arial.ttf' (line 80)

Betűtípus ttf fájljának útvonala

  • access: protected
int $height = 50 (line 59)

A kép magassága

  • access: protected
array $params = array() (line 121)

__toString() -ben generált html img tag plusz paraméterei

Például:

  1.  $params array('style'='width: 300px;''onclick'=>'eventHandler();');

  • access: protected
string $session_name = 'captcha_code' (line 129)

Ezen nevű session változóba teszi be a captcha -ra adandó válasz értékét.

Ezt lehet majd felhasználni az ellenőrzésnél.

  • access: protected
array $spacerange = array(6,8) (line 137)

Karakterek közti minimális és maximális távolság pixelben A tömb első és második elemei sorrendben.

  • access: protected
string $text (line 110)

A Captcha által megjelenített képre adandó válasz értéke.

Matematikai művelet esetén annak megoldása, karakterek esetén a megjelenített karakterek.

  • access: protected
string $type = 'jpeg' (line 45)

A kép típusa (jpeg, png, gif)

  • access: protected
int $width = 200 (line 52)

A kép szélessége

  • access: protected
int $_bgcolor (line 73)

Háttérszín azonosítója

  • access: protected
Methods
Constructor __construct (line 145)

Captcha létrehozása különböző opciókkal. Az opciókról részletesebben a setProperties() metódus dokumentációjánál.

  • access: public
RECaptcha __construct ([array $options = array()])
  • array $options
codeGenerator (line 364)

Captcha kód generálása a képre

  • return: A szükséges válasz $text
  • access: protected
string codeGenerator (int $fontsize)
  • int $fontsize: Betűméret
flush (line 233)

Kép kimenetre küldése.

  • access: public
void flush ([bool $bool = false])
  • bool $bool: ha true, akkor nem küld Content-type header-t. Ez a __toString() metódusnál lényeges.
randomBg (line 316)

Random kép torzítás

  • access: protected
void randomBg (int $intensity)
  • int $intensity: Torzítás erőssége
setBackground (line 276)
  • access: protected
void setBackground (mixed $bgcolor, [int $greenc = null], [int $bluec = null])
  • mixed $bgcolor: Ha a második két paraméter is meg van adva, akkor az RGB színösszetevők vörös komponense. egyébként 2 formátum engedélyezett.
    • Decimális: R,G,B
    • Hexa: #RGB
  • int $greenc: RGB zöld komponense (decimális)
  • int $bluec: RGB kék komponense (decimális)
setProperties (line 169)

Captcha opcióinak beállítása

  • access: protected
void setProperties ( &$options, array $options)
__toString (line 490)

A kép html img tagba helyezve base64 encode-olással.

  • access: public
string __toString ()

Documentation generated on Mon, 29 Mar 2010 19:52:11 +0200 by phpDocumentor 1.4.1