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 the output of a simple template.


1     <?php
2     
3      $widget = new MF_Widget_template ('template1');
4      $widget->setValue ('some_template.spt');
5      $widget->display ();
6     
7      ? >

Tags:

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

$data = array ()

[line 60]

The data to pass to the template.

Tags:

access:

public

Type:

mixed

[ Top ]

$submitButtons = array ()

[line 80]

If you define any submit buttons that are meant to actually submit the form (ie. not stopped in their tracks via the onclick handler) within your template, then you need to specify those here, so that MailForm knows the form was submitted.

Tags:

access:

public

Type:	mixed
Overrides:	Array

[ Top ]

Class Methods

constructor MF_Widget_template [line 89]

MF_Widget_template MF_Widget_template(
string
$name)

Constructor Method.

method display [line 164]

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 150]

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

Fetches the actual value for this widget.

method setValue [line 136]

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 setValues [line 119]

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

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

Tags:

access:

public

Overrides MF_Widget::setValues() (Sets the *POSSIBLE* values for this widget. If $value is given, sets $this->value as a hash, otherwise, as a string.)

Parameters:

string	$key
string	$value

[ Top ]

method validate [line 106]

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_template

Class Overview

Author(s)

Version

Copyright

Variables

Methods

Inherited Variables

Class: MF_Widget

Inherited Methods

Class: MF_Widget

Class Details

Tags:

Class Variables

$data = array ()

Tags:

$submitButtons = array ()

Tags:

$template =

Tags:

$type = 'template'

Tags:

Class Methods

constructor MF_Widget_template [line 89]

Tags:

Parameters:

method display [line 164]

Tags:

Parameters:

method getValue [line 150]

Tags:

Parameters:

method setValue [line 136]

Tags:

Parameters:

method setValues [line 119]

Tags:

Parameters:

method validate [line 106]

Tags:

Parameters: