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 55]
Msubmit widget (as in Multiple Submit). Displays a list of submit buttons all in a horizontal row.


1     <?php
2     
3      $widget = new MF_Widget_msubmit ('name');
4     
5      $inner_one =& $widget->getButton ();
6      $inner_one->addRule ('is "foo"', 'You must select "foo", even if you want to choose "bar".');
7      $inner_one->setValues ('foo');
8     
9      $inner_two =& $widget->addButton ('name', 'bar');
10    
11     echo $widget->display (false);
12    
13     ?>

Tags:

access:	public
version:	1.0, 2002-09-21, $Id: Msubmit.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

$buttons = array ()

[line 81]

A list of "inner" submit buttons, which are MF_Widget_submit objects.

Tags:

access:

public

Type:	mixed
Overrides:	Array

[ Top ]

Class Methods

constructor MF_Widget_msubmit [line 95]

MF_Widget_msubmit MF_Widget_msubmit(
[string
$name = 'submit_button'], [string
$value = ''])

Constructor Method. This creates the first submit widget in

the list. To retrieve a reference to this widget (to set it's value, etc.), use the getButton() method before adding any additional buttons with the addButton() method. You can also set the value of the first button immediately by passing a second parameter to the constructor.

Tags:

access:

public

Parameters:

string	$name
string	$value

[ Top ]

method addButton [line 123]

object reference &addButton(
[string
$name = 'submit_button'], [string
$value = ''])

Adds a new submit button to the $buttons list.

Tags:

access:

public

Parameters:

string	$name
string	$value

[ Top ]

method display [line 178]

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 getButton [line 110]

object reference &getButton(
)

Returns a reference to the first submit button.

Tags:

access:

public

[ Top ]

method getValue [line 158]

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

Fetches the actual value for this widget.

method validate [line 140]

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_msubmit

Class Overview

Author(s)

Version

Copyright

Variables

Methods

Inherited Variables

Class: MF_Widget

Inherited Methods

Class: MF_Widget

Class Details

Tags:

Class Variables

$buttons = array ()

Tags:

$extra = ''

Tags:

$type = 'submit'

Tags:

Class Methods

constructor MF_Widget_msubmit [line 95]

Tags:

Parameters:

method addButton [line 123]

Tags:

Parameters:

method display [line 178]

Tags:

Parameters:

method getButton [line 110]

Tags:

method getValue [line 158]

Tags:

Parameters:

method validate [line 140]

Tags:

Parameters: