zCaptcha Class Reference
[Captcha Validation Images]

zCaptcha generates Captcha Images Dynamically Requires GD Librery To be Installed Its Meant to be Called from a Controller More...

Inheritance diagram for zCaptcha:

[legend]

Collaboration diagram for zCaptcha:

[legend]

Public Member Functions
	captcha (&$controller, $len=null)
	Supply the Controller Object and Length(optional) of the captcha Image e.g.
	putText ()
	makeImg ($length)
	output ()
	Outputs the image as image/png.
	strSep ($str, $id=-100)
Data Fields
	$canvas
	$baseColor
	$store = array()
	$setup
	$fonts
	$orgStr
	$controller

---

Detailed Description

zCaptcha generates Captcha Images Dynamically Requires GD Librery To be Installed Its Meant to be Called from a Controller

Definition at line 30 of file captcha.php.

---

Member Function Documentation

zCaptcha::captcha( zigControiller& $controller, int $len = null )

Supply the Controller Object and Length(optional) of the captcha Image e.g.

use new zCaptcha($this) in the controller to initialize

Parameters:

	$controller
	$len

Definition at line 46 of file captcha.php.

References $controller, $val, zDef::get(), makeImg(), zDef::set(), and zSession::start().

Show Source

                                             {
    $this->controller = $controller;
    $deff = parse_ini_file(ZIGROOT.DRS.Z_DIR_PROJECTS.DRS.Z_PROJECT_DIR.DRS.ZIGSETTINGSDIR.DRS.'captcha.ini.php', true);
    foreach($deff['sys'] as $key => $val){
      if(eregi('^on$', $val))$val = true;
      if(eregi('^off$', $val))$val = false;
      zDef::set($key, $val);
    }
    if($len == null)$len = zDef::get('Z_CAPTCHA_LENGTH');//Using the default Length
    if(zDef::get('Z_CAPTCHA_USE_EXCLUSIVE_FONT'))$this->fonts = array_keys($deff['fonts']);//Gathering the Fonts
    //Prepare the basic canvas
    $this->canvas = imagecreate(zDef::get('Z_CAPTCHA_HEIGHT'), zDef::get('Z_CAPTCHA_WIDTH'));
    $_tmp_col = explode(',',zDef::get('Z_CAPTCHA_BASE_COLOR'));
    $this->baseColor = imagecolorallocate($this->canvas, (int)trim($_tmp_col[0]), (int)trim($_tmp_col[1]), (int)trim($_tmp_col[2]));
    if(eregi('on', zDef::get('Z_CAPTCHA_TRANSPARENT'))){
      $tmp_trans = imagecolorexact($this->canvas, (int)trim($_tmp_col[0]), (int)trim($_tmp_col[1]), (int)trim($_tmp_col[2]));
      imagecolortransparent($this->canvas, $tmp_trans);
    }
    //}
    $this->makeImg($len);
    zSession::start();//Start the session
  }

Here is the call graph for this function:

Top 

zCaptcha::putText( ) 

For internal use only.

Definition at line 71 of file captcha.php.

References zDef::get(), and strSep().

Referenced by makeImg().

Show Source

                    {
    if(count($this->store) > 0){
      $next = max($this->store)+zDef::get('Z_CAPTCHA_TEXT_GAP');
    }else{
      $next = zDef::get('Z_CAPTCHA_TEXT_X_START');
    }
    $rand = rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_CHAR_RANGE'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_CHAR_RANGE'), 1));
    if(zDef::get('Z_CAPTCHA_USE_EXCLUSIVE_FONT')){
      $currentFont = ZIGROOT.DRS.Z_DIR_PROJECTS.DRS.Z_PROJECT_DIR.DRS.Z_DIR_FONT.DRS.$this->fonts[rand(0, count($this->fonts)-1)];
      imagefttext($this->canvas,
                    rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_SIZE_RANGE'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_SIZE_RANGE'), 1)),
                    rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_ANGLE_RANGE'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_ANGLE_RANGE'), 1)),
                    $next,
                    rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_Y_RANGE'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_Y_RANGE'), 1)),
                    imagecolorallocate($this->canvas,
                                        rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_RED'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_RED'), 1)),
                                        rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_GRN'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_GRN'), 1)),
                                        rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_BLU'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_BLU'), 1))
                                      ),
                    $currentFont,
                    chr($rand)
                  );
    }else{
      imagechar($this->canvas,
                  zDef::get('Z_CAPTCHA_PLAIN_TEXT_SIZE'),
                  $next,
                  rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_Y_RANGE'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_Y_RANGE'), 1)),
                  chr($rand),
                  imagecolorallocate($this->canvas,
                                      rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_RED'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_RED'), 1)),
                                      rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_GRN'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_GRN'), 1)),
                                      rand($this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_BLU'), 0), $this->strSep(zDef::get('Z_CAPTCHA_TEXT_COL_RANGE_BLU'), 1))
                                    )
                );
    }
    $this->store[] = $next;
    $this->orgStr .= chr($rand);
  }

Here is the call graph for this function:

Top 

zCaptcha::makeImg( int $length ) 

For internal use only.

Definition at line 112 of file captcha.php.

References putText().

Referenced by captcha().

Show Source

                           {
    for($i=0;$i<=$length-1;$i++){
      $this->putText();
    }
  }

Here is the call graph for this function:

Top 

zCaptcha::output( ) 

Outputs the image as image/png.

Call This Method Finall to show the Image

$captchaObj = new zCaptcha($this);
 $captchaObj->output();

Stores the String in the Captcha Object in a Session variable $_SESSION['gd_str']

Definition at line 125 of file captcha.php.

Show Source

                   {
    $this->controller->noAutoViewRender();
    $this->controller->noLayout();
    $this->controller->setContentType('image/png');
    imagepng($this->canvas);
    imagedestroy($this->canvas);
    $_SESSION['gd_str'] = $this->orgStr;
  }

Top 

zCaptcha::strSep( int $str, int $id = -100 )

For internal use only.

Definition at line 136 of file captcha.php.

Referenced by putText().

Show Source

                                   {
    foreach(explode(',', $str) as $k => $v){
      $ret[$k] = trim($v);
    }
    if($id == -100){
      return $ret;
    }else{
      return $ret[$id];
    }
  }

Top 

---

Field Documentation

zCaptcha::$canvas

Definition at line 31 of file captcha.php.

Top 

zCaptcha::$baseColor

Definition at line 32 of file captcha.php.

Top 

zCaptcha::$store = array()

Definition at line 33 of file captcha.php.

Top 

zCaptcha::$setup

Definition at line 34 of file captcha.php.

Top 

zCaptcha::$fonts

Definition at line 35 of file captcha.php.

Top 

zCaptcha::$orgStr

Definition at line 36 of file captcha.php.

Top 

zCaptcha::$controller

Definition at line 37 of file captcha.php.

Referenced by captcha().

Top 

---

The documentation for this class was generated from the following file:

• captcha.php