MF_Widget::MF_Widget(): Constructor Method.
MF_Widget::addRule(): Adds a validation rule to the list of $rules.
MF_Widget::attr(): This is the accessor method for setting and getting the value of
MF_Widget::changeType()
MF_Widget::display(): Returns the display HTML for this widget. The optional parameter determines whether or not to automatically display the widget nicely, or whether to simply return the widget (for use in a template).
MF_Widget::getAttrs(): Returns a list of all of the attributes of this object's HTML tag in a string ready to be concatenated into the actual rendered tag output.
MF_Widget::getValue(): Fetches the actual value for this widget.
MF_Widget::invalid(): Returns a ' class="invalid"' string if the widget's $invalid property is set to true, or an empty string otherwise.
MF_Widget::setDefault(): Sets the default value for the widget.
MF_Widget::setValue(): Sets the *ACTUAL* value for this widget. An optional second parameter can be passed, which is unused here, but can be used in complex widget types to assign parts of a value and piece it together from multiple physical form fields.
MF_Widget::setValues(): Sets the *POSSIBLE* values for this widget. If $value is given, sets $this->value as a hash, otherwise, as a string.
MF_Widget::unsetAttr(): Use this method to remove an attribute from the tag
MF_Widget::validate(): Validates the widget against its set of $rules. Returns false on failure to pass any rule.
MF_Widget::validation(): Sets the validation $rule for this widget. Note: This method is deprecated and only wraps around the addRule() method anyway. Please use addRule() instead, since this method will be removed in a near-future release.

Class Details

[line 46]
Security widget. Performs a CAPTCHA test on the user.


1     <?php
2     
3      $widget = new MF_Widget_security ('name');
4      $widget->validation ('is "foo"');
5      $widget->setValue ('foo');
6      $widget->error_message = 'Oops!  This widget is being unruly!';
7     
8      ? >

Tags:

access:	public
version:	1.2, 2002-05-03, $Id: Security.php,v 1.1 2007/01/14 22:10:43 lux Exp $
license:	http://www.sitellite.org/index/license
copyright:	Copyright (C) 2001-2003, Simian Systems Inc.
author:	John Luxford <mailto:lux@simian.ca>

[ Top ]

Class Variables

$extra = ''

[line 54]

A way to pass extra parameters to the HTML form tag, for example 'enctype="multipart/formdata"'.

Tags:

access:

public

Type:	mixed
Overrides:	Array

[ Top ]

$verify_method = 'figlet'

[line 86]

This is the method to use to verify the user is human. The default

is 'figlet' which renders random letters and numbers using a combination of ascii symbols on several lines. This technique is less typical than other form security techniques, which may increase its security slightly, but it is also text-based and therefore less secure in that regard. It is the default because it requires no special PHP extensions to use.

The alternative is 'turing' which generates an image of random letters and numbers, making it a slightly more effective security precaution. This requires PHP's GD extension however, which is not available on all systems. Check your phpinfo() output to determine compatibility.

Turing tests are also known as CAPTCHA tests. Their purpose is to verify that the user is human by having them perform a test that would be difficult for a computer to pass.

Tags:

access:

public

Type:

mixed

[ Top ]

Class Methods

constructor MF_Widget_security [line 95]

MF_Widget_security MF_Widget_security(
string
$name)

Constructor Method.

method display [line 129]

string display(
[boolean
$generate_html = 0])

Returns the display HTML for this widget. The optional parameter determines whether or not to automatically display the widget nicely, or whether to simply return the widget (for use in a template).

Tags:

access:

public

Overrides MF_Widget::display() (Returns the display HTML for this widget. The optional parameter determines whether or not to automatically display the widget nicely, or whether to simply return the widget (for use in a template).)

Parameters:

boolean

$generate_html

[ Top ]

method verify [line 104]

void verify(
)

[ Top ]

Packages

Classes

Files

Class: MF_Widget_security

Class Overview

Author(s)

Version

Copyright

Variables

Methods

Inherited Variables

Class: MF_Widget

Inherited Methods

Class: MF_Widget

Class Details

Tags:

Class Variables

$extra = ''

Tags:

$type = 'security'

Tags:

$verify_method = 'figlet'

Tags:

Class Methods

constructor MF_Widget_security [line 95]

Tags:

Parameters:

method display [line 129]

Tags:

Parameters:

method verify [line 104]