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 56]
Password widget. Displays an HTML <input type="password" /> form field.

New in 1.2:

Added encrypt() and verify() methods.

New in 1.4:

Added a makeStrong() method that automatically defines a series of recommended rules for all passwords, such as minimum length and required characters to reduce the odds of guessability.
Added a generate() method that generates strong passwords for you.
Added a $ignoreEmpty property.


1     <?php
2     
3      $widget = new MF_Widget_password ('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-08-27, $Id: Password.php,v 1.2 2005/07/06 15:30:56 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 64]

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

Tags:

access:

public

Type:

mixed

[ Top ]

$ignoreEmpty = true

[line 85]

Determines whether or not this password field should be ignored

if left blank. This is useful for situations where a password change field may be present in a form but is not required to be filled out to change it since the current value cannot or should not be sent back to the browser. Defaults to true.

Tags:

access:

public

Type:	mixed
Overrides:	Array

[ Top ]

Class Methods

method display [line 216]

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 encrypt [line 98]

string encrypt(
[string
$value = ''], [string
$salt = ''])

Encrypts the value given with the optional salt. If the value is also missing, uses the $data_value property. Returns the encrypted string.

Tags:

access:

public

Parameters:

string	$value
string	$salt

[ Top ]

method generate [line 147]

string generate(
[integer
$length = 8])

Creates a "secure" password of the specified $length using a random

combination of lowercase and uppercase letters, numbers, and symbols (containing one of each for every four characters of the password, not necessarily in any order). This aims to help site administrators enforce more secure password policies, in conjunction with the makeStrong() method for verifying that user-created passwords meet certain security criteria.

method makeStrong [line 125]

void makeStrong(
)

Creates a series of rules for the current widget that state the minimum length of a valid password (8), and that it must contain at least one of each of the following: a lowercase letter, an uppercase letter, a number, a symbol.

Tags:

access:

public

[ Top ]

method validate [line 198]

boolean validate(
string
$value, object
$form, object
$cgi)

Validates the widget against its set of $rules. Returns false on failure to pass any rule.

Tags:

access:

public

Overrides MF_Widget::validate() (Validates the widget against its set of $rules. Returns false on failure to pass any rule.)

Parameters:

string	$value
object	$form
object	$cgi

[ Top ]

method verify [line 112]

boolean verify(
string
$input, string
$encrypted)

Verifies input agains an encrypted value to see if it matches.

Tags:

access:

public

Parameters:

string	$input
string	$encrypted

[ Top ]

Packages

Classes

Files

Class: MF_Widget_password

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:

$ignoreEmpty = true

Tags:

$type = 'password'

Tags:

Class Methods

method display [line 216]

Tags:

Parameters:

method encrypt [line 98]

Tags:

Parameters:

method generate [line 147]

Tags:

Parameters:

method makeStrong [line 125]

Tags:

method validate [line 198]

Tags:

Parameters:

method verify [line 112]

Tags:

Parameters: