[ class tree: ] [ index: ] [ all elements ]

Index of all elements

[ a ] [ c ] [ d ] [ f ] [ g ] [ i ] [ l ] [ m ] [ s ] [ t ] [ u ] [ w ]

a

$arc_linethrough
in file securimage.php, variable Securimage::$arc_linethrough
    For added security, it is a good idea to draw arced lines over the letters to make it harder for bots to segment the letters.
Two arced lines will be drawn over the text on each side of the image.
This is currently expirimental and may be off in certain configurations.
$arc_line_colors
in file securimage.php, variable Securimage::$arc_line_colors
    The colors or color of the arced lines.
Use HTML hex notation with preceding # sign, and separate each value with a comma.
This should be similar to your font color for single color images.
$audio_path
in file securimage.php, variable Securimage::$audio_path
    Full path to the WAV files to use to make the audio files, include trailing /.
Name Files [A-Z0-9].wav
top

c

$charset
in file securimage.php, variable Securimage::$charset
    The character set for individual characters in the image.
Letters are converted to uppercase.
The font must support the letters or there may be problematic substitutions.
$code_length
in file securimage.php, variable Securimage::$code_length
    The length of the code to generate.
check
in file securimage.php, method Securimage::check()
    Validate the code entered by the user.
createCode
in file securimage.php, method Securimage::createCode()
    Create a code and save to the session
top

d

$draw_angled_lines
in file securimage.php, variable Securimage::$draw_angled_lines
    Set to true to draw angled lines on the image in addition to the horizontal and vertical lines.
$draw_lines
in file securimage.php, variable Securimage::$draw_lines
    Draw vertical and horizontal lines on the image.
$draw_lines_over_text
in file securimage.php, variable Securimage::$draw_lines_over_text
    Draw the lines over the text.
If fales lines will be drawn before putting the text on the image.
This can make the image hard for humans to read depending on the line thickness and distance.
top

f

$font_size
in file securimage.php, variable Securimage::$font_size
    The font size.
Depending on your version of GD, this should be specified as the pixel size (GD1) or point size (GD2)
top

g

$gd_font_file
in file securimage.php, variable Securimage::$gd_font_file
    The GD font to use.
Internal gd fonts can be loaded by their number.
Alternatively, a file path can be given and the font will be loaded from file.
$gd_font_size
in file securimage.php, variable Securimage::$gd_font_size
    The approximate size of the font in pixels.
This does not control the size of the font because that is determined by the GD font itself.
This is used to aid the calculations of positioning used by this class.
getAudibleCode
in file securimage.php, method Securimage::getAudibleCode()
    Get WAV file data of the spoken code.
This is appropriate for output to the browser as audio/x-wav
getCode
in file securimage.php, method Securimage::getCode()
    Get the captcha code
top

i

$image_bg_color
in file securimage.php, variable Securimage::$image_bg_color
    The background color for the image.
This should be specified in HTML hex format.
Make sure to include the preceding # sign!
$image_height
in file securimage.php, variable Securimage::$image_height
    The desired width of the CAPTCHA image.
$image_type
in file securimage.php, variable Securimage::$image_type
    The image format for output.
Valid options: SI_IMAGE_PNG, SI_IMAGE_JPG, SI_IMAGE_GIF
$image_width
in file securimage.php, variable Securimage::$image_width
    The desired width of the CAPTCHA image.
top

l

$line_color
in file securimage.php, variable Securimage::$line_color
    The color of the lines drawn on the image.
Use HTML hex format with preceding # sign.
$line_distance
in file securimage.php, variable Securimage::$line_distance
    How far apart to space the lines from eachother in pixels.
$line_thickness
in file securimage.php, variable Securimage::$line_thickness
    How thick to draw the lines in pixels.
1-3 is ideal depending on distance
top

m

$multi_text_color
in file securimage.php, variable Securimage::$multi_text_color
    String of HTML hex colors to use.
Separate each possible color with commas.
Be sure to precede each value with the # sign.
top

s

Securimage
in file securimage.php, method Securimage::Securimage()
    Class constructor.
Because the class uses sessions, this will attempt to start a session if there is no previous one.
If you do not start a session before calling the class, the constructor must be called before any output is sent to the browser.
Securimage
in file securimage.php, class Securimage
    Securimage CAPTCHA Class.
securimage.php
procedural page securimage.php
show
in file securimage.php, method Securimage::show()
    Generate a code and output the image to the browser.
SI_IMAGE_GIF
in file securimage.php, constant SI_IMAGE_GIF
    Output images in GIF format
SI_IMAGE_JPEG
in file securimage.php, constant SI_IMAGE_JPEG
    Output images in JPEG format
SI_IMAGE_PNG
in file securimage.php, constant SI_IMAGE_PNG
    Output images in PNG format
top

t

$text_angle_maximum
in file securimage.php, variable Securimage::$text_angle_maximum
    The minimum angle in degrees, with 0 degrees being left-to-right reading text.
Higher values represent a counter-clockwise rotation.
For example, a value of 90 would result in bottom-to-top reading text.
$text_angle_minimum
in file securimage.php, variable Securimage::$text_angle_minimum
    The minimum angle in degrees, with 0 degrees being left-to-right reading text.
Higher values represent a counter-clockwise rotation.
For example, a value of 90 would result in bottom-to-top reading text.
$text_color
in file securimage.php, variable Securimage::$text_color
    The text color to use for drawing characters.
$text_maximum_distance
in file securimage.php, variable Securimage::$text_maximum_distance
    Letters can be spaced apart at random distances.
$text_minimum_distance
in file securimage.php, variable Securimage::$text_minimum_distance
    Letters can be spaced apart at random distances.
$text_transparency_percentage
in file securimage.php, variable Securimage::$text_transparency_percentage
    The percentage of transparency, 0 to 100.
A value of 0 is completely opaque, 100 is completely transparent (invisble)
$text_x_start
in file securimage.php, variable Securimage::$text_x_start
    The X-Position on the image where letter drawing will begin.
This value is in pixels from the left side of the image.
$ttf_file
in file securimage.php, variable Securimage::$ttf_file
    The path to the TTF font file to load.
top

u

$use_gd_font
in file securimage.php, variable Securimage::$use_gd_font
    Whether to use a GD font instead of a TTF font.
TTF offers more support and options, but use this if your PHP doesn't support TTF.
$use_multi_text
in file securimage.php, variable Securimage::$use_multi_text
    Set to true to use multiple colors for each character.
$use_transparent_text
in file securimage.php, variable Securimage::$use_transparent_text
    Set to true to make the characters appear transparent.
$use_wordlist
in file securimage.php, variable Securimage::$use_wordlist
    True to use a word list file instead of a random code
top

w

$wordlist_file
in file securimage.php, variable Securimage::$wordlist_file
    Create codes using this word list
top

Documentation generated on Sun, 06 Jan 2008 21:12:50 -0800 by phpDocumentor 1.3.1