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

Element index for package Securimage

[ a ] [ b ] [ c ] [ d ] [ g ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ w ]

a

$audio_format
in file securimage.php, variable Securimage::$audio_format
    Type of audio file to generate (mp3 or wav)
$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

b

$b
in file securimage.php, variable Securimage_Color::$b
    Blue component: 0-255
$background_directory
in file securimage.php, variable Securimage::$background_directory
    Scan this directory for gif, jpg, and png files to use as background images.
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.
top

d

$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.
top

g

$g
in file securimage.php, variable Securimage_Color::$g
    Green component: 0-255
$gd_font_file
in file securimage.php, variable Securimage::$gd_font_file
    Note: Use of GD fonts is not recommended as many distortion features are not available
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 or MP3 file data of the spoken code.
This is appropriate for output to the browser as audio/x-wav or audio/mpeg
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 as a Securimage_Color.
$image_height
in file securimage.php, variable Securimage::$image_height
    The desired width of the CAPTCHA image.
$image_signature
in file securimage.php, variable Securimage::$image_signature
    Text to write at the bottom corner of 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
    Color of lines drawn over text
top

m

$multi_text_color
in file securimage.php, variable Securimage::$multi_text_color
    Array of Securimage_Colors which will be randomly selected for each letter.
top

n

$num_lines
in file securimage.php, variable Securimage::$num_lines
    Draw vertical and horizontal lines on the image.
top

o

outputAudioFile
in file securimage.php, method Securimage::outputAudioFile()
    Output audio file with HTTP headers to browser
top

p

$perturbation
in file securimage.php, variable Securimage::$perturbation
    How much to distort image, higher = more distortion.
Distortion is only available when using TTF fonts.
top

r

$r
in file securimage.php, variable Securimage_Color::$r
    Red component: 0-255
top

s

$session_name
in file securimage.php, variable Securimage::$session_name
    The session name to use if not the default. Blank for none
$signature_color
in file securimage.php, variable Securimage::$signature_color
    Color to use for writing signature text
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
Securimage_Color
in file securimage.php, method Securimage_Color::Securimage_Color()
    Create a new Securimage_Color object.
Securimage_Color
in file securimage.php, class Securimage_Color
    Color object for Securimage CAPTCHA
setAudioPath
in file securimage.php, method Securimage::setAudioPath()
    Set the path to the audio directory.
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.
$text_color
in file securimage.php, variable Securimage::$text_color
    The text color to use for drawing characters as a Securimage_Color.
This value is ignored if $use_multi_text is set to true.
Make sure this contrasts well with the background color or image.
$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
    Use a gd font instead of 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
    Use wordlist of not
top

w

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

Documentation generated on Fri, 13 Nov 2009 02:59:27 -0800 by phpDocumentor 1.4.3