Sitellite Application Framework
Class Tree         Index         All Elements

Class: MF_Widget_hiddenswitch

Source Location: Program_Root/MailForm/Widget/Hiddenswitch.php

Class Overview

MF_Widget
   |
   --MF_Widget_hiddenswitch

Hiddenswitch widget. Displays no form field, but returns a value based on another field's value.


Author(s)

Version

  • 1.2, 2002-05-18, $Id: Hiddenswitch.php,v 1.2 2005/07/06 15:30:56 lux Exp $

Copyright

  • Copyright (C) 2001-2003, Simian Systems Inc.

Variables

Methods


Inherited Variables

Inherited Methods

Class: MF_Widget

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 61]
Hiddenswitch widget. Displays no form field, but returns a value based on another field's value.

New in 1.2:

  • Added a constructor method to set the $passover_isset value to true, which is inherited from MF_Widget.

1 <?php
2
3 $widget = new MF_Widget_hiddenswitch ('associations');
4 $widget->set = array (
5 'foo' => 'bar',
6 'asdf' => 'qwerty',
7 'apples' => 'oranges',
8 );
9 $widget->field = 'pick';
10
11 // now create a Select widget called 'pick' and give it the
12 // options 'foo', 'asdf', and 'apples'. when you submit
13 // your form, you will end up with a field called 'associations'
14 // containing the appropriate value using the value of
15 // 'pick' as the key.
16
17 ?>




Tags:

access:  public
version:  1.2, 2002-05-18, $Id: Hiddenswitch.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

$field =  ''

[line 68]

The field to use to determine the key in the key/value $set property.



Tags:

access:  public

Type:   mixed


[ Top ]

$type =  'hiddenswitch'

[line 77]

This is the short name for this widget. The short name is the class name minus the 'MF_Widget_' prefix.



Tags:

access:  public

Type:   mixed
Overrides:   Array


[ Top ]



Class Methods


constructor MF_Widget_hiddenswitch [line 87]

MF_Widget_hiddenswitch MF_Widget_hiddenswitch( string $name)

Constructor Method. Also sets the $passover_isset property to false.



Tags:

access:  public


Parameters:

string   $name  

[ Top ]

method getValue [line 101]

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

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



Tags:

access:  public


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

Parameters:

object   $cgi  

[ Top ]


Copyright © 2007, SIMIAN systems Inc.
All rights reserved. Privacy policy
Documentation generated on Tue, 13 Feb 2007 17:17:43 -0600 by Sitellite AppDoc and phpDocumentor 1.2.2