Sitellite Application Framework
Class Tree         Index         All Elements

Class: MF_Widget_dirlist

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

Class Overview

MF_Widget
   |
   --MF_Widget_dirlist

Dirlist widget. Displays a select box with a list of files from a specific folder.


Author(s)

Version

  • 1.2, 2002-04-27, $Id: Dirlist.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 53]
Dirlist widget. Displays a select box with a list of files from a specific folder.

Note: If $show_viewbutton is true, requires the $intl object.

New in 1.2:

  • Added a $recursive option.

1 <?php
2
3 $widget = new MF_Widget_dirlist ('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.2, 2002-04-27, $Id: Dirlist.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

$directory =

[line 69]

Contains the directory to read the list of files from.



Tags:

access:  public

Type:   mixed


[ Top ]

$extensions = array ()

[line 61]

Contains a list of valid file extensions to display from the directory.



Tags:

access:  public

Type:   mixed


[ Top ]

$extra =  ''

[line 86]

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



Tags:

access:  public

Type:   mixed


[ Top ]

$formname =

[line 112]

Contains the name property of the current form. Required only if $show_viewbutton is true.



Tags:

access:  public

Type:   mixed


[ Top ]

$recursive =

[line 120]

Whether or not the list should display recursively into sub-directories.



Tags:

access:  public

Type:   mixed


[ Top ]

$show_viewbutton =

[line 95]

Determines whether or not to display a 'view' link next to the select box, which will pop up a view of the item from the list.



Tags:

access:  public

Type:   mixed


[ Top ]

$type =  'dirlist'

[line 129]

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 ]

$web_path =

[line 103]

Contains the web directory to access the list of files from.



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


constructor MF_Widget_dirlist [line 138]

MF_Widget_dirlist MF_Widget_dirlist( string $name)

Constructor Method.



Tags:

access:  public


Parameters:

string   $name  

[ Top ]

method display [line 201]

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

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

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:17:21 -0600 by Sitellite AppDoc and phpDocumentor 1.2.2