Docs For Class MF

MF_Widget MF_Widget(
string
$name)

Constructor Method.

Tags:

access:

public

Parameters:

string

$name

[ Top ]

boolean addRule(
string
$rule, [string
$msg = ''])

Adds a validation rule to the list of $rules.

Tags:

access:

public

Parameters:

string	$rule
string	$msg

[ Top ]

string attr(
string
$key, [mixed
$value = false])

This is the accessor method for setting and getting the value of

any attribute of the tag, including 'method' and 'action'. This will replace the $extra property, which is henceforth deprecated. If you call this method and provide no $value, you are using it as a 'getter', as in you are getting the current value. If you provide a value, the new value will be set, so you are acting as a 'setter'. If you simply specify that the $value be true, then it will appear filled with its own name (useful for things like the checked="checked" attribute of a checkbox input field).

Tags:

access:

public

Parameters:

string

$key

[ Top ]

void changeType(
mixed
$newType, [mixed
$extra = array ()])

[ Top ]

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

Overridden in child classes as:

MF_Widget_attach::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_calendar::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_checkbox::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_allow::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_date::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_datetime::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_datetimeinterval::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_dirlist::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_file::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_hidden::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_image::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_imagechooser::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_info::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_msubmit::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_multiple::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_mref::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_owner::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_password::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_radio::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_radiogroup::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_reset::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_section::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_security::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_select::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_access::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_ref::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_status::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_selector::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_separator::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_set::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_submit::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_tab::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_team::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_template::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_tie::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_time::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_timeinterval::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_virtual::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 ]

string 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.

Tags:

access:

public

[ Top ]

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

Fetches the actual value for this widget.

Tags:

access:

public

Overridden in child classes as:

MF_Widget_attach::getValue()

MF_Widget_checkbox::getValue(): Fetches the actual value for this widget.

MF_Widget_date::getValue(): Fetches the actual value for this widget.

MF_Widget_datetime::getValue(): Fetches the actual value for this widget.

MF_Widget_datetimeinterval::getValue(): Fetches the actual value for this widget.

MF_Widget_dirlist::getValue(): Fetches the actual value for this widget.

MF_Widget_hiddenswitch::getValue(): Fetches the actual value for this widget. Note: This field actual relies on a global $cgi object.

MF_Widget_image::getValue(): Fetches the actual value for this widget, which is an array with keys x and y, representing the coordinates of the mouse click of the visitor.

MF_Widget_msubmit::getValue(): Fetches the actual value for this widget.

MF_Widget_multiple::getValue(): Fetches the actual value for this widget.

MF_Widget_radiogroup::getValue(): Fetches the actual value for this widget.

MF_Widget_section::getValue(): Fetches the actual value for this widget.

MF_Widget_selector::getValue(): Fetches the actual value for this widget.

MF_Widget_separator::getValue(): Fetches the actual value for this widget.

MF_Widget_set::getValue(): Fetches the actual value for this widget.

MF_Widget_tab::getValue(): Fetches the actual value for this widget.

MF_Widget_template::getValue(): Fetches the actual value for this widget.

MF_Widget_time::getValue(): Fetches the actual value for this widget.

MF_Widget_timeinterval::getValue(): Fetches the actual value for this widget.

MF_Widget_virtual::getValue(): Fetches the actual value for this widget. Returns whatever the function or database query returns. If $column is specified, returns the value of the $column field from the first record of the database results.

Parameters:

object

$cgi

[ Top ]

string invalid(
)

Returns a ' class="invalid"' string if the widget's $invalid property is set to true, or an empty string otherwise.

Tags:

access:

public

[ Top ]

void setDefault(
string
$value)

Sets the default value for the widget.

Tags:

access:

public

Overridden in child classes as:

MF_Widget_date::setDefault(): Gives this widget a default value. Accepts a date string of the format 'YYYY-MM-DD'.

