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 45]
Pseudo-Widget that displays a section header.


1     <?php
2     
3      $widget = new MF_Widget_section ('section2');
4      $widget->setValue ('Section Title');
5      $widget->display ();
6     
7      ?>

Tags:

access:	public
version:	1.0, 2002-08-31, $Id: Section.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

$bold = true

[line 69]

Set this to false if you don't want the text to be bolded.

Tags:

access:

public

Type:	mixed
Overrides:	Array

[ Top ]

Class Methods

constructor MF_Widget_section [line 78]

MF_Widget_section MF_Widget_section(
string
$name)

Constructor Method.

method display [line 135]

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 getValue [line 121]

string getValue(
[object
$cgi = ''])

Fetches the actual value for this widget.

method setValue [line 107]

void setValue(
[string
$key = ''], [string
$value = ''])

Sets the section title. The second parameter is ignored.

Tags:

access:

public

Overrides 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.)

Parameters:

string	$key
string	$value

[ Top ]

method validate [line 95]

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 ]

Packages

Classes

Files

Class: MF_Widget_section

Class Overview

Author(s)

Version

Copyright

Variables

Methods

Inherited Variables

Class: MF_Widget

Inherited Methods

Class: MF_Widget

Class Details

Tags:

Class Variables

$bold = true

Tags:

$title =

Tags:

$type = 'section'

Tags:

Class Methods

constructor MF_Widget_section [line 78]

Tags:

Parameters:

method display [line 135]

Tags:

Parameters:

method getValue [line 121]

Tags:

Parameters:

method setValue [line 107]

Tags:

Parameters:

method validate [line 95]

Tags:

Parameters: