Class: MF_Widget_attach

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

Class Overview

MF_Widget
   |
   --MF_Widget_attach

Attach widget. Implements the interface to an "attachment" component for messages. Leaves the add and remove logic to separate scripts which are called through popup windows. Used in the Sitellite Personal Workspace.

Author(s)

John Luxford <mailto:lux@simian.ca>

Version

1.0, 2002-09-27, $Id: Attach.php,v 1.2 2005/07/06 15:30:56 lux Exp $

Copyright

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 54]
Attach widget. Implements the interface to an "attachment" component for messages. Leaves the add and remove logic to separate scripts which are called through popup windows. Used in the Sitellite Personal Workspace.

The submitted value of this widget does not represent the list of attachments, since adding and removing attachments are handled externally.


1     <?php
2     
3      $widget = new MF_Widget_attach ('name');
4      $widget->validation ('is "foo"');
5      $widget->setValue ('foo');
6      $widget->error_message = 'Oops!  This widget is being unruly!';
7     
8      ? >

Tags:

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

$addLink = 'addAttachment.php'

[line 89]

This is the link to send the 'Add' button to. Defaults to 'addAttachment.php'.

Tags:

access:

public

Type:	mixed
Overrides:	Array

[ Top ]

Class Methods

method buttons [line 100]

void buttons(
)

[ Top ]

method display [line 133]

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

void getValue(
)

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

[ Top ]

method validate [line 115]

void validate(
)

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

[ Top ]

Packages

Classes

Files

Class: MF_Widget_attach

Class Overview

Author(s)

Version

Copyright

Variables

Methods

Inherited Variables

Class: MF_Widget

Inherited Methods

Class: MF_Widget

Class Details

Tags:

Class Variables

$addLink = 'addAttachment.php'

Tags:

$extra = ''

Tags:

$removeLink = 'removeAttachment.php'

Tags:

$size = 3

Tags:

$type = 'attach'

Tags:

Class Methods

method buttons [line 100]

method display [line 133]

Tags:

Parameters:

method getValue [line 119]

method validate [line 115]