Sitellite Application Framework
Class Tree         Index         All Elements
You are here: SAF / MailForm / MF_Widget_selector

Packages

Cache
Cart
CGI
Database
Date
Diff
File
Functions
GUI
HTML
I18n
Loader
Mail
MailForm
Misc
Parser
Security
Session
Site
Template
XML

Classes

MailForm
MailFormRule
MF_Widget
MF_Widget_access
MF_Widget_allow
MF_Widget_attach
MF_Widget_calendar
MF_Widget_checkbox
MF_Widget_date
MF_Widget_datetime
MF_Widget_datetimeinterval
MF_Widget_dirlist
MF_Widget_file
MF_Widget_hidden
MF_Widget_hiddenswitch
MF_Widget_image
MF_Widget_imagechooser
MF_Widget_info
MF_Widget_mref
MF_Widget_msubmit
MF_Widget_multiple
MF_Widget_owner
MF_Widget_password
MF_Widget_radio
MF_Widget_radiogroup
MF_Widget_ref
MF_Widget_reset
MF_Widget_section
MF_Widget_security
MF_Widget_select
MF_Widget_selector
MF_Widget_separator
MF_Widget_set
MF_Widget_status
MF_Widget_submit
MF_Widget_tab
MF_Widget_team
MF_Widget_template
MF_Widget_tie
MF_Widget_time
MF_Widget_timeinterval
MF_Widget_virtual

Files

Access.php
Allow.php
Attach.php
Calendar.php
Checkbox.php
Date.php
Datetime.php
Datetimeinterval.php
Dirlist.php
File.php
Functions.php
Hidden.php
Hiddenswitch.php
Image.php
Imagechooser.php
Info.php
MailForm.php
Mref.php
Msubmit.php
Multiple.php
Owner.php
Password.php
Radio.php
Radiogroup.php
Ref.php
Reset.php
Rule.php
Section.php
Security.php
Select.php
Selector.php
Separator.php
Set.php
Status.php
Submit.php
Tab.php
Team.php
Template.php
Tie.php
Time.php
Timeinterval.php
Virtual.php
Widget.php

Class: MF_Widget_selector

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

Class Overview

MF_Widget
   |
   --MF_Widget_selector

Selector widget. Displays a multiple-select box with a Javascript popup to add/remove items from the list.


Author(s)

Version

  • 1.0, 2003-08-16, $Id: Selector.php,v 1.4 2007/02/05 00:11:42 lux Exp $

Copyright

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

Variables

Methods

Inherited Variables

Class: MF_Widget

MF_Widget::$advanced
MF_Widget::$data_value
MF_Widget::$default_value
MF_Widget::$display_value
MF_Widget::$form
MF_Widget::$invalid
MF_Widget::$name
MF_Widget::$nullable
MF_Widget::$passover_isset
MF_Widget::$rule
MF_Widget::$rules
MF_Widget::$value

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 46]
Selector widget. Displays a multiple-select box with a Javascript popup to add/remove items from the list.


1     <?php
2     
3      $widget = new MF_Widget_selector ('name');
4      echo $widget->display ();
5     
6      ? >




Tags:

access:  public
version:  1.0, 2003-08-16, $Id: Selector.php,v 1.4 2007/02/05 00:11:42 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

$addAction =  'cms/selector/add'

[line 107]

Name of the box that adds the new item or items to the database table underlying the selector.



Tags:

access:  public

Type:   mixed


[ Top ]

$extra =  ''

[line 54]

A way to pass extra parameters to the HTML form tag, for example 'enctype="multipart/formdata"'.



Tags:

access:  public

Type:   mixed


[ Top ]

$key =  'id'

[line 79]

This is the primary key of the list table.



Tags:

access:  public

Type:   mixed


[ Top ]

$multiple =  false

[line 98]

If you want this to be a multiple-select widget, set this property to true.



Tags:

access:  public

Type:   mixed


[ Top ]

$removeAction =  'cms/selector/remove'

[line 116]

Name of the box that removes the specified item or items from the database table underlying the selector.



Tags:

access:  public

Type:   mixed


[ Top ]

$size =  false

[line 89]

Set this property to the number of options to display.



Tags:

access:  public

Type:   mixed


[ Top ]

$table =  'sitellite_category'

[line 71]

This is the database table to get the list of items from.



Tags:

access:  public

Type:   mixed


[ Top ]

$title =  false

[line 81]


Type:   mixed


[ Top ]

$type =  'selector'

[line 63]

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_selector [line 125]

MF_Widget_selector MF_Widget_selector( string $name)

Constructor Method.



Tags:

access:  public


Parameters:

string   $name  

[ Top ]

method display [line 198]

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 getList [line 137]

array getList( )

Retrieve the list of items.



[ Top ]

method getValue [line 174]

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

Fetches the actual value for this widget.



Tags:

access:  public


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

Parameters:

object   $cgi  

[ Top ]

method setValue [line 158]

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


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   $value  
string   $inner_component  

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