MF_Widget_datetime::setDefault(): Gives this widget a default value. Accepts a date string of the format 'YYYY-MM-DD HH:MM:SS' or 'YYYYMMDDHHMMSS'.

MF_Widget_datetimeinterval::setDefault(): Gives this widget a default value. Accepts a date string of the format 'YYYY-MM-DD HH:MM:SS' or 'YYYYMMDDHHMMSS'.

MF_Widget_set::setDefault(): Gives this widget a default value. Accepts a date string of the format 'YYYY-MM-DD'.

MF_Widget_time::setDefault(): Gives this widget a default value. Accepts a time string of the format 'HH:MM:SS'.

MF_Widget_timeinterval::setDefault(): Gives this widget a default value. Accepts a time string of the format 'HH:MM:SS'.

Parameters:

string

$value

[ Top ]

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

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.

Tags:

access:

public

Overridden in child classes as:

MF_Widget_checkbox::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_date::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_datetime::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_datetimeinterval::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_dirlist::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_multiple::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_section::setValue(): Sets the section title. The second parameter is ignored.

MF_Widget_selector::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_set::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_template::setValue(): Sets the section title. The second parameter is ignored.

MF_Widget_time::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_timeinterval::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_virtual::setValue(): Sets either the $function or $query property. If the property name is specified as $key, then $value is what it is set to, otherwise it checks to see if the $key is an existing function and if so sets $function to $key, otherwise sets $query to $key.

Parameters:

string	$value
string	$inner_component

[ Top ]

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

Sets the *POSSIBLE* values for this widget. If $value is given, sets $this->value as a hash, otherwise, as a string.

Please Note: No simple arrays allowed, or the numeric keys will be used as the value property in the HTML output.

Tags:

access:

public

Overridden in child classes as:

MF_Widget_set::setValues(): Sets the *POSSIBLE* values for this widget. Uses

MF_Widget_template::setValues(): Sets the data values to pass to the template. If $value is given, sets $this->value as a hash, otherwise, as a string.

MF_Widget_tie::setValues(): Sets the values to display for the specified value of the other widget, which is specified in $name parameter.

Parameters:

string	$key
string	$value

[ Top ]

string unsetAttr(
string
$key)

Use this method to remove an attribute from the tag

attribute list. Use this instead of passing a false value to attr(), because a false value essentially means "return the current value" in that method. This method returns the old value of the attribute being unset.

Tags:

access:

public

Parameters:

string

$key

[ Top ]

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

Overridden in child classes as:

MF_Widget_attach::validate()

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

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

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

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

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

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

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

MF_Widget_virtual::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 ]

void validation(
string
$rule)

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.

Tags:

access:

public

Parameters:

string

$rule

[ Top ]

Packages

Classes

Files

Class: MF_Widget

Class Overview

Author(s)

Version

Copyright

Variables

Methods

Child Classes

Inherited Variables

Inherited Methods

Class Details

Tags:

Class Variables

$advanced = false

Tags:

$data_value =

Tags:

$default_value =

Tags:

$display_value =

Tags:

$form = false

Tags:

$invalid = false

Tags:

$name =

Tags:

$nullable = false

Tags:

$passover_isset = false

Tags:

$rule =

Tags:

$rules = array ()

Tags:

$type =

Tags:

$value = array ()

Tags:

Class Methods

constructor MF_Widget [line 265]

Tags:

Parameters:

method addRule [line 300]

Tags:

Parameters:

method attr [line 460]

Tags:

Parameters:

method changeType [line 524]

method display [line 437]

Tags:

Parameters:

method getAttrs [line 495]

Tags:

method getValue [line 388]

Tags:

Parameters:

method invalid [line 517]

Tags:

method setDefault [line 419]

Tags:

Parameters:

method setValue [line 372]

Tags:

Parameters:

method setValues [line 350]

Tags:

Parameters:

method unsetAttr [line 481]

Tags:

Parameters:

method validate [line 315]

Tags:

Parameters:

method validation [line 287]

Tags